NAME

       sc::SCMatrixKit - The SCMatrixKit abstract class acts as a factory for producing matrices.

SYNOPSIS

       #include <abstract.h>

       Inherits sc::DescribedClass.

       Inherited by sc::BlockedSCMatrixKit, sc::DistSCMatrixKit, sc::LocalSCMatrixKit, and
       sc::ReplSCMatrixKit.

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

   Static Public Member Functions
       static SCMatrixKit * default_matrixkit ()
           This returns a LocalSCMatrixKit, unless the default has been changed with
           set_default_matrixkit.
       static void set_default_matrixkit (const Ref< SCMatrixKit > &)

   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

   virtual SCMatrix * sc::SCMatrixKit::matrix (const RefSCDimension &, const RefSCDimension &)
       [pure virtual]
       Given the dimensions, create matrices or vectors.

       Implemented in sc::BlockedSCMatrixKit, sc::DistSCMatrixKit, sc::LocalSCMatrixKit, and
       sc::ReplSCMatrixKit.

Author

       Generated automatically by Doxygen for MPQC from the source code.