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

FreeBSD Manual Pages

  
 
  

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

NAME
       sc::DistSCVector

SYNOPSIS
       Inherits	sc::SCVector.

   Public Member Functions
       DistSCVector (const RefSCDimension &, DistSCMatrixKit *)
       void assign_p (const double *)
       void assign_v (SCVector *a)
       void convert (double *v)	const
	   Assign v[i] to element i for	all i.
       void convert (SCVector *)
	   Convert an SCVector of a different specialization to	this
	   specialization and possibly accumulate the data.
       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 the value of element i.
       void accumulate (const SCVector *)
	   Sum v into this.
       void accumulate (const SCMatrix *m)
	   Sum m into this. One	of m's dimensions must be 1.
       double scalar_product (SCVector *)
	   Return the dot product.
       void accumulate_product_rv (SCMatrix *, SCVector	*)
       void element_op (const Ref< SCElementOp > &)
	   Perform the element operation op on each element of this.
       void element_op (const Ref< SCElementOp2	> &, SCVector *)
       void element_op (const Ref< SCElementOp3	> &, SCVector *, SCVector *)
       void vprint (const char *title=0, std::ostream &out=ExEnv::out0(),
	   int=10) const
       Ref< SCMatrixSubblockIter > local_blocks	(SCMatrixSubblockIter::Access)
	   Returns iterators for the local (rapidly accessible)	blocks used in
	   this	vector.
       Ref< SCMatrixSubblockIter > all_blocks (SCMatrixSubblockIter::Access)
	   Returns iterators for the all blocks	used in	this vector.
       Ref< DistSCMatrixKit > skit ()

       Public Member Functions inherited from sc::SCVector
       SCVector	(const RefSCDimension &, SCMatrixKit *)
       virtual void save (StateOut &)
	   Save	and restore this in an implementation independent way.
       virtual void restore (StateIn &)
       Ref< SCMatrixKit	> kit () const
	   Return the SCMatrixKit used to create this object.
       virtual SCVector	* copy ()
	   Return a vector with	the same dimension and same elements.
       virtual SCVector	* clone	()
	   Return a vector with	the same dimension but uninitialized memory.
       int n ()	const
	   Return the length of	the vector.
       virtual double maxabs ()	const
	   Return the maximum absolute value element of	this vector.
       virtual void normalize ()
	   Normalize this.
       virtual void randomize ()
	   Assign each element to a random number between -1 and 1.
       void assign (double val)
	   Assign all elements of this to val.
       void assign (const double *v)
	   Assign element i to v[i] for	all i.
       void assign (SCVector *v)
	   Make	this have the same elements as v.
       virtual void assign_val (double val)
	   Overridden to implement the assign functions.
       virtual void assign_p (const double *v)
       virtual void assign_v (SCVector *v)
       virtual void convert (double *v)	const
	   Assign v[i] to element i for	all i.
       virtual void convert (SCVector *)
	   Convert an SCVector of a different specialization to	this
	   specialization and possibly accumulate the data.
       virtual void convert_accumulate (SCVector *)
       virtual void scale (double val)
	   Multiply each element by val.
       RefSCDimension dim () const
	   Return the RefSCDimension corresponding to this vector.
       virtual void set_element	(int i,	double val)=0
	   Set element i to val.
       virtual void accumulate_element (int, double)=0
	   Add val to element i.
       virtual double get_element (int i) const	=0
	   Return the value of element i.
       void accumulate_product (SymmSCMatrix *m, SCVector *v)
	   Sum the result of m times v into this.
       void accumulate_product (SCMatrix *m, SCVector *v)
       virtual void accumulate_product_sv (SymmSCMatrix	*m, SCVector *v)
       virtual void accumulate_product_rv (SCMatrix *m,	SCVector *v)=0
       virtual void accumulate (const SCVector *v)=0
	   Sum v into this.
       virtual void accumulate (const SCMatrix *m)=0
	   Sum m into this. One	of m's dimensions must be 1.
       virtual double scalar_product (SCVector *)=0
	   Return the dot product.
       virtual void element_op (const Ref< SCElementOp > &)=0
	   Perform the element operation op on each element of this.
       virtual void element_op (const Ref< SCElementOp2	> &, SCVector *)=0
       virtual void element_op (const Ref< SCElementOp3	> &, SCVector *,
	   SCVector *)=0
       void print (std::ostream	&o=ExEnv::out0()) const
	   Print out the vector.
       void print (const char *title=0,	std::ostream &out=ExEnv::out0(),
	   int=10) const
       virtual void vprint (const char *title=0, std::ostream
	   &out=ExEnv::out0(), int=10) const =0
       Ref< MessageGrp > messagegrp () const
	   Returns the message group used by the matrix	kit.
       virtual Ref< SCMatrixSubblockIter > local_blocks
	   (SCMatrixSubblockIter::Access)=0
	   Returns iterators for the local (rapidly accessible)	blocks used in
	   this	vector.
       virtual Ref< SCMatrixSubblockIter > all_blocks
	   (SCMatrixSubblockIter::Access)=0
	   Returns iterators for the all blocks	used in	this vector.

       Public Member Functions inherited from sc::DescribedClass
       DescribedClass (const DescribedClass &)
       DescribedClass &	operator= (const DescribedClass	&)
       ClassDesc * class_desc () const	throw ()
	   This	returns	the unique pointer to the ClassDesc corresponding to
	   the given type_info object.
       const char * class_name () const
	   Return the name of the object's exact type.
       int class_version () const
	   Return the version of the class.
       virtual void print (std::ostream	&=ExEnv::out0()) const
	   Print the object.

       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 Member Functions
       void init_blocklist ()
       double *	find_element (int i) const
       int element_to_node (int	i) const
       int block_to_node (int) const
       Ref< SCMatrixBlock > block_to_block (int) const
       void error (const char *)

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

   Protected Attributes
       Ref< SCMatrixBlockList >	blocklist

       Protected Attributes inherited from sc::SCVector
       RefSCDimension d
       Ref< SCMatrixKit	> kit_

   Friends
       class DistSCMatrix
       class DistSymmSCMatrix
       class DistDiagSCMatrix

Member Function	Documentation
   void	sc::DistSCVector::accumulate (const SCMatrix * m) [virtual]
       Sum m into this.	One of m's dimensions must be 1.

       Implements sc::SCVector.

   void	sc::DistSCVector::accumulate (const SCVector * v) [virtual]
       Sum v into this.

       Implements sc::SCVector.

   void	sc::DistSCVector::accumulate_element (int, double) [virtual]
       Add val to element i.

       Implements sc::SCVector.

   void	sc::DistSCVector::accumulate_product_rv	(SCMatrix *, SCVector *)
       [virtual]
       Implements sc::SCVector.

   Ref<	SCMatrixSubblockIter > sc::DistSCVector::all_blocks
       (SCMatrixSubblockIter::Access) [virtual]
       Returns iterators for the all blocks used in this vector.

       Implements sc::SCVector.

   void	sc::DistSCVector::assign_p (const double *) [virtual]
       Reimplemented from sc::SCVector.

   void	sc::DistSCVector::assign_v (SCVector * a) [virtual]
       Reimplemented from sc::SCVector.

   void	sc::DistSCVector::convert (double * v) const [virtual]
       Assign v[i] to element i	for all	i.

       Reimplemented from sc::SCVector.

   void	sc::DistSCVector::convert (SCVector *) [virtual]
       Convert an SCVector of a	different specialization to this
       specialization and possibly accumulate the data.

       Reimplemented from sc::SCVector.

   void	sc::DistSCVector::element_op (const Ref< SCElementOp > &) [virtual]
       Perform the element operation op	on each	element	of this.

       Implements sc::SCVector.

   void	sc::DistSCVector::element_op (const Ref< SCElementOp2 >	&, SCVector *)
       [virtual]
       Implements sc::SCVector.

   void	sc::DistSCVector::element_op (const Ref< SCElementOp3 >	&, SCVector *,
       SCVector	*) [virtual]
       Implements sc::SCVector.

   double sc::DistSCVector::get_element	(int i)	const [virtual]
       Return the value	of element i.

       Implements sc::SCVector.

   Ref<	SCMatrixSubblockIter > sc::DistSCVector::local_blocks
       (SCMatrixSubblockIter::Access) [virtual]
       Returns iterators for the local (rapidly	accessible) blocks used	in
       this vector. Only one iterator is allowed for a matrix is it has	Accum
       or Write	access is allowed. Multiple Read iterators are permitted.

       Implements sc::SCVector.

   double sc::DistSCVector::scalar_product (SCVector *)	[virtual]
       Return the dot product.

       Implements sc::SCVector.

   void	sc::DistSCVector::set_element (int i, double val) [virtual]
       Set element i to	val.

       Implements sc::SCVector.

   void	sc::DistSCVector::vprint (const	char * title = 0, std::ostream & out =
       ExEnv::out0(), int = 10)	const [virtual]
       Implements sc::SCVector.

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

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

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

home | help