libhoomd/extern/mmio.h

   1 /*
   2 *   Matrix Market I/O library for ANSI C
   3 *
   4 *   See http://math.nist.gov/MatrixMarket for details.
   5 *
   6 *
   7 */
   8
   9 #ifndef MM_IO_H
  10 #define MM_IO_H
  11
  12 #define MM_MAX_LINE_LENGTH 1025
  13 #define MatrixMarketBanner "%%MatrixMarket"
  14 #define MM_MAX_TOKEN_LENGTH 64
  15
  16 typedef char MM_typecode[4];
  17
  18 char *mm_typecode_to_str(MM_typecode matcode);
  19
  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);
  23
  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);
  27
  28
  29 /********************* MM_typecode query fucntions ***************************/
  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
  51 /********************* MM_typecode modify fucntions ***************************/
  52
  53 #define mm_set_matrix(typecode) ((*typecode)[0]='M')
  54 #define mm_set_coordinate(typecode)     ((*typecode)[1]='C')
  55 #define mm_set_array(typecode)  ((*typecode)[1]='A')
  56 #define mm_set_dense(typecode)  mm_set_array(typecode)
  57 #define mm_set_sparse(typecode) mm_set_coordinate(typecode)
  58
  59 #define mm_set_complex(typecode)((*typecode)[2]='C')
  60 #define mm_set_real(typecode)   ((*typecode)[2]='R')
  61 #define mm_set_pattern(typecode)((*typecode)[2]='P')
  62 #define mm_set_integer(typecode)((*typecode)[2]='I')
  63
  64
  65 #define mm_set_symmetric(typecode)((*typecode)[3]='S')
  66 #define mm_set_general(typecode)((*typecode)[3]='G')
  67 #define mm_set_skew(typecode)   ((*typecode)[3]='K')
  68 #define mm_set_hermitian(typecode)((*typecode)[3]='H')
  69
  70 #define mm_clear_typecode(typecode) ((*typecode)[0]=(*typecode)[1]= \
  71                                                                         (*typecode)[2]=' ',(*typecode)[3]='G')
  72
  73 #define mm_initialize_typecode(typecode) mm_clear_typecode(typecode)
  74
  75
  76 /********************* Matrix Market error codes ***************************/
  77
  78
  79 #define MM_COULD_NOT_READ_FILE  11
  80 #define MM_PREMATURE_EOF                12
  81 #define MM_NOT_MTX                              13
  82 #define MM_NO_HEADER                    14
  83 #define MM_UNSUPPORTED_TYPE             15
  84 #define MM_LINE_TOO_LONG                16
  85 #define MM_COULD_NOT_WRITE_FILE 17
  86
  87
  88 /******************** Matrix Market internal definitions ********************
  89
  90    MM_matrix_typecode: 4-character sequence
  91
  92                                     ojbect              sparse/         data        storage
  93                                                                 dense           type        scheme
  94
  95    string position:      [0]        [1]                 [2]         [3]
  96
  97    Matrix typecode:  M(atrix)  C(oord)          R(eal)          G(eneral)
  98                                                         A(array)        C(omplex)   H(ermitian)
  99                                                                                         P(attern)   S(ymmetric)
 100                                                                                 I(nteger)       K(kew)
 101
 102  ***********************************************************************/
 103
 104 #define MM_MTX_STR              "matrix"
 105 #define MM_ARRAY_STR    "array"
 106 #define MM_DENSE_STR    "array"
 107 #define MM_COORDINATE_STR "coordinate"
 108 #define MM_SPARSE_STR   "coordinate"
 109 #define MM_COMPLEX_STR  "complex"
 110 #define MM_REAL_STR             "real"
 111 #define MM_INT_STR              "integer"
 112 #define MM_GENERAL_STR  "general"
 113 #define MM_SYMM_STR             "symmetric"
 114 #define MM_HERM_STR             "hermitian"
 115 #define MM_SKEW_STR             "skew-symmetric"
 116 #define MM_PATTERN_STR  "pattern"
 117
 118
 119 /*  high level routines */
 120
 121 int mm_write_mtx_crd(char fname[], int M, int N, int nz, int I[], int J[],
 122                  double val[], MM_typecode matcode);
 123 int mm_read_mtx_crd_data(FILE *f, int M, int N, int nz, int I[], int J[],
 124                 double val[], MM_typecode matcode);
 125 int mm_read_mtx_crd_entry(FILE *f, int *I, int *J, double *real, double *img,
 126                         MM_typecode matcode);
 127
 128 int mm_read_unsymmetric_sparse(const char *fname, int *M_, int *N_, int *nz_,
 129                 double **val_, int **I_, int **J_);
 130
 131
 132
 133 #endif