MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_DVectorInFunc.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 VECTOR_IN_FUNC_H
00043 #define VECTOR_IN_FUNC_H
00044 
00045 #include "DenseLinAlgPack_IOBasic.hpp"
00046 
00047 namespace DenseLinAlgPack {
00048 
00049 /* * @name DVector/DVectorSlice input stream functions.
00050   *
00051   * These are functions that are used to read a DVector
00052   * or DVectorSlice object from a formated input stream.
00053   *
00054   * The input format is diferent depending on the on whether the
00055   * bit #LinAlgPackIO::ignore_dim_bit# is set.  If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
00056   * then the input format is:
00057   *
00058   * Case 1\\
00059   * #n#\\
00060   * #v(1) v(2) v(3) ... v(n)#\\
00061   *
00062   * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the input format is:
00063   *
00064   * Case 2\\
00065   * #v(1) v(2) v(3) ... v(v.size())#\\
00066   *
00067   * The numbers of the input must be seperated by white space and be valid
00068   * C numeric constants.  For example, the input format for the vector {1.1, 2.2, 3.3}
00069   * for case 1 is:
00070   *
00071   * #3#\\
00072   * #1.1  2.2   3.3#\\
00073   *
00074   * And for case 2 is:
00075   *
00076   * #1.1  2.2   3.3#\\
00077   *
00078   * It is permisible for the dimension #n# in case 1 to be 0.  In this case there will be
00079   * no elements.  So to input an empty vector you would use:
00080   *
00081   * #0#\\
00082   *
00083   * If any of the input operations fails then a LinAlgPackIO::InputException exception
00084   * is thrown.  In other words if #is.fail()# or #is.eof()# is true
00085   * before all of the elements have been read in then the exception is thrown.
00086   * Also if the stream becomes corrupted (#is.bad() == true#) then a #std::ios_base::failure#
00087   * exception is thrown. 
00088   */
00089 // @{
00090 
00092 /* * DVector input stream function.
00093   *
00094   * Inputs a DVector object from an input stream.  If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
00095   * then #v# is resized to #n# given in the file.  If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0#
00096   * then the number of elements read in depends on the current size of #v#.
00097   *
00098   */
00099 std::istream& input(std::istream& is, DVector* v, LinAlgPackIO::fmtflags extra_flags);
00100 
00102 /* * DVectorSlice input stream function.
00103   *
00104   * Inputs a DVectorSlice object from an input stream.  If #exta_flags & LinAlgPackIO::ignore_dim_bit != 0#
00105   * then the size (!= 0) of #vs# is compared to the #n# given in the file and if they are not equal
00106   * then a #LinAlgPackIO::InputException# is thrown.  If #vs# is unsized then it is resized to #n#.
00107   * If #exta_flags & LinAlgPackIO::ignore_dim_bit == 0# then the number of elements read in depends
00108   * on the current size of #vs#.
00109   */
00110 std::istream& input(std::istream& is, DVectorSlice* vs, LinAlgPackIO::fmtflags extra_flags);
00111 
00112 // @}
00113 
00114 } // end namespace DenseLinAlgPack
00115 
00116 #endif  // VECTOR_IN_FUNC_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines