/*! @file slu_ddefs.h
* \brief Header file for real operations
*
* <pre>
* -- SuperLU routine (version 4.1) --
* Univ. of California Berkeley, Xerox Palo Alto Research Center,
* and Lawrence Berkeley National Lab.
* November, 2010
*
* Global data structures used in LU factorization -
*
* nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
* (xsup,supno): supno[i] is the supernode no to which i belongs;
* xsup(s) points to the beginning of the s-th supernode.
* e.g. supno 0 1 2 2 3 3 3 4 4 4 4 4 (n=12)
* xsup 0 1 2 4 7 12
* Note: dfs will be performed on supernode rep. relative to the new
* row pivoting ordering
*
* (xlsub,lsub): lsub[*] contains the compressed subscript of
* rectangular supernodes; xlsub[j] points to the starting
* location of the j-th column in lsub[*]. Note that xlsub
* is indexed by column.
* Storage: original row subscripts
*
* During the course of sparse LU factorization, we also use
* (xlsub,lsub) for the purpose of symmetric pruning. For each
* supernode {s,s+1,...,t=s+r} with first column s and last
* column t, the subscript set
* lsub[j], j=xlsub[s], .., xlsub[s+1]-1
* is the structure of column s (i.e. structure of this supernode).
* It is used for the storage of numerical values.
* Furthermore,
* lsub[j], j=xlsub[t], .., xlsub[t+1]-1
* is the structure of the last column t of this supernode.
* It is for the purpose of symmetric pruning. Therefore, the
* structural subscripts can be rearranged without making physical
* interchanges among the numerical values.
*
* However, if the supernode has only one column, then we
* only keep one set of subscripts. For any subscript interchange
* performed, similar interchange must be done on the numerical
* values.
*
* The last column structures (for pruning) will be removed
* after the numercial LU factorization phase.
*
* (xlusup,lusup): lusup[*] contains the numerical values of the
* rectangular supernodes; xlusup[j] points to the starting
* location of the j-th column in storage vector lusup[*]
* Note: xlusup is indexed by column.
* Each rectangular supernode is stored by column-major
* scheme, consistent with Fortran 2-dim array storage.
*
* (xusub,ucol,usub): ucol[*] stores the numerical values of
* U-columns outside the rectangular supernodes. The row
* subscript of nonzero ucol[k] is stored in usub[k].
* xusub[i] points to the starting location of column i in ucol.
* Storage: new row subscripts; that is subscripts of PA.
* </pre>
*/
#ifndef __SUPERLU_dSP_DEFS /* allow multiple inclusions */
#define __SUPERLU_dSP_DEFS
/*
* File name: dsp_defs.h
* Purpose: Sparse matrix types and function prototypes
* History:
*/
#ifdef _CRAY
#include <fortran.h>
#include <string.h>
#endif
/* Define my integer type int_t */
typedef int int_t; /* default */
#include <math.h>
#include <limits.h>
#include "slu_Cnames.h"
#include "supermatrix.h"
#include "slu_util.h"
typedef struct {
int *xsup; /* supernode and column mapping */
int *supno;
int *lsub; /* compressed L subscripts */
int *xlsub;
double *lusup; /* L supernodes */
int *xlusup;
double *ucol; /* U columns */
int *usub;
int *xusub;
int nzlmax; /* current max size of lsub */
int nzumax; /* " " " ucol */
int nzlumax; /* " " " lusup */
int n; /* number of columns in the matrix */
LU_space_t MemModel; /* 0 - system malloc'd; 1 - user provided */
int num_expansions;
ExpHeader *expanders; /* Array of pointers to 4 types of memory */
LU_stack_t stack; /* use user supplied memory */
} GlobalLU_t;
/* -------- Prototypes -------- */
#ifdef __cplusplus
extern "C" {
#endif
/*! \brief Driver routines */
extern void
dgssv(superlu_options_t *, SuperMatrix *, int *, int *, SuperMatrix *,
SuperMatrix *, SuperMatrix *, SuperLUStat_t *, int *);
extern void
dgssvx(superlu_options_t *, SuperMatrix *, int *, int *, int *,
char *, double *, double *, SuperMatrix *, SuperMatrix *,
void *, int, SuperMatrix *, SuperMatrix *,
double *, double *, double *, double *,
mem_usage_t *, SuperLUStat_t *, int *);
/* ILU */
extern void
dgsisv(superlu_options_t *, SuperMatrix *, int *, int *, SuperMatrix *,
SuperMatrix *, SuperMatrix *, SuperLUStat_t *, int *);
extern void
dgsisx(superlu_options_t *, SuperMatrix *, int *, int *, int *,
char *, double *, double *, SuperMatrix *, SuperMatrix *,
void *, int, SuperMatrix *, SuperMatrix *, double *, double *,
mem_usage_t *, SuperLUStat_t *, int *);
/*! \brief Supernodal LU factor related */
extern void
dCreate_CompCol_Matrix(SuperMatrix *, int, int, int, double *,
int *, int *, Stype_t, Dtype_t, Mtype_t);
extern void
dCreate_CompRow_Matrix(SuperMatrix *, int, int, int, double *,
int *, int *, Stype_t, Dtype_t, Mtype_t);
extern void
dCopy_CompCol_Matrix(SuperMatrix *, SuperMatrix *);
extern void
dCreate_Dense_Matrix(SuperMatrix *, int, int, double *, int,
Stype_t, Dtype_t, Mtype_t);
extern void
dCreate_SuperNode_Matrix(SuperMatrix *, int, int, int, double *,
int *, int *, int *, int *, int *,
Stype_t, Dtype_t, Mtype_t);
extern void
dCopy_Dense_Matrix(int, int, double *, int, double *, int);
extern void countnz (const int, int *, int *, int *, GlobalLU_t *);
extern void ilu_countnz (const int, int *, int *, GlobalLU_t *);
extern void fixupL (const int, const int *, GlobalLU_t *);
extern void dallocateA (int, int, double **, int **, int **);
extern void dgstrf (superlu_options_t*, SuperMatrix*,
int, int, int*, void *, int, int *, int *,
SuperMatrix *, SuperMatrix *, SuperLUStat_t*, int *);
extern int dsnode_dfs (const int, const int, const int *, const int *,
const int *, int *, int *, GlobalLU_t *);
extern int dsnode_bmod (const int, const int, const int, double *,
double *, GlobalLU_t *, SuperLUStat_t*);
extern void dpanel_dfs (const int, const int, const int, SuperMatrix *,
int *, int *, double *, int *, int *, int *,
int *, int *, int *, int *, GlobalLU_t *);
extern void dpanel_bmod (const int, const int, const int, const int,
double *, double *, int *, int *,
GlobalLU_t *, SuperLUStat_t*);
extern int dcolumn_dfs (const int, const int, int *, int *, int *, int *,
int *, int *, int *, int *, int *, GlobalLU_t *);
extern int dcolumn_bmod (const int, const int, double *,
double *, int *, int *, int,
GlobalLU_t *, SuperLUStat_t*);
extern int dcopy_to_ucol (int, int, int *, int *, int *,
double *, GlobalLU_t *);
extern int dpivotL (const int, const double, int *, int *,
int *, int *, int *, GlobalLU_t *, SuperLUStat_t*);
extern void dpruneL (const int, const int *, const int, const int,
const int *, const int *, int *, GlobalLU_t *);
extern void dreadmt (int *, int *, int *, double **, int **, int **);
extern void dGenXtrue (int, int, double *, int);
extern void dFillRHS (trans_t, int, double *, int, SuperMatrix *,
SuperMatrix *);
extern void dgstrs (trans_t, SuperMatrix *, SuperMatrix *, int *, int *,
SuperMatrix *, SuperLUStat_t*, int *);
/* ILU */
extern void dgsitrf (superlu_options_t*, SuperMatrix*, int, int, int*,
void *, int, int *, int *, SuperMatrix *, SuperMatrix *,
SuperLUStat_t*, int *);
extern int dldperm(int, int, int, int [], int [], double [],
int [], double [], double []);
extern int ilu_dsnode_dfs (const int, const int, const int *, const int *,
const int *, int *, GlobalLU_t *);
extern void ilu_dpanel_dfs (const int, const int, const int, SuperMatrix *,
int *, int *, double *, double *, int *, int *,
int *, int *, int *, int *, GlobalLU_t *);
extern int ilu_dcolumn_dfs (const int, const int, int *, int *, int *,
int *, int *, int *, int *, int *,
GlobalLU_t *);
extern int ilu_dcopy_to_ucol (int, int, int *, int *, int *,
double *, int, milu_t, double, int,
double *, int *, GlobalLU_t *, double *);
extern int ilu_dpivotL (const int, const double, int *, int *, int, int *,
int *, int *, int *, double, milu_t,
double, GlobalLU_t *, SuperLUStat_t*);
extern int ilu_ddrop_row (superlu_options_t *, int, int, double,
int, int *, double *, GlobalLU_t *,
double *, double *, int);
/*! \brief Driver related */
extern void dgsequ (SuperMatrix *, double *, double *, double *,
double *, double *, int *);
extern void dlaqgs (SuperMatrix *, double *, double *, double,
double, double, char *);
extern void dgscon (char *, SuperMatrix *, SuperMatrix *,
double, double *, SuperLUStat_t*, int *);
extern double dPivotGrowth(int, SuperMatrix *, int *,
SuperMatrix *, SuperMatrix *);
extern void dgsrfs (trans_t, SuperMatrix *, SuperMatrix *,
SuperMatrix *, int *, int *, char *, double *,
double *, SuperMatrix *, SuperMatrix *,
double *, double *, SuperLUStat_t*, int *);
extern int sp_dtrsv (char *, char *, char *, SuperMatrix *,
SuperMatrix *, double *, SuperLUStat_t*, int *);
extern int sp_dgemv (char *, double, SuperMatrix *, double *,
int, double, double *, int);
extern int sp_dgemm (char *, char *, int, int, int, double,
SuperMatrix *, double *, int, double,
double *, int);
extern double dlamch_(char *);
/*! \brief Memory-related */
extern int dLUMemInit (fact_t, void *, int, int, int, int, int,
double, SuperMatrix *, SuperMatrix *,
GlobalLU_t *, int **, double **);
extern void dSetRWork (int, int, double *, double **, double **);
extern void dLUWorkFree (int *, double *, GlobalLU_t *);
extern int dLUMemXpand (int, int, MemType, int *, GlobalLU_t *);
extern double *doubleMalloc(int);
extern double *doubleCalloc(int);
extern int dmemory_usage(const int, const int, const int, const int);
extern int dQuerySpace (SuperMatrix *, SuperMatrix *, mem_usage_t *);
extern int ilu_dQuerySpace (SuperMatrix *, SuperMatrix *, mem_usage_t *);
/*! \brief Auxiliary routines */
extern void dreadhb(int *, int *, int *, double **, int **, int **);
extern void dreadrb(int *, int *, int *, double **, int **, int **);
extern void dreadtriple(int *, int *, int *, double **, int **, int **);
extern void dCompRow_to_CompCol(int, int, int, double*, int*, int*,
double **, int **, int **);
extern void dfill (double *, int, double);
extern void dinf_norm_error (int, SuperMatrix *, double *);
extern void PrintPerf (SuperMatrix *, SuperMatrix *, mem_usage_t *,
double, double, double *, double *, char *);
extern double dqselect(int, double *, int);
/*! \brief Routines for debugging */
extern void dPrint_CompCol_Matrix(char *, SuperMatrix *);
extern void dPrint_SuperNode_Matrix(char *, SuperMatrix *);
extern void dPrint_Dense_Matrix(char *, SuperMatrix *);
extern void dprint_lu_col(char *, int, int, int *, GlobalLU_t *);
extern int print_double_vec(char *, int, double *);
extern void check_tempv(int, double *);
#ifdef __cplusplus
}
#endif
#endif /* __SUPERLU_dSP_DEFS */