Helper class used by the comma initializer operator. More...

#include <STK_ArrayBaseInitializer.h>

Public Types
typedef Derived::Type	Type

Public Member Functions
	ArrayInitializer (Derived &array, Type const &s)
	Constructor.

ArrayInitializer &	operator, (Type const &s)
	inserts a scalar value in the target matrix

	~ArrayInitializer ()
	destructor

Protected Member Functions
void	toFirstElt ()
	Set (row_, col_) to the first element of the array.

void	toNextElt ()
	Compute the next element.

Protected Attributes
Derived &	array_

int	row_

int	col_

Detailed Description

template<typename Derived>
class STK::ArrayInitializer< Derived >

Helper class used by the comma initializer operator.

This class is internally used to implement the comma initializer feature. It is the return type of ArrayBase::operator<<, and most of the time this is the only way it is used.

Definition at line 48 of file STK_ArrayBaseInitializer.h.

Member Typedef Documentation

◆ Type

template<typename Derived >

typedef Derived::Type STK::ArrayInitializer< Derived >::Type

Definition at line 51 of file STK_ArrayBaseInitializer.h.

Constructor & Destructor Documentation

◆ ArrayInitializer()

template<typename Derived >

STK::ArrayInitializer< Derived >::ArrayInitializer	(	Derived &	array,
		Type const &	s
	)

inline

Constructor.

Definition at line 53 of file STK_ArrayBaseInitializer.h.

                           : array_(array), row_(array.beginRows()), col_(array.beginCols())
    { // check if there is space
      if (array.empty())
      { STKRUNTIME_ERROR_NO_ARG(ArrayInitializer::ArrayInitializer,array is empty);}
      toFirstElt();
      array_.elt(row_, col_) = s;
    }

References STK::ArrayInitializer< Derived >::array_, STK::ArrayInitializer< Derived >::ArrayInitializer(), STK::ArrayInitializer< Derived >::col_, STK::ArrayInitializer< Derived >::row_, STKRUNTIME_ERROR_NO_ARG, and STK::ArrayInitializer< Derived >::toFirstElt().

Referenced by STK::ArrayInitializer< Derived >::ArrayInitializer().

◆ ~ArrayInitializer()

template<typename Derived >

STK::ArrayInitializer< Derived >::~ArrayInitializer ( )

inline

destructor

Definition at line 69 of file STK_ArrayBaseInitializer.h.

69{}

Member Function Documentation

◆ operator,()

template<typename Derived >

ArrayInitializer & STK::ArrayInitializer< Derived >::operator, ( Type const & s )

inline

inserts a scalar value in the target matrix

Definition at line 62 of file STK_ArrayBaseInitializer.h.

    {
      toNextElt();
      array_.elt(row_, col_) = s;
      return *this;
    }

References STK::ArrayInitializer< Derived >::array_, STK::ArrayInitializer< Derived >::col_, STK::ArrayInitializer< Derived >::row_, and STK::ArrayInitializer< Derived >::toNextElt().

◆ toFirstElt()

template<typename Derived >

void STK::ArrayInitializer< Derived >::toFirstElt ( )

inlineprotected

Set (row_, col_) to the first element of the array.

Note: Useful only if the structure of the array does not allow element in the (beginRows(), beginCols()) position.

Definition at line 76 of file STK_ArrayBaseInitializer.h.

    {
      // loop over the rows, until we get existing columns
      while (array_.rangeColsInRow(row_).size() <= 0)
      { row_++;
        if (row_ >= array_.endRows())
        { STKRUNTIME_ERROR_NO_ARG(ArrayInitializer::toFirstElt,array is empty);}
      }
      col_ = array_.rangeColsInRow(row_).begin();
    }

References STK::ArrayInitializer< Derived >::array_, STK::ArrayInitializer< Derived >::col_, STK::ArrayInitializer< Derived >::row_, STKRUNTIME_ERROR_NO_ARG, and STK::ArrayInitializer< Derived >::toFirstElt().

Referenced by STK::ArrayInitializer< Derived >::ArrayInitializer(), and STK::ArrayInitializer< Derived >::toFirstElt().

◆ toNextElt()

template<typename Derived >

void STK::ArrayInitializer< Derived >::toNextElt ( )

inlineprotected

Compute the next element.

Definition at line 87 of file STK_ArrayBaseInitializer.h.

    {
      // for the current row go to first available column if necessary
      if (col_ < array_.rangeColsInRow(row_).begin())
      { col_ = array_.rangeColsInRow(row_).begin();}
      else // otherwise just increment
      { col_++;}
      // check if we need to go to next row
      if (col_ > array_.rangeColsInRow(row_).lastIdx())
      {
        row_++;
        while ( (array_.rangeColsInRow(row_).size() <= 0) && (row_ <= array_.lastIdxRows()))
        { row_++;}
        if (row_ > array_.lastIdxRows())
        { STKRUNTIME_ERROR_NO_ARG(ArrayInitializer::toNextElt,Too many coefficients passed to operator<<);}
        col_ = array_.rangeColsInRow(row_).begin();
      }
    }