numcxx::TSolverLapackLU< T > Class Template Reference

Description

template<typename T>
class numcxx::TSolverLapackLU< T >

Lapack LU factorization class.

Examples:

13-numcxx-lapack.cxx.

Definition at line 18 of file tsolver-lapacklu.hxx.

Inheritance diagram for numcxx::TSolverLapackLU< T >:

Collaboration diagram for numcxx::TSolverLapackLU< T >:

Public Member Functions
	TSolverLapackLU (const std::shared_ptr< TMatrix< T >> pMatrix)
	Object constructor, calls update() to obtain factorization. More...
	TSolverLapackLU (const TMatrix< T > &Matrix)
	Object constructor, calls update(Matrix) to obtain factorization. More...
void	update ()
	Perform computation of LU factorization using actual state of matrix. More...
void	update (const TMatrix< T > &Matrix)
	Perform computation of LU factorization using actual state of matrix. More...
void	solve (TArray< T > &Sol, const TArray< T > &Rhs) const
	Solve LU factorized system. More...
void	solve (std::shared_ptr< TArray1< T >> Sol, const std::shared_ptr< TArray1< T >> Rhs) const
	Solve LU factorized system. More...
std::shared_ptr< TMatrix< T > >	calculate_inverse ()
	Calculate inverse of matrix A from its LU factors. More...
	TSolverLapackLU ()
	Default constructor for swig. More...
TMatrix< T > &	LU ()
TArray1< int > &	IPiv ()
template<>
void	update (const TMatrix< double > &Matrix)
template<>
void	solve (TArray< double > &sol, const TArray< double > &rhs) const
template<>
void	update (const TMatrix< float > &Matrix)
template<>
void	solve (TArray< float > &sol, const TArray< float > &rhs) const
template<>
std::shared_ptr< TMatrix< double > >	calculate_inverse ()
template<>
std::shared_ptr< TMatrix< float > >	calculate_inverse ()

Static Public Member Functions
static std::shared_ptr< TSolverLapackLU< T > >	create (const std::shared_ptr< TMatrix< T >> pMatrix)
	Static wrapper around constructor. More...

Private Attributes
const std::shared_ptr< TMatrix< T > >	pMatrix
const std::shared_ptr< TMatrix< T > >	pLU
const std::shared_ptr< TArray1< int > >	pIPiv

Constructor & Destructor Documentation

template<typename T >

numcxx::TSolverLapackLU< T >::TSolverLapackLU ( const std::shared_ptr< TMatrix< T >>  pMatrix )

inline

Object constructor, calls update() to obtain factorization.

Definition at line 9 of file tsolver-lapacklu.ixx.

                                                                                   :
    TLinSolver<T>(),
    pMatrix(pMatrix),
    pLU(pMatrix->clone()),
    pIPiv(TArray1<int>::create(pMatrix->shape(0)))
  {
    update();;
  }

Here is the call graph for this function:

template<typename T >

numcxx::TSolverLapackLU< T >::TSolverLapackLU ( const TMatrix< T > &  Matrix )

inline

Object constructor, calls update(Matrix) to obtain factorization.

Definition at line 19 of file tsolver-lapacklu.ixx.

                                                                    :
    TLinSolver<T>(),
    pMatrix(0),
    pLU(TMatrix<T>::create(Matrix.shape(0),Matrix.shape(1))),
    pIPiv(TArray1<int>::create(Matrix.shape(0)))
  { 
    update(Matrix);
  }

Here is the call graph for this function:

template<typename T >

numcxx::TSolverLapackLU< T >::TSolverLapackLU ( )

inline

Default constructor for swig.

Definition at line 60 of file tsolver-lapacklu.hxx.

{};

Member Function Documentation

template<typename T >

std::shared_ptr< TSolverLapackLU< T > > numcxx::TSolverLapackLU< T >::create ( const std::shared_ptr< TMatrix< T >>  pMatrix )

inlinestatic

Static wrapper around constructor.

Examples:

14-numcxx-lapack-sharedptr.cxx.

Definition at line 29 of file tsolver-lapacklu.ixx.

  {
    return std::make_shared<TSolverLapackLU<T>>(a);
  }

Here is the call graph for this function:

template<typename T >

void numcxx::TSolverLapackLU< T >::update ( void  )

virtual

Perform computation of LU factorization using actual state of matrix.

Uses dgetrf from the LAPACK library (for T=double)

Reimplemented from numcxx::TLinSolver< T >.

Definition at line 95 of file tsolver-lapacklu.ixx.

  {
    if (pMatrix==nullptr)
      throw std::runtime_error("numcxx: TSolverLapackLU created without smartpointer");
    update(*pMatrix);
  }

template<typename T >

void numcxx::TSolverLapackLU< T >::update

(

const TMatrix< T > &

Matrix

)

Perform computation of LU factorization using actual state of matrix.

template<typename T >

void numcxx::TSolverLapackLU< T >::solve ( TArray< T > &  Sol, const TArray< T > &  Rhs  ) const

virtual

Solve LU factorized system.

Uses dgetrs from the LAPACK library (for T=double)

Reimplemented from numcxx::TLinSolver< T >.

Examples:

13-numcxx-lapack.cxx.

template<typename T >

void numcxx::TSolverLapackLU< T >::solve ( std::shared_ptr< TArray1< T >>  Sol, const std::shared_ptr< TArray1< T >>  Rhs  ) const

inline

Solve LU factorized system.

Definition at line 53 of file tsolver-lapacklu.hxx.

{solve(*Sol,*Rhs);};

Here is the call graph for this function:

template<typename T >

std::shared_ptr<TMatrix<T> > numcxx::TSolverLapackLU< T >::calculate_inverse

(

)

Calculate inverse of matrix A from its LU factors.

Todo:

move constructor

template<typename T >

TMatrix<T>& numcxx::TSolverLapackLU< T >::LU ( )

inline

Definition at line 64 of file tsolver-lapacklu.hxx.

{ return *pLU;}

template<typename T >

TArray1<int>& numcxx::TSolverLapackLU< T >::IPiv ( )

inline

Definition at line 65 of file tsolver-lapacklu.hxx.

{ return *pIPiv;}

template<>

void numcxx::TSolverLapackLU< double >::update ( const TMatrix< double > &  Matrix )

inline

Definition at line 46 of file tsolver-lapacklu.ixx.

  {
    int n=pLU->shape(0);
    int info=0;
    *pLU=Matrix;
    dgetrf_(&n,&n,pLU->data(),&n,pIPiv->data(),&info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::update: dgetrf error %d\n",info);
      throw std::runtime_error(errormsg);
    }
  }

Here is the call graph for this function:

template<>

void numcxx::TSolverLapackLU< double >::solve ( TArray< double > &  sol, const TArray< double > &  rhs  ) const

inline

Definition at line 61 of file tsolver-lapacklu.ixx.

  {
    assign(sol,rhs);
    char trans[2]={'T','\0'};
    int n=pLU->shape(0);
    int one=1;
    int info=0;
    dgetrs_(trans,&n,&one,pLU->data(),&n,pIPiv->data(),sol.data(),&n,&info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::update: dgetrs error %d\n",info);
      throw std::runtime_error(errormsg);
    }
  }

Here is the call graph for this function:

template<>

void numcxx::TSolverLapackLU< float >::update ( const TMatrix< float > &  Matrix )

inline

Definition at line 79 of file tsolver-lapacklu.ixx.

  {
    int n=pLU->shape(0);
    int info;
    *pLU=Matrix;
    sgetrf_(&n,&n,pLU->data(),&n,pIPiv->data(),&info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::update: sgetrf error %d\n",info);
      throw std::runtime_error(errormsg);
    }

  }

Here is the call graph for this function:

template<>

void numcxx::TSolverLapackLU< float >::solve ( TArray< float > &  sol, const TArray< float > &  rhs  ) const

inline

Definition at line 104 of file tsolver-lapacklu.ixx.

  {
    assign(sol,rhs);
    char trans[2]={'T','\0'};
    int n=pLU->shape(0);
    int one=1;
    int info;
    sgetrs_(trans,&n,&one,pLU->data(),&n,pIPiv->data(),sol.data(),&n,&info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::update: sgetrs error %d\n",info);
      throw std::runtime_error(errormsg);
    }

  }

Here is the call graph for this function:

template<>

std::shared_ptr< TMatrix< double > > numcxx::TSolverLapackLU< double >::calculate_inverse ( )

inline

Definition at line 124 of file tsolver-lapacklu.ixx.

  {
    int n=pLU->shape(0);
    auto pInverse=std::make_shared<TMatrix<double>>(*pLU);
    int info;
    TArray1<double> Work(n);
    dgetri_(&n, 
            pInverse->data(), 
            &n, 
            pIPiv->data(),
            Work.data(),
            &n,
            &info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::calculate_inverse: dgetri error %d\n",info);
      throw std::runtime_error(errormsg);
    }
    return pInverse;
  }

Here is the call graph for this function:

template<>

std::shared_ptr< TMatrix< float > > numcxx::TSolverLapackLU< float >::calculate_inverse ( )

inline

Definition at line 147 of file tsolver-lapacklu.ixx.

  {
    int n=pLU->shape(0);
    auto pInverse=std::make_shared<TMatrix<float>>(*pLU);
    int info;
    TArray1<float> Work(n);
    sgetri_(&n, 
            pInverse->data(), 
            &n, 
            pIPiv->data(),
            Work.data(),
            &n,
            &info);
    if (info!=0)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverLapackLU::calculate_inverse: sgetri error %d\n",info);
      throw std::runtime_error(errormsg);
    }
    return pInverse;
  }

Here is the call graph for this function:

Member Data Documentation

template<typename T >

const std::shared_ptr< TMatrix<T> > numcxx::TSolverLapackLU< T >::pMatrix

private

Definition at line 20 of file tsolver-lapacklu.hxx.

template<typename T >

const std::shared_ptr< TMatrix<T> > numcxx::TSolverLapackLU< T >::pLU

private

Definition at line 21 of file tsolver-lapacklu.hxx.

template<typename T >

const std::shared_ptr< TArray1<int> > numcxx::TSolverLapackLU< T >::pIPiv

private

Definition at line 22 of file tsolver-lapacklu.hxx.

---

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

• tsolver-lapacklu.hxx
• tsolver-lapacklu.ixx