OpenVDB: SparseStencilMatrix< ValueType_, STENCIL_SIZE >::RowEditor Class Reference

OpenVDB 9.0.0

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SparseStencilMatrix< ValueType_, STENCIL_SIZE >::RowEditor Class Reference

Read/write accessor to a row of this matrix. More...

`#include <openvdb/math/ConjGradient.h>`

Inherits SparseStencilMatrix< ValueType_, STENCIL_SIZE >::RowBase< DataType_ >.

## Public Types
using | DataType = DataType_

## Public Member Functions
| RowEditor (ValueType *valueHead, SizeType *columnHead, SizeType &rowSize, SizeType colSize)
void | clear ()
| Set the number of entries in this row to zero. More...
SizeType | setValue (SizeType column, const ValueType &value)
| Set the value of the entry in the specified column. More...
template<typename Scalar >
void | scale (const Scalar &)
| Scale all of the entries in this row. More...
template<typename Scalar >
RowEditor & | operator*= (const Scalar &s)
bool | empty () const
const SizeType & | size () const
const ValueType & | getValue (SizeType columnIdx, bool &active) const
const ValueType & | getValue (SizeType columnIdx) const
ConstValueIter | cbegin () const
| Return an iterator over the stored values in this row. More...
template<typename OtherDataType >
bool | eq (const RowBase< OtherDataType > &other, ValueType eps=Tolerance< ValueType >::value()) const
| Return `true` if this row is equivalent to the given row to within the specified tolerance. More...
template<typename VecValueType >
VecValueType | dot (const VecValueType *inVec, SizeType vecSize) const
| Return the dot product of this row with the first vecSize elements of inVec. More...
template<typename VecValueType >
VecValueType | dot (const Vector< VecValueType > &inVec) const
| Return the dot product of this row with the given vector. More...
std::string | str () const
| Return a string representation of this row. More...

## Static Public Member Functions
static SizeType | capacity ()

## Protected Member Functions
const ValueType & | value (SizeType i) const
SizeType | column (SizeType i) const
SizeType | find (SizeType columnIdx) const
| Return the array index of the first column index that is equal to or greater than the given column index. More...

## Protected Attributes
DataType | mData

## Detailed Description

template<typename ValueType_, SizeType STENCIL_SIZE>
class openvdb::v9_0::math::pcg::SparseStencilMatrix< ValueType_, STENCIL_SIZE >::RowEditor

Read/write accessor to a row of this matrix.

## Member Typedef Documentation

## ◆ DataType

using DataType = DataType_
| inherited

## Constructor & Destructor Documentation

## ◆ RowEditor()

RowEditor | ( | ValueType * | valueHead,
|  | SizeType * | columnHead,
|  | SizeType & | rowSize,
|  | SizeType | colSize
| ) |  |
| inline

## Member Function Documentation

## ◆ capacity()

static SizeType capacity | ( |  | ) |
| inlinestaticinherited

## ◆ cbegin()

SparseStencilMatrix< ValueType, STENCIL_SIZE >::ConstValueIter cbegin
| inlineinherited

Return an iterator over the stored values in this row.

## ◆ clear()

void clear
| inline

Set the number of entries in this row to zero.

## ◆ column()

SizeType column | ( | SizeType | i | ) | const
| inlineprotectedinherited

## ◆ dot() [1/2]

VecValueType dot | ( | const Vector< VecValueType > & | inVec | ) | const
| inlineinherited

Return the dot product of this row with the given vector.

## ◆ dot() [2/2]

VecValueType dot | ( | const VecValueType * | inVec,
|  | SizeType | vecSize
| ) |  | const
| inlineinherited

Return the dot product of this row with the first vecSize elements of inVec.

Warning
  inVec must have at least vecSize elements.

## ◆ empty()

bool empty | ( |  | ) | const
| inlineinherited

## ◆ eq()

bool eq | ( | const RowBase< OtherDataType > & | other,
|  | ValueType | eps = `Tolerance<ValueType>::value()`
| ) |  | const
| inlineinherited

Return `true` if this row is equivalent to the given row to within the specified tolerance.

## ◆ find()

SizeType find | ( | SizeType | columnIdx | ) | const
| inlineprotectedinherited

Return the array index of the first column index that is equal to or greater than the given column index.

Note
  If columnIdx is larger than any existing column index, the return value will point beyond the end of the array.

## ◆ getValue() [1/2]

const ValueType & getValue | ( | SizeType | columnIdx | ) | const
| inlineinherited

## ◆ getValue() [2/2]

const ValueType & getValue | ( | SizeType | columnIdx,
|  | bool & | active
| ) |  | const
| inlineinherited

## ◆ operator*=()

RowEditor & operator*= | ( | const Scalar & | s | ) |
| inline

## ◆ scale()

void scale | ( | const Scalar & | s | ) |
| inline

Scale all of the entries in this row.

## ◆ setValue()

SizeType setValue | ( | SizeType | column,
|  | const ValueType & | value
| ) |  |
| inline

Set the value of the entry in the specified column.

Returns
  the current number of entries stored in this row.

## ◆ size()

const SizeType & size | ( |  | ) | const
| inlineinherited

## ◆ str()

std::string str
| inlineinherited

Return a string representation of this row.

## ◆ value()

const ValueType & value | ( | SizeType | i | ) | const
| inlineprotectedinherited

## Member Data Documentation

## ◆ mData

DataType mData
| protectedinherited