DenseLinAlgPack_MatlabPack.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 MATLAB_PACK_H
00030 #define MATLAB_PACK_H
00031 
00032 #include "DenseLinAlgPack_Types.hpp"
00033 
00034 namespace DenseLinAlgPack {
00035 namespace MatlabPack {
00036 
00037 /* * @name MatlabPack.
00038   *
00039   * This package contains functions that allow integration with 
00040   * Matlab.
00041   */
00042 // @{
00043 
00044 /* * @name Output matrices and vectors in Matlab readable format.
00045   *
00046   * These function output vectors and matrices with enought digits
00047   * to reproduce the exact same floating point numbers.
00048   */
00049 // @{
00050 
00052 /* * Output a DVectorSlice.
00053   *
00054   * The DVectorSlice is output in the following format:
00055   *
00056   \verbatim
00057   name = [ vs(1); vs(2); ... vs(n); ];
00058   \endverbatim
00059   *
00060   * Above #n = vs.size()# and #'# is appended to the end if #trans != BLAS_Cpp::no_trans#.
00061   * Also, a newline character #\n# is appended to the end after #']'#.
00062   */
00063 std::ostream& out( std::ostream& o, const char* name, const DVectorSlice& vs
00064   , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );
00065 
00067 /* * Output a DMatrixSlice.
00068   *
00069   * The DMatrixSlice is output in the following format:
00070   *
00071   \verbatim
00072   name = [
00073   gms(1,1), gms(1,2), ... gms(1,n);
00074   gms(2,1), gms(2,2), ... gms(2,n);
00075   ...       ...       ... ...
00076   gms(m,1), gms(m,2), ... gms(m,n);
00077    ];
00078   \endverbatim
00079   *
00080   * Above #m = gms.rows()#, #n = gms.cols()# and #'# is appended to the end
00081   * if #trans != BLAS_Cpp::no_trans#.
00082   * Also, a newline character #\n# is appended to the end
00083   */
00084 std::ostream& out( std::ostream& o, const char* name, const DMatrixSlice& gms
00085   , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );
00086 
00087 // @}
00088 
00089 // @}
00090 
00091 } // end namespace MatlabPack
00092 } // end namespace DenseLinAlgPack
00093 
00094 #endif  // MATLAB_PACK_H

Generated on Tue Jul 13 09:30:52 2010 for MOOCHO (Single Doxygen Collection) by  doxygen 1.4.7