suanPan
SymmPackMat< T > Class Template Referencefinal

A SymmPackMat class that holds matrices. More...

#include <SymmPackMat.hpp>

Inheritance diagram for SymmPackMat< T >:
Collaboration diagram for SymmPackMat< T >:

Public Member Functions

 SymmPackMat (const uword in_size)
 
unique_ptr< MetaMat< T > > make_copy () override
 
void nullify (const uword K) override
 
T operator() (const uword in_row, const uword in_col) const override
 Access element (read-only), returns zero if out-of-bound. More...
 
Tunsafe_at (const uword in_row, const uword in_col) override
 Access element without bound check. More...
 
Tat (const uword in_row, const uword in_col) override
 Access element with bound check. More...
 
Mat< Toperator* (const Mat< T > &) const override
 
- Public Member Functions inherited from DenseMat< T >
 DenseMat (const uword in_rows, const uword in_cols, const uword in_elem)
 
 DenseMat (const DenseMat &old_mat)
 
 DenseMat (DenseMat &&) noexcept=delete
 
DenseMatoperator= (const DenseMat &)=delete
 
DenseMatoperator= (DenseMat &&) noexcept=delete
 
 ~DenseMat () override=default
 
bool is_empty () const override
 
void zeros () override
 
T max () const override
 
Col< Tdiag () const override
 
const Tmemptr () const override
 
Tmemptr () override
 
void scale_accu (const T scalar, const shared_ptr< MetaMat< T > > &M) override
 
void scale_accu (const T scalar, const triplet_form< T, uword > &M) override
 
void operator*= (const T value) override
 
int sign_det () const override
 
- Public Member Functions inherited from MetaMat< T >
 MetaMat (const uword in_rows, const uword in_cols, const uword in_elem)
 
 MetaMat (const MetaMat &)=default
 
 MetaMat (MetaMat &&) noexcept=delete
 
MetaMatoperator= (const MetaMat &)=delete
 
MetaMatoperator= (MetaMat &&) noexcept=delete
 
virtual ~MetaMat ()=default
 
void set_solver_setting (const SolverSetting< T > &SS)
 
SolverSetting< T > & get_solver_setting ()
 
void set_factored (const bool F)
 
virtual bool is_empty () const =0
 
virtual void zeros ()=0
 
virtual unique_ptr< MetaMatmake_copy ()=0
 
void unify (const uword K)
 
virtual void nullify (uword)=0
 
virtual T max () const =0
 
virtual Col< Tdiag () const =0
 
virtual T operator() (uword, uword) const =0
 Access element (read-only), returns zero if out-of-bound. More...
 
virtual Tunsafe_at (const uword I, const uword J)
 Access element without bound check. More...
 
virtual Tat (uword, uword)=0
 Access element with bound check. More...
 
virtual const Tmemptr () const =0
 
virtual Tmemptr ()=0
 
virtual void scale_accu (T, const shared_ptr< MetaMat > &)=0
 
virtual void scale_accu (T, const triplet_form< T, uword > &)=0
 
void operator+= (const shared_ptr< MetaMat > &M)
 
void operator-= (const shared_ptr< MetaMat > &M)
 
void operator+= (const op_scale< T > &M)
 
void operator-= (const op_scale< T > &M)
 
void operator+= (const triplet_form< T, uword > &M)
 
void operator-= (const triplet_form< T, uword > &M)
 
virtual Mat< Toperator* (const Mat< T > &) const =0
 
virtual void operator*= (T)=0
 
template<ArmaContainer< T > C>
int solve (Mat< T > &X, C &&B)
 
template<ArmaContainer< T > C>
Mat< Tsolve (C &&B)
 
virtual int sign_det () const =0
 
void save (const char *name)
 
virtual void csc_condense ()
 
virtual void csr_condense ()
 
Col< Tevaluate (const Col< T > &X) const
 

Protected Member Functions

int direct_solve (Mat< T > &, Mat< T > &&) override
 
- Protected Member Functions inherited from DenseMat< T >
int direct_solve (Mat< T > &X, const Mat< T > &B) override
 
podarray< float > to_float ()
 
- Protected Member Functions inherited from MetaMat< T >
virtual int direct_solve (Mat< T > &, const Mat< T > &)=0
 
virtual int direct_solve (Mat< T > &, Mat< T > &&)=0
 
int direct_solve (Mat< T > &X, const SpMat< T > &B)
 
int direct_solve (Mat< T > &X, SpMat< T > &&B)
 
int iterative_solve (Mat< T > &, const Mat< T > &)
 
int iterative_solve (Mat< T > &X, const SpMat< T > &B)
 
template<std::invocable< fmat & > F>
int mixed_trs (mat &X, mat &&B, F trs)
 

Additional Inherited Members

- Public Attributes inherited from MetaMat< T >
triplet_form< T, uword > triplet_mat
 
const uword n_rows
 
const uword n_cols
 
const uword n_elem
 
- Protected Attributes inherited from DenseMat< T >
podarray< int > pivot
 
podarray< float > s_memory
 
std::unique_ptr< T[]> memory = nullptr
 
- Protected Attributes inherited from MetaMat< T >
bool factored = false
 
SolverSetting< Tsetting {}
 

Detailed Description

template<sp_d T>
class SymmPackMat< T >

A SymmPackMat class that holds matrices.

Author
tlc
Date
13/11/2022
Version
0.2.0

Constructor & Destructor Documentation

◆ SymmPackMat()

template<sp_d T>
SymmPackMat< T >::SymmPackMat ( const uword  in_size)
inlineexplicit

Member Function Documentation

◆ at()

template<sp_d T>
T & SymmPackMat< T >::at ( const uword  ,
const uword   
)
inlineoverridevirtual

Access element with bound check.

Returns
value

Implements MetaMat< T >.

Here is the call graph for this function:

◆ make_copy()

template<sp_d T>
unique_ptr< MetaMat< T > > SymmPackMat< T >::make_copy ( )
inlineoverridevirtual

Implements MetaMat< T >.

◆ nullify()

template<sp_d T>
void SymmPackMat< T >::nullify ( const uword  K)
inlineoverridevirtual

Implements MetaMat< T >.

Here is the call graph for this function:

◆ operator()()

template<sp_d T>
T SymmPackMat< T >::operator() ( const uword  ,
const uword   
) const
inlineoverridevirtual

Access element (read-only), returns zero if out-of-bound.

Returns
value

Implements MetaMat< T >.

◆ unsafe_at()

template<sp_d T>
T & SymmPackMat< T >::unsafe_at ( const uword  I,
const uword  J 
)
inlineoverridevirtual

Access element without bound check.

Returns
value

Reimplemented from MetaMat< T >.

Here is the caller graph for this function:

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