Loading...
Searching...
No Matches
Public Member Functions |
Static Public Member Functions |
Protected Attributes |
List of all members
sc::SCMatrixKit Class Referenceabstract
The SCMatrixKit abstract class acts as a factory for producing matrices. More...
#include <math/scmat/abstract.h>
Inheritance diagram for sc::SCMatrixKit:
Public Member Functions | |
| SCMatrixKit (const Ref< KeyVal > &) | |
| Ref< MessageGrp > | messagegrp () const |
| virtual SCMatrix * | matrix (const RefSCDimension &, const RefSCDimension &)=0 |
| Given the dimensions, create matrices or vectors. | |
| virtual SymmSCMatrix * | symmmatrix (const RefSCDimension &)=0 |
| virtual DiagSCMatrix * | diagmatrix (const RefSCDimension &)=0 |
| virtual SCVector * | vector (const RefSCDimension &)=0 |
| SCMatrix * | restore_matrix (StateIn &, const RefSCDimension &, const RefSCDimension &) |
| Given the dimensions and a StateIn object, restore matrices or vectors. | |
| SymmSCMatrix * | restore_symmmatrix (StateIn &, const RefSCDimension &) |
| DiagSCMatrix * | restore_diagmatrix (StateIn &, const RefSCDimension &) |
| SCVector * | restore_vector (StateIn &, const RefSCDimension &) |
 Public Member Functions inherited from sc::DescribedClass | |
| DescribedClass (const DescribedClass &) | |
| DescribedClass & | operator= (const DescribedClass &) |
| ClassDesc * | class_desc () const MPQC__NOEXCEPT |
| This returns the unique pointer to the ClassDesc corresponding to the given type_info object. | |
| const char * | class_name () const |
| Return the name of the object's exact type. | |
| int | class_version () const |
| Return the version of the class. | |
| virtual void | print (std::ostream &=ExEnv::out0()) const |
| Print the object. | |
| Ref< DescribedClass > | ref () |
| Return this object wrapped up in a Ref smart pointer. | |
| Public Member Functions inherited from sc::RefCount | |
| size_t | identifier () const |
| Return the unique identifier for this object that can be compared for different objects of different types. | |
| int | lock_ptr () const |
| Lock this object. | |
| int | unlock_ptr () const |
| Unlock this object. | |
| void | use_locks (bool inVal) |
| start and stop using locks on this object | |
| refcount_t | nreference () const |
| Return the reference count. | |
| refcount_t | reference () |
| Increment the reference count and return the new count. | |
| refcount_t | dereference () |
| Decrement the reference count and return the new count. | |
| int | managed () const |
| Return 1 if the object is managed. Otherwise return 0. | |
Static Public Member Functions | |
| static SCMatrixKit * | default_matrixkit () |
| This returns the default matrix kit. | |
| static void | set_default_matrixkit (const Ref< SCMatrixKit > &) |
| change the default matrix kit | |
Protected Attributes | |
| Ref< MessageGrp > | grp_ |
Additional Inherited Members | |
| Protected Member Functions inherited from sc::RefCount | |
| RefCount (const RefCount &) | |
| RefCount & | operator= (const RefCount &) |
Detailed Description
The SCMatrixKit abstract class acts as a factory for producing matrices.
By using one of these, the program makes sure that all of the matrices are consistent.
Member Function Documentation
◆ default_matrixkit()
|
static |
This returns the default matrix kit.
It is currently a ReplSCMatrixKit, unless the the user has changed it with with set_default_matrixkit.
◆ matrix()
|
pure virtual |
Given the dimensions, create matrices or vectors.
Implemented in sc::BlockedSCMatrixKit, sc::DistSCMatrixKit, sc::LocalSCMatrixKit, and sc::ReplSCMatrixKit.
The documentation for this class was generated from the following file:
- src/lib/math/scmat/abstract.h