MOOCHO (Single Doxygen Collection) Version of the Day
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 // 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 MATLAB_PACK_H
00043 #define MATLAB_PACK_H
00044 
00045 #include "DenseLinAlgPack_Types.hpp"
00046 
00047 namespace DenseLinAlgPack {
00048 namespace MatlabPack {
00049 
00050 /* * @name MatlabPack.
00051   *
00052   * This package contains functions that allow integration with 
00053   * Matlab.
00054   */
00055 // @{
00056 
00057 /* * @name Output matrices and vectors in Matlab readable format.
00058   *
00059   * These function output vectors and matrices with enought digits
00060   * to reproduce the exact same floating point numbers.
00061   */
00062 // @{
00063 
00065 /* * Output a DVectorSlice.
00066   *
00067   * The DVectorSlice is output in the following format:
00068   *
00069   \verbatim
00070   name = [ vs(1); vs(2); ... vs(n); ];
00071   \endverbatim
00072   *
00073   * Above #n = vs.size()# and #'# is appended to the end if #trans != BLAS_Cpp::no_trans#.
00074   * Also, a newline character #\n# is appended to the end after #']'#.
00075   */
00076 std::ostream& out( std::ostream& o, const char* name, const DVectorSlice& vs
00077   , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );
00078 
00080 /* * Output a DMatrixSlice.
00081   *
00082   * The DMatrixSlice is output in the following format:
00083   *
00084   \verbatim
00085   name = [
00086   gms(1,1), gms(1,2), ... gms(1,n);
00087   gms(2,1), gms(2,2), ... gms(2,n);
00088   ...       ...       ... ...
00089   gms(m,1), gms(m,2), ... gms(m,n);
00090    ];
00091   \endverbatim
00092   *
00093   * Above #m = gms.rows()#, #n = gms.cols()# and #'# is appended to the end
00094   * if #trans != BLAS_Cpp::no_trans#.
00095   * Also, a newline character #\n# is appended to the end
00096   */
00097 std::ostream& out( std::ostream& o, const char* name, const DMatrixSlice& gms
00098   , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );
00099 
00100 // @}
00101 
00102 // @}
00103 
00104 } // end namespace MatlabPack
00105 } // end namespace DenseLinAlgPack
00106 
00107 #endif  // MATLAB_PACK_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines