1.2.1
CCC
 
LinkMatrixSparse.cpp File Reference
#include "Matrix/LinkMatrixSparse.hpp"
#include "Matrix/NF_Triplet.hpp"
#include "Basic/AStringable.hpp"
#include "Basic/Utilities.hpp"
#include "Basic/VectorHelper.hpp"
#include "Basic/File.hpp"
#include "Basic/String.hpp"
#include "Basic/OptDbg.hpp"
#include "geoslib_old_f.h"
#include <set>
#include "csparse_f.h"

Macros

#define MAX_NEIGH   100
 
#define XCR(ilevel, i)   (xcr[(ilevel) * ncur + (i)])
 
#define RHS(ilevel, i)   (rhs[(ilevel) * ncur + (i)])
 
#define MAT(i, j)   (mat[(i) * n + (j)])
 
#define DEBUG   0
 

Functions

void cs_set_status_update_nonzero_value (int status)
 
int cs_get_status_update_nonzero_value ()
 
cs * cs_spalloc2 (int m, int n, int nzmax, int values, int triplet)
 
cs * cs_spfree2 (cs *A)
 TODO : cs_*2 functions to be removed (encapsulation) More...
 
css * cs_sfree2 (css *S)
 
csn * cs_nfree2 (csn *N)
 
int cs_entry2 (cs *T, int i, int j, double x)
 
cs * cs_triplet2 (const cs *T)
 
cs * cs_transpose2 (const cs *A, int values)
 
cs * cs_multiply2 (const cs *A, const cs *B)
 
int cs_print2 (const cs *A, int brief)
 
void cs_force_dimension (cs *T, int nrow, int ncol)
 
cs * cs_diag (VectorDouble diag, double tol)
 
cs * cs_prod_norm_diagonal (int mode, const cs *B, VectorDouble diag)
 
MatrixSparsecs_arrays_to_sparse (int n, int nrow, int ncol, const double *rows, const double *cols, const double *vals)
 
MatrixSparsecs_vectors_to_sparse (int nrow, int ncol, const VectorDouble &rows, const VectorDouble &cols, const VectorDouble &values)
 
cs * cs_invert (const cs *A, int order, double epsilon)
 
int _cs_findColor (const cs *Q, int imesh, int ncolor, VectorInt &colors, VectorInt &temp)
 
int qchol_cholesky (int verbose, QChol *QC)
 
void cs_multigrid_params (cs_MGS *mgs, int flag_cg, int type_coarse, int ngc, int nmg, int ngs, double tolcg, double tolnmg)
 
cs_MGScs_multigrid_manage (cs_MGS *mgs, int mode, int nlevels, int path_type)
 
void cs_multigrid_print (cs_MGS *mgs)
 
int cs_multigrid_get_nlevels (cs_MGS *mgs)
 
void cs_multigrid_coarse2fine (cs_MGS *mgs, double *z, double *work)
 
int cs_multigrid_setup (cs_MGS *mgs, QChol *qctt, int flag_sel, int verbose, double **sel_arg)
 
int cs_scale (const cs *A)
 
void cs_chol_invert (QChol *qctt, double *xcr, double *rhs, double *work)
 
void cs_chol_simulate (QChol *qctt, double *simu, double *work)
 
int cs_multigrid_process (cs_MGS *mgs, QChol *qctt, int verbose, double *x0, double *b, double *work)
 
NF_Triplet csToTriplet (const cs *A, int shiftRow, int shiftCol, double tol)
 
String toStringDim (const String &title, const cs *A)
 
String toStringRange (const String &title, const cs *C)
 
bool cs_isSymmetric (const cs *A, bool verbose, bool detail)
 
bool cs_isDiagonalDominant (cs *A, bool verbose, bool detail)
 
bool cs_isDefinitePositive (cs *A, bool verbose)
 
cs * cs_extract_submatrix (cs *C, int row_from, int row_length, int col_from, int col_length)
 
int cs_get_nrow (const cs *A)
 
int cs_get_ncol (const cs *A)
 
int cs_get_ncell (const cs *A)
 
void cs_print_dim (const char *title, const cs *A)
 
void cs_print_range (const char *title, const cs *C)
 
cs * cs_eye (int number, double value)
 
cs * cs_extract_diag (const cs *C, int oper_choice)
 
double * csd_extract_diag (const cs *C, int oper_choice)
 
VectorDouble csd_extract_diag_VD (const cs *C, int oper_choice)
 
void cs_diag_suppress (cs *C)
 
int cs_sort_i (cs *C)
 
void cs_rowcol (const cs *A, int *nrows, int *ncols, int *count, double *percent)
 
void cs_print_nice (const char *title, const cs *A, int maxrow, int maxcol)
 
void cs_print_only (const char *title, const cs *A, int nlimit)
 
void cs_print_short (const char *title, const cs *L, int nmax)
 
cs * cs_eye_tab (int number, double *values)
 
cs * cs_multiply_and_release (cs *b1, const cs *b2, int flag_release)
 
cs * cs_add_and_release (cs *b1, const cs *b2, double alpha, double beta, int flag_release)
 
cs * cs_duplicate (const cs *b1)
 
cs * cs_prod_norm_and_release (cs *b1, cs *lambda, int flag_release)
 
double cs_maxsumabscol (const cs *A)
 
double * cs_col_sumrow (const cs *A, int *ncol, int *nrow)
 
void cs_vector_Mx (const cs *A, int nout, const double *x, double *y)
 
void cs_vector_tMx (const cs *A, int nout, const double *x, double *y)
 
void cs_vector_xM (const cs *A, int nout, const double *x, double *y)
 
void cs_vector_xtM (const cs *A, int nout, const double *x, double *y)
 
cs * cs_normalize_by_diag_and_release (cs *Q, int flag_release)
 
cs * cs_matvecR (const cs *A, const double *x, int oper_choice)
 
cs * cs_matvecL (const cs *A, const double *x, int oper_choice)
 
cs * cs_matvecnorm (const cs *A, const double *x, int oper_choice)
 
void cs_matvecnorm_inplace (cs *A, const double *x, int oper_choice)
 
int cs_coarsening (const cs *Q, int type, int **indCo_ret, cs **L_ret)
 
cs * cs_interpolate (const cs *AA, const cs *Lt, int *Co)
 
cs * cs_prod_norm (int mode, const cs *A, const cs *B)
 
cs * cs_prod_norm_single (int mode, const cs *B)
 
cs * cs_triangle (cs *A, int flag_upper, int flag_diag)
 
int cs_lsolve_lowtri (const cs *L, const double *x, double *y)
 
int cs_lsolve_uptri (const cs *L, const double *x, double *y)
 
void cs_mulvec_uptri (const cs *A, int nout, const double *x, double *y, int flag_diag)
 
void cs_mulvec_lowtri (const cs *A, int nout, const double *x, double *y, int flag_diag)
 
cs * cs_compress (cs *A)
 
void cs_print_file (const char *radix, int rank, const cs *A)
 
bool cs_exist (const cs *A, int row, int col)
 
double cs_get_value (const cs *A, int row, int col)
 
void cs_set_value (const cs *A, int row, int col, double value)
 
void cs_add_value (const cs *A, int row, int col, double value)
 
void cs_add_cste (cs *A, double value)
 
void cs_set_cste (const cs *A, double value)
 
double * cs_toArray (const cs *A)
 
int cs_nnz (const cs *A)
 
cs * cs_strip (cs *A, double eps, int hypothesis, bool verbose)
 
cs * cs_glue (const cs *A1, const cs *A2, bool shiftRow, bool shiftCol)
 

Macro Definition Documentation

#define DEBUG   0
#define MAT (   i,
 
)    (mat[(i) * n + (j)])
#define MAX_NEIGH   100
#define RHS (   ilevel,
 
)    (rhs[(ilevel) * ncur + (i)])
#define XCR (   ilevel,
 
)    (xcr[(ilevel) * ncur + (i)])

Function Documentation

int _cs_findColor ( const cs *  Q,
int  imesh,
int  ncolor,
VectorInt colors,
VectorInt temp 
)
cs* cs_add_and_release ( cs *  b1,
const cs *  b2,
double  alpha,
double  beta,
int  flag_release 
)
void cs_add_cste ( cs *  A,
double  value 
)
void cs_add_value ( const cs *  A,
int  row,
int  col,
double  value 
)
MatrixSparse* cs_arrays_to_sparse ( int  n,
int  nrow,
int  ncol,
const double *  rows,
const double *  cols,
const double *  vals 
)
void cs_chol_invert ( QChol qctt,
double *  xcr,
double *  rhs,
double *  work 
)

Inversion using Cholesky

Parameters
[in]qcttQchol structure
[in,out]xcrCurrent vector
[in]rhsCurrent R.H.S. vector
[out]workWorking array
void cs_chol_simulate ( QChol qctt,
double *  simu,
double *  work 
)

Simulate using Cholesky

Parameters
[in]qcttQchol structure
[out]simuSimulated array
[out]workWorking array
int cs_coarsening ( const cs *  Q,
int  type,
int **  indCo_ret,
cs **  L_ret 
)
double* cs_col_sumrow ( const cs *  A,
int *  ncol,
int *  nrow 
)
cs* cs_compress ( cs *  A)
cs* cs_diag ( VectorDouble  diag,
double  tol 
)
void cs_diag_suppress ( cs *  C)
cs* cs_duplicate ( const cs *  b1)
int cs_entry2 ( cs *  T,
int  i,
int  j,
double  x 
)
bool cs_exist ( const cs *  A,
int  row,
int  col 
)
cs* cs_extract_diag ( const cs *  C,
int  oper_choice 
)
cs* cs_extract_submatrix ( cs *  C,
int  row_from,
int  row_length,
int  col_from,
int  col_length 
)
cs* cs_eye ( int  number,
double  value 
)
cs* cs_eye_tab ( int  number,
double *  values 
)
void cs_force_dimension ( cs *  T,
int  nrow,
int  ncol 
)
int cs_get_ncell ( const cs *  A)
int cs_get_ncol ( const cs *  A)
int cs_get_nrow ( const cs *  A)
int cs_get_status_update_nonzero_value ( )
double cs_get_value ( const cs *  A,
int  row,
int  col 
)
cs* cs_glue ( const cs *  A1,
const cs *  A2,
bool  shiftRow,
bool  shiftCol 
)

This method glues two sparse matrices into an output sparse matrix The second matrix is appended after addresses have been shifted either by row or by column

Parameters
A1First sparse matrix
A2Secon sparse matrix
shiftRowShift A2 addresses by the number of rows of A1
shiftColShift A2 addresses by the number of columns of A1
Returns
The newly create sparse matrix
cs* cs_interpolate ( const cs *  AA,
const cs *  Lt,
int *  Co 
)
cs* cs_invert ( const cs *  A,
int  order,
double  epsilon 
)
bool cs_isDefinitePositive ( cs *  A,
bool  verbose 
)
bool cs_isDiagonalDominant ( cs *  A,
bool  verbose,
bool  detail 
)
bool cs_isSymmetric ( const cs *  A,
bool  verbose,
bool  detail 
)
int cs_lsolve_lowtri ( const cs *  L,
const double *  x,
double *  y 
)
int cs_lsolve_uptri ( const cs *  L,
const double *  x,
double *  y 
)
cs* cs_matvecL ( const cs *  A,
const double *  x,
int  oper_choice 
)
cs* cs_matvecnorm ( const cs *  A,
const double *  x,
int  oper_choice 
)
void cs_matvecnorm_inplace ( cs *  A,
const double *  x,
int  oper_choice 
)
cs* cs_matvecR ( const cs *  A,
const double *  x,
int  oper_choice 
)
double cs_maxsumabscol ( const cs *  A)

Compute the max along the lines of the sum of the absolute values along the columns

void cs_multigrid_coarse2fine ( cs_MGS mgs,
double *  z,
double *  work 
)

Convert results from coarsest to final scale

Parameters
[in]mgscs_MGS structure
[in,out]zInput vector
[out]workWorking array
Remarks
Arguments 'z' and 'work' maust be dimensioned to the finest size
int cs_multigrid_get_nlevels ( cs_MGS mgs)

Returns the number of multigrid levels

Parameters
[in]mgscs_MGS structure
cs_MGS* cs_multigrid_manage ( cs_MGS mgs,
int  mode,
int  nlevels,
int  path_type 
)

Allocate the structure for the multigrid manipulation

Parameters
[in]mgscs_MGS structure
[in]mode1 for allocation; -1 for deallocation
[in]nlevelsNumber of levels of the multigrid (only for mode > 0)
[in]path_typeType of the Path (1:V; 2:W, 3:F) (only for mode > 0)
void cs_multigrid_params ( cs_MGS mgs,
int  flag_cg,
int  type_coarse,
int  ngc,
int  nmg,
int  ngs,
double  tolcg,
double  tolnmg 
)

Define the parameters for the multigrid manipulation

Parameters
[in]mgscs_MGS structure
[in]flag_cg1 for Conjugate-Gradient use; 0 otherwise
[in]type_coarseType of coarsening algorithm
[in]ngcMaximum number of Conjugate-Gradient iterations
[in]nmgMaximum number of mutligrid iterations
[in]ngsNumber of Gauss-Siedel relaxation cycles
[in]tolcgTolerance for the Conjugate-Gradient algorithm
[in]tolnmgTolerance for the Multigrid algorithm
void cs_multigrid_print ( cs_MGS mgs)

Print the cs_MGS structure

Parameters
[in]mgscs_MGS structure
int cs_multigrid_process ( cs_MGS mgs,
QChol qctt,
int  verbose,
double *  x0,
double *  b,
double *  work 
)

Perform the multigrid kriging

Returns
Error return code
Parameters
[in]mgscs_MGS structure
[in]qcttQChol matrix of the upper level
[in]verboseVerbose flag
[in]x0Input vector
[in]bR.H.S. vector
[out]workWorking array
int cs_multigrid_setup ( cs_MGS mgs,
QChol qctt,
int  flag_sel,
int  verbose,
double **  sel_arg 
)

Setup the Multigrid system

Returns
Error return code
Parameters
[in]mgscs_MGS structure
[in]qcttQChol matrix of the upper level
[in]flag_selIf 1, an output selection is created
[in]verboseVerbose flag
[out]sel_argVector of selection (in double as used in db)
cs* cs_multiply2 ( const cs *  A,
const cs *  B 
)
cs* cs_multiply_and_release ( cs *  b1,
const cs *  b2,
int  flag_release 
)
void cs_mulvec_lowtri ( const cs *  A,
int  nout,
const double *  x,
double *  y,
int  flag_diag 
)
void cs_mulvec_uptri ( const cs *  A,
int  nout,
const double *  x,
double *  y,
int  flag_diag 
)
csn* cs_nfree2 ( csn *  N)
int cs_nnz ( const cs *  A)
cs* cs_normalize_by_diag_and_release ( cs *  Q,
int  flag_release 
)
int cs_print2 ( const cs *  A,
int  brief 
)
void cs_print_dim ( const char *  title,
const cs *  A 
)
void cs_print_file ( const char *  radix,
int  rank,
const cs *  A 
)
void cs_print_nice ( const char *  title,
const cs *  A,
int  maxrow,
int  maxcol 
)
void cs_print_only ( const char *  title,
const cs *  A,
int  nlimit 
)
void cs_print_range ( const char *  title,
const cs *  C 
)
void cs_print_short ( const char *  title,
const cs *  L,
int  nmax 
)
cs* cs_prod_norm ( int  mode,
const cs *  A,
const cs *  B 
)
cs* cs_prod_norm_and_release ( cs *  b1,
cs *  lambda,
int  flag_release 
)
cs* cs_prod_norm_diagonal ( int  mode,
const cs *  B,
VectorDouble  diag 
)
cs* cs_prod_norm_single ( int  mode,
const cs *  B 
)
void cs_rowcol ( const cs *  A,
int *  nrows,
int *  ncols,
int *  count,
double *  percent 
)
int cs_scale ( const cs *  A)
void cs_set_cste ( const cs *  A,
double  value 
)
void cs_set_status_update_nonzero_value ( int  status)

Define the status when modifying the value of a nonzero element of the sparse matrix

Parameters
status0 (no test); 1 (warning issued); 2 (throw issued)
void cs_set_value ( const cs *  A,
int  row,
int  col,
double  value 
)
css* cs_sfree2 ( css *  S)
int cs_sort_i ( cs *  C)
cs* cs_spalloc2 ( int  m,
int  n,
int  nzmax,
int  values,
int  triplet 
)
cs* cs_spfree2 ( cs *  A)

TODO : cs_*2 functions to be removed (encapsulation)

cs* cs_strip ( cs *  A,
double  eps,
int  hypothesis,
bool  verbose 
)

Strip off elements of the input Sparse Matrix whose absolute value is smaller than eps. Return a new compressed sparse matrix. Consequently, strip off the vector P[in/out] which contains the order of the samples

Parameters
AInput sparse matrix
epsTolerance on absolute value of the input sparse matrix elements
hypothesisStripping hypothesis
verboseVerbose flag
Returns
A pointer to the new sparse matrix (it must be freed by calling function)
Note
Note that in the current version, the input matrix A is also modified
double* cs_toArray ( const cs *  A)
cs* cs_transpose2 ( const cs *  A,
int  values 
)
cs* cs_triangle ( cs *  A,
int  flag_upper,
int  flag_diag 
)
cs* cs_triplet2 ( const cs *  T)
void cs_vector_Mx ( const cs *  A,
int  nout,
const double *  x,
double *  y 
)
void cs_vector_tMx ( const cs *  A,
int  nout,
const double *  x,
double *  y 
)
void cs_vector_xM ( const cs *  A,
int  nout,
const double *  x,
double *  y 
)
void cs_vector_xtM ( const cs *  A,
int  nout,
const double *  x,
double *  y 
)
MatrixSparse* cs_vectors_to_sparse ( int  nrow,
int  ncol,
const VectorDouble rows,
const VectorDouble cols,
const VectorDouble values 
)
double* csd_extract_diag ( const cs *  C,
int  oper_choice 
)
VectorDouble csd_extract_diag_VD ( const cs *  C,
int  oper_choice 
)
NF_Triplet csToTriplet ( const cs *  A,
int  shiftRow,
int  shiftCol,
double  tol 
)
int qchol_cholesky ( int  verbose,
QChol QC 
)

Finalize the construction of the QChol structure. Perform the Cholesky decomposition

Returns
Error return code
Parameters
[in]verboseVerbose flag
[in]QCQChol structure to be finalized
Remarks
In case of problem the message is issued in this function
If the decomposition is already performed, nothing is done
String toStringDim ( const String title,
const cs *  A 
)
String toStringRange ( const String title,
const cs *  C 
)