oracular (3) sc_SCMatrixBlock.3.gz

NAME

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

SYNOPSIS

       #include <block.h>

       Inherits sc::SavableState.

       Inherited by sc::SCMatrixDiagBlock, sc::SCMatrixDiagSubBlock, sc::SCMatrixLTriBlock,
       sc::SCMatrixLTriSubBlock, sc::SCMatrixRectBlock, sc::SCMatrixRectSubBlock, sc::SCVectorSimpleBlock, and
       sc::SCVectorSimpleSubBlock.

   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.
       virtual SCMatrixBlock * deepcopy () const
           Return of copy of this.
       virtual double * dat ()
           Return a pointer to the block's data and the number of elements in the block.
       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
       SavableState & operator= (const SavableState &)
       void save_state (StateOut &)
           Save the state of the object as specified by the StateOut object.
       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.
       virtual void save_vbase_state (StateOut &)
           Save the virtual bases for the object.

       Public Member Functions inherited from sc::DescribedClass
       DescribedClass (const DescribedClass &)
       DescribedClass & operator= (const DescribedClass &)
       ClassDesc * class_desc () const  throw ()
           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.

       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.
       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.

   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 SavableState * restore_state (StateIn &si)
           Restores objects saved with save_state.
       static SavableState * key_restore_state (StateIn &si, const char *keyword)
           Like restore_state, but keyword is used to override values while restoring.
       static SavableState * dir_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.

       Protected Member Functions inherited from sc::RefCount
       RefCount (const RefCount &)
       RefCount & operator= (const RefCount &)

Detailed Description

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

Member Function Documentation

   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::SCVectorSimpleBlock, sc::SCMatrixRectBlock, sc::SCMatrixLTriBlock, and
       sc::SCMatrixDiagBlock.

   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::SCVectorSimpleBlock, sc::SCMatrixRectBlock, sc::SCMatrixLTriBlock, and
       sc::SCMatrixDiagBlock.

   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::SCVectorSimpleBlock, sc::SCVectorSimpleSubBlock, sc::SCMatrixRectBlock,
       sc::SCMatrixRectSubBlock, sc::SCMatrixLTriBlock, sc::SCMatrixLTriSubBlock, sc::SCMatrixDiagBlock, and
       sc::SCMatrixDiagSubBlock.

Author

       Generated automatically by Doxygen for MPQC from the source code.