Psi4
Public Member Functions | Protected Attributes | List of all members
psi::Cholesky Class Referenceabstract

#include <cholesky.h>

Inheritance diagram for psi::Cholesky:
psi::CholeskyDelta psi::CholeskyERI psi::CholeskyLocal psi::CholeskyMatrix psi::CholeskyMP2

Public Member Functions

 Cholesky (double delta, size_t memory)
 
virtual ~Cholesky ()
 Destructor, resets L_. More...
 
virtual void choleskify ()
 Perform the cholesky decomposition (requires 2QN memory) More...
 
SharedMatrix L () const
 Shared pointer to decomposition (Q x N), if choleskify() called. More...
 
size_t Q () const
 Number of columns required to reach accuracy delta, if choleskify() called. More...
 
virtual size_t N ()=0
 Dimension of the original square tensor, provided by the subclass. More...
 
double delta () const
 Maximum Chebyshev error allowed in the decomposition. More...
 
virtual void compute_diagonal (double *target)=0
 Diagonal of the original square tensor, provided by the subclass. More...
 
virtual void compute_row (int row, double *target)=0
 Row row of the original square tensor, provided by the subclass. More...
 

Protected Attributes

double delta_
 Maximum Chebyshev error allowed in the decomposition. More...
 
size_t memory_
 Maximum memory to use, in doubles. More...
 
SharedMatrix L_
 Full L (Q x n), if choleskify() called() More...
 
size_t Q_
 Number of columns required, if choleskify() called. More...
 

Constructor & Destructor Documentation

psi::Cholesky::Cholesky ( double  delta,
size_t  memory 
)

Constructor, does not build decomposition.

Parameters
deltamaximum Chebyshev error allowed in the decomposition
memorymaximum memory allowed, in doubles
psi::Cholesky::~Cholesky ( )
virtual

Destructor, resets L_.

Member Function Documentation

void psi::Cholesky::choleskify ( )
virtual

Perform the cholesky decomposition (requires 2QN memory)

virtual void psi::Cholesky::compute_diagonal ( double *  target)
pure virtual

Diagonal of the original square tensor, provided by the subclass.

Implemented in psi::CholeskyLocal, psi::CholeskyDelta, psi::CholeskyMP2, psi::CholeskyERI, and psi::CholeskyMatrix.

virtual void psi::Cholesky::compute_row ( int  row,
double *  target 
)
pure virtual

Row row of the original square tensor, provided by the subclass.

Implemented in psi::CholeskyLocal, psi::CholeskyDelta, psi::CholeskyMP2, psi::CholeskyERI, and psi::CholeskyMatrix.

double psi::Cholesky::delta ( ) const
inline

Maximum Chebyshev error allowed in the decomposition.

SharedMatrix psi::Cholesky::L ( ) const
inline

Shared pointer to decomposition (Q x N), if choleskify() called.

virtual size_t psi::Cholesky::N ( )
pure virtual

Dimension of the original square tensor, provided by the subclass.

Implemented in psi::CholeskyLocal, psi::CholeskyDelta, psi::CholeskyMP2, psi::CholeskyERI, and psi::CholeskyMatrix.

size_t psi::Cholesky::Q ( ) const
inline

Number of columns required to reach accuracy delta, if choleskify() called.

Member Data Documentation

double psi::Cholesky::delta_
protected

Maximum Chebyshev error allowed in the decomposition.

SharedMatrix psi::Cholesky::L_
protected

Full L (Q x n), if choleskify() called()

size_t psi::Cholesky::memory_
protected

Maximum memory to use, in doubles.

size_t psi::Cholesky::Q_
protected

Number of columns required, if choleskify() called.


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