ERC CISST - cisst software

vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension > Class Template Reference

#include <vctDynamicConstNArrayBase.h>

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

This class is templated with the ``nArray owner type'', which may be a vctDynamicNArrayOwner or a vctDynamicNArrayRefOwner. It provides const operations on the nArray, such as SumOfElements etc.

nArray indexing is zero-based.

nArray dimensions are zero-based.

The method provided for the compatibility with the STL containers start with a lower case. Other methods start with a capitalilized letter (see CISST naming convention).

Parameters:
_nArrayOwnerType the type of nArray owner
_elementType the type of elements of the nArray

Definition at line 156 of file vctDynamicConstNArrayBase.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

Incremental operations returning a scalar.
Compute a scalar from all the elements of the nArray.

Storage format.
Elementwise comparisons between nArray.
Returns the result of the comparison.

Elementwise comparisons between nArrays.
Returns the nArray of comparison's results.

Elementwise comparisons between an nArray and a scalar.
Returns the result of the comparison.

Elementwise comparisons between an nArray and a scalar.
Returns the result of the comparison.

Unary elementwise operations.
Returns the result of nArray.op().

Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

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

Type of the nArray itself.

Reimplemented in vctDynamicConstNArrayRef< _elementType, _dimension >, vctDynamicNArray< _elementType, _dimension >, vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayRef< _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 164 of file vctDynamicConstNArrayBase.h.

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

Type of the data owner (dynamic array or pointer)

Definition at line 167 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef vctReturnDynamicNArray<value_type, DIMENSION> vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NArrayValueType

The type of nArray used to store by value results of the same type as this object.

Definition at line 206 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef vctDynamicNArray<value_type, DIMENSION> vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NArrayReturnType

The type of nArray returned by value from operations on this object

Definition at line 210 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef TypeTraits::BoolType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::BoolType

Define bool based on the container type to force some compilers (i.e. gcc 4.0) to delay the instantiation of the ElementWiseCompare methods.

Definition at line 217 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
typedef vctReturnDynamicNArray<BoolType, DIMENSION> vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::BoolNArrayReturnType

The type of an nArray of booleans returned from operations on this object, e.g., ElementwiseEqual.

Definition at line 221 of file vctDynamicConstNArrayBase.h.

Member Function Documentation

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ThrowUnlessValidDimensionIndex ( dimension_type  dimensionIndex  )  const throw (std::out_of_range) [inline, protected]

Check the validity of the given dimension index

Definition at line 231 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ThrowUnlessValidIndex ( size_type  index  )  const throw (std::out_of_range) [inline, protected]

Check the validity of an index

Definition at line 242 of file vctDynamicConstNArrayBase.h.

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

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ThrowUnlessValidIndex ( const nsize_type &  indices  )  const throw (std::out_of_range) [inline, protected]

Check the validity of the nArray indices

Definition at line 252 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ThrowUnlessValidIndex ( dimension_type  dimension,
size_type  index 
) const throw (std::out_of_range) [inline, protected]

Check the validity of the given index in the (dimension)th-dimension

Definition at line 262 of file vctDynamicConstNArrayBase.h.

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 276 of file vctDynamicConstNArrayBase.h.

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

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 283 of file vctDynamicConstNArrayBase.h.

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

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 290 of file vctDynamicConstNArrayBase.h.

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

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 297 of file vctDynamicConstNArrayBase.h.

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

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
size_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::size ( void   )  const [inline]

Return the number of elements in the nArray. This is not equivalent to the difference between the end and the beginning.

Definition at line 305 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::empty(), vctDynamicNArray< _elementType, _dimension >::ForceAssign(), vctDynamicNArrayRef< _elementType, _dimension >::PermutationOf(), vctDynamicConstNArrayRef< _elementType, _dimension >::PermutationOf(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ValidIndex(), and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Zeros().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const nsize_type& vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::sizes ( void   )  const [inline]

Not required by STL but provided for completeness

Definition at line 311 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Assign(), operator *(), operator+(), operator-(), operator/(), vctDynamicNArray< _elementType, _dimension >::operator=(), vctDynamicConstNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicConstNArrayRef< _elementType, _dimension >::SubarrayOf(), vctDynamicNArrayRef< _elementType, _dimension >::SubarrayOf(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ValidIndex(), vctDynamicConstNArrayRef< _elementType, _dimension >::vctDynamicConstNArrayRef(), vctDynamicNArray< _elementType, _dimension >::vctDynamicNArray(), vctDynamicNArrayRef< _elementType, _dimension >::vctDynamicNArrayRef(), and vctReturnDynamicNArray< _elementType, _dimension >::vctReturnDynamicNArray().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
size_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::size ( dimension_type  dimension  )  const [inline]

Not required by STL but provided for completeness

Definition at line 317 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const nstride_type& vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::strides ( void   )  const [inline]

Not required by STL but provided for completeness

Definition at line 323 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Assign(), vctDynamicConstNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicConstNArrayRef< _elementType, _dimension >::SubarrayOf(), vctDynamicNArrayRef< _elementType, _dimension >::SubarrayOf(), vctDynamicConstNArrayRef< _elementType, _dimension >::vctDynamicConstNArrayRef(), and vctDynamicNArrayRef< _elementType, _dimension >::vctDynamicNArrayRef().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
difference_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::stride ( dimension_type  dimension  )  const [inline]

Not required by STL but provided for completeness

Definition at line 329 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayRef< _elementType, _dimension >::PermutationOf(), and vctDynamicNArrayRef< _elementType, _dimension >::PermutationOf().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
dimension_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::dimension ( void   )  const [inline]

Not required by STL but provided for completeness

Definition at line 335 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Slice(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Slice(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ThrowUnlessValidIndex(), and vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ValidDimensionIndex().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::empty ( void   )  const [inline]

Tell if the narray is empty (STL compatibility). False unless size is zero.

Definition at line 342 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ValidDimension ( dimension_type  dimension  )  const [inline]

Returns true if the given dimension value is equal to this nArray's dimension.

Definition at line 350 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ValidDimensionIndex ( dimension_type  dimensionIndex  )  const [inline]

Returns true if the given dimension index is valid.

Definition at line 356 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ThrowUnlessValidDimensionIndex().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ValidIndex ( size_type  index  )  const [inline]

Returns true if the index is less than the number of elements of the nArray.

Definition at line 363 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ThrowUnlessValidIndex().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ValidIndex ( const nsize_type &  indices  )  const [inline]

Returns true if all indices are valid indices.

Definition at line 369 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ValidIndex ( dimension_type  dimension,
size_type  index 
) const [inline]

Returns true if the given index is a valid index.

Definition at line 390 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicConstNArrayBase< _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 in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 402 of file vctDynamicConstNArrayBase.h.

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

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicConstNArrayBase< _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 in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 413 of file vctDynamicConstNArrayBase.h.

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 421 of file vctDynamicConstNArrayBase.h.

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

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const OwnerType& vctDynamicConstNArrayBase< _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).

Definition at line 431 of file vctDynamicConstNArrayBase.h.

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

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 439 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::at(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Element(), vctDynamicConstNArrayRef< _elementType, _dimension >::PermutationOf(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Pointer(), vctDynamicConstNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstNArrayRef< _elementType, _dimension >::SliceOf(), vctDynamicConstNArrayRef< _elementType, _dimension >::SubarrayOf(), and vctDynamicConstNArrayRef< _elementType, _dimension >::vctDynamicConstNArrayRef().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_pointer vctDynamicConstNArrayBase< _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 in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 447 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
const_reference vctDynamicConstNArrayBase< _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 in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 458 of file vctDynamicConstNArrayBase.h.

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

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

Create a 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 470 of file vctDynamicConstNArrayBase.h.

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

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

Create a 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 485 of file vctDynamicConstNArrayBase.h.

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

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

Create a 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 501 of file vctDynamicConstNArrayBase.h.

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

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

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

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

Reimplemented in vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >, vctDynamicNArrayBase< vctDynamicNArrayOwner< _elementType, _dimension >, _elementType, _dimension >, and vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >.

Definition at line 512 of file vctDynamicConstNArrayBase.h.

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

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::SumOfElements ( void   )  const [inline]

Return the sum of the elements of the nArray.

Returns:
The sum of all the elements

Definition at line 524 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ProductOfElements ( void   )  const [inline]

Return the product of the elements of the nArray.

Returns:
The product of all the elements

Definition at line 534 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NormSquare ( void   )  const [inline]

Return the square of the norm of the nArray.

Returns:
The square of the norm

Definition at line 544 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Norm().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
NormType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Norm ( void   )  const [inline]

Return the norm of the nArray.

Returns:
The norm.

Definition at line 554 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::L1Norm ( void   )  const [inline]

Return the L1 norm of the nArray, i.e. the sum of the absolute values of all the elements.

Returns:
The L1 norm.

Definition at line 563 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::LinfNorm ( void   )  const [inline]

Return the Linf norm of the nArray, i.e. the maximum of the absolute values of all the elements.

Returns:
The Linf norm.

Definition at line 575 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::AlmostEqual().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::MaxElement ( void   )  const [inline]

Return the maximum element of the nArray.

Returns:
The maximum element

Definition at line 582 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::MinElement ( void   )  const [inline]

Return the minimum element of the nArray.

Returns:
The minimum element

Definition at line 592 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::MaxAbsElement ( void   )  const [inline]

Return the maximum of the absolute values of all the elements.

See also:
LinfNorm.
Returns:
The maximum of the absolute values.

Definition at line 606 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::LinfNorm().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
value_type vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::MinAbsElement ( void   )  const [inline]

Return the minimum of the absolute values of all the elements.

Returns:
The minimum of the absolute values.

Definition at line 618 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::MinAndMaxElement ( value_type &  minElement,
value_type &  maxElement 
) const [inline]

Compute the minimum AND maximum elements of the nArray. This method is more runtime-efficient than computing them separately.

Parameters:
minElement reference to store the minimum element result.
maxElement reference to store the maximum element result.
Note:
If this nArray is empty (null pointer) the result is undefined.

Definition at line 634 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::IsPositive ( void   )  const [inline]

Return true if all the elements of this nArray are strictly positive, false otherwise

Definition at line 642 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::IsNonNegative ( void   )  const [inline]

Return true if all the elements of this nArray are non-negative, false otherwise

Definition at line 652 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::IsNonPositive ( void   )  const [inline]

Return true if all the elements of this nArray are non-positive, false otherwise

Definition at line 662 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::IsNegative ( void   )  const [inline]

Return true if all the elements of this nArray are strictly negative, false otherwise

Definition at line 672 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::All ( void   )  const [inline]

Return true if all the elements of this nArray are nonzero, false otherwise

Definition at line 682 of file vctDynamicConstNArrayBase.h.

Referenced by vctAll().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Any ( void   )  const [inline]

Return true if any element of this nArray is nonzero, false otherwise

Definition at line 692 of file vctDynamicConstNArrayBase.h.

Referenced by vctAny().

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::IsCompact ( void   )  const [inline]

Test if the nArray is compact, i.e. the nArray actually uses a contiguous block of memory.

Note:
An empty nArray is considered compact

Definition at line 710 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
template<class __nArrayOwnerType>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::FastCopyCompatible ( const vctDynamicConstNArrayBase< __nArrayOwnerType, value_type, DIMENSION > &  source  )  const [inline]

Test if the method FastCopyOf can be used instead of Assign. See FastCopyOf for more details.

Definition at line 720 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 742 of file vctDynamicConstNArrayBase.h.

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

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 752 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 759 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 767 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 774 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::operator!=().

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 784 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 791 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 801 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 811 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArray of the same size, containing the same type of elements. The strides can be different. The comparaison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two nArrays. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 821 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 848 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 857 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 866 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 875 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 884 of file vctDynamicConstNArrayBase.h.

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

Comparison between two nArrays of the same size, containing the same type of elements. The strides and the internal representation (_nArrayOwnerType) can be different. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two nArrays and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

Definition at line 893 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Equal ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 917 of file vctDynamicConstNArrayBase.h.

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

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 926 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NotEqual ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 932 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::operator!= ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 941 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Lesser ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 947 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::LesserOrEqual ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 956 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Greater ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 965 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
bool vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::GreaterOrEqual ( const value_type &  scalar  )  const [inline]

Comparison between an nArray and a scalar. The type of the elements of the nArray and the scalar must be the same. The comparison ($ = \neq < \leq > \geq $) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the nArray and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns:
A boolean.

Definition at line 974 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseEqual ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseNotEqual ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseLesser ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseLesserOrEqual ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseGreater ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
BoolNArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ElementwiseGreaterOrEqual ( const value_type &  scalar  )  const

Comparison between an nArray and a scalar, containing the same type of elements. The comparison ($ = \neq < \leq > \geq $) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the nArray and the scalar and stored in a newly created nArray. There is no operator provided since the semantic would be ambiguous.

Returns:
An nArray of booleans.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
NArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Abs ( void   )  const [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 (Abs) or the opposite (Negation).

Returns:
A new nArray.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
NArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Negation ( void   )  const [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 (Abs) or the opposite (Negation).

Returns:
A new nArray.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
NArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Floor ( void   )  const [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 (Abs) or the opposite (Negation).

Returns:
A new nArray.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
NArrayReturnType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::Ceil ( void   )  const [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 (Abs) or the opposite (Negation).

Returns:
A new nArray.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
std::string vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ToString ( void   )  [inline]

Return a string representation of the nArray elements

Definition at line 1041 of file vctDynamicConstNArrayBase.h.

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
void vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::ToStream ( std::ostream &  outputStream  )  const [inline]

Print the nArray to a text stream

Definition at line 1050 of file vctDynamicConstNArrayBase.h.

Referenced by operator<<(), and vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ToString().

Member Data Documentation

template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
OwnerType vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >::NArray [protected]

Declaration of the nArray-defining member object

Definition at line 228 of file vctDynamicConstNArrayBase.h.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::begin(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::begin(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::dimension(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::end(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::end(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::IsCompact(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Owner(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Owner(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Pointer(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Pointer(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::rbegin(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::rbegin(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::rend(), vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::rend(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::size(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::sizes(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::stride(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::strides(), vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ValidIndex(), and vctReturnDynamicNArray< _elementType, _dimension >::vctReturnDynamicNArray().

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