Shiokaze Framework
A research-oriented fluid solver for computer graphics
array2< T >::iterator Class Reference

Writable iterator. More...

#include <array2.h>

Public Member Functions

void set (const T &value)
 Set a value. More...
 
void set_off ()
 Inactivate a cell.
 
void increment (const T &value)
 Increment value. More...
 
void subtract (const T &value)
 Subtract value. More...
 
void multiply (const T &value)
 Multiply value. More...
 
void divide (const T &value)
 Divide by value. More...
 
bool active () const
 Get if a cell is active.
 
bool filled () const
 Get if a cell is filled.
 
const T & operator() () const
 Get the value. More...
 
T * ptr ()
 Get pointer to the value. More...
 
const T * ptr () const
 Get const pointer to the value. More...
 

Friends

class array2< T >
 

Detailed Description

template<class T>
class array2< T >::iterator

Writable iterator.

Member Function Documentation

◆ divide()

template<class T >
void array2< T >::iterator::divide ( const T &  value)
inline

Divide by value.

Parameters
[in]valueValue to divide.

◆ increment()

template<class T >
void array2< T >::iterator::increment ( const T &  value)
inline

Increment value.

Parameters
[in]valueValue to increment.

◆ multiply()

template<class T >
void array2< T >::iterator::multiply ( const T &  value)
inline

Multiply value.

Parameters
[in]valueValue to multiply.

◆ operator()()

template<class T >
const T& array2< T >::iterator::operator() ( ) const
inline

Get the value.

Returns
Value on the cell.

◆ ptr() [1/2]

template<class T >
T* array2< T >::iterator::ptr ( )
inline

Get pointer to the value.

Returns
Pointer to the value on the cell.

◆ ptr() [2/2]

template<class T >
const T* array2< T >::iterator::ptr ( ) const
inline

Get const pointer to the value.

Returns
Const pointer to the value on the cell.

◆ set()

template<class T >
void array2< T >::iterator::set ( const T &  value)
inline

Set a value.

Parameters
[in]valueValue to set.

◆ subtract()

template<class T >
void array2< T >::iterator::subtract ( const T &  value)
inline

Subtract value.

Parameters
[in]valueValue to subtract.

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