Mercurial > octave-nkf

comparison liboctave/UMFPACK/UMFPACK/Include/umfpack_report_triplet.h @ 5164:57077d0ddc8e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2005-02-25 19:55:24 by jwe]
author jwe
date Fri, 25 Feb 2005 19:55:28 +0000
parents
children
comparison
equal deleted inserted replaced
5163:9f3299378193 5164:57077d0ddc8e
1 /* ========================================================================== */
2 /* === umfpack_report_triplet =============================================== */
3 /* ========================================================================== */
4
5 /* -------------------------------------------------------------------------- */
6 /* UMFPACK Version 4.4, Copyright (c) 2005 by Timothy A. Davis. CISE Dept, */
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_triplet
12 (
13 int n_row,
14 int n_col,
15 int nz,
16 const int Ti [ ],
17 const int Tj [ ],
18 const double Tx [ ],
19 const double Control [UMFPACK_CONTROL]
20 ) ;
21
22 long umfpack_dl_report_triplet
23 (
24 long n_row,
25 long n_col,
26 long nz,
27 const long Ti [ ],
28 const long Tj [ ],
29 const double Tx [ ],
30 const double Control [UMFPACK_CONTROL]
31 ) ;
32
33 int umfpack_zi_report_triplet
34 (
35 int n_row,
36 int n_col,
37 int nz,
38 const int Ti [ ],
39 const int Tj [ ],
40 const double Tx [ ], const double Tz [ ],
41 const double Control [UMFPACK_CONTROL]
42 ) ;
43
44 long umfpack_zl_report_triplet
45 (
46 long n_row,
47 long n_col,
48 long nz,
49 const long Ti [ ],
50 const long Tj [ ],
51 const double Tx [ ], const double Tz [ ],
52 const double Control [UMFPACK_CONTROL]
53 ) ;
54
55 /*
56 double int Syntax:
57
58 #include "umfpack.h"
59 int n_row, n_col, nz, *Ti, *Tj, status ;
60 double *Tx, Control [UMFPACK_CONTROL] ;
61 status = umfpack_di_report_triplet (n_row, n_col, nz, Ti, Tj, Tx, Control) ;
62
63 double long Syntax:
64
65 #include "umfpack.h"
66 long n_row, n_col, nz, *Ti, *Tj, status ;
67 double *Tx, Control [UMFPACK_CONTROL] ;
68 status = umfpack_dl_report_triplet (n_row, n_col, nz, Ti, Tj, Tx, Control) ;
69
70 complex int Syntax:
71
72 #include "umfpack.h"
73 int n_row, n_col, nz, *Ti, *Tj, status ;
74 double *Tx, *Tz, Control [UMFPACK_CONTROL] ;
75 status = umfpack_zi_report_triplet (n_row, n_col, nz, Ti, Tj, Tx, Tz,
76 Control) ;
77
78 complex long Syntax:
79
80 #include "umfpack.h"
81 long n_row, n_col, nz, *Ti, *Tj, status ;
82 double *Tx, *Tz, Control [UMFPACK_CONTROL] ;
83 status = umfpack_zl_report_triplet (n_row, n_col, nz, Ti, Tj, Tx, Tz,
84 Control) ;
85
86 packed complex Syntax:
87
88 Same as above, except Tz is NULL.
89
90 Purpose:
91
92 Verifies and prints a matrix in triplet form.
93
94 Returns:
95
96 UMFPACK_OK if Control [UMFPACK_PRL] <= 2 (the input is not checked).
97
98 Otherwise:
99
100 UMFPACK_OK if the Triplet matrix is OK.
101 UMFPACK_ERROR_argument_missing if Ti and/or Tj are missing.
102 UMFPACK_ERROR_n_nonpositive if n_row <= 0 or n_col <= 0.
103 UMFPACK_ERROR_invalid_matrix if nz < 0, or
104 if any row or column index in Ti and/or Tj
105 is not in the range 0 to n_row-1 or 0 to n_col-1, respectively.
106
107 Arguments:
108
109 Int n_row ; Input argument, not modified.
110 Int n_col ; Input argument, not modified.
111
112 A is an n_row-by-n_col matrix.
113
114 Int nz ; Input argument, not modified.
115
116 The number of entries in the triplet form of the matrix.
117
118 Int Ti [nz] ; Input argument, not modified.
119 Int Tj [nz] ; Input argument, not modified.
120 double Tx [nz] ; Input argument, not modified.
121 Size 2*nz for packed complex case.
122 double Tz [nz] ; Input argument, not modified, for complex versions.
123
124 Ti, Tj, Tx (and Tz for complex versions) hold the "triplet" form of a
125 sparse matrix. The kth nonzero entry is in row i = Ti [k], column
126 j = Tj [k], the real numerical value of a_ij is Tx [k], and the
127 imaginary part of a_ij is Tz [k] (for complex versions). The row and
128 column indices i and j must be in the range 0 to n_row-1 or 0 to
129 n_col-1, respectively. Duplicate entries may be present. The
130 "triplets" may be in any order. Tx and Tz are optional; if Tx is
131 not present ((double *) NULL), then the numerical values are
132 not printed.
133
134 If Tx is present and Tz is NULL, then both real
135 and imaginary parts are contained in Tx[0..2*nz-1], with Tx[2*k]
136 and Tx[2*k+1] being the real and imaginary part of the kth entry.
137
138 double Control [UMFPACK_CONTROL] ; Input argument, not modified.
139
140 If a (double *) NULL pointer is passed, then the default control
141 settings are used. Otherwise, the settings are determined from the
142 Control array. See umfpack_*_defaults on how to fill the Control
143 array with the default settings. If Control contains NaN's, the
144 defaults are used. The following Control parameters are used:
145
146 Control [UMFPACK_PRL]: printing level.
147
148 2 or less: no output. returns silently without checking anything.
149 3: fully check input, and print a short summary of its status
150 4: as 3, but print first few entries of the input
151 5: as 3, but print all of the input
152 Default: 1
153 */