Blame view

fvn_sparse/UMFPACK/Include/umfpack_scale.h 3.09 KB
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
  /* ========================================================================== */
  /* === umfpack_scale ======================================================== */
  /* ========================================================================== */
  
  /* -------------------------------------------------------------------------- */
  /* 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_scale
  (
      double X [ ],
      const double B [ ],
      void *Numeric
  ) ;
  
  UF_long umfpack_dl_scale
  (
      double X [ ],
      const double B [ ],
      void *Numeric
  ) ;
  
  int umfpack_zi_scale
  (
      double Xx [ ],	 double Xz [ ],
      const double Bx [ ], const double Bz [ ],
      void *Numeric
  ) ;
  
  UF_long umfpack_zl_scale
  (
      double Xx [ ],	 double Xz [ ],
      const double Bx [ ], const double Bz [ ],
      void *Numeric
  ) ;
  
  /*
  double int Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      double *B, *X ;
      status = umfpack_di_scale (X, B, Numeric) ;
  
  double UF_long Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      double *B, *X ;
      status = umfpack_dl_scale (X, B, Numeric) ;
  
  complex int Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      double *Bx, *Bz, *Xx, *Xz ;
      status = umfpack_zi_scale (Xx, Xz, Bx, Bz, Numeric) ;
  
  complex UF_long Syntax:
  
      #include "umfpack.h"
      void *Numeric ;
      double *Bx, *Bz, *Xx, *Xz ;
      status = umfpack_zl_scale (Xx, Xz, Bx, Bz, Numeric) ;
  
  packed complex Syntax:
  
      Same as above, except both Xz and Bz are NULL.
  
  Purpose:
  
      Given LU factors computed by umfpack_*_numeric (PAQ=LU, PRAQ=LU, or
      P(R\A)Q=LU), and a vector B, this routine computes X = B, X = R*B, or
      X = R\B, as appropriate.  X and B must be vectors equal in length to the
      number of rows of A.
  
  Returns:
  
      The status code is returned.  UMFPACK_OK is returned if successful.
      UMFPACK_ERROR_invalid_Numeric_object is returned in the Numeric
      object is invalid.  UMFPACK_ERROR_argument_missing is returned if
      any of the input vectors are missing (X and B for the real version,
      and Xx and Bx for the complex version).
  
  Arguments:
  
      double X [n_row] ;	Output argument.
      or:
      double Xx [n_row] ;	Output argument, real part.
  			Size 2*n_row for packed complex case.
      double Xz [n_row] ;	Output argument, imaginary part.
  
  	The output vector X.  If either Xz or Bz are NULL, the vector
  	X is in packed complex form, with the kth entry in Xx [2*k] and
  	Xx [2*k+1], and likewise for B.
  
      double B [n_row] ;	Input argument, not modified.
      or:
      double Bx [n_row] ;	Input argument, not modified, real part.
  			Size 2*n_row for packed complex case.
      double Bz [n_row] ;	Input argument, not modified, imaginary part.
  
  	The input vector B.  See above if either Xz or Bz are NULL.
  
      void *Numeric ;		Input argument, not modified.
  
  	Numeric must point to a valid Numeric object, computed by
  	umfpack_*_numeric.
  
  */