Section 3: library functions
sc::SCMatrixDiagBlockIter – Synopsis Inherits sc::SCMatrixBlockIter. Public Member Functions SCMatrixDiagBlockIter (SCMatrixDiagBlock *) int i () Returns the row index. int j () Returns the column index. double get () Return the value of the current element. void set (double) Set the current element to val. operator int () Return nonzero if there are more elements. void…
sc::SCMatrixDiagBlock – The SCMatrixDiagBlock describes a diagonal piece of a matrix. Synopsis #include <block.h> Inherits sc::SCMatrixBlock. Public Member Functions SCMatrixDiagBlock (int istart, int iend, int jstart) SCMatrixDiagBlock (int istart, int iend) SCMatrixDiagBlock (StateIn &) void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR…
sc::SCMatrixCompositeSubblockIter – Synopsis Inherits sc::SCMatrixSubblockIter. Public Member Functions SCMatrixCompositeSubblockIter (Access, int niter) SCMatrixCompositeSubblockIter (Ref< SCMatrixSubblockIter > &, Ref< SCMatrixSubblockIter > &) void set_iter (int i, const Ref< SCMatrixSubblockIter > &) void begin () Start at the beginning. int ready () Returns nonzero if there is another block. void next () Proceed to the next block….
sc::SCMatrixBlockList – Synopsis Inherits sc::SavableState. Public Member Functions SCMatrixBlockList (StateIn &) void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void insert (SCMatrixBlock *) void append (SCMatrixBlock *) SCMatrixBlockListIter begin () SCMatrixBlockListIter end () SCMatrixBlockList * deepcopy () Member Function Documentation…
sc::SCMatrixBlockIter – The SCMatrixBlockIter class is used to described iterates that loop through the elements in a block. Synopsis #include <blkiter.h> Inherited by sc::SCMatrixDiagBlockIter, sc::SCMatrixDiagSubBlockIter, sc::SCMatrixLTriBlockIter, sc::SCMatrixLTriSubBlockIter, sc::SCMatrixRectBlockIter, sc::SCMatrixRectSubBlockIter, sc::SCVectorSimpleBlockIter, and sc::SCVectorSimpleSubBlockIter. Public Member Functions virtual int i ()=0 Returns the row index. virtual int j ()=0 Returns the column index. virtual void set (double…
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…
sc::SCMatrix3 – Synopsis Public Member Functions SCMatrix3 (const SCMatrix3 &) SCMatrix3 (const RefSCMatrix3 &) SCMatrix3 (double x[9]) SCMatrix3 (const SCVector3 &p1, const SCVector3 &p2, const SCVector3 &p3) SCMatrix3 & operator= (const SCMatrix3 &) SCMatrix3 operator* (double) const SCMatrix3 operator* (const SCMatrix3 &) const SCVector3 operator* (const SCVector3 &v) const SCMatrix3 operator+ (const SCMatrix3 &) const…
sc::SCMatrix – The SCMatrix class is the abstract base class for general double valued n by m matrices. Synopsis #include <abstract.h> Inherits sc::DescribedClass. Inherited by sc::BlockedSCMatrix, sc::DistSCMatrix, sc::LocalSCMatrix, and sc::ReplSCMatrix. Public Types enum Transform { NormalTransform = 0, TransposeTransform = 1 } Public Member Functions SCMatrix (const RefSCDimension &, const RefSCDimension &, SCMatrixKit *) virtual…
sc::SCFormIO – This utility class is used to print only on node 0 and to provide attractive indentation of output. Synopsis #include <formio.h> Static Public Member Functions static std::ios & indent (std::ios &o) static std::ios & decindent (std::ios &o) static std::ios & incindent (std::ios &o) static std::ios & skipnextindent (std::ios &o) static void setverbose (std::ios…
sc::SCF – The SCF class is the base for all classes that use a self-consistent field procedure to solve an effective one body problem. Synopsis #include <scf.h> Inherits sc::OneBodyWavefunction. Inherited by sc::CLSCF, sc::HSOSSCF, sc::OSSSCF, sc::TCSCF, and sc::UnrestrictedSCF. Public Member Functions SCF (StateIn &) SCF (const Ref< KeyVal > &) The KeyVal constructor. void save_data_state (StateOut…
sc::SCExtrapError – SCExtrapError holds the error data needed by SelfConsistentExtrapolation. Synopsis #include <scextrap.h> Inherits sc::SavableState. Inherited by sc::SymmSCMatrixSCExtrapError. Public Member Functions SCExtrapError () Construct a new SCExtrapError. SCExtrapError (StateIn &) Constructor to restore SCExtrapError from a StateIn object. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order…
sc::SCExtrapData – SCExtrapData hold the data to be extrapolated needed by SelfConsistentExtrapolation. Synopsis #include <scextrap.h> Inherits sc::SavableState. Inherited by sc::SymmSCMatrix2SCExtrapData, sc::SymmSCMatrix4SCExtrapData, sc::SymmSCMatrixNSCExtrapData, and sc::SymmSCMatrixSCExtrapData. Public Member Functions SCExtrapData () Construct a new SCExtrapData. SCExtrapData (StateIn &) Constructor to restore SCExtrapData from a StateIn object. void save_data_state (StateOut &) Save the base classes (with save_data_state) and…
sc::SCException – This is a std::exception specialization that records information about where an exception took place. Synopsis #include <scexception.h> Inherited by sc::AlgorithmException, sc::InputError, sc::LimitExceeded< T >, sc::ProgrammingError, and sc::SystemException. Public Member Functions SCException (const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type=’SCException’) throw () SCException (const SCException &) throw ()…
sc::SCElementSumAbs – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementSumAbs (StateIn &) void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is called by process_spec members that are not…
sc::SCElementSquareRoot – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementSquareRoot (double a) SCElementSquareRoot (StateIn &) int has_side_effects () By default this returns nonzero. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to…
sc::SCElementShiftDiagonal – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementShiftDiagonal (double a) SCElementShiftDiagonal (StateIn &) int has_side_effects () By default this returns nonzero. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to…
sc::SCElementScaleDiagonal – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementScaleDiagonal (double a) SCElementScaleDiagonal (StateIn &) int has_side_effects () By default this returns nonzero. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to…
sc::SCElementScale – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementScale (double a) SCElementScale (StateIn &) int has_side_effects () By default this returns nonzero. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to…
sc::SCElementScalarProduct – Synopsis Inherits sc::SCElementOp2. Public Member Functions SCElementScalarProduct (StateIn &) void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &, SCMatrixBlockIter &) int has_collect () void defer_collect (int) void collect (const Ref< MessageGrp > &) double result…
sc::SCElementRandomize – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementRandomize (StateIn &) int has_side_effects () By default this returns nonzero. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and…