EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_mmio.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ***********************************************************************
4 //
5 // EpetraExt: Epetra Extended - Linear Algebra Services Package
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ***********************************************************************
41 //@HEADER
42 */
43 
44 /*
45 * Matrix Market I/O library for ANSI C
46 *
47 * See http://math.nist.gov/MatrixMarket for details.
48 *
49 *
50 */
51 
52 #include <cstdio>
53 #include <cstdlib>
54 
55 #ifndef MM_IO_H
56 #define MM_IO_H
57 
58 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
59 #ifdef __GNUC__
60 #warning "The EpetraExt package is deprecated"
61 #endif
62 #endif
63 
64 #define MM_MAX_LINE_LENGTH 1025
65 #define MatrixMarketBanner "%%MatrixMarket"
66 #define MM_MAX_TOKEN_LENGTH 64
67 
68 typedef char MM_typecode[4];
69 
70 namespace EpetraExt {
71 
72  void mm_typecode_to_str(MM_typecode matcode, char * buffer);
73 
74 int mm_read_banner(std::FILE *f, MM_typecode *matcode);
75 int mm_read_mtx_crd_size(std::FILE *f, int *M, int *N, int *nz);
76 int mm_read_mtx_crd_size(std::FILE *f, long long *M, long long *N, long long *nz);
77 int mm_read_mtx_array_size(std::FILE *f, int *M, int *N);
78 
79 int mm_write_banner(std::FILE *f, MM_typecode matcode);
80 int mm_write_mtx_crd_size(std::FILE *f, long long M, long long N, long long nz);
81 int mm_write_mtx_array_size(std::FILE *f, long long M, long long N);
82 
83 
84 /********************* MM_typecode query fucntions ***************************/
85 
86 #define mm_is_matrix(typecode) ((typecode)[0]=='M')
87 
88 #define mm_is_sparse(typecode) ((typecode)[1]=='C')
89 #define mm_is_coordinate(typecode)((typecode)[1]=='C')
90 #define mm_is_dense(typecode) ((typecode)[1]=='A')
91 #define mm_is_array(typecode) ((typecode)[1]=='A')
92 
93 #define mm_is_complex(typecode) ((typecode)[2]=='C')
94 #define mm_is_real(typecode) ((typecode)[2]=='R')
95 #define mm_is_pattern(typecode) ((typecode)[2]=='P')
96 #define mm_is_integer(typecode) ((typecode)[2]=='I')
97 
98 #define mm_is_symmetric(typecode)((typecode)[3]=='S')
99 #define mm_is_general(typecode) ((typecode)[3]=='G')
100 #define mm_is_skew(typecode) ((typecode)[3]=='K')
101 #define mm_is_hermitian(typecode)((typecode)[3]=='H')
102 
103 int mm_is_valid(MM_typecode matcode); /* too complex for a macro */
104 
105 
106 /********************* MM_typecode modify fucntions ***************************/
107 
108 #define mm_set_matrix(typecode) ((*typecode)[0]='M')
109 #define mm_set_coordinate(typecode) ((*typecode)[1]='C')
110 #define mm_set_array(typecode) ((*typecode)[1]='A')
111 #define mm_set_dense(typecode) mm_set_array(typecode)
112 #define mm_set_sparse(typecode) mm_set_coordinate(typecode)
113 
114 #define mm_set_complex(typecode)((*typecode)[2]='C')
115 #define mm_set_real(typecode) ((*typecode)[2]='R')
116 #define mm_set_pattern(typecode)((*typecode)[2]='P')
117 #define mm_set_integer(typecode)((*typecode)[2]='I')
118 
119 
120 #define mm_set_symmetric(typecode)((*typecode)[3]='S')
121 #define mm_set_general(typecode)((*typecode)[3]='G')
122 #define mm_set_skew(typecode) ((*typecode)[3]='K')
123 #define mm_set_hermitian(typecode)((*typecode)[3]='H')
124 
125 #define mm_clear_typecode(typecode) ((*typecode)[0]=(*typecode)[1]= \
126  (*typecode)[2]=' ',(*typecode)[3]='G')
127 
128 #define mm_initialize_typecode(typecode) mm_clear_typecode(typecode)
129 
130 
131 /********************* Matrix Market error codes ***************************/
132 
133 
134 #define MM_COULD_NOT_READ_FILE 11
135 #define MM_PREMATURE_EOF 12
136 #define MM_NOT_MTX 13
137 #define MM_NO_HEADER 14
138 #define MM_UNSUPPORTED_TYPE 15
139 #define MM_LINE_TOO_LONG 16
140 #define MM_COULD_NOT_WRITE_FILE 17
141 
142 
143 /******************** Matrix Market internal definitions ********************
144 
145  MM_matrix_typecode: 4-character sequence
146 
147  ojbect sparse/ data storage
148  dense type scheme
149 
150  string position: [0] [1] [2] [3]
151 
152  Matrix typecode: M(atrix) C(oord) R(eal) G(eneral)
153  A(array) C(omplex) H(ermitian)
154  P(attern) S(ymmetric)
155  I(nteger) K(kew)
156 
157  ***********************************************************************/
158 
159 #define MM_MTX_STR "matrix"
160 #define MM_ARRAY_STR "array"
161 #define MM_DENSE_STR "array"
162 #define MM_COORDINATE_STR "coordinate"
163 #define MM_SPARSE_STR "coordinate"
164 #define MM_COMPLEX_STR "complex"
165 #define MM_REAL_STR "real"
166 #define MM_INT_STR "integer"
167 #define MM_GENERAL_STR "general"
168 #define MM_SYMM_STR "symmetric"
169 #define MM_HERM_STR "hermitian"
170 #define MM_SKEW_STR "skew-symmetric"
171 #define MM_PATTERN_STR "pattern"
172 
173 
174 /* high level routines */
175 
176 int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I[], int J[],
177  double val[], MM_typecode matcode);
178 int mm_read_mtx_crd_data(std::FILE *f, int M, int N, int nz, int I[], int J[],
179  double val[], MM_typecode matcode);
180 int mm_read_mtx_crd_entry(std::FILE *f, int *I, int *J, double *real, double *img,
181  MM_typecode matcode);
182 int mm_read_mtx_crd_entry(std::FILE *f, long long *I, long long *J, double *real, double *img,
183  MM_typecode matcode);
184 
185 int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_,
186  double **val_, int **I_, int **J_);
187 
188 
189 } // namespace EpetraExt
190 
191 #endif
int mm_read_mtx_crd_data(FILE *f, int, int, int nz, int I[], int J[], double val[], MM_typecode matcode)
void f()
int mm_read_mtx_crd_size(FILE *f, int *M, int *N, int *nz)
int mm_read_mtx_array_size(FILE *f, int *M, int *N)
int mm_is_valid(MM_typecode matcode)
int mm_write_banner(FILE *f, MM_typecode matcode)
void mm_typecode_to_str(MM_typecode matcode, char *buffer)
int mm_read_banner(FILE *f, MM_typecode *matcode)
const int N
int mm_write_mtx_crd_size(FILE *f, long long M, long long N, long long nz)
int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I[], int J[], double val[], MM_typecode matcode)
char MM_typecode[4]
int mm_read_mtx_crd_entry(FILE *f, int *I, int *J, double *real, double *imag, MM_typecode matcode)
int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_, double **val_, int **I_, int **J_)
int mm_write_mtx_array_size(FILE *f, long long M, long long N)