TBCI Numerical high perf. C++ Library: csp

00001 
00006 /* $Id: csp_defs.h,v 1.3 2000/08/19 23:32:38 garloff Exp $ */
00007 
00008 /*
00009  * -- SuperLU routine (version 1.1) --
00010  * Univ. of California Berkeley, Xerox Palo Alto Research Center,
00011  * and Lawrence Berkeley National Lab.
00012  * November 15, 1997
00013  *
00014  */
00015 
00016 #ifndef __SUPERLU_cSP_DEFS /* allow multiple inclusions */
00017 #define __SUPERLU_cSP_DEFS
00018 
00019 /*
00020  * File name:           csp_defs.h
00021  * Purpose:             Sparse matrix types and function prototypes
00022  * History:
00023  */
00024 #ifdef _CRAY
00025 #include <fortran.h>
00026 #include <string.h>
00027 #endif
00028 #include "Cnames.h"
00029 #include "supermatrix.h"
00030 #include "scomplex.h"
00031 
00032 
00033 /* No of marker arrays used in the symbolic factorization,
00034    each of size n */
00035 #define NO_MARKER     3
00036 #define NUM_TEMPV(m,w,t,b)  ( MAX(m, (t + b)*w) )
00037 
00038 typedef enum {LUSUP, UCOL, LSUB, USUB} MemType;
00039 typedef enum {HEAD, TAIL}              stack_end_t;
00040 typedef enum {SYSTEM, USER}            LU_space_t;
00041 
00042 /*
00043  * Global data structures used in LU factorization -
00044  * 
00045  *   nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
00046  *   (xsup,supno): supno[i] is the supernode no to which i belongs;
00047  *      xsup(s) points to the beginning of the s-th supernode.
00048  *      e.g.   supno 0 1 2 2 3 3 3 4 4 4 4 4   (n=12)
00049  *              xsup 0 1 2 4 7 12
00050  *      Note: dfs will be performed on supernode rep. relative to the new 
00051  *            row pivoting ordering
00052  *
00053  *   (xlsub,lsub): lsub[*] contains the compressed subscript of
00054  *      rectangular supernodes; xlsub[j] points to the starting
00055  *      location of the j-th column in lsub[*]. Note that xlsub 
00056  *      is indexed by column.
00057  *      Storage: original row subscripts
00058  *
00059  *      During the course of sparse LU factorization, we also use
00060  *      (xlsub,lsub) for the purpose of symmetric pruning. For each
00061  *      supernode {s,s+1,...,t=s+r} with first column s and last
00062  *      column t, the subscript set
00063  *              lsub[j], j=xlsub[s], .., xlsub[s+1]-1
00064  *      is the structure of column s (i.e. structure of this supernode).
00065  *      It is used for the storage of numerical values.
00066  *      Furthermore,
00067  *              lsub[j], j=xlsub[t], .., xlsub[t+1]-1
00068  *      is the structure of the last column t of this supernode.
00069  *      It is for the purpose of symmetric pruning. Therefore, the
00070  *      structural subscripts can be rearranged without making physical
00071  *      interchanges among the numerical values.
00072  *
00073  *      However, if the supernode has only one column, then we
00074  *      only keep one set of subscripts. For any subscript interchange
00075  *      performed, similar interchange must be done on the numerical
00076  *      values.
00077  *
00078  *      The last column structures (for pruning) will be removed
00079  *      after the numercial LU factorization phase.
00080  *
00081  *   (xlusup,lusup): lusup[*] contains the numerical values of the
00082  *      rectangular supernodes; xlusup[j] points to the starting
00083  *      location of the j-th column in storage vector lusup[*]
00084  *      Note: xlusup is indexed by column.
00085  *      Each rectangular supernode is stored by column-major
00086  *      scheme, consistent with Fortran 2-dim array storage.
00087  *
00088  *   (xusub,ucol,usub): ucol[*] stores the numerical values of
00089  *      U-columns outside the rectangular supernodes. The row
00090  *      subscript of nonzero ucol[k] is stored in usub[k].
00091  *      xusub[i] points to the starting location of column i in ucol.
00092  *      Storage: new row subscripts; that is subscripts of PA.
00093  */
00094 typedef struct {
00095     int     *xsup;    /* supernode and column mapping */
00096     int     *supno;   
00097     int     *lsub;    /* compressed L subscripts */
00098     int     *xlsub;
00099     complex  *lusup;   /* L supernodes */
00100     int     *xlusup;
00101     complex  *ucol;    /* U columns */
00102     int     *usub;
00103     int     *xusub;
00104     int     nzlmax;   /* current max size of lsub */
00105     int     nzumax;   /*    "    "    "      ucol */
00106     int     nzlumax;  /*    "    "    "     lusup */
00107     int     n;        /* number of columns in the matrix */
00108     LU_space_t MemModel; /* 0 - system malloc'd; 1 - user provided */
00109 } GlobalLU_t;
00110 
00111 typedef struct {
00112     int panel_size;
00113     int relax;
00114     float diag_pivot_thresh;
00115     float drop_tol;
00116 } factor_param_t;
00117 
00118 typedef struct {
00119     float for_lu;
00120     float total_needed;
00121     int   expansions;
00122 } mem_usage_t;
00123 
00124 #ifdef __cplusplus
00125 extern "C" {
00126 #endif
00127 
00128 /* Driver routines */
00129 extern void
00130 cgssv(SuperMatrix *, int *, int *, SuperMatrix *, SuperMatrix *, 
00131         SuperMatrix *, int *);
00132 extern void
00133 cgssvx(char *, char *, char *, SuperMatrix *, factor_param_t *,
00134        int *, int *, int *, char *, float *, float *,
00135        SuperMatrix *, SuperMatrix *, void *, int, SuperMatrix *, 
00136        SuperMatrix *, float *, float *, float *,
00137        float *, mem_usage_t *, int *);
00138 
00139 /* Supernodal LU factor related */
00140 extern void
00141 cCreate_CompCol_Matrix(SuperMatrix *, int, int, int, complex *,
00142                        int *, int *, Stype_t, Dtype_t, Mtype_t);
00143 extern void
00144 cCopy_CompCol_Matrix(SuperMatrix *, SuperMatrix *);
00145 extern void
00146 cCreate_Dense_Matrix(SuperMatrix *, int, int, complex *, int,
00147                      Stype_t, Dtype_t, Mtype_t);
00148 extern void
00149 cCreate_SuperNode_Matrix(SuperMatrix *, int, int, int, complex *, 
00150                          int *, int *, int *, int *, int *,
00151                          Stype_t, Dtype_t, Mtype_t);
00152 extern void
00153 cCopy_Dense_Matrix(int, int, complex *, int, complex *, int);
00154 
00155 extern void Destroy_SuperMatrix_Store(SuperMatrix *);
00156 extern void Destroy_CompCol_Matrix(SuperMatrix *);
00157 extern void Destroy_SuperNode_Matrix(SuperMatrix *);
00158 extern void Destroy_CompCol_Permuted(SuperMatrix *);
00159 extern void Destroy_Dense_Matrix(SuperMatrix *);
00160 
00161 extern void    callocateA (int, int, complex **, int **, int **);
00162 extern void    StatInit    (int, int);
00163 extern void    StatFree    ();
00164 extern void    get_perm_c(int, SuperMatrix *, int *);
00165 extern void    sp_preorder (char*, SuperMatrix*, int*, int*, SuperMatrix*);
00166 extern int     sp_coletree (int *, int *, int *, int, int, int *);
00167 extern void    cgstrf (char*, SuperMatrix*, float, float, int, int, int*,
00168                         void *, int, int *, int *, 
00169                         SuperMatrix *, SuperMatrix *, int *);
00170 extern void    relax_snode  (int, int *, int, int *, int *);
00171 extern int     csnode_dfs (const int, const int, const int *, const int *,
00172                              const int *, int *, int *, GlobalLU_t *);
00173 extern int     csnode_bmod (const int, const int, const int, complex *,
00174                               complex *, GlobalLU_t *);
00175 extern void    cpanel_dfs (const int, const int, const int, SuperMatrix *,
00176                            int *, int *, complex *, int *, int *, int *,
00177                            int *, int *, int *, int *, GlobalLU_t *);
00178 extern void    cpanel_bmod (const int, const int, const int, const int,
00179                            complex *, complex *, int *, int *,
00180                            GlobalLU_t *);
00181 extern int     ccolumn_dfs (const int, const int, int *, int *, int *, int *,
00182                            int *, int *, int *, int *, int *, GlobalLU_t *);
00183 extern int     ccolumn_bmod (const int, const int, complex *,
00184                            complex *, int *, int *, int, GlobalLU_t *);
00185 extern int     ccopy_to_ucol (int, int, int *, int *, int *,
00186                               complex *, GlobalLU_t *);         
00187 extern int     cpivotL (const int, const float, int *, int *, 
00188                               int *, int *, int *, GlobalLU_t *);
00189 extern void    cpruneL (const int, const int *, const int, const int,
00190                              const int *, const int *, int *, GlobalLU_t *);
00191 extern void    resetrep_col (const int, const int *, int *);
00192 extern void    countnz (const int, int *, int *, int *, GlobalLU_t *);
00193 extern void    fixupL (const int, const int *, GlobalLU_t *);
00194 extern int     spcoletree (int *, int *, int *, int, int, int *);
00195 extern int     *TreePostorder (int, int *);
00196 extern void    creadmt (int *, int *, int *, complex **, int **, int **);
00197 extern void    cGenXtrue (int, int, complex *, int);
00198 extern void    cFillRHS (char *, int, complex *, int, SuperMatrix *,
00199                         SuperMatrix *);
00200 extern void    cgstrs (char *, SuperMatrix *, SuperMatrix *, int *, int *,
00201                         SuperMatrix *, int *);
00202 
00203 
00204 /* Driver related */
00205 
00206 extern void    cgsequ (SuperMatrix *, float *, float *, float *,
00207                              float *, float *, int *);
00208 extern void    claqgs (SuperMatrix *, float *, float *, float,
00209                              float, float, char *);
00210 extern void    cgscon (char *, SuperMatrix *, SuperMatrix *, 
00211                         float, float *, int *);
00212 extern float   cPivotGrowth(int, SuperMatrix *, int *, 
00213                             SuperMatrix *, SuperMatrix *);
00214 extern void    cgsrfs (char *, SuperMatrix *, SuperMatrix *,
00215                         SuperMatrix *, int *, int *, char *, float *, 
00216                         float *, SuperMatrix *, SuperMatrix *, float *,
00217                         float *, int *);
00218 
00219 extern int     sp_ctrsv (char *, char *, char *, SuperMatrix *,
00220                         SuperMatrix *, complex *, int *);
00221 extern int     sp_cgemv (char *, complex, SuperMatrix *, complex *,
00222                         int, complex, complex *, int);
00223 
00224 extern int     sp_cgemm (char *, char *, int, int, int, complex,
00225                         SuperMatrix *, complex *, int, complex, 
00226                         complex *, int);
00227 
00228 /* Memory-related */
00229 extern void     superlu_abort_and_exit(char*);
00230 extern void    *superlu_malloc (int);
00231 extern void    superlu_free (void*);
00232 extern int     cLUMemInit (char *, void *, int, int, int, int, int,
00233                              SuperMatrix *, SuperMatrix *,
00234                              GlobalLU_t *, int **, complex **);
00235 extern void    SetIWork (int, int, int, int *, int **, int **, int **,
00236                          int **, int **, int **, int **);
00237 extern void    cSetRWork (int, int, complex *, complex **, complex **);
00238 extern void    cLUWorkFree (int *, complex *, GlobalLU_t *);
00239 extern int     cLUMemXpand (int, int, MemType, int *, GlobalLU_t *);
00240 
00241 extern int     *intMalloc (int);
00242 extern int     *intCalloc (int);
00243 extern complex  *complexMalloc(int);
00244 extern complex  *complexCalloc(int);
00245 extern float  *floatMalloc(int);
00246 extern float  *floatCalloc(int);
00247 extern void    *superlu_malloc(int);
00248 extern int     memory_usage();
00249 extern int     cQuerySpace (SuperMatrix *, SuperMatrix *, int,
00250                                 mem_usage_t *);
00251 
00252 /* Auxiliary routines */
00253 extern void    cCompRow_to_CompCol(int, int, int, complex*, int*, int*,
00254                                    complex **, int **, int **);
00255 extern double  SuperLU_timer_ ();
00256 extern int     sp_ienv (int);
00257 extern int     lsame_ (char *, char *);
00258 extern int     xerbla_ (char *, int *);
00259 extern void    ifill (int *, int, int);
00260 extern void    cfill (complex *, int, complex);
00261 extern void    inf_norm_error (int, SuperMatrix *, complex *);
00262 extern void    snode_profile (int, int *);
00263 extern void    super_stats (int, int *);
00264 extern void    PrintSumm (char *, int, int, int);
00265 extern void    PrintPerf (SuperMatrix *, SuperMatrix *, mem_usage_t *,
00266                          complex, complex, complex *, complex *, char *);
00267 
00268 /* Routines for debugging */
00269 extern void    cPrint_CompCol_Matrix(char *, SuperMatrix *);
00270 extern void    cPrint_SuperNode_Matrix(char *, SuperMatrix *);
00271 extern void    cPrint_Dense_Matrix(char *, SuperMatrix *);
00272 extern void    print_lu_col(char *, int, int, int *, GlobalLU_t *);
00273 extern void    print_panel_seg(int, int, int, int, int *, int *);
00274 extern void    check_tempv(int, complex *);
00275 extern void    check_repfnz(int, int, int, int *);
00276 
00277 #ifdef __cplusplus
00278   }
00279 #endif
00280 
00281 #endif /* __SUPERLU_cSP_DEFS */
00282