DenseLinAlgPack: Concreate C++ Classes for Dense Blas-Compatible Linear Algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DenseLinAlgPack_DVectorInFunc.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef VECTOR_IN_FUNC_H
43 #define VECTOR_IN_FUNC_H
44 
45 #include "DenseLinAlgPack_IOBasic.hpp"
46 
47 namespace DenseLinAlgPack {
48 
49 /* * @name DVector/DVectorSlice input stream functions.
50  *
51  * These are functions that are used to read a DVector
52  * or DVectorSlice object from a formated input stream.
53  *
54  * The input format is diferent depending on the on whether the
55  * bit #LinAlgPackIO::ignore_dim_bit# is set. If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
56  * then the input format is:
57  *
58  * Case 1\\
59  * #n#\\
60  * #v(1) v(2) v(3) ... v(n)#\\
61  *
62  * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the input format is:
63  *
64  * Case 2\\
65  * #v(1) v(2) v(3) ... v(v.size())#\\
66  *
67  * The numbers of the input must be seperated by white space and be valid
68  * C numeric constants. For example, the input format for the vector {1.1, 2.2, 3.3}
69  * for case 1 is:
70  *
71  * #3#\\
72  * #1.1 2.2 3.3#\\
73  *
74  * And for case 2 is:
75  *
76  * #1.1 2.2 3.3#\\
77  *
78  * It is permisible for the dimension #n# in case 1 to be 0. In this case there will be
79  * no elements. So to input an empty vector you would use:
80  *
81  * #0#\\
82  *
83  * If any of the input operations fails then a LinAlgPackIO::InputException exception
84  * is thrown. In other words if #is.fail()# or #is.eof()# is true
85  * before all of the elements have been read in then the exception is thrown.
86  * Also if the stream becomes corrupted (#is.bad() == true#) then a #std::ios_base::failure#
87  * exception is thrown.
88  */
89 // @{
90 
92 /* * DVector input stream function.
93  *
94  * Inputs a DVector object from an input stream. If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
95  * then #v# is resized to #n# given in the file. If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0#
96  * then the number of elements read in depends on the current size of #v#.
97  *
98  */
99 std::istream& input(std::istream& is, DVector* v, LinAlgPackIO::fmtflags extra_flags);
100 
102 /* * DVectorSlice input stream function.
103  *
104  * Inputs a DVectorSlice object from an input stream. If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
105  * then the size (!= 0) of #vs# is compared to the #n# given in the file and if they are not equal
106  * then a #LinAlgPackIO::InputException# is thrown. If #vs# is unsized then it is resized to #n#.
107  * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the number of elements read in depends
108  * on the current size of #vs#.
109  */
110 std::istream& input(std::istream& is, DVectorSlice* vs, LinAlgPackIO::fmtflags extra_flags);
111 
112 // @}
113 
114 } // end namespace DenseLinAlgPack
115 
116 #endif // VECTOR_IN_FUNC_H