MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_DVectorOutFunc.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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef VECTOR_OUT_FUNC_H
00030 #define VECTOR_OUT_FUNC_H
00031 
00032 #include "DenseLinAlgPack_IOBasic.hpp"
00033 
00034 namespace DenseLinAlgPack {
00035 
00036 /* * @name DVectorSlice output stream function.
00037   *
00038   * This is a functions that are used to output a DVectorSlice object
00039   * to a char based output stream.
00040   *
00041   * The output format is diferent depending on the on whether the
00042   * bits #LinAlgPackIO::ignore_dim_bit# and #LinAlgPackIO::no_insert_newlines_bit# are set.
00043   * If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
00044   * then the output format is:
00045   *
00046   * Case 1\\
00047   * #v.size()#\\
00048   * # v(1)  v(2)  v(3) ... v(v.size())#\\
00049   *
00050   * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the output format is:
00051   *
00052   * Case 2\\
00053   * # v(1)  v(2)  v(3) ... v(v.size())#\\
00054   *
00055   * Each of the elements are are put into columns according to the width set in the 
00056   * output stream #os# and other formating commands when it is called.  Even if the set
00057   * width is 0 or less than
00058   * the number of char's for the element a space ' ' will be inserted between them.
00059   * The elements are formated according to the format in the stream #os#.
00060   *
00061   * If #exta_flags & LinAlgPackIO::no_insert_newlines_bit == 0# then a newline charactor
00062   * will not be inserted after the last element, otherwise (by default) it will be.
00063   *
00064   * If #vs.size() == 0# then no elements will be output and if
00065   * #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then only the operation
00066   * #os << vs.size() << endl;# will be performed.
00067   *
00068   * If any of the output operations fails then a #std::ios_base::failure# exception is thrown. 
00069   */
00070 std::ostream& output(std::ostream& os, const DVectorSlice& vs, LinAlgPackIO::fmtflags extra_flags);
00071 
00072 } // end namespace DenseLinAlgPack
00073 
00074 #endif  // VECTOR_OUT_FUNC_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines