MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_DMatrixOutFunc.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef GENMATRIX_OUT_FUNC_H
00043 #define GENMATRIX_OUT_FUNC_H
00044 
00045 #include "DenseLinAlgPack_IOBasic.hpp"
00046 
00047 namespace DenseLinAlgPack {
00048 
00049 /* * @name DMatrixSlice output stream function.
00050   *
00051   * This is a function that are used to output a DMatrixSlice object
00052   * to a char based output stream.  This format is ment to be both
00053   * human and machine readable.  In fact the \Ref{input} function
00054   * can be used to read in the output produced by this function.
00055   * This function is ment to be the machinary for an optional output stream
00056   * operator \Ref{operator<<}.
00057   *
00058   * The output format is diferent depending on the on whether the
00059   * bits #LinAlgPackIO::ignore_dim_bit# and #LinAlgPackIO::no_insert_newlines_bit# are set.
00060   * The default output format is (exta_flags == 0):
00061   *
00062   * #gms.rows()  gms.cols()#\\
00063   * #gms(1,1)           gms(1,2)          gms(1,3)          ...      gms(1,gms.cols())#\\
00064   * #gms(2,1)           gms(2,2)          gms(2,3)          ...      gms(2,gms.cols())#\\
00065   * #   .                   .                .                               .#\\
00066   * #gms(gms.rows(),1) gms(gms.rows(),2)  gms(gms.rows(),3)          gms(gms.rows(),gms.cols())#\\
00067   *
00068   * If #extra_flags & LinAlgPackIO::ignore_dim_bit != 0# then the dimensions of the
00069   * matrix are not output and if #extra_flags & LinAlgPackIO::no_insert_newlines_bit != 0#
00070   * then newline char ('\n') are not inserted after each row.
00071   *
00072   * Each of the elements are are put into columns according to the width set in the 
00073   * output stream #os# when it is called and other formating commands.  Even if the set
00074   * width is 0 or less than
00075   * the number of char's for the element a space ' ' will be inserted between them.
00076   * The elements are formated according to the format in the stream #os#.
00077   *
00078   * If #gms.rows() == 0# then no elements will be output and if
00079   * #extra_flags & LinAlgPackIO::ignore_dim_bit != 0# and only the operation
00080   * #os << gms.rows() << ' ' << gms.cols() << endl;# will be performed.
00081   *
00082   * If any of the output operations fails then a #std::ios_base::failure# exception is thrown. 
00083   */
00084 std::ostream& output(std::ostream& os, const DMatrixSlice& gms, LinAlgPackIO::fmtflags extra_flags);
00085 
00086 } // end namespace DenseLinAlgPack
00087 
00088 #endif  // GENMATRIX_OUT_FUNC_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines