suanPan
Public Member Functions | Protected Member Functions | List of all members
SparseMatLis< T > Class Template Referencefinal
MetaMat

A SparseMatLis class that holds matrices. More...

#include <SparseMatLis.hpp>

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

Public Member Functions

 SparseMatLis (const uword in_row, const uword in_col, const uword in_elem=0)
 
 SparseMatLis (const SparseMatLis &other)
 
 SparseMatLis (SparseMatLis &&) noexcept=delete
 
SparseMatLis & operator= (const SparseMatLis &)=delete
 
SparseMatLis & operator= (SparseMatLis &&) noexcept=delete
 
 ~SparseMatLis () override
 
unique_ptr< MetaMat< T > > make_copy () override
 
- Public Member Functions inherited from SparseMat< T >
 SparseMat (const uword in_row, const uword in_col, const uword in_elem=0)
 
bool is_empty () const override
 
void zeros () override
 
void nullify (const uword idx) override
 
T max () const override
 
Col< T > diag () const override
 
T operator() (const uword in_row, const uword in_col) const override
 Access element (read-only), returns zero if out-of-bound. More...
 
T & at (const uword in_row, const uword in_col) override
 Access element with bound check. More...
 
const T * memptr () const override
 
T * memptr () override
 
void scale_accu (const T scalar, const shared_ptr< MetaMat< T > > &in_mat) override
 
void scale_accu (const T scalar, const triplet_form< T, uword > &in_mat) override
 
Mat< T > operator* (const Mat< T > &in_mat) const override
 
void operator*= (const T scalar) override
 
int sign_det () const override
 
void csc_condense () override
 
void csr_condense () 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
 
MetaMat & operator= (const MetaMat &)=delete
 
MetaMat & operator= (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< MetaMat > make_copy ()=0
 
void unify (const uword K)
 
virtual void nullify (uword)=0
 
virtual T max () const =0
 
virtual Col< T > diag () const =0
 
virtual T operator() (uword, uword) const =0
 Access element (read-only), returns zero if out-of-bound. More...
 
virtual T & unsafe_at (const uword I, const uword J)
 Access element without bound check. More...
 
virtual T & at (uword, uword)=0
 Access element with bound check. More...
 
virtual const T * memptr () const =0
 
virtual T * memptr ()=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< T > operator* (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< T > solve (C &&B)
 
virtual int sign_det () const =0
 
void save (const char *name)
 
virtual void csc_condense ()
 
virtual void csr_condense ()
 
Col< T > evaluate (const Col< T > &X) const
 

Protected Member Functions

int direct_solve (Mat< T > &, const Mat< T > &) override
 
- Protected Member Functions inherited from SparseMat< T >
int direct_solve (Mat< T > &X, Mat< T > &&B) override
 
- 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 MetaMat< T >
bool factored = false
 
SolverSetting< T > setting {}
 

Detailed Description

template<sp_d T>
class SparseMatLis< T >

A SparseMatLis class that holds matrices.

Author
tlc
Date
15/06/2023
Version
0.1.0

Constructor & Destructor Documentation

◆ SparseMatLis() [1/3]

template<sp_d T>
SparseMatLis< T >::SparseMatLis ( const uword  in_row,
const uword  in_col,
const uword  in_elem = 0 
)
inline

◆ SparseMatLis() [2/3]

template<sp_d T>
SparseMatLis< T >::SparseMatLis ( const SparseMatLis< T > &  other)
inline

◆ SparseMatLis() [3/3]

template<sp_d T>
SparseMatLis< T >::SparseMatLis ( SparseMatLis< T > &&  )
deletenoexcept

◆ ~SparseMatLis()

template<sp_d T>
SparseMatLis< T >::~SparseMatLis ( )
inlineoverride

Member Function Documentation

◆ make_copy()

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

Implements MetaMat< T >.

◆ operator=() [1/2]

template<sp_d T>
SparseMatLis & SparseMatLis< T >::operator= ( const SparseMatLis< T > &  )
delete

◆ operator=() [2/2]

template<sp_d T>
SparseMatLis & SparseMatLis< T >::operator= ( SparseMatLis< T > &&  )
deletenoexcept
The documentation for this class was generated from the following file: