Section 3: library functions
sc::SCElementOp3 – The SCElementOp3 class is very similar to the SCElementOp class except that a triplet of blocks is treated simultaneously. Synopsis #include <elemop.h> Inherits sc::SavableState. Inherited by sc::BlockedSCElementOp3, and sc::OneBody3IntOp. Public Member Functions SCElementOp3 (StateIn &s) virtual int has_collect () virtual void defer_collect (int) virtual int has_side_effects () virtual int has_side_effects_in_arg1 () virtual int…
sc::SCElementOp2 – The SCElementOp2 class is very similar to the SCElementOp class except that pairs of blocks are treated simultaneously. Synopsis #include <elemop.h> Inherits sc::SavableState. Inherited by sc::BlockedSCElementOp2, sc::SCDestructiveElementProduct, sc::SCElementScalarProduct, and sc::SCFEnergy. Public Member Functions SCElementOp2 (StateIn &s) virtual int has_collect () virtual void defer_collect (int) virtual int has_side_effects () virtual int has_side_effects_in_arg () virtual…
sc::SCElementOp – Objects of class SCElementOp are used to perform operations on the elements of matrices. Synopsis #include <elemop.h> Inherits sc::SavableState. Inherited by sc::BlockedSCElementOp, sc::OneBodyIntOp, sc::SCElementAccumulateDiagSCMatrix, sc::SCElementAccumulateSCMatrix, sc::SCElementAccumulateSCVector, sc::SCElementAccumulateSymmSCMatrix, sc::SCElementAssign, sc::SCElementDot, sc::SCElementInvert, sc::SCElementKNorm, sc::SCElementMaxAbs, sc::SCElementMinAbs, sc::SCElementRandomize, sc::SCElementScale, sc::SCElementScaleDiagonal, sc::SCElementShiftDiagonal, sc::SCElementSquareRoot, and sc::SCElementSumAbs. Public Member Functions SCElementOp (StateIn &s) virtual int has_collect () If duplicates of…
sc::SCElementMinAbs – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementMinAbs (double rinit) SCElementMinAbs (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…
sc::SCElementMaxAbs – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementMaxAbs (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::SCElementKNorm – Computed k-norm of matrix. Synopsis #include <elemop.h> Inherits sc::SCElementOp. Public Member Functions SCElementKNorm (double k=2.0) by default compute 2-norm SCElementKNorm (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…
sc::SCElementInvert – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementInvert (double threshold=0.0) SCElementInvert (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::SCElementDot – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementDot (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. SCElementDot (double **a, double **b, int length) void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is…
sc::SCElementAssign – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementAssign (double a) SCElementAssign (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::SCElementAccumulateSymmSCMatrix – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementAccumulateSymmSCMatrix (SymmSCMatrix *) int has_side_effects () By default this returns nonzero. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is called by process_spec members that are not overridden. Member Function Documentation int sc::SCElementAccumulateSymmSCMatrix::has_side_effects () [virtual] By default this returns nonzero. If the…
sc::SCElementAccumulateSCVector – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementAccumulateSCVector (SCVector *) int has_side_effects () By default this returns nonzero. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is called by process_spec members that are not overridden. Member Function Documentation int sc::SCElementAccumulateSCVector::has_side_effects () [virtual] By default this returns nonzero. If the…
sc::SCElementAccumulateSCMatrix – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementAccumulateSCMatrix (SCMatrix *) int has_side_effects () By default this returns nonzero. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is called by process_spec members that are not overridden. Member Function Documentation int sc::SCElementAccumulateSCMatrix::has_side_effects () [virtual] By default this returns nonzero. If the…
sc::SCElementAccumulateDiagSCMatrix – Synopsis Inherits sc::SCElementOp. Public Member Functions SCElementAccumulateDiagSCMatrix (DiagSCMatrix *) int has_side_effects () By default this returns nonzero. void process (SCMatrixBlockIter &) This is the fallback routine to process blocks and is called by process_spec members that are not overridden. Member Function Documentation int sc::SCElementAccumulateDiagSCMatrix::has_side_effects () [virtual] By default this returns nonzero. If the…
sc::SCDimension – The SCDimension class is used to determine the size and blocking of matrices. Synopsis #include <dim.h> Inherits sc::SavableState. Public Member Functions SCDimension (int n, const char *name=0) Create a dimension with an optional name. SCDimension (const Ref< SCBlockInfo > &, const char *name=0) SCDimension (int n, int nblocks, const int *blocksizes=0, const char…
sc::SCDestructiveElementProduct – Synopsis Inherits sc::SCElementOp2. Public Member Functions SCDestructiveElementProduct (StateIn &) int has_side_effects () 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 &) Member Function Documentation void sc::SCDestructiveElementProduct::save_data_state (StateOut &) [virtual] Save the base classes…
sc::SCBlockInfo – SCBlockInfo contains blocking information for the SCDimension class. Synopsis #include <dim.h> Inherits sc::SavableState. Public Member Functions SCBlockInfo (int n, int nblocks=0, const int *blocksizes=0) Create a SCBlockInfo object. SCBlockInfo (StateIn &) SCBlockInfo (const Ref< KeyVal > &keyval) The KeyVal constructor. void save_data_state (StateOut &) Save the base classes (with save_data_state) and the members…
sc::ResultInfo – This is a base class for all of Compute’s result types. Synopsis #include <compute.h> Inherited by sc::AccResultInfo, sc::NCResult< T >, and sc::Result< T >. Public Member Functions ResultInfo (Compute *c) int & compute () const int & compute () const int compute (int c) int & computed () const int & computed ()…
sc::Result – Result are members of Compute specializations that keep track of whether or not a particular result should be computed or if it has already been computed. Synopsis #include <comptmpl.h> Inherits sc::ResultInfo. Public Member Functions Result (Compute *c) Result (const Result< T > &r, Compute *c) operator T & () T * operator-> ()…
sc::ReplSymmSCMatrix – Synopsis Inherits sc::SymmSCMatrix. Public Member Functions ReplSymmSCMatrix (const RefSCDimension &, ReplSCMatrixKit *) void assign_val (double) Overridden to implement the assign functions. void assign_s (SymmSCMatrix *) void assign_p (const double *) void assign_pp (const double **) double get_element (int, int) const Return or modify an element. void set_element (int, int, double) void accumulate_element (int,…
sc::ReplSCVector – Synopsis Inherits sc::SCVector. Public Member Functions ReplSCVector (const RefSCDimension &, ReplSCMatrixKit *) void assign_val (double) Overridden to implement the assign functions. void assign_v (SCVector *) void assign_p (const double *) void set_element (int, double) Set element i to val. void accumulate_element (int, double) Add val to element i. double get_element (int) const Return…