SpM Handbook 1.2.4
Loading...
Searching...
No Matches
const.h File Reference
#include "spm/config.h"

Go to the source code of this file.

Macros

#define CBLAS_SADDR(_a_)   (&(_a_))
 Macro to get the address if need in the cblas calls.
 
#define SpmDistByColumn   (0x1 << 0)
 Distribution of the matrix storage.
 
#define SpmDistByRow   (0x1 << 1)
 

Typedefs

typedef enum spm_verbose_e spm_verbose_t
 Verbose modes.
 
typedef enum spm_coeftype_e spm_coeftype_t
 Arithmetic types.
 
typedef enum spm_fmttype_e spm_fmttype_t
 Sparse matrix format.
 
typedef enum spm_error_e spm_error_t
 Error codes.
 
typedef enum spm_driver_e spm_driver_t
 The list of matrix driver readers and generators.
 
typedef enum spm_rhstype_e spm_rhstype_t
 How to generate RHS.
 

Enumerations

enum  spm_verbose_e { SpmVerboseNot = 0 , SpmVerboseNo = 1 , SpmVerboseYes = 2 }
 Verbose modes. More...
 
enum  spm_coeftype_e {
  SpmPattern = 0 , SpmFloat = 2 , SpmDouble = 3 , SpmComplex32 = 4 ,
  SpmComplex64 = 5
}
 Arithmetic types. More...
 
enum  spm_fmttype_e { SpmCSC , SpmCSR , SpmIJV }
 Sparse matrix format. More...
 
enum  spm_error_e {
  SPM_SUCCESS = 0 , SPM_ERR_UNKNOWN = 1 , SPM_ERR_ALLOC = 2 , SPM_ERR_NOTIMPLEMENTED = 3 ,
  SPM_ERR_OUTOFMEMORY = 4 , SPM_ERR_THREAD = 5 , SPM_ERR_INTERNAL = 6 , SPM_ERR_BADPARAMETER = 7 ,
  SPM_ERR_FILE = 8 , SPM_ERR_INTEGER_TYPE = 9 , SPM_ERR_IO = 10 , SPM_ERR_MPI = 11
}
 Error codes. More...
 
enum  spm_driver_e {
  SpmDriverRSA , SpmDriverHB , SpmDriverIJV , SpmDriverMM ,
  SpmDriverLaplacian , SpmDriverXLaplacian , SpmDriverGraph , SpmDriverSPM
}
 The list of matrix driver readers and generators. More...
 
enum  spm_rhstype_e { SpmRhsOne , SpmRhsI , SpmRhsRndX , SpmRhsRndB }
 How to generate RHS. More...
 

Constants compatible with CBLAS & LAPACK & PLASMA

The naming and numbering of the following constants is consistent with:

enum  spm_layout_e { SpmRowMajor = 101 , SpmColMajor = 102 }
 Direction of the matrix storage. More...
 
enum  spm_trans_e { SpmNoTrans = 111 , SpmTrans = 112 , SpmConjTrans = 113 }
 Transpostion. More...
 
enum  spm_mtxtype_e { SpmGeneral = SpmNoTrans , SpmSymmetric = SpmTrans , SpmHermitian = SpmConjTrans }
 Matrix symmetry type property. More...
 
enum  spm_uplo_e { SpmUpper = 121 , SpmLower = 122 , SpmUpperLower = 123 }
 Upper/Lower part. More...
 
enum  spm_diag_e { SpmNonUnit = 131 , SpmUnit = 132 }
 Diagonal. More...
 
enum  spm_side_e { SpmLeft = 141 , SpmRight = 142 }
 Side of the operation. More...
 
enum  spm_normtype_e { SpmOneNorm = 171 , SpmFrobeniusNorm = 174 , SpmInfNorm = 175 , SpmMaxNorm = 177 }
 Norms. More...
 
enum  spm_dir_e { SpmDirForward = 391 , SpmDirBackward = 392 }
 Direction. More...
 
typedef enum spm_layout_e spm_layout_t
 Direction of the matrix storage.
 
typedef enum spm_trans_e spm_trans_t
 Transpostion.
 
typedef enum spm_mtxtype_e spm_mtxtype_t
 Matrix symmetry type property.
 
typedef enum spm_uplo_e spm_uplo_t
 Upper/Lower part.
 
typedef enum spm_diag_e spm_diag_t
 Diagonal.
 
typedef enum spm_side_e spm_side_t
 Side of the operation.
 
typedef enum spm_normtype_e spm_normtype_t
 Norms.
 
typedef enum spm_dir_e spm_dir_t
 Direction.
 

Detailed Description

Spm API enums parameters.

Version
1.2.4
Author
Pierre Ramet
Mathieu Faverge
Tony Delarue
Date
2024-05-29

Definition in file const.h.