lxsd / fvn

Blame view

fvn_sparse/UMFPACK/Include/umfpack_get_lunz.h 3.9 KB
edit raw normal view history
422234dc3   daniau   git-svn-id: https... 
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
  /* ========================================================================== */
  /* === umfpack_get_lunz ===================================================== */
  /* ========================================================================== */
  
  /* -------------------------------------------------------------------------- */
  /* 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_get_lunz
  (
      int *lnz,
      int *unz,
      int *n_row,
      int *n_col,
      int *nz_udiag,
      void *Numeric
  ) ;
  
  UF_long umfpack_dl_get_lunz
  (
      UF_long *lnz,
      UF_long *unz,
      UF_long *n_row,
      UF_long *n_col,
      UF_long *nz_udiag,
      void *Numeric
  ) ;
  
  int umfpack_zi_get_lunz
  (
      int *lnz,
      int *unz,
      int *n_row,
      int *n_col,
      int *nz_udiag,
      void *Numeric
  ) ;
  
  UF_long umfpack_zl_get_lunz
  (
      UF_long *lnz,
      UF_long *unz,
      UF_long *n_row,
      UF_long *n_col,
      UF_long *nz_udiag,
      void *Numeric
  ) ;
  
  /*
  double int Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      int status, lnz, unz, n_row, n_col, nz_udiag ;
      status = umfpack_di_get_lunz (&lnz, &unz, &n_row, &n_col, &nz_udiag,
  	Numeric) ;
  
  double UF_long Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      UF_long status, lnz, unz, n_row, n_col, nz_udiag ;
      status = umfpack_dl_get_lunz (&lnz, &unz, &n_row, &n_col, &nz_udiag,
  	Numeric) ;
  
  complex int Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      int status, lnz, unz, n_row, n_col, nz_udiag ;
      status = umfpack_zi_get_lunz (&lnz, &unz, &n_row, &n_col, &nz_udiag,
  	Numeric) ;
  
  complex UF_long Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      UF_long status, lnz, unz, n_row, n_col, nz_udiag ;
      status = umfpack_zl_get_lunz (&lnz, &unz, &n_row, &n_col, &nz_udiag,
  	Numeric) ;
  
  Purpose:
  
      Determines the size and number of nonzeros in the LU factors held by the
      Numeric object.  These are also the sizes of the output arrays required
      by umfpack_*_get_numeric.
  
      The matrix L is n_row -by- min(n_row,n_col), with lnz nonzeros, including
      the entries on the unit diagonal of L.
  
      The matrix U is min(n_row,n_col) -by- n_col, with unz nonzeros, including
      nonzeros on the diagonal of U.
  
  Returns:
  
      UMFPACK_OK if successful.
      UMFPACK_ERROR_invalid_Numeric_object if Numeric is not a valid object.
      UMFPACK_ERROR_argument_missing if any other argument is (Int *) NULL.
  
  Arguments:
  
      Int *lnz ;		Output argument.
  
  	The number of nonzeros in L, including the diagonal (which is all
  	one's).  This value is the required size of the Lj and Lx arrays as
  	computed by umfpack_*_get_numeric.  The value of lnz is identical to
  	Info [UMFPACK_LNZ], if that value was returned by umfpack_*_numeric.
  
      Int *unz ;		Output argument.
  
  	The number of nonzeros in U, including the diagonal.  This value is the
  	required size of the Ui and Ux arrays as computed by
  	umfpack_*_get_numeric.  The value of unz is identical to
  	Info [UMFPACK_UNZ], if that value was returned by umfpack_*_numeric.
  
      Int *n_row ;	Output argument.
      Int *n_col ;	Output argument.
  
  	The order of the L and U matrices.  L is n_row -by- min(n_row,n_col)
  	and U is min(n_row,n_col) -by- n_col.
  
      Int *nz_udiag ;	Output argument.
  
  	The number of numerically nonzero values on the diagonal of U.  The
  	matrix is singular if nz_diag < min(n_row,n_col).  A divide-by-zero
  	will occur if nz_diag < n_row == n_col when solving a sparse system
  	involving the matrix U in umfpack_*_*solve.  The value of nz_udiag is
  	identical to Info [UMFPACK_UDIAG_NZ] if that value was returned by
  	umfpack_*_numeric.
  
      void *Numeric ;	Input argument, not modified.
  
  	Numeric must point to a valid Numeric object, computed by
  	umfpack_*_numeric.
  */