← Back to branch summary

~ubuntu-branches/ubuntu/natty/suitesparse/natty

« back to all changes in this revision

Viewing changes to UMFPACK/Include/umfpack_report_symbolic.h

  • Committer: Bazaar Package Importer
  • Author(s): Christophe Prud'homme
  • Date: 2006-12-22 10:16:15 UTC
  • Revision ID: james.westby@ubuntu.com-20061222101615-2ohaj8902oix2rnk
Tags: upstream-2.3.1
Import upstream version 2.3.1

Show diffs side-by-side

added added

removed removed

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