MPQC  2.3.1
Public Member Functions | Public Attributes | List of all members
sc::SCMatrixBlock Class Referenceabstract

SCMatrixBlock is the base clase for all types of blocks that comprise matrices and vectors. More...

#include <block.h>

Inheritance diagram for sc::SCMatrixBlock:
Inheritance graph
[legend]
Collaboration diagram for sc::SCMatrixBlock:
Collaboration graph
[legend]

Public Member Functions

 SCMatrixBlock (StateIn &s)
 
void save_data_state (StateOut &s)
 Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. More...
 
virtual SCMatrixBlockdeepcopy () const
 Return of copy of this. More...
 
virtual double * dat ()
 Return a pointer to the block's data and the number of elements in the block. More...
 
virtual int ndat () const
 
virtual void process (SCElementOp *)=0
 
virtual void process (SCElementOp2 *, SCMatrixBlock *)=0
 
virtual void process (SCElementOp3 *, SCMatrixBlock *, SCMatrixBlock *)=0
 
- Public Member Functions inherited from sc::SavableState
SavableStateoperator= (const SavableState &)
 
void save_state (StateOut &)
 Save the state of the object as specified by the StateOut object. More...
 
void save_object_state (StateOut &)
 This can be used for saving state when the exact type of the object is known for both the save and the restore. More...
 
virtual void save_vbase_state (StateOut &)
 Save the virtual bases for the object. More...
 
- Public Member Functions inherited from sc::DescribedClass
 DescribedClass (const DescribedClass &)
 
DescribedClassoperator= (const DescribedClass &)
 
ClassDescclass_desc () const throw ()
 This returns the unique pointer to the ClassDesc corresponding to the given type_info object. More...
 
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.
 
- Public Member Functions inherited from sc::RefCount
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
 
void unmanage ()
 Turn off the reference counting mechanism for this object. More...
 
int managed () const
 Return 1 if the object is managed. Otherwise return 0.
 
- Public Member Functions inherited from sc::Identity
Identifier identifier ()
 Return the Identifier for this argument. More...
 

Public Attributes

int blocki
 
int blockj
 

Additional Inherited Members

- Static Public Member Functions inherited from sc::SavableState
static void save_state (SavableState *s, StateOut &)
 
static SavableStaterestore_state (StateIn &si)
 Restores objects saved with save_state. More...
 
static SavableStatekey_restore_state (StateIn &si, const char *keyword)
 Like restore_state, but keyword is used to override values while restoring.
 
static SavableStatedir_restore_state (StateIn &si, const char *objectname, const char *keyword=0)
 
- Protected Member Functions inherited from sc::SavableState
 SavableState (const SavableState &)
 
 SavableState (StateIn &)
 Each derived class StateIn CTOR handles the restore corresponding to calling save_object_state, save_vbase_state, and save_data_state listed above. More...
 
- Protected Member Functions inherited from sc::RefCount
 RefCount (const RefCount &)
 
RefCountoperator= (const RefCount &)
 

Detailed Description

SCMatrixBlock is the base clase for all types of blocks that comprise matrices and vectors.

Member Function Documentation

◆ dat()

virtual double* sc::SCMatrixBlock::dat ( )
virtual

Return a pointer to the block's data and the number of elements in the block.

Some blocks cannot provide this information and a runtime error will be generated if these members are called. These routines are only used internally in the matrix library.

Reimplemented in sc::SCMatrixDiagBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectBlock, and sc::SCVectorSimpleBlock.

◆ deepcopy()

virtual SCMatrixBlock* sc::SCMatrixBlock::deepcopy ( ) const
virtual

Return of copy of this.

A runtime error will be generated for blocks that cannot do a deepcopy. These routines are only used internally in the matrix library.

Reimplemented in sc::SCMatrixDiagBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectBlock, and sc::SCVectorSimpleBlock.

◆ save_data_state()

void sc::SCMatrixBlock::save_data_state ( StateOut )
virtual

Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.

This must be implemented by the derived class if the class has data.

Reimplemented from sc::SavableState.

Reimplemented in sc::SCMatrixDiagSubBlock, sc::SCMatrixDiagBlock, sc::SCMatrixLTriSubBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectSubBlock, sc::SCMatrixRectBlock, sc::SCVectorSimpleSubBlock, and sc::SCVectorSimpleBlock.


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

Generated at Sun Jan 26 2020 23:33:09 for MPQC 2.3.1 using the documentation package Doxygen 1.8.16.