xref: /petsc/src/mat/tests/mmio.h (revision 21e3ffae2f3b73c0bd738cf6d0a809700fc04bb0)
1 /*
2    Matrix Market I/O library for ANSI C
3 
4    See https://math.nist.gov/MatrixMarket/ for details.
5 
6 */
7 
8 #ifndef MM_IO_H
9 #define MM_IO_H
10 
11 #include <stdio.h>
12 
13 #define MM_MAX_LINE_LENGTH  1025
14 #define MatrixMarketBanner  "%%MatrixMarket"
15 #define MM_MAX_TOKEN_LENGTH 64
16 
17 typedef char MM_typecode[4];
18 
19 char *mm_typecode_to_str(MM_typecode matcode);
20 
21 int mm_read_banner(FILE *f, MM_typecode *matcode);
22 int mm_read_mtx_crd_size(FILE *f, int *M, int *N, int *nz);
23 int mm_read_mtx_array_size(FILE *f, int *M, int *N);
24 
25 int mm_write_banner(FILE *f, MM_typecode matcode);
26 int mm_write_mtx_crd_size(FILE *f, int M, int N, int nz);
27 int mm_write_mtx_array_size(FILE *f, int M, int N);
28 
29 /********************* MM_typecode query functions ***************************/
30 
31 #define mm_is_matrix(typecode) ((typecode)[0] == 'M')
32 
33 #define mm_is_sparse(typecode)     ((typecode)[1] == 'C')
34 #define mm_is_coordinate(typecode) ((typecode)[1] == 'C')
35 #define mm_is_dense(typecode)      ((typecode)[1] == 'A')
36 #define mm_is_array(typecode)      ((typecode)[1] == 'A')
37 
38 #define mm_is_complex(typecode) ((typecode)[2] == 'C')
39 #define mm_is_real(typecode)    ((typecode)[2] == 'R')
40 #define mm_is_pattern(typecode) ((typecode)[2] == 'P')
41 #define mm_is_integer(typecode) ((typecode)[2] == 'I')
42 
43 #define mm_is_symmetric(typecode) ((typecode)[3] == 'S')
44 #define mm_is_general(typecode)   ((typecode)[3] == 'G')
45 #define mm_is_skew(typecode)      ((typecode)[3] == 'K')
46 #define mm_is_hermitian(typecode) ((typecode)[3] == 'H')
47 
48 int mm_is_valid(MM_typecode matcode); /* too complex for a macro */
49 
50 /********************* MM_typecode modify functions ***************************/
51 
52 #define mm_set_matrix(typecode)     ((*typecode)[0] = 'M')
53 #define mm_set_coordinate(typecode) ((*typecode)[1] = 'C')
54 #define mm_set_array(typecode)      ((*typecode)[1] = 'A')
55 #define mm_set_dense(typecode)      mm_set_array(typecode)
56 #define mm_set_sparse(typecode)     mm_set_coordinate(typecode)
57 
58 #define mm_set_complex(typecode) ((*typecode)[2] = 'C')
59 #define mm_set_real(typecode)    ((*typecode)[2] = 'R')
60 #define mm_set_pattern(typecode) ((*typecode)[2] = 'P')
61 #define mm_set_integer(typecode) ((*typecode)[2] = 'I')
62 
63 #define mm_set_symmetric(typecode) ((*typecode)[3] = 'S')
64 #define mm_set_general(typecode)   ((*typecode)[3] = 'G')
65 #define mm_set_skew(typecode)      ((*typecode)[3] = 'K')
66 #define mm_set_hermitian(typecode) ((*typecode)[3] = 'H')
67 
68 #define mm_clear_typecode(typecode) ((*typecode)[0] = (*typecode)[1] = (*typecode)[2] = ' ', (*typecode)[3] = 'G')
69 
70 #define mm_initialize_typecode(typecode) mm_clear_typecode(typecode)
71 
72 /********************* Matrix Market error codes ***************************/
73 
74 #define MM_COULD_NOT_READ_FILE  11
75 #define MM_PREMATURE_EOF        12
76 #define MM_NOT_MTX              13
77 #define MM_NO_HEADER            14
78 #define MM_UNSUPPORTED_TYPE     15
79 #define MM_LINE_TOO_LONG        16
80 #define MM_COULD_NOT_WRITE_FILE 17
81 
82 /******************** Matrix Market internal definitions ********************
83 
84    MM_matrix_typecode: 4-character sequence
85 
86                     object      sparse/     data        storage
87                                 dense       type        scheme
88 
89    string position:  [0]        [1]         [2]         [3]
90 
91    Matrix typecode:  M(atrix)   C(oord)     R(eal)      G(eneral)
92                                 A(array)    C(omplex)   H(ermitian)
93                                             P(attern)   S(ymmetric)
94                                             I(nteger)   K(kew)
95 
96  ***********************************************************************/
97 
98 #define MM_MTX_STR        "matrix"
99 #define MM_ARRAY_STR      "array"
100 #define MM_DENSE_STR      "array"
101 #define MM_COORDINATE_STR "coordinate"
102 #define MM_SPARSE_STR     "coordinate"
103 #define MM_COMPLEX_STR    "complex"
104 #define MM_REAL_STR       "real"
105 #define MM_INT_STR        "integer"
106 #define MM_GENERAL_STR    "general"
107 #define MM_SYMM_STR       "symmetric"
108 #define MM_HERM_STR       "hermitian"
109 #define MM_SKEW_STR       "skew-symmetric"
110 #define MM_PATTERN_STR    "pattern"
111 
112 /*  high level routines */
113 
114 int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I_[], int J_[], double val[], MM_typecode matcode);
115 int mm_read_mtx_crd_data(FILE *f, int M, int N, int nz, int I_[], int J_[], double val[], MM_typecode matcode);
116 int mm_read_mtx_crd_entry(FILE *f, int *I_, int *J_, double *real, double *img, MM_typecode matcode);
117 int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_, double **val_, int **I_, int **J_);
118 
119 #endif
120