ViennaCL - The Vienna Computing Library  1.5.2
Public Member Functions
amg_nonzero_scalar< InternalType, IteratorType, ScalarType > Class Template Reference

A class for a scalar that can be written to the sparse matrix or sparse vector datatypes. More...

#include <amg_base.hpp>

Public Member Functions

 amg_nonzero_scalar ()
 
 amg_nonzero_scalar (InternalType *m, IteratorType &iter, unsigned int i, unsigned int j, ScalarType s=0)
 The constructor. More...
 
ScalarType operator= (const ScalarType value)
 Assignment operator. Writes value into matrix at the given position. More...
 
ScalarType operator+= (const ScalarType value)
 Addition operator. Adds a constant. More...
 
ScalarType operator++ (int)
 
ScalarType operator++ ()
 
 operator ScalarType (void)
 

Detailed Description

template<typename InternalType, typename IteratorType, typename ScalarType>
class viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalType, IteratorType, ScalarType >

A class for a scalar that can be written to the sparse matrix or sparse vector datatypes.

Values are only written to those datatypes if non-zero to optimize memory usage and performance. Needed for the []- and ()-operators.

Constructor & Destructor Documentation

amg_nonzero_scalar ( InternalType *  m,
IteratorType &  iter,
unsigned int  i,
unsigned int  j,
ScalarType  s = 0 
)
inline

The constructor.

Parameters
mPointer to the sparse vector/matrix the scalar will be written to
iterIterator pointing to the respective element in the vector/matrix if available
iRow index scalar will be written to
jCol index scalar will be written to
sValue of the scalar (usually used as dummy here as it will be set by the assignment operator)

Member Function Documentation

operator ScalarType ( void  )
inline
ScalarType operator++ ( int  )
inline
ScalarType operator++ ( )
inline
ScalarType operator+= ( const ScalarType  value)
inline

Addition operator. Adds a constant.

Parameters
valueValue that will be written
ScalarType operator= ( const ScalarType  value)
inline

Assignment operator. Writes value into matrix at the given position.

Parameters
valueValue that will be written

The documentation for this class was generated from the following file: