---
name: "sc_SCElementOp"
section: "3"
platform: "linux"
package: "libsc-doc"
version: "2.3.1-22"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/sc_SCElementOp"
---

# sc\_SCElementOp(3)

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

## NAME

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 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.  virtual void **defer\_collect** (int)\
 virtual void **collect** (const **Ref**\< **MessageGrp** \> &)\
 virtual void **collect** (const **Ref**\< **SCElementOp** \> &)\
 Multithreaded use of cloneable **SCElementOp** objects requires that data from cloned objects be collected.  virtual int **has\_side\_effects** ()\
 By default this returns nonzero.  virtual bool **threadsafe** ()\
 Returns true if this **SCElementOp** is threadsafe.  virtual bool **cloneable** ()\
 Returns true if this **SCElementOp** supports the cloneable member.  virtual **Ref**\< **SCElementOp** \> **clone** ()\
 Returns a clone of this object.  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.  virtual void **process\_spec\_rect** (**SCMatrixRectBlock** \*)\
 Matrices should call these members when the type of block is known.  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** \*)\

### Additional Inherited Members

## 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 Ref\< SCElementOp \> sc::SCElementOp::clone ()` [virtual]`

Returns a clone of this object. This is needed for multithreaded use of **SCElementOp** objects that are not thread safe. The default implemenation throws an exception.

Reimplemented in **sc::OneBodyIntOp**.

### virtual bool sc::SCElementOp::cloneable ()` [virtual]`

Returns true if this **SCElementOp** supports the cloneable member. The default implmentation returns false.

Reimplemented in **sc::OneBodyIntOp**.

### virtual void sc::SCElementOp::collect (const Ref\< SCElementOp \> &)` [virtual]`

Multithreaded use of cloneable **SCElementOp** objects requires that data from cloned objects be collected. The default implementation will throw an exception.

Reimplemented in **sc::SCElementInvert**, **sc::SCElementMaxAbs**, **sc::SCElementMinAbs**, **sc::SCElementSumAbs**, and **sc::SCElementKNorm**.

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

Reimplemented in **sc::SCElementInvert**, **sc::SCElementMaxAbs**, **sc::SCElementMinAbs**, **sc::SCElementSumAbs**, and **sc::SCElementKNorm**.

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

Reimplemented in **sc::OneBodyIntOp**, **sc::LevelShift**, **sc::SCElementScale**, **sc::SCElementRandomize**, **sc::SCElementAssign**, **sc::SCElementSquareRoot**, **sc::SCElementInvert**, **sc::SCElementScaleDiagonal**, **sc::SCElementShiftDiagonal**, **sc::SCElementDot**, **sc::SCElementAccumulateSCMatrix**, **sc::SCElementAccumulateSymmSCMatrix**, **sc::SCElementAccumulateDiagSCMatrix**, and **sc::SCElementAccumulateSCVector**.

### virtual void sc::SCElementOp::process (SCMatrixBlockIter &)` [pure virtual]`

This is the fallback routine to process blocks and is called by process\_spec members that are not overridden.

Implemented in **sc::OneBodyIntOp**, **sc::LevelShift**, **sc::ALevelShift**, **sc::BLevelShift**, **sc::SCElementScale**, **sc::SCElementRandomize**, **sc::SCElementAssign**, **sc::SCElementSquareRoot**, **sc::SCElementInvert**, **sc::SCElementScaleDiagonal**, **sc::SCElementShiftDiagonal**, **sc::SCElementMaxAbs**, **sc::SCElementMinAbs**, **sc::SCElementSumAbs**, **sc::SCElementKNorm**, **sc::SCElementDot**, **sc::SCElementAccumulateSCMatrix**, **sc::SCElementAccumulateSymmSCMatrix**, **sc::SCElementAccumulateDiagSCMatrix**, and **sc::SCElementAccumulateSCVector**.

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

Reimplemented in **sc::OneBodyIntOp**.

### virtual bool sc::SCElementOp::threadsafe ()` [virtual]`

Returns true if this **SCElementOp** is threadsafe. The default implementation returns false.

## Author

Generated automatically by Doxygen for MPQC from the source code.