DenseLinAlgPack_MatlabPack.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MATLAB_PACK_H
#define MATLAB_PACK_H

#include "DenseLinAlgPack_Types.hpp"

namespace DenseLinAlgPack {
namespace MatlabPack {

/* * @name MatlabPack.
  *
  * This package contains functions that allow integration with 
  * Matlab.
  */
// @{

/* * @name Output matrices and vectors in Matlab readable format.
  *
  * These function output vectors and matrices with enought digits
  * to reproduce the exact same floating point numbers.
  */
// @{

/* * Output a DVectorSlice.
  *
  * The DVectorSlice is output in the following format:
  *
  \verbatim
  name = [ vs(1); vs(2); ... vs(n); ];
  \endverbatim
  *
  * Above #n = vs.size()# and #'# is appended to the end if #trans != BLAS_Cpp::no_trans#.
  * Also, a newline character #\n# is appended to the end after #']'#.
  */
std::ostream& out( std::ostream& o, const char* name, const DVectorSlice& vs
  , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );

/* * Output a DMatrixSlice.
  *
  * The DMatrixSlice is output in the following format:
  *
  \verbatim
  name = [
  gms(1,1), gms(1,2), ... gms(1,n);
  gms(2,1), gms(2,2), ... gms(2,n);
  ...       ...       ... ...
  gms(m,1), gms(m,2), ... gms(m,n);
   ];
  \endverbatim
  *
  * Above #m = gms.rows()#, #n = gms.cols()# and #'# is appended to the end
  * if #trans != BLAS_Cpp::no_trans#.
  * Also, a newline character #\n# is appended to the end
  */
std::ostream& out( std::ostream& o, const char* name, const DMatrixSlice& gms
  , BLAS_Cpp::Transp trans = BLAS_Cpp::no_trans );

// @}

// @}

} // end namespace MatlabPack
} // end namespace DenseLinAlgPack

#endif  // MATLAB_PACK_H