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