← Back to branch summary

~ubuntu-branches/ubuntu/saucy/python-scipy/saucy

« back to all changes in this revision

Viewing changes to Lib/sandbox/pysparse/umfpack/umfpack_report_symbolic.h

  • Committer: Bazaar Package Importer
  • Author(s): Ondrej Certik
  • Date: 2008-06-16 22:58:01 UTC
  • mfrom: (2.1.24 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080616225801-irdhrpcwiocfbcmt
Tags: 0.6.0-12
http://bugs.debian.org/489149
* The description updated to match the current SciPy (Closes: #489149).
* Standards-Version bumped to 3.8.0 (no action needed)
* Build-Depends: netcdf-dev changed to libnetcdf-dev

Show diffs side-by-side

added added

removed removed

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