mmio.h

Go to the documentation of this file.

 
/*************************************************************************
 * Copyright (c) 2011 AT&T Intellectual Property 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors: Details at https://graphviz.org
 *************************************************************************/
/* 
*   Matrix Market I/O library for ANSI C
*
*   See http://math.nist.gov/MatrixMarket for details.
*
*
*/
 
#pragma once
 
#define MM_MAX_LINE_LENGTH 100025
#define MatrixMarketBanner "%%MatrixMarket"
#define MM_MAX_TOKEN_LENGTH 64
 
typedef char MM_typecode[4];
 
int mm_read_banner(FILE * f, MM_typecode * matcode);
int mm_read_mtx_crd_size(FILE * f, int *M, int *N, int *nz);
 
/********************* MM_typecode query fucntions ***************************/
 
#define mm_is_matrix(typecode)  ((typecode)[0]=='M')
 
#define mm_is_sparse(typecode)  ((typecode)[1]=='C')
#define mm_is_coordinate(typecode)((typecode)[1]=='C')
#define mm_is_dense(typecode)   ((typecode)[1]=='A')
#define mm_is_array(typecode)   ((typecode)[1]=='A')
 
#define mm_is_complex(typecode) ((typecode)[2]=='C')
#define mm_is_real(typecode)            ((typecode)[2]=='R')
#define mm_is_pattern(typecode) ((typecode)[2]=='P')
#define mm_is_integer(typecode) ((typecode)[2]=='I')
 
#define mm_is_symmetric(typecode)((typecode)[3]=='S')
#define mm_is_general(typecode) ((typecode)[3]=='G')
#define mm_is_skew(typecode)    ((typecode)[3]=='K')
#define mm_is_hermitian(typecode)((typecode)[3]=='H')
 
/********************* MM_typecode modify fucntions ***************************/
 
#define mm_set_matrix(typecode) ((*typecode)[0]='M')
#define mm_set_coordinate(typecode)     ((*typecode)[1]='C')
#define mm_set_array(typecode)  ((*typecode)[1]='A')
#define mm_set_dense(typecode)  mm_set_array(typecode)
#define mm_set_sparse(typecode) mm_set_coordinate(typecode)
 
#define mm_set_complex(typecode)((*typecode)[2]='C')
#define mm_set_real(typecode)   ((*typecode)[2]='R')
#define mm_set_pattern(typecode)((*typecode)[2]='P')
#define mm_set_integer(typecode)((*typecode)[2]='I')
 
 
#define mm_set_symmetric(typecode)((*typecode)[3]='S')
#define mm_set_general(typecode)((*typecode)[3]='G')
#define mm_set_skew(typecode)   ((*typecode)[3]='K')
#define mm_set_hermitian(typecode)((*typecode)[3]='H')
 
#define mm_clear_typecode(typecode) ((*typecode)[0]=(*typecode)[1]= \
                                                                        (*typecode)[2]=' ',(*typecode)[3]='G')
 
#define mm_initialize_typecode(typecode) mm_clear_typecode(typecode)
 
 
/********************* Matrix Market error codes ***************************/
 
 
#define MM_COULD_NOT_READ_FILE  11
#define MM_PREMATURE_EOF                12
#define MM_NOT_MTX                              13
#define MM_NO_HEADER                    14
#define MM_UNSUPPORTED_TYPE             15
#define MM_LINE_TOO_LONG                16
#define MM_COULD_NOT_WRITE_FILE 17
 
 
/******************** Matrix Market internal definitions ********************
 
   MM_matrix_typecode: 4-character sequence
 
                                    ojbect              sparse/         data        storage 
                                                                dense           type        scheme
 
   string position:      [0]        [1]                 [2]         [3]
 
   Matrix typecode:  M(atrix)  C(oord)          R(eal)          G(eneral)
                                                        A(array)        C(omplex)   H(ermitian)
                                                                                        P(attern)   S(ymmetric)
                                                                                I(nteger)       K(kew)
 
 ***********************************************************************/
 
#define MM_MTX_STR              "matrix"
#define MM_ARRAY_STR    "array"
#define MM_DENSE_STR    "array"
#define MM_COORDINATE_STR "coordinate"
#define MM_SPARSE_STR   "coordinate"
#define MM_COMPLEX_STR  "complex"
#define MM_REAL_STR             "real"
#define MM_INT_STR              "integer"
#define MM_GENERAL_STR  "general"
#define MM_SYMM_STR             "symmetric"
#define MM_HERM_STR             "hermitian"
#define MM_SKEW_STR             "skew-symmetric"
#define MM_PATTERN_STR  "pattern"