.TH "sc::SCMatrixSubblockIter" 3 "Fri Dec 2 2022" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::SCMatrixSubblockIter \- Objects of class \fBSCMatrixSubblockIter\fP are used to iterate through the blocks of a matrix\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <block\&.h>\fP
.PP
Inherits \fBsc::RefCount\fP\&.
.PP
Inherited by \fBsc::SCMatrixCompositeSubblockIter\fP, \fBsc::SCMatrixJointSubblockIter\fP, \fBsc::SCMatrixListSubblockIter\fP, \fBsc::SCMatrixNullSubblockIter\fP, and \fBsc::SCMatrixSimpleSubblockIter\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBAccess\fP { \fBRead\fP, \fBWrite\fP, \fBAccum\fP, \fBNone\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSCMatrixSubblockIter\fP (Access \fBaccess\fP)"
.br
.RI "The access variable should be one of Read, Write, Accum, and None, with the \fBSCMatrixSubblockIter\fP:: scope operator applied\&. "
.ti -1c
.RI "virtual void \fBbegin\fP ()=0"
.br
.RI "Start at the beginning\&. "
.ti -1c
.RI "virtual int \fBready\fP ()=0"
.br
.RI "Returns nonzero if there is another block\&. "
.ti -1c
.RI "virtual void \fBnext\fP ()=0"
.br
.RI "Proceed to the next block\&. "
.ti -1c
.RI "virtual \fBSCMatrixBlock\fP * \fBblock\fP ()=0"
.br
.RI "Return the current block\&. "
.ti -1c
.RI "Access \fBaccess\fP () const"
.br
.RI "Return the type of Access allowed for these blocks\&. "
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "Access \fBaccess_\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Objects of class \fBSCMatrixSubblockIter\fP are used to iterate through the blocks of a matrix\&. 

The object must be deleted before using the matrix that owns the blocks that \fBSCMatrixSubblockIter\fP is iterating through\&. 
.SH "Member Function Documentation"
.PP 
.SS "virtual void sc::SCMatrixSubblockIter::begin ()\fC [pure virtual]\fP"

.PP
Start at the beginning\&. 
.PP
Implemented in \fBsc::SCMatrixSimpleSubblockIter\fP, \fBsc::SCMatrixListSubblockIter\fP, \fBsc::SCMatrixNullSubblockIter\fP, \fBsc::SCMatrixCompositeSubblockIter\fP, \fBsc::SCMatrixJointSubblockIter\fP, and \fBsc::DistSCMatrixListSubblockIter\fP\&.
.SS "virtual \fBSCMatrixBlock\fP * sc::SCMatrixSubblockIter::block ()\fC [pure virtual]\fP"

.PP
Return the current block\&. 
.PP
Implemented in \fBsc::SCMatrixSimpleSubblockIter\fP, \fBsc::SCMatrixListSubblockIter\fP, \fBsc::SCMatrixNullSubblockIter\fP, \fBsc::SCMatrixCompositeSubblockIter\fP, and \fBsc::SCMatrixJointSubblockIter\fP\&.
.SS "virtual void sc::SCMatrixSubblockIter::next ()\fC [pure virtual]\fP"

.PP
Proceed to the next block\&. 
.PP
Implemented in \fBsc::SCMatrixSimpleSubblockIter\fP, \fBsc::SCMatrixListSubblockIter\fP, \fBsc::SCMatrixNullSubblockIter\fP, \fBsc::SCMatrixCompositeSubblockIter\fP, \fBsc::SCMatrixJointSubblockIter\fP, and \fBsc::DistSCMatrixListSubblockIter\fP\&.
.SS "virtual int sc::SCMatrixSubblockIter::ready ()\fC [pure virtual]\fP"

.PP
Returns nonzero if there is another block\&. 
.PP
Implemented in \fBsc::SCMatrixSimpleSubblockIter\fP, \fBsc::SCMatrixListSubblockIter\fP, \fBsc::SCMatrixNullSubblockIter\fP, \fBsc::SCMatrixCompositeSubblockIter\fP, and \fBsc::SCMatrixJointSubblockIter\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.