cgv
Loading...
Searching...
No Matches
cgv::math::sparse_les_factory Class Referenceabstract

factory class for sparse linear system solvers More...

#include <sparse_les.h>

Inheritance diagram for cgv::math::sparse_les_factory:
cgv::data::ref_counted cgv::math::sparse_les_factory_impl< T >

Public Member Functions

virtual ~sparse_les_factory ()
 make constructor virtual
 
virtual SparseLesCaps get_caps () const =0
 return the supported capabilities of the solver
 
virtual std::string get_solver_name () const =0
 return the name of the solver
 
virtual sparse_les_ptr create (int n, int nr_rhs, int nr_nze=-1)=0
 create an instance of the solver.
 
- Public Member Functions inherited from cgv::data::ref_counted
int get_ref_count () const
 read access to current count
 

Additional Inherited Members

- Protected Member Functions inherited from cgv::data::ref_counted
 ref_counted ()
 constructor initializes the count to 0
 
void set_ref_count (int c) const
 write access is also const to allow ref counted pointers to const instances
 

Detailed Description

factory class for sparse linear system solvers

Definition at line 27 of file sparse_les.h.

Constructor & Destructor Documentation

◆ ~sparse_les_factory()

cgv::math::sparse_les_factory::~sparse_les_factory ( )
virtual

make constructor virtual

Definition at line 8 of file sparse_les.cxx.

Member Function Documentation

◆ create()

virtual sparse_les_ptr cgv::math::sparse_les_factory::create ( int  n,
int  nr_rhs,
int  nr_nze = -1 
)
pure virtual

create an instance of the solver.

The parameters to the creation function are

  • n ... the number of unknowns,
  • nr_rhs ... the number of right hand sides
  • nr_nze ... the estimated number of non zero elements in the sparse matrix. For solvers with the SLC_NZE_OPTIONAL cap flag set, one can skip this argument.

Implemented in cgv::math::sparse_les_factory_impl< T >.

◆ get_caps()

virtual SparseLesCaps cgv::math::sparse_les_factory::get_caps ( ) const
pure virtual

return the supported capabilities of the solver

Implemented in cgv::math::sparse_les_factory_impl< T >.

◆ get_solver_name()

virtual std::string cgv::math::sparse_les_factory::get_solver_name ( ) const
pure virtual

return the name of the solver

Implemented in cgv::math::sparse_les_factory_impl< T >.


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