All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT > 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 (InternalT *m, IteratorT &iter, unsigned int i, unsigned int j, NumericT s=0)
| The constructor. More...
NumericT | operator= (const NumericT value)
| Assignment operator. Writes value into matrix at the given position. More...
NumericT | operator+= (const NumericT value)
| Addition operator. Adds a constant. More...
NumericT | operator++ (int)
NumericT | operator++ ()
| operator NumericT (void)

## Detailed Description

### template<typename InternalT, typename IteratorT, typename NumericT>
class viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >

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.

Definition at line 124 of file amg_base.hpp.

## Constructor & Destructor Documentation

template<typename InternalT , typename IteratorT , typename NumericT >

viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::amg_nonzero_scalar | ( |  | ) |

template<typename InternalT , typename IteratorT , typename NumericT >

viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::amg_nonzero_scalar | ( | InternalT * | m,
|  | IteratorT & | iter,
|  | unsigned int | i,
|  | unsigned int | j,
|  | NumericT | s = `0`
| ) |  |

inline

The constructor.

Parameters

  m | Pointer to the sparse vector/matrix the scalar will be written to
  iter | Iterator pointing to the respective element in the vector/matrix if available
  i | Row index scalar will be written to
  j | Col index scalar will be written to
  s | Value of the scalar (usually used as dummy here as it will be set by the assignment operator)

Definition at line 148 of file amg_base.hpp.

## Member Function Documentation

template<typename InternalT , typename IteratorT , typename NumericT >

viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::operator NumericT | ( | void |  | ) |

inline

Definition at line 203 of file amg_base.hpp.

template<typename InternalT , typename IteratorT , typename NumericT >

NumericT viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::operator++ | ( | int |  | ) |

inline

Definition at line 187 of file amg_base.hpp.

template<typename InternalT , typename IteratorT , typename NumericT >

NumericT viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::operator++ | ( |  | ) |

inline

Definition at line 195 of file amg_base.hpp.

template<typename InternalT , typename IteratorT , typename NumericT >

NumericT viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::operator+= | ( | const NumericT | value | ) |

inline

Addition operator. Adds a constant.

Parameters

  value | Value that will be written

Definition at line 170 of file amg_base.hpp.

template<typename InternalT , typename IteratorT , typename NumericT >

NumericT viennacl::linalg::detail::amg::amg_nonzero_scalar< InternalT, IteratorT, NumericT >::operator= | ( | const NumericT | value | ) |

inline

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

Parameters

  value | Value that will be written

Definition at line 157 of file amg_base.hpp.

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

- viennacl/linalg/detail/amg/amg_base.hpp