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