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_DVectorOutFunc.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_OUT_FUNC_H
43 #define VECTOR_OUT_FUNC_H
44 
45 #include "DenseLinAlgPack_IOBasic.hpp"
46 
47 namespace DenseLinAlgPack {
48 
49 /* * @name DVectorSlice output stream function.
50  *
51  * This is a functions that are used to output a DVectorSlice object
52  * to a char based output stream.
53  *
54  * The output format is diferent depending on the on whether the
55  * bits #LinAlgPackIO::ignore_dim_bit# and #LinAlgPackIO::no_insert_newlines_bit# are set.
56  * If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
57  * then the output format is:
58  *
59  * Case 1\\
60  * #v.size()#\\
61  * # v(1) v(2) v(3) ... v(v.size())#\\
62  *
63  * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the output format is:
64  *
65  * Case 2\\
66  * # v(1) v(2) v(3) ... v(v.size())#\\
67  *
68  * Each of the elements are are put into columns according to the width set in the
69  * output stream #os# and other formating commands when it is called. Even if the set
70  * width is 0 or less than
71  * the number of char's for the element a space ' ' will be inserted between them.
72  * The elements are formated according to the format in the stream #os#.
73  *
74  * If #exta_flags & LinAlgPackIO::no_insert_newlines_bit == 0# then a newline charactor
75  * will not be inserted after the last element, otherwise (by default) it will be.
76  *
77  * If #vs.size() == 0# then no elements will be output and if
78  * #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then only the operation
79  * #os << vs.size() << endl;# will be performed.
80  *
81  * If any of the output operations fails then a #std::ios_base::failure# exception is thrown.
82  */
83 std::ostream& output(std::ostream& os, const DVectorSlice& vs, LinAlgPackIO::fmtflags extra_flags);
84 
85 } // end namespace DenseLinAlgPack
86 
87 #endif // VECTOR_OUT_FUNC_H