Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members   Related Pages  

sc::SCElementOp Class Reference

Objects of class SCElementOp are used to perform operations on the elements of matrices. More...

#include <elemop.h>

Inheritance diagram for sc::SCElementOp:

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

Collaboration graph
[legend]
List of all members.

Public Methods

 SCElementOp ()
 SCElementOp (StateIn &s)
virtual ~SCElementOp ()
virtual int has_collect ()
 If duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a MessageGrp reference after all of the blocks have been processed. More...

virtual void defer_collect (int)
virtual void collect (const Ref< MessageGrp > &)
virtual int has_side_effects ()
 By default this returns nonzero. More...

virtual void process (SCMatrixBlockIter &)=0
 This is the fallback routine to process blocks and is called by process_spec members that are not overridden.

void process_base (SCMatrixBlock *block)
 Lazy matrix implementors can call this member when the type of block specialization is unknown. More...

virtual void process_spec_rect (SCMatrixRectBlock *)
 Matrices should call these members when the type of block is known. More...

virtual void process_spec_ltri (SCMatrixLTriBlock *)
virtual void process_spec_diag (SCMatrixDiagBlock *)
virtual void process_spec_vsimp (SCVectorSimpleBlock *)
virtual void process_spec_rectsub (SCMatrixRectSubBlock *)
virtual void process_spec_ltrisub (SCMatrixLTriSubBlock *)
virtual void process_spec_diagsub (SCMatrixDiagSubBlock *)
virtual void process_spec_vsimpsub (SCVectorSimpleSubBlock *)

Detailed Description

Objects of class SCElementOp are used to perform operations on the elements of matrices.

When the SCElementOp object is given to the element_op member of a matrix, each block the matrix is passed to one of the process, process_base, or process_base members.


Member Function Documentation

virtual int sc::SCElementOp::has_collect   [virtual]
 

If duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a MessageGrp reference after all of the blocks have been processed.

The default return value of has_collect is 0 and collect's default action is do nothing. If defer_collect member is called with nonzero, collect will do nothing (this is only used by the blocked matrices).

virtual int sc::SCElementOp::has_side_effects   [virtual]
 

By default this returns nonzero.

If the ElementOp specialization will change any elements of the matrix, then this must be overridden to return nonzero.

void sc::SCElementOp::process_base SCMatrixBlock   block
 

Lazy matrix implementors can call this member when the type of block specialization is unknown.

However, this will attempt to dynamic_cast block to a block specialization and will thus be less efficient.

virtual void sc::SCElementOp::process_spec_rect SCMatrixRectBlock   [virtual]
 

Matrices should call these members when the type of block is known.

ElementOp specializations should override these when efficiency is important, since these give the most efficient access to the elements of the block.


The documentation for this class was generated from the following file:
Generated at Fri Jan 10 08:16:41 2003 for MPQC 2.1.3 using the documentation package Doxygen 1.2.14.