~ubuntu-branches/ubuntu/raring/python-scipy/raring-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-01-07 14:12:12 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070107141212-mm0ebkh5b37hcpzn
* Remove build dependency on python-numpy-dev.
* python-scipy: Depend on python-numpy instead of python-numpy-dev.
* Package builds on other archs than i386. Closes: #402783.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* ========================================================================== */
 
2
/* === umfpack_qsymbolic ==================================================== */
 
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_qsymbolic
 
13
(
 
14
    int n_row,
 
15
    int n_col,
 
16
    const int Ap [ ],
 
17
    const int Ai [ ],
 
18
    const double Ax [ ],
 
19
    const int Qinit [ ],
 
20
    void **Symbolic,
 
21
    const double Control [UMFPACK_CONTROL],
 
22
    double Info [UMFPACK_INFO]
 
23
) ;
 
24
 
 
25
long umfpack_dl_qsymbolic
 
26
(
 
27
    long n_row,
 
28
    long n_col,
 
29
    const long Ap [ ],
 
30
    const long Ai [ ],
 
31
    const double Ax [ ],
 
32
    const long Qinit [ ],
 
33
    void **Symbolic,
 
34
    const double Control [UMFPACK_CONTROL],
 
35
    double Info [UMFPACK_INFO]
 
36
) ;
 
37
 
 
38
int umfpack_zi_qsymbolic
 
39
(
 
40
    int n_row,
 
41
    int n_col,
 
42
    const int Ap [ ],
 
43
    const int Ai [ ],
 
44
    const double Ax [ ], const double Az [ ],
 
45
    const int Qinit [ ],
 
46
    void **Symbolic,
 
47
    const double Control [UMFPACK_CONTROL],
 
48
    double Info [UMFPACK_INFO]
 
49
) ;
 
50
 
 
51
long umfpack_zl_qsymbolic
 
52
(
 
53
    long n_row,
 
54
    long n_col,
 
55
    const long Ap [ ],
 
56
    const long Ai [ ],
 
57
    const double Ax [ ], const double Az [ ],
 
58
    const long Qinit [ ],
 
59
    void **Symbolic,
 
60
    const double Control [UMFPACK_CONTROL],
 
61
    double Info [UMFPACK_INFO]
 
62
) ;
 
63
 
 
64
/*
 
65
double int Syntax:
 
66
 
 
67
    #include "umfpack.h"
 
68
    void *Symbolic ;
 
69
    int n_row, n_col, *Ap, *Ai, *Qinit, status ;
 
70
    double Control [UMFPACK_CONTROL], Info [UMFPACK_INFO], *Ax ;
 
71
    status = umfpack_di_qsymbolic (n_row, n_col, Ap, Ai, Ax, Qinit,
 
72
        &Symbolic, Control, Info) ;
 
73
 
 
74
double long Syntax:
 
75
 
 
76
    #include "umfpack.h"
 
77
    void *Symbolic ;
 
78
    long n_row, n_col, *Ap, *Ai, *Qinit, status ;
 
79
    double Control [UMFPACK_CONTROL], Info [UMFPACK_INFO], *Ax ;
 
80
    status = umfpack_dl_qsymbolic (n_row, n_col, Ap, Ai, Ax, Qinit,
 
81
        &Symbolic, Control, Info) ;
 
82
 
 
83
complex int Syntax:
 
84
 
 
85
    #include "umfpack.h"
 
86
    void *Symbolic ;
 
87
    int n_row, n_col, *Ap, *Ai, *Qinit, status ;
 
88
    double Control [UMFPACK_CONTROL], Info [UMFPACK_INFO], *Ax, *Az ;
 
89
    status = umfpack_zi_qsymbolic (n_row, n_col, Ap, Ai, Ax, Az, Qinit,
 
90
        &Symbolic, Control, Info) ;
 
91
 
 
92
complex long Syntax:
 
93
 
 
94
    #include "umfpack.h"
 
95
    void *Symbolic ;
 
96
    long n_row, n_col, *Ap, *Ai, *Qinit, status ;
 
97
    double Control [UMFPACK_CONTROL], Info [UMFPACK_INFO], *Ax, *Az ;
 
98
    status = umfpack_zl_qsymbolic (n_row, n_col, Ap, Ai, Ax, Az, Qinit,
 
99
        &Symbolic, Control, Info) ;
 
100
 
 
101
Purpose:
 
102
 
 
103
    Given the nonzero pattern of a sparse matrix A in column-oriented form, and
 
104
    a sparsity preserving column pre-ordering Qinit, umfpack_*_qsymbolic
 
105
    performs the symbolic factorization of A*Qinit (or A (:,Qinit) in MATLAB
 
106
    notation).  This is identical to umfpack_*_symbolic, except that neither
 
107
    COLAMD nor AMD are called and the user input column order Qinit is used
 
108
    instead.  Note that in general, the Qinit passed to umfpack_*_qsymbolic
 
109
    can differ from the final Q found in umfpack_*_numeric.  The unsymmetric
 
110
    strategy will perform a column etree postordering done in
 
111
    umfpack_*_qsymbolic and sparsity-preserving modifications are made within
 
112
    each frontal matrix during umfpack_*_numeric.  The symmetric and 2-by-2
 
113
    strategies will preserve Qinit, unless the matrix is structurally singular.
 
114
 
 
115
    See umfpack_*_symbolic for more information.
 
116
 
 
117
    *** WARNING ***  A poor choice of Qinit can easily cause umfpack_*_numeric
 
118
    to use a huge amount of memory and do a lot of work.  The "default" symbolic
 
119
    analysis method is umfpack_*_symbolic, not this routine.  If you use this
 
120
    routine, the performance of UMFPACK is your responsibility;  UMFPACK will
 
121
    not try to second-guess a poor choice of Qinit.
 
122
 
 
123
Returns:
 
124
 
 
125
    The value of Info [UMFPACK_STATUS]; see umfpack_*_symbolic.
 
126
    Also returns UMFPACK_ERROR_invalid_permuation if Qinit is not a valid
 
127
    permutation vector.
 
128
 
 
129
Arguments:
 
130
 
 
131
    All arguments are the same as umfpack_*_symbolic, except for the following:
 
132
 
 
133
    Int Qinit [n_col] ;         Input argument, not modified.
 
134
 
 
135
        The user's fill-reducing initial column pre-ordering.  This must be a
 
136
        permutation of 0..n_col-1.  If Qinit [k] = j, then column j is the kth
 
137
        column of the matrix A (:,Qinit) to be factorized.  If Qinit is an
 
138
        (Int *) NULL pointer, then COLAMD or AMD are called instead.
 
139
 
 
140
*/