summaryrefslogtreecommitdiff
path: root/inc/math_GaussLeastSquare.hxx
blob: 1691f624b76c904d5b9a934b365d796a8b8001b2 (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
// 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_GaussLeastSquare_HeaderFile
#define _math_GaussLeastSquare_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 StdFail_NotDone;
class Standard_DimensionError;
class math_Matrix;
class math_Vector;



//! This class implements the least square solution of a set of <br>
//! n linear equations of m unknowns (n >= m) using the gauss LU <br>
//! decomposition algorithm. <br>
//! This algorithm is more likely subject to numerical instability <br>
//!  than math_SVD. <br>
class math_GaussLeastSquare  {
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 m matrix A with n >= m this constructor <br>
//!          performs the LU decomposition with partial pivoting <br>
//!          (interchange of rows) of the matrix AA = A.Transposed() * A; <br>
//! 	        This LU decomposition is stored internally and may be used <br>
//! 	        to do subsequent calculation. <br>
//!          If the largest pivot found is less than MinPivot the matrix <A> <br>
//!          is considered as singular. <br>
  Standard_EXPORT   math_GaussLeastSquare(const math_Matrix& A,const Standard_Real MinPivot = 1.0e-20);
  //! Returns true if the computations are successful, otherwise returns false.e <br>
        Standard_Boolean IsDone() const;
  //! Given the input Vector <B> this routine solves the set <br>
//!          of linear equations A . X = B. <br>
//!          Exception NotDone is raised if the decomposition of A was <br>
//!          not done successfully. <br>
//!          Exception DimensionError is raised if the range of B Inv is <br>
//!          not equal to the rowrange of A. <br>
//!          Exception DimensionError is raised if the range of X Inv is <br>
//!          not equal to the colrange of A. <br>
  Standard_EXPORT     void Solve(const math_Vector& B,math_Vector& X) 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_Matrix A2;
math_IntegerVector Index;
Standard_Real D;


private:



Standard_Boolean Done;


};


#include <math_GaussLeastSquare.lxx>



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


#endif