summaryrefslogtreecommitdiff
path: root/inc/math_Gauss.hxx
blob: c8685935f4012f17727277ff3b89ee29033a8fbc (plain)
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
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _math_Gauss_HeaderFile
#define _math_Gauss_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _math_Matrix_HeaderFile
#include <math_Matrix.hxx>
#endif
#ifndef _math_IntegerVector_HeaderFile
#include <math_IntegerVector.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class math_NotSquare;
class Standard_DimensionError;
class StdFail_NotDone;
class math_Matrix;
class math_Vector;



//! This class implements the Gauss LU decomposition (Crout algorithm) <br>
//! with partial pivoting (rows interchange) of a square matrix and <br>
//! the different possible derived calculation : <br>
//!    - solution of a set of linear equations. <br>
//!    - inverse of a matrix. <br>
//!    - determinant of a matrix. <br>
class math_Gauss  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  
//! Given an input n X n matrix A this constructor performs its LU <br>
//! decomposition with partial pivoting (interchange of rows). <br>
//! This LU decomposition is stored internally and may be used to <br>
//! do subsequent calculation. <br>
//! If the largest pivot found is less than MinPivot the matrix A is <br>
//! considered as singular. <br>
//! Exception NotSquare is raised if A is not a square matrix. <br>
  Standard_EXPORT   math_Gauss(const math_Matrix& A,const Standard_Real MinPivot = 1.0e-20);
  //! Returns true if the computations are successful, otherwise returns false <br>
        Standard_Boolean IsDone() const;
  
//! Given the input Vector B this routine returns the solution X of the set <br>
//! of linear equations A . X = B. <br>
//! Exception NotDone is raised if the decomposition of A was not done <br>
//! successfully. <br>
//! Exception DimensionError is raised if the range of B is not <br>
//! equal to the number of rows of A. <br>
  Standard_EXPORT     void Solve(const math_Vector& B,math_Vector& X) const;
  
//! Given the input Vector B this routine solves the set of linear <br>
//! equations A . X = B. B is replaced by the vector solution X. <br>
//! Exception NotDone is raised if the decomposition of A was not done <br>
//! successfully. <br>
//! Exception DimensionError is raised if the range of B is not <br>
//! equal to the number of rows of A. <br>
  Standard_EXPORT     void Solve(math_Vector& B) const;
  
//! This routine returns the value of the determinant of the previously LU <br>
//! decomposed matrix A. <br>
//! Exception NotDone may be raised if the decomposition of A was not done <br>
//! successfully, zero is returned if the matrix A was considered as singular. <br>
  Standard_EXPORT     Standard_Real Determinant() const;
  
//! This routine outputs Inv the inverse of the previously LU decomposed <br>
//! matrix A. <br>
//! Exception DimensionError is raised if the ranges of B are not <br>
//! equal to the ranges of A. <br>
  Standard_EXPORT     void Invert(math_Matrix& Inv) const;
  //! Prints on the stream o information on the current state <br>
//!          of the object. <br>
//!          Is used to redefine the operator <<. <br>
  Standard_EXPORT     void Dump(Standard_OStream& o) const;





protected:



Standard_Boolean Singular;
math_Matrix LU;
math_IntegerVector Index;
Standard_Real D;


private:



Standard_Boolean Done;


};


#include <math_Gauss.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif