ERC CISST - cisst software

vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension > Class Template Reference

#include <vctDynamicNArrayBase.h>

Inheritance diagram for vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >:

Inheritance graph
[legend]
Collaboration diagram for vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
class vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >

This class provides all the const methods inherited from vctDynamicConstNArrayBase, and extends them with non const methods, such as SumOf.

See also:
vctDynamicConstNArrayBase

Definition at line 43 of file vctDynamicNArrayBase.h.

Public Types

Iterators on the elements of the nArray
The type of the object representing a subarray of
this nArray. Access is by (const and non const) reference.

The type of the object representing a permutation of
this nArray. Access is by (const and non const) reference.

The type of the object representing a slice of this
nArray. Access is by (const and non const) reference.

Public Member Functions

Assignment operation between arrays containing the same data type but different owners
Parameters:
other The array to be copied.


Assignment operation between nArrays of different types.
Parameters:
other The nArray to be copied.


Binary elementwise operations between two nArrays.
Store the result of op(nArray1, nArray2) to a third nArray.

Binary elementwise operations between two nArrays.
Store the result of op(this, otherNArray) back to this nArray.

Binary elementwise operations an nArray and a scalar.
Store the result of op(nArray, scalar) to a third nArray.

Binary elementwise operations a scalar and an nArray.
Store the result of op(scalar, nArray) to a third nArray.

Binary elementwise operations between an nArray and a scalar.
Store the result of op(this, scalar) back to this nArray.

Unary elementwise operations.
Store the result of op(nArray) to another nArray.

Store back unary elementwise operations.
Store the result of op(this) to this nArray.

Public Attributes

Member Typedef Documentation

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef vctDynamicNArrayBase vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ThisType

Type of the nArray itself

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Reimplemented in vctDynamicNArray< _elementType, _dimension >, and vctDynamicNArrayRef< _elementType, _dimension >.

Definition at line 51 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef vctDynamicConstNArrayBase<_nArrayOwnerType, _elementType, _dimension> vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::BaseType

Type of the base class

Reimplemented in vctDynamicNArray< _elementType, _dimension >, vctReturnDynamicNArray< _elementType, _dimension >, and vctDynamicNArrayRef< _elementType, _dimension >.

Definition at line 54 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef _nArrayOwnerType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::OwnerType

Type of the data owner (dynamic array or pointer)

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 57 of file vctDynamicNArrayBase.h.

Member Function Documentation

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::begin ( void   )  [inline]

Returns an iterator on the first element (STL compatibility).

Definition at line 94 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::at(), and vctRandom().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::begin ( void   )  const [inline]

Returns a const iterator on the first element (STL compatibility).

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 100 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::end ( void   )  [inline]

Returns an iterator on the last element (STL compatibility).

Definition at line 107 of file vctDynamicNArrayBase.h.

Referenced by vctRandom().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::end ( void   )  const [inline]

Returns a const iterator on the last element (STL compatibility).

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 113 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reverse_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::rbegin ( void   )  [inline]

Returns a reverse iterator on the last element (STL compatibility).

Definition at line 120 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reverse_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::rbegin ( void   )  const [inline]

Returns a reverse const iterator on the last element (STL compatibility).

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 126 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reverse_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::rend ( void   )  [inline]

Returns a reverse iterator on the element before first (STL compatibility).

Definition at line 133 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reverse_iterator vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::rend ( void   )  const [inline]

Returns a reverse const iterator on the element before first (STL compatibility).

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 139 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const OwnerType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Owner ( void   )  const [inline]

Access the NArray owner. This method should be used only to access some extra information related to the memory layout. It is used by the engines (vctDynamicNArrayLoopEngines).

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 146 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
pointer vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Pointer ( const nsize_type &  indices  )  [inline]

Return a non const pointer to an element of the container, specified by its indices. Addition to the STL requirements.

Definition at line 157 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayRef< _elementType, _dimension >::PermutationOf(), vctDynamicNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicNArrayRef< _elementType, _dimension >::SubarrayOf(), and vctDynamicNArrayRef< _elementType, _dimension >::vctDynamicNArrayRef().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_pointer vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Pointer ( const nsize_type &  indices  )  const [inline]

Returns a const pointer to an element of the container, specified by its indices. Addition to the STL requirements.

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 163 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
pointer vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Pointer ( void   )  [inline]

Returns a non const pointer to the first element of the container. Addition to the STL requirements.

Definition at line 171 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::at(), and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Element().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_pointer vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Pointer ( void   )  const [inline]

Returns a const pointer to the first element of the container. Addition to the STL requirements.

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 177 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::at ( size_type  metaIndex  )  throw (std::out_of_range) [inline]

Access an element by index (non const). Compare with std::vector::at(). This method can be a handy substitute for the overloaded operator () when operator overloading is unavailable or inconvenient.

Returns:
a const reference to the element at indices

Definition at line 187 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator()().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::at ( size_type  metaIndex  )  const throw (std::out_of_range) [inline]

Access an element by index (const). Compare with std::matrix::at(). This method can be a handy substitute for the overloaded operator [] when operator overloading is unavailable or inconvenient.

Returns:
a const reference to element[index]

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 196 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::at ( const nsize_type &  coordinates  )  throw (std::out_of_range) [inline]

Access an element by index. Compare with std::vector::at(). This method can be a handy substitute for the overloaded operator () when operator overloading is unavailable or inconvenient.

Returns:
a reference to the element at indices

Definition at line 207 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::at ( const nsize_type &  coordinates  )  const throw (std::out_of_range) [inline]

Access an element by indices (const). Compare with std::vector::at(). This method can be a handy substitute for the overloaded operator () when operator overloading is unavailable or inconvenient.

Returns:
a const reference to the element at indices

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 215 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator() ( const nsize_type &  coordinates  )  throw (std::out_of_range) [inline]

Overloaded operator () for simplified (non const) element access with bounds checking

Definition at line 223 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator() ( const nsize_type &  coordinates  )  const throw (std::out_of_range) [inline]

documented in base class

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 230 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Element ( const nsize_type &  coordinates  )  [inline]

Access an element by indices (non const). This method allows to access an element without any bounds checking. It doesn't create any temporary references as a nArray[][]...[] would do.

Returns:
a reference to the element at the specified indices

Definition at line 242 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Element ( const nsize_type &  coordinates  )  const [inline]

Access an element by indices (const). This method allows to access an element without any bounds checking. It doesn't create any temporary references as nArray[][]...[] would do.

Returns:
a reference to the element at the specified indices

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 248 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
SubarrayRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Subarray ( const nsize_type &  startPosition,
const nsize_type &  lengths 
) [inline]

Create a non-const reference to a subarray of this nArray.

Parameters:
startPosition vector of indices of the element position where the reference will start
lengths the number of elements to reference in each dimension
Note:
Preserves the number of dimensions.

Definition at line 260 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ConstSubarrayRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Subarray ( const nsize_type &  startPosition,
const nsize_type &  lengths 
) const [inline]

documented in base class

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 270 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
PermutationRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Permutation ( const ndimension_type &  dimensions  )  [inline]

Create a non-const reference to this nArray with the strides permuted.

Parameters:
dimensions a sequence of dimension numbers representing the permuted order of strides
Note:
Preserves the number of dimensions.

Definition at line 283 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ConstPermutationRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Permutation ( const ndimension_type &  dimensions  )  const [inline]

documented in base class

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 292 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
SliceRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Slice ( dimension_type  dimension,
size_type  index 
) throw (std::runtime_error, std::out_of_range) [inline]

Create a non-const reference to a slice of dimension n-1, where n is the dimension of this nArray.

Parameters:
dimension the dimension number of the direction by which to reduce
slice the index number in the dimension specified by which to set the reference
Note:
The number of dimensions is reduced by one.

Definition at line 306 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator[]().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ConstSliceRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Slice ( dimension_type  dimension,
size_type  index 
) const throw (std::runtime_error, std::out_of_range) [inline]

documented in base class

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 314 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
SliceRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator[] ( size_type  index  )  [inline]

Reference an (n-1)-dimension slice of this nArray by index (non-const).

Returns:
a non-const reference to the given index in the most significant dimension

Definition at line 325 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ConstSliceRefType vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator[] ( size_type  index  )  const [inline]

documented in base class

Reimplemented from vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >.

Definition at line 332 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::SetAll ( const value_type  value  )  [inline]

Assign the given value to all the elements.

Parameters:
value the value used to set all the elements of the nArray
Returns:
The value used to set all the elements

Definition at line 342 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Zeros().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Zeros ( void   )  [inline]

Assign zero to all elements. This methods assumes that the element type has a zero and this zero value can be set using memset(0). If the nArray is not compact this method will use SetAll(0) and memset otherwise. This provides a slightly more efficent way to set all elements to zero.

Returns:
true if the nArray is compact and memset was used, false otherwise.

Definition at line 359 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Assign ( const value_type *  elements  )  [inline]

Assign to this nArray values from a C array given as a pointer to value_type. The purpose of this method is to simplify the syntax by not necessitating the creation of an explicit nArray for the given array. However, we only provide this method for an array of value_type. For arrays of other types an nArray still needs to be declared.

Parameters:
elements a pointer to a C array of elements to be assigned to this nArray
Note:
This method assumes two things: (1) that the input array is _packed_, that is, that all the elements are stored in a contiguous memory block with no gaps; and (2) that the storage order of the input array matches the storage order of this nArray.
Returns:
a reference to this object.

Definition at line 431 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType, typename __elementType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ForceAssign ( const vctDynamicConstNArrayBase< __nArrayOwnerType, __elementType, DIMENSION > &  other  )  [inline]

Forced assignment operation between arrays of different types. This method will use SetSize on the destination array (this nArray) to make sure the assignment will work. It is important to note that if the sizes don't match, memory for this array will be re-allocated. If the program has previously created some references (as in vctDynamic{Const}NArrayRef) on this array, they will become invalid.

Note:
For a non-reallocating Assign, it is recommended to use the Assign() methods.

If the destination array doesn't have the same size as the source and can not be resized, an exception will be thrown by the Assign method called internally.

Parameters:
other The array to be copied.

Definition at line 482 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
bool vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::FastCopyOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  source,
bool  performSafetyChecks = true 
) throw (std::runtime_error) [inline]

Fast copy. This method uses memcpy whenever it is possible to perform a fast copy from another array to this array.

The basic and safe use of this method for an array would be: 

        if (!destination.FastCopyOf(source)) {
            destination.Assign(source);
        }

If the method is to be called many times (in a loop for example), it is recommended to check that the source and destination are compatible once and then use the option to turn off the different safety checks for each FastCopyOf. 

        bool canUseFastCopy = destination.FastCopyPossible(source);
        vct::index_type index;
        for (index = 0; index < 1000; index++) {
            DoSomethingUseful(source);
            if (canUseFastCopy) {
                destination.FastCopyOf(source, false); // Do not check again
            } else {
                destination.Assign(source);
            }
        }

Parameters:
source NArray used to set the content of this array.
performSafetyChecks Flag set to false to avoid safety checks, use with extreme caution.

Definition at line 548 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Assign().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::SumOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 574 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::DifferenceOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 585 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseProductOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 596 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseRatioOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 607 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseMinOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 618 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType1, class __nArrayOwnerType2>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseMaxOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType1, value_type, DIMENSION > &  nArray1,
const vctDynamicConstNArrayBase< __nArrayOwnerType2, value_type, DIMENSION > &  nArray2 
) [inline]

Binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(nArray1[i], nArray2[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters:
nArray1 The first operand of the binary operation
nArray2 The second operand of the binary operation
Returns:
The nArray "this" modified.

Definition at line 629 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Add ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 658 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator+=().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Subtract ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 668 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator-=().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseMultiply ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 678 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseDivide ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 688 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseMin ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 698 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseMax ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 708 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator+= ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 718 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator-= ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Store back binary elementwise operations between two nArrays. For each element of the nArrays, performs $ this[i] \leftarrow op(this[i], otherNArray[i])$ where $op$ is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters:
otherNArray The second operand of the binary operation (this[i] is the first operand)
Returns:
The nArray "this" modified.

Definition at line 725 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::SumOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  scalar 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 748 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::DifferenceOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  scalar 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 759 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ProductOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  scalar 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 770 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::RatioOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  scalar 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 781 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClippedAboveOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  lowerBound 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 792 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClippedBelowOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray,
const value_type  upperBound 
) [inline]

Binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(nArray[i], scalar)$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
nArray The first operand of the binary operation.
scalar The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 803 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::SumOf ( const value_type  scalar,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 831 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::DifferenceOf ( const value_type  scalar,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 842 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ProductOf ( const value_type  scalar,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 853 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::RatioOf ( const value_type  scalar,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 864 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClippedAboveOf ( const value_type  upperBound,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 875 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClippedBelowOf ( const value_type  lowerBound,
const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  nArray 
) [inline]

Binary elementwise operations between a scalar and an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(scalar, nArray[i])$ where $op$ is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters:
scalar The first operand of the binary operation.
nArray The second operand of the binary operation.
Returns:
The nArray "this" modified.

Definition at line 886 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Add ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 912 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Subtract ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 921 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Multiply ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 930 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator *=().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Divide ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 939 of file vctDynamicNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator/=().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClipAbove ( const value_type  upperBound  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 948 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ClipBelow ( const value_type  lowerBound  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 957 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator+= ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 966 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator-= ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 972 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator *= ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 978 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator/= ( const value_type  scalar  )  [inline]

Store back binary elementwise operations between an nArray and a scalar. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i], scalar)$ where $op$ is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters:
scalar The second operand of the binary operation (this[i] is the first operand).
Returns:
The nArray "this" modified.

Definition at line 984 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::AbsOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(otherNArray[i])$ where $op$ can calculate the absolute value (AbsOf) or the opposite (NegationOf).

Parameters:
otherNArray The operand of the unary operation.
Returns:
The nArray "this" modified.

Definition at line 1017 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NegationOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(otherNArray[i])$ where $op$ can calculate the absolute value (AbsOf) or the opposite (NegationOf).

Parameters:
otherNArray The operand of the unary operation.
Returns:
The nArray "this" modified.

Definition at line 1027 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::FloorOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(otherNArray[i])$ where $op$ can calculate the absolute value (AbsOf) or the opposite (NegationOf).

Parameters:
otherNArray The operand of the unary operation.
Returns:
The nArray "this" modified.

Definition at line 1037 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::CeilOf ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  otherNArray  )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(otherNArray[i])$ where $op$ can calculate the absolute value (AbsOf) or the opposite (NegationOf).

Parameters:
otherNArray The operand of the unary operation.
Returns:
The nArray "this" modified.

Definition at line 1047 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::AbsSelf ( void   )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i])$ where $op$ can calculate the absolute value (AbsSelf) or the opposite (NegationSelf).

Returns:
The nArray "this" modified.

Definition at line 1067 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NegationSelf ( void   )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i])$ where $op$ can calculate the absolute value (AbsSelf) or the opposite (NegationSelf).

Returns:
The nArray "this" modified.

Definition at line 1076 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::FloorSelf ( void   )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i])$ where $op$ can calculate the absolute value (AbsSelf) or the opposite (NegationSelf).

Returns:
The nArray "this" modified.

Definition at line 1085 of file vctDynamicNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
ThisType& vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >::CeilSelf ( void   )  [inline]

Unary elementwise operations on an nArray. For each element of the nArray "this", performs $ this[i] \leftarrow op(this[i])$ where $op$ can calculate the absolute value (AbsSelf) or the opposite (NegationSelf).

Returns:
The nArray "this" modified.

Definition at line 1094 of file vctDynamicNArrayBase.h.

The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu