Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
sc::SCMatrixSubblockIter(3)	     MPQC	   sc::SCMatrixSubblockIter(3)

NAME
       sc::SCMatrixSubblockIter	- Objects of class SCMatrixSubblockIter	are
       used to iterate through the blocks of a matrix.

SYNOPSIS
       #include	<block.h>

       Inherits	sc::RefCount.

       Inherited by sc::SCMatrixCompositeSubblockIter,
       sc::SCMatrixJointSubblockIter, sc::SCMatrixListSubblockIter,
       sc::SCMatrixNullSubblockIter, and sc::SCMatrixSimpleSubblockIter.

   Public Types
       enum Access { Read, Write, Accum, None }

   Public Member Functions
       SCMatrixSubblockIter (Access access)
	   The access variable should be one of	Read, Write, Accum, and	None,
	   with	the SCMatrixSubblockIter:: scope operator applied.
       virtual void begin ()=0
	   Start at the	beginning.
       virtual int ready ()=0
	   Returns nonzero if there is another block.
       virtual void next ()=0
	   Proceed to the next block.
       virtual SCMatrixBlock * block ()=0
	   Return the current block.
       Access access ()	const
	   Return the type of Access allowed for these blocks.

       Public Member Functions inherited from sc::RefCount
       int lock_ptr () const
	   Lock	this object.
       int unlock_ptr () const
	   Unlock this object.
       void use_locks (bool inVal)
	   start and stop using	locks on this object
       refcount_t nreference ()	const
	   Return the reference	count.
       refcount_t reference ()
	   Increment the reference count and return the	new count.
       refcount_t dereference ()
	   Decrement the reference count and return the	new count.
       int managed () const
       void unmanage ()
	   Turn	off the	reference counting mechanism for this object.
       int managed () const
	   Return 1 if the object is managed. Otherwise	return 0.

       Public Member Functions inherited from sc::Identity
       Identifier identifier ()
	   Return the Identifier for this argument.

   Protected Attributes
       Access access_

   Additional Inherited	Members
       Protected Member	Functions inherited from sc::RefCount
       RefCount	(const RefCount	&)
       RefCount	& operator= (const RefCount &)

Detailed Description
       Objects of class	SCMatrixSubblockIter are used to iterate through the
       blocks of a matrix.

       The object must be deleted before using the matrix that owns the	blocks
       that SCMatrixSubblockIter is iterating through.

Member Function	Documentation
   virtual void	sc::SCMatrixSubblockIter::begin	() [pure virtual]
       Start at	the beginning.

       Implemented in sc::SCMatrixSimpleSubblockIter,
       sc::SCMatrixListSubblockIter, sc::SCMatrixNullSubblockIter,
       sc::SCMatrixCompositeSubblockIter, sc::SCMatrixJointSubblockIter, and
       sc::DistSCMatrixListSubblockIter.

   virtual SCMatrixBlock * sc::SCMatrixSubblockIter::block () [pure virtual]
       Return the current block.

       Implemented in sc::SCMatrixSimpleSubblockIter,
       sc::SCMatrixListSubblockIter, sc::SCMatrixNullSubblockIter,
       sc::SCMatrixCompositeSubblockIter, and sc::SCMatrixJointSubblockIter.

   virtual void	sc::SCMatrixSubblockIter::next () [pure	virtual]
       Proceed to the next block.

       Implemented in sc::SCMatrixSimpleSubblockIter,
       sc::SCMatrixListSubblockIter, sc::SCMatrixNullSubblockIter,
       sc::SCMatrixCompositeSubblockIter, sc::SCMatrixJointSubblockIter, and
       sc::DistSCMatrixListSubblockIter.

   virtual int sc::SCMatrixSubblockIter::ready () [pure	virtual]
       Returns nonzero if there	is another block.

       Implemented in sc::SCMatrixSimpleSubblockIter,
       sc::SCMatrixListSubblockIter, sc::SCMatrixNullSubblockIter,
       sc::SCMatrixCompositeSubblockIter, and sc::SCMatrixJointSubblockIter.

Author
       Generated automatically by Doxygen for MPQC from	the source code.

Version	2.3.1			Tue May	13 2025	   sc::SCMatrixSubblockIter(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sc_SCMatrixSubblockIter&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help