DenseLinAlgPack: Concreate C++ Classes for Dense Blas-Compatible Linear Algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DenseLinAlgPack_MatlabPack.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MATLAB_PACK_H
43 #define MATLAB_PACK_H
44 
45 #include "DenseLinAlgPack_Types.hpp"
46 
47 namespace DenseLinAlgPack {
48 namespace MatlabPack {
49 
50 /* * @name MatlabPack.
51  *
52  * This package contains functions that allow integration with
53  * Matlab.
54  */
55 // @{
56 
57 /* * @name Output matrices and vectors in Matlab readable format.
58  *
59  * These function output vectors and matrices with enought digits
60  * to reproduce the exact same floating point numbers.
61  */
62 // @{
63 
65 /* * Output a DVectorSlice.
66  *
67  * The DVectorSlice is output in the following format:
68  *
69  \verbatim
70  name = [ vs(1); vs(2); ... vs(n); ];
71  \endverbatim
72  *
73  * Above #n = vs.size()# and #'# is appended to the end if #trans != BLAS_Cpp::no_trans#.
74  * Also, a newline character #\n# is appended to the end after #']'#.
75  */
76 std::ostream& out( std::ostream& o, const char* name, const DVectorSlice& vs
78 
80 /* * Output a DMatrixSlice.
81  *
82  * The DMatrixSlice is output in the following format:
83  *
84  \verbatim
85  name = [
86  gms(1,1), gms(1,2), ... gms(1,n);
87  gms(2,1), gms(2,2), ... gms(2,n);
88  ... ... ... ...
89  gms(m,1), gms(m,2), ... gms(m,n);
90  ];
91  \endverbatim
92  *
93  * Above #m = gms.rows()#, #n = gms.cols()# and #'# is appended to the end
94  * if #trans != BLAS_Cpp::no_trans#.
95  * Also, a newline character #\n# is appended to the end
96  */
97 std::ostream& out( std::ostream& o, const char* name, const DMatrixSlice& gms
99 
100 // @}
101 
102 // @}
103 
104 } // end namespace MatlabPack
105 } // end namespace DenseLinAlgPack
106 
107 #endif // MATLAB_PACK_H
Transp