EpetraExt Development
Loading...
Searching...
No Matches
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#define MM_MAX_LINE_LENGTH 1025
59#define MatrixMarketBanner "%%MatrixMarket"
60#define MM_MAX_TOKEN_LENGTH 64
61
62typedef char MM_typecode[4];
63
64namespace EpetraExt {
65
66 void mm_typecode_to_str(MM_typecode matcode, char * buffer);
67
68int mm_read_banner(std::FILE *f, MM_typecode *matcode);
69int mm_read_mtx_crd_size(std::FILE *f, int *M, int *N, int *nz);
70int mm_read_mtx_crd_size(std::FILE *f, long long *M, long long *N, long long *nz);
71int mm_read_mtx_array_size(std::FILE *f, int *M, int *N);
72
73int mm_write_banner(std::FILE *f, MM_typecode matcode);
74int mm_write_mtx_crd_size(std::FILE *f, long long M, long long N, long long nz);
75int mm_write_mtx_array_size(std::FILE *f, long long M, long long N);
76
77
78/********************* MM_typecode query fucntions ***************************/
79
80#define mm_is_matrix(typecode) ((typecode)[0]=='M')
81
82#define mm_is_sparse(typecode) ((typecode)[1]=='C')
83#define mm_is_coordinate(typecode)((typecode)[1]=='C')
84#define mm_is_dense(typecode) ((typecode)[1]=='A')
85#define mm_is_array(typecode) ((typecode)[1]=='A')
86
87#define mm_is_complex(typecode) ((typecode)[2]=='C')
88#define mm_is_real(typecode) ((typecode)[2]=='R')
89#define mm_is_pattern(typecode) ((typecode)[2]=='P')
90#define mm_is_integer(typecode) ((typecode)[2]=='I')
91
92#define mm_is_symmetric(typecode)((typecode)[3]=='S')
93#define mm_is_general(typecode) ((typecode)[3]=='G')
94#define mm_is_skew(typecode) ((typecode)[3]=='K')
95#define mm_is_hermitian(typecode)((typecode)[3]=='H')
96
97int mm_is_valid(MM_typecode matcode); /* too complex for a macro */
98
99
100/********************* MM_typecode modify fucntions ***************************/
101
102#define mm_set_matrix(typecode) ((*typecode)[0]='M')
103#define mm_set_coordinate(typecode) ((*typecode)[1]='C')
104#define mm_set_array(typecode) ((*typecode)[1]='A')
105#define mm_set_dense(typecode) mm_set_array(typecode)
106#define mm_set_sparse(typecode) mm_set_coordinate(typecode)
107
108#define mm_set_complex(typecode)((*typecode)[2]='C')
109#define mm_set_real(typecode) ((*typecode)[2]='R')
110#define mm_set_pattern(typecode)((*typecode)[2]='P')
111#define mm_set_integer(typecode)((*typecode)[2]='I')
112
113
114#define mm_set_symmetric(typecode)((*typecode)[3]='S')
115#define mm_set_general(typecode)((*typecode)[3]='G')
116#define mm_set_skew(typecode) ((*typecode)[3]='K')
117#define mm_set_hermitian(typecode)((*typecode)[3]='H')
118
119#define mm_clear_typecode(typecode) ((*typecode)[0]=(*typecode)[1]= \
120 (*typecode)[2]=' ',(*typecode)[3]='G')
121
122#define mm_initialize_typecode(typecode) mm_clear_typecode(typecode)
123
124
125/********************* Matrix Market error codes ***************************/
126
127
128#define MM_COULD_NOT_READ_FILE 11
129#define MM_PREMATURE_EOF 12
130#define MM_NOT_MTX 13
131#define MM_NO_HEADER 14
132#define MM_UNSUPPORTED_TYPE 15
133#define MM_LINE_TOO_LONG 16
134#define MM_COULD_NOT_WRITE_FILE 17
135
136
137/******************** Matrix Market internal definitions ********************
138
139 MM_matrix_typecode: 4-character sequence
140
141 ojbect sparse/ data storage
142 dense type scheme
143
144 string position: [0] [1] [2] [3]
145
146 Matrix typecode: M(atrix) C(oord) R(eal) G(eneral)
147 A(array) C(omplex) H(ermitian)
148 P(attern) S(ymmetric)
149 I(nteger) K(kew)
150
151 ***********************************************************************/
152
153#define MM_MTX_STR "matrix"
154#define MM_ARRAY_STR "array"
155#define MM_DENSE_STR "array"
156#define MM_COORDINATE_STR "coordinate"
157#define MM_SPARSE_STR "coordinate"
158#define MM_COMPLEX_STR "complex"
159#define MM_REAL_STR "real"
160#define MM_INT_STR "integer"
161#define MM_GENERAL_STR "general"
162#define MM_SYMM_STR "symmetric"
163#define MM_HERM_STR "hermitian"
164#define MM_SKEW_STR "skew-symmetric"
165#define MM_PATTERN_STR "pattern"
166
167
168/* high level routines */
169
170int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I[], int J[],
171 double val[], MM_typecode matcode);
172int mm_read_mtx_crd_data(std::FILE *f, int M, int N, int nz, int I[], int J[],
173 double val[], MM_typecode matcode);
174int mm_read_mtx_crd_entry(std::FILE *f, int *I, int *J, double *real, double *img,
175 MM_typecode matcode);
176int mm_read_mtx_crd_entry(std::FILE *f, long long *I, long long *J, double *real, double *img,
177 MM_typecode matcode);
178
179int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_,
180 double **val_, int **I_, int **J_);
181
182
183} // namespace EpetraExt
184
185#endif
char MM_typecode[4]
EpetraExt::BlockCrsMatrix: A class for constructing a distributed block matrix.
int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_, double **val_, int **I_, int **J_)
void mm_typecode_to_str(MM_typecode matcode, char *buffer)
int mm_write_mtx_array_size(FILE *f, long long M, long long N)
int mm_write_banner(FILE *f, MM_typecode matcode)
int mm_read_mtx_crd_size(FILE *f, int *M, int *N, int *nz)
int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I[], int J[], double val[], MM_typecode matcode)
int mm_write_mtx_crd_size(FILE *f, long long M, long long N, long long nz)
int mm_read_banner(FILE *f, MM_typecode *matcode)
int mm_is_valid(MM_typecode matcode)
int mm_read_mtx_array_size(FILE *f, int *M, int *N)
int mm_read_mtx_crd_data(FILE *f, int, int, int nz, int I[], int J[], double val[], MM_typecode matcode)
int mm_read_mtx_crd_entry(FILE *f, int *I, int *J, double *real, double *imag, MM_typecode matcode)