umfpack_report_numeric.h
3.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/* ========================================================================== */
/* === umfpack_report_numeric =============================================== */
/* ========================================================================== */
/* -------------------------------------------------------------------------- */
/* UMFPACK Copyright (c) Timothy A. Davis, CISE, */
/* Univ. of Florida. All Rights Reserved. See ../Doc/License for License. */
/* web: http://www.cise.ufl.edu/research/sparse/umfpack */
/* -------------------------------------------------------------------------- */
int umfpack_di_report_numeric
(
void *Numeric,
const double Control [UMFPACK_CONTROL]
) ;
UF_long umfpack_dl_report_numeric
(
void *Numeric,
const double Control [UMFPACK_CONTROL]
) ;
int umfpack_zi_report_numeric
(
void *Numeric,
const double Control [UMFPACK_CONTROL]
) ;
UF_long umfpack_zl_report_numeric
(
void *Numeric,
const double Control [UMFPACK_CONTROL]
) ;
/*
double int Syntax:
#include "umfpack.h"
void *Numeric ;
double Control [UMFPACK_CONTROL] ;
int status ;
status = umfpack_di_report_numeric (Numeric, Control) ;
double UF_long Syntax:
#include "umfpack.h"
void *Numeric ;
double Control [UMFPACK_CONTROL] ;
UF_long status ;
status = umfpack_dl_report_numeric (Numeric, Control) ;
complex int Syntax:
#include "umfpack.h"
void *Numeric ;
double Control [UMFPACK_CONTROL] ;
int status ;
status = umfpack_zi_report_numeric (Numeric, Control) ;
complex UF_long Syntax:
#include "umfpack.h"
void *Numeric ;
double Control [UMFPACK_CONTROL] ;
UF_long status ;
status = umfpack_zl_report_numeric (Numeric, Control) ;
Purpose:
Verifies and prints a Numeric object (the LU factorization, both its pattern
numerical values, and permutation vectors P and Q). This routine checks the
object more carefully than the computational routines. Normally, this check
is not required, since umfpack_*_numeric either returns (void *) NULL, or a
valid Numeric object. However, if you suspect that your own code has
corrupted the Numeric object (by overruning memory bounds, for example),
then this routine might be able to detect a corrupted Numeric object. Since
this is a complex object, not all such user-generated errors are guaranteed
to be caught by this routine.
Returns:
UMFPACK_OK if Control [UMFPACK_PRL] <= 2 (the input is not checked).
Otherwise:
UMFPACK_OK if the Numeric object is valid.
UMFPACK_ERROR_invalid_Numeric_object if the Numeric object is invalid.
UMFPACK_ERROR_out_of_memory if out of memory.
Arguments:
void *Numeric ; Input argument, not modified.
The Numeric object, which holds the numeric factorization computed by
umfpack_*_numeric.
double Control [UMFPACK_CONTROL] ; Input argument, not modified.
If a (double *) NULL pointer is passed, then the default control
settings are used. Otherwise, the settings are determined from the
Control array. See umfpack_*_defaults on how to fill the Control
array with the default settings. If Control contains NaN's, the
defaults are used. The following Control parameters are used:
Control [UMFPACK_PRL]: printing level.
2 or less: no output. returns silently without checking anything.
3: fully check input, and print a short summary of its status
4: as 3, but print first few entries of the input
5: as 3, but print all of the input
Default: 1
*/