include/opencascade/math_EigenValuesSearcher.hxx

0001 // Created on: 2005-12-15
0002 // Created by: Julia GERASIMOVA
0003 // Copyright (c) 2005-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _math_EigenValuesSearcher_HeaderFile
0017 #define _math_EigenValuesSearcher_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022
0023 #include <TColStd_HArray1OfReal.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <TColStd_HArray2OfReal.hxx>
0026 #include <TColStd_Array1OfReal.hxx>
0027 #include <Standard_Real.hxx>
0028 #include <math_Vector.hxx>
0029
0030
0031 //! This class finds eigen values and vectors of
0032 //! real symmetric tridiagonal matrix
0033 class math_EigenValuesSearcher
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   Standard_EXPORT math_EigenValuesSearcher(const TColStd_Array1OfReal& Diagonal, const TColStd_Array1OfReal& Subdiagonal);
0041
0042   //! Returns Standard_True if computation is performed
0043   //! successfully.
0044   Standard_EXPORT Standard_Boolean IsDone() const;
0045
0046   //! Returns the dimension of matrix
0047   Standard_EXPORT Standard_Integer Dimension() const;
0048
0049   //! Returns the Index_th eigen value of matrix
0050   //! Index must be in [1, Dimension()]
0051   Standard_EXPORT Standard_Real EigenValue (const Standard_Integer Index) const;
0052
0053   //! Returns the Index_th eigen vector of matrix
0054   //! Index must be in [1, Dimension()]
0055   Standard_EXPORT math_Vector EigenVector (const Standard_Integer Index) const;
0056
0057
0058
0059
0060 protected:
0061
0062
0063
0064
0065
0066 private:
0067
0068
0069
0070   Handle(TColStd_HArray1OfReal) myDiagonal;
0071   Handle(TColStd_HArray1OfReal) mySubdiagonal;
0072   Standard_Boolean myIsDone;
0073   Standard_Integer myN;
0074   Handle(TColStd_HArray1OfReal) myEigenValues;
0075   Handle(TColStd_HArray2OfReal) myEigenVectors;
0076
0077
0078 };
0079
0080
0081
0082
0083
0084
0085
0086 #endif // _math_EigenValuesSearcher_HeaderFile