0022651: Impossible to build OCC as static library due to using Standard_EXPORT inste...
[occt.git] / src / math / math_Recipes.hxx
1 // Copyright (c) 1997-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef math_Recipes_HeaderFile
16 #define math_Recipes_HeaderFile
17
18 #include <Standard_Boolean.hxx>
19 #include <Standard_Integer.hxx>
20 #include <Standard_Real.hxx>
21
22 class math_IntegerVector;
23 class math_Vector;
24 class math_Matrix;
25
26
27 const Standard_Integer math_Status_OK                  = 0;
28 const Standard_Integer math_Status_SingularMatrix      = 1;
29 const Standard_Integer math_Status_ArgumentError       = 2;
30 const Standard_Integer math_Status_NoConvergence       = 3;
31
32 Standard_EXPORT Standard_Integer  LU_Decompose(math_Matrix& a, 
33                                           math_IntegerVector& indx, 
34                                           Standard_Real&   d,
35                                           Standard_Real    TINY = 1.0e-20);
36
37 // Given a matrix a(1..n, 1..n), this routine computes its LU decomposition, 
38 // The matrix a is replaced by this LU decomposition and the vector indx(1..n)
39 // is an output which records the row permutation effected by the partial
40 // pivoting; d is output as +1 or -1 depending on wether the number of row
41 // interchanges was even or odd.
42
43 Standard_EXPORT Standard_Integer LU_Decompose(math_Matrix& a, 
44                                          math_IntegerVector& indx, 
45                                          Standard_Real&   d, 
46                                          math_Vector& vv,
47                                          Standard_Real    TINY = 1.0e-30);
48
49 // Idem to the previous LU_Decompose function. But the input Vector vv(1..n) is
50 // used internally as a scratch area.
51
52
53 Standard_EXPORT void LU_Solve(const math_Matrix& a,
54               const math_IntegerVector& indx, 
55               math_Vector& b);
56
57 // Solves a * x = b for a vector x, where x is specified by a(1..n, 1..n),
58 // indx(1..n) as returned by LU_Decompose. n is the dimension of the 
59 // square matrix A. b(1..n) is the input right-hand side and will be 
60 // replaced by the solution vector.Neither a and indx are destroyed, so 
61 // the routine may be called sequentially with different b's.
62
63
64 Standard_EXPORT Standard_Integer LU_Invert(math_Matrix& a);
65
66 // Given a matrix a(1..n, 1..n) this routine computes its inverse. The matrix
67 // a is replaced by its inverse.
68
69
70 Standard_EXPORT Standard_Integer SVD_Decompose(math_Matrix& a,
71                                           math_Vector& w,                    
72                                           math_Matrix& v);
73
74 // Given a matrix a(1..m, 1..n), this routine computes its singular value 
75 // decomposition, a = u * w * transposed(v). The matrix u replaces a on 
76 // output. The diagonal matrix of singular values w is output as a vector 
77 // w(1..n). The matrix v is output as v(1..n, 1..n). m must be greater or
78 // equal to n; if it is smaller, then a should be filled up to square with
79 // zero rows.
80
81
82 Standard_EXPORT Standard_Integer SVD_Decompose(math_Matrix& a,
83                                           math_Vector& w,
84                                           math_Matrix& v,
85                                           math_Vector& rv1);
86
87
88 // Idem to the previous LU_Decompose function. But the input Vector vv(1..m) 
89 // (the number of rows a(1..m, 1..n)) is used internally as a scratch area.
90
91
92 Standard_EXPORT void SVD_Solve(const math_Matrix& u,
93                           const math_Vector& w,
94                           const math_Matrix& v,
95                           const math_Vector& b,
96                           math_Vector& x);
97
98 // Solves a * x = b for a vector x, where x is specified by u(1..m, 1..n),
99 // w(1..n), v(1..n, 1..n) as returned by SVD_Decompose. m and n are the 
100 // dimensions of A, and will be equal for square matrices. b(1..m) is the 
101 // input right-hand side. x(1..n) is the output solution vector.
102 // No input quantities are destroyed, so the routine may be called 
103 // sequentially with different b's.
104
105
106
107 Standard_EXPORT Standard_Integer DACTCL_Decompose(math_Vector& a, const math_IntegerVector& indx,
108                                              const Standard_Real MinPivot = 1.e-20);
109
110 // Given a SYMMETRIC matrix a, this routine computes its 
111 // LU decomposition. 
112 // a is given through a vector of its non zero components of the upper
113 // triangular matrix.
114 // indx is the indice vector of the diagonal elements of a.
115 // a is replaced by its LU decomposition.
116 // The range of the matrix is n = indx.Length(), 
117 // and a.Length() = indx(n).
118
119
120
121 Standard_EXPORT Standard_Integer DACTCL_Solve(const math_Vector& a, math_Vector& b, 
122                                          const math_IntegerVector& indx, 
123                                          const Standard_Real MinPivot = 1.e-20);
124
125 // Solves a * x = b for a vector x and a matrix a coming from DACTCL_Decompose.
126 // indx is the same vector as in DACTCL_Decompose.
127 // the vector b is replaced by the vector solution x.
128
129
130
131
132 Standard_EXPORT Standard_Integer Jacobi(math_Matrix& a, math_Vector& d, math_Matrix& v, Standard_Integer& nrot);
133
134 // Computes all eigenvalues and eigenvectors of a real symmetric matrix
135 // a(1..n, 1..n). On output, elements of a above the diagonal are destroyed. 
136 // d(1..n) returns the eigenvalues of a. v(1..n, 1..n) is a matrix whose 
137 // columns contain, on output, the normalized eigenvectors of a. nrot returns
138 // the number of Jacobi rotations that were required.
139 // Eigenvalues are sorted into descending order, and eigenvectors are 
140 // arranges correspondingly.
141
142 #endif
143
144
145
146
147
148
149
150
151