Open CASCADE Technology  7.7.0.dev
Public Member Functions

math_Jacobi Class Reference

This class implements the Jacobi method to find the eigenvalues and the eigenvectors of a real symmetric square matrix. A sort of eigenvalues is done. More...

#include <math_Jacobi.hxx>

Public Member Functions

 math_Jacobi (const math_Matrix &A)
 Given a Real n X n matrix A, this constructor computes all its eigenvalues and eigenvectors using the Jacobi method. The exception NotSquare is raised if the matrix is not square. No verification that the matrix A is really symmetric is done. More...
 
Standard_Boolean IsDone () const
 Returns true if the computations are successful, otherwise returns false. More...
 
const math_VectorValues () const
 Returns the eigenvalues vector. Exception NotDone is raised if calculation is not done successfully. More...
 
Standard_Real Value (const Standard_Integer Num) const
 returns the eigenvalue number Num. Eigenvalues are in the range (1..n). Exception NotDone is raised if calculation is not done successfully. More...
 
const math_MatrixVectors () const
 returns the eigenvectors matrix. Exception NotDone is raised if calculation is not done successfully. More...
 
void Vector (const Standard_Integer Num, math_Vector &V) const
 Returns the eigenvector V of number Num. Eigenvectors are in the range (1..n). Exception NotDone is raised if calculation is not done successfully. More...
 
void Dump (Standard_OStream &o) const
 Prints information on the current state of the object. Is used to redefine the operator <<. More...
 

Detailed Description

This class implements the Jacobi method to find the eigenvalues and the eigenvectors of a real symmetric square matrix. A sort of eigenvalues is done.

Constructor & Destructor Documentation

◆ math_Jacobi()

math_Jacobi::math_Jacobi ( const math_Matrix A)

Given a Real n X n matrix A, this constructor computes all its eigenvalues and eigenvectors using the Jacobi method. The exception NotSquare is raised if the matrix is not square. No verification that the matrix A is really symmetric is done.

Member Function Documentation

◆ Dump()

void math_Jacobi::Dump ( Standard_OStream o) const

Prints information on the current state of the object. Is used to redefine the operator <<.

◆ IsDone()

Standard_Boolean math_Jacobi::IsDone ( ) const

Returns true if the computations are successful, otherwise returns false.

◆ Value()

Standard_Real math_Jacobi::Value ( const Standard_Integer  Num) const

returns the eigenvalue number Num. Eigenvalues are in the range (1..n). Exception NotDone is raised if calculation is not done successfully.

◆ Values()

const math_Vector& math_Jacobi::Values ( ) const

Returns the eigenvalues vector. Exception NotDone is raised if calculation is not done successfully.

◆ Vector()

void math_Jacobi::Vector ( const Standard_Integer  Num,
math_Vector V 
) const

Returns the eigenvector V of number Num. Eigenvectors are in the range (1..n). Exception NotDone is raised if calculation is not done successfully.

◆ Vectors()

const math_Matrix& math_Jacobi::Vectors ( ) const

returns the eigenvectors matrix. Exception NotDone is raised if calculation is not done successfully.


The documentation for this class was generated from the following file: