[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]

TinyVectorBase< VALUETYPE, SIZE, DATA, DERIVED > Class Template Reference

Base class for fixed size vectors. More...

`#include <vigra/tinyvector.hxx>`

Inheritance diagram for TinyVectorBase< VALUETYPE, SIZE, DATA, DERIVED >:

## Public Types

enum |
typedef value_type const * | const_iterator
typedef VALUETYPE const * | const_pointer
typedef VALUETYPE const & | const_reference
typedef std::ptrdiff_t | difference_type
typedef value_type * | iterator
typedef SquareRootTraits< SquaredNormType >::SquareRootResult | NormType
typedef VALUETYPE * | pointer
typedef VALUETYPE & | reference
typedef double | scalar_multiplier
typedef unsigned int | size_type
typedef NormTraits< VALUETYPE >::SquaredNormType | SquaredNormType
typedef VALUETYPE | value_type

## Public Member Functions

bool | all () const
bool | any () const
iterator | begin ()
const_iterator | begin () const
const_iterator | cbegin () const
const_iterator | cend () const
iterator | end ()
const_iterator | end () const
template<class Iterator >
void | init (Iterator i, Iterator end)
void | init (value_type initial)
NormType | magnitude () const
VALUETYPE const & | maximum () const
VALUETYPE const & | minimum () const
template<class T1 , class D1 , class D2 >
DERIVED & | operator%= (TinyVectorBase< T1, SIZE, D1, D2 > const &r)
DERIVED & | operator*= (double r)
template<class T1 , class D1 , class D2 >
DERIVED & | operator*= (TinyVectorBase< T1, SIZE, D1, D2 > const &r)
DERIVED & | operator+= (double r)
template<class T1 , class D1 , class D2 >
DERIVED & | operator+= (TinyVectorBase< T1, SIZE, D1, D2 > const &r)
DERIVED & | operator-= (double r)
template<class T1 , class D1 , class D2 >
DERIVED & | operator-= (TinyVectorBase< T1, SIZE, D1, D2 > const &r)
DERIVED & | operator/= (double r)
template<class T1 , class D1 , class D2 >
DERIVED & | operator/= (TinyVectorBase< T1, SIZE, D1, D2 > const &r)
reference | operator[] (difference_type i)
const_reference | operator[] (difference_type i) const
size_type | size () const
SquaredNormType | squaredMagnitude () const
template<int FROM, int TO>
TinyVectorView< VALUETYPE, TO-FROM > | subarray () const

## Static Public Member Functions

static TinyVector< VALUETYPE, SIZE > | linearSequence (VALUETYPE start=VALUETYPE(), VALUETYPE step=VALUETYPE(1))
| Factory function for a linear sequence.
static TinyVector< VALUETYPE, SIZE > | unitVector (int k)
| Factory function for a unit vector for dimension k.

## Detailed Description

template<class VALUETYPE, int SIZE, class DATA, class DERIVED>
class vigra::TinyVectorBase< VALUETYPE, SIZE, DATA, DERIVED >

Base class for fixed size vectors.

This class contains functionality shared by TinyVector and TinyVectorView, and enables these classes to be freely mixed within expressions. It is typically not used directly.

#include <vigra/tinyvector.hxx>
Namespace: vigra

## Member Typedef Documentation

## ◆ value_type

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef VALUETYPE value_type

STL-compatible definition of valuetype

## ◆ reference

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef VALUETYPE& reference

reference (return of operator[]).

## ◆ const_reference

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef VALUETYPE const& const_reference

const reference (return of operator[] const).

## ◆ pointer

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef VALUETYPE* pointer

pointer (return of operator->).

## ◆ const_pointer

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef VALUETYPE const* const_pointer

const pointer (return of operator-> const).

## ◆ iterator

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef value_type* iterator

STL-compatible definition of iterator

## ◆ const_iterator

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef value_type const* const_iterator

STL-compatible definition of const iterator

## ◆ size_type

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef unsigned int size_type

STL-compatible definition of size_type

## ◆ difference_type

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef std::ptrdiff_t difference_type

STL-compatible definition of difference_type

## ◆ scalar_multiplier

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef double scalar_multiplier

the scalar type for the outer product

## ◆ SquaredNormType

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef NormTraits<VALUETYPE>::SquaredNormType SquaredNormType

the vector's squared norm type

## ◆ NormType

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

typedef SquareRootTraits<SquaredNormType>::SquareRootResult NormType

the vector's norm type

## Member Enumeration Documentation

## ◆ anonymous enum

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

anonymous enum

the vector's size

## Member Function Documentation

## ◆ init() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class Iterator >

void init | ( | Iterator | i,
|  | Iterator | end
| ) |  |

Initialize from another sequence (must have length SIZE!)

## ◆ init() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

void init | ( | value_type | initial | ) |

Initialize with constant value

## ◆ operator+=() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class T1 , class D1 , class D2 >

DERIVED & operator+= | ( | TinyVectorBase< T1, SIZE, D1, D2 > const & | r | ) |

Component-wise add-assignment

## ◆ operator-=() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class T1 , class D1 , class D2 >

DERIVED & operator-= | ( | TinyVectorBase< T1, SIZE, D1, D2 > const & | r | ) |

Component-wise subtract-assignment

## ◆ operator*=() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class T1 , class D1 , class D2 >

DERIVED & operator*= | ( | TinyVectorBase< T1, SIZE, D1, D2 > const & | r | ) |

Component-wise multiply-assignment

## ◆ operator/=() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class T1 , class D1 , class D2 >

DERIVED & operator/= | ( | TinyVectorBase< T1, SIZE, D1, D2 > const & | r | ) |

Component-wise divide-assignment

## ◆ operator%=()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<class T1 , class D1 , class D2 >

DERIVED & operator%= | ( | TinyVectorBase< T1, SIZE, D1, D2 > const & | r | ) |

Component-wise modulo-assignment

## ◆ operator+=() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

DERIVED & operator+= | ( | double | r | ) |

Component-wise scalar multiply-assignment

## ◆ operator-=() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

DERIVED & operator-= | ( | double | r | ) |

Component-wise scalar divide-assignment

## ◆ operator*=() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

DERIVED & operator*= | ( | double | r | ) |

Component-wise scalar multiply-assignment

## ◆ operator/=() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

DERIVED & operator/= | ( | double | r | ) |

Component-wise scalar divide-assignment

## ◆ magnitude()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

NormType magnitude | ( |  | ) | const

Calculate magnitude (i.e. 2-norm / Euclidean norm / length).

See also
  squaredMagnitude()

## ◆ squaredMagnitude()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

SquaredNormType squaredMagnitude | ( |  | ) | const

Calculate squared magnitude (i.e. sum of squared elements).

## ◆ minimum()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

VALUETYPE const & minimum | ( |  | ) | const

Return the minimal element.

## ◆ maximum()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

VALUETYPE const & maximum | ( |  | ) | const

Return the maximal element.

## ◆ all()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

bool all | ( |  | ) | const

Check that all elements of this vector are non-zero (or 'true' if T is bool).

## ◆ any()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

bool any | ( |  | ) | const

Check that at least one element of this vector is non-zero (or 'true' if T is bool).

## ◆ operator[]() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

reference operator[] | ( | difference_type | i | ) |

Access component by index.

## ◆ operator[]() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

const_reference operator[] | ( | difference_type | i | ) | const

Get component by index.

## ◆ begin() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

iterator begin | ( |  | ) |

Get random access iterator to begin of vector.

## ◆ end() [1/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

iterator end | ( |  | ) |

Get random access iterator past-the-end of vector.

## ◆ begin() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

const_iterator begin | ( |  | ) | const

Get const random access iterator to begin of vector.

## ◆ end() [2/2]

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

const_iterator end | ( |  | ) | const

Get const random access iterator past-the-end of vector.

## ◆ cbegin()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

const_iterator cbegin | ( |  | ) | const

Get const random access iterator to begin of vector.

## ◆ cend()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

const_iterator cend | ( |  | ) | const

Get const random access iterator past-the-end of vector.

## ◆ subarray()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >
template<int FROM, int TO>

TinyVectorView< VALUETYPE, TO-FROM > subarray | ( |  | ) | const

Get a view to the subarray with length `(TO-FROM)` starting at `FROM`. The bounds must fullfill `0 <= FROM < TO <= SIZE`, but this is only checked when `VIGRA_CHECK_BOUNDS` is #define'd.

Examples
  composite.cxx, dissolve.cxx, smooth_explicitly.cxx, and subimage_tutorial.cxx.

## ◆ size()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

size_type size | ( |  | ) | const

Size of TinyVector vector always equals the template parameter SIZE.

Examples
  graph_agglomerative_clustering.cxx, smooth_explicitly.cxx, and transpose.cxx.

## ◆ linearSequence()

template<class VALUETYPE , int SIZE, class DATA , class DERIVED >

static TinyVector< VALUETYPE, SIZE > linearSequence | ( | VALUETYPE | start = `VALUETYPE()`,
|  | VALUETYPE | step = `VALUETYPE(1)`
| ) |  |

static

Factory function for a linear sequence.

The result will be initialized as `res[k] = start + k*step`.

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

- vigra/tinyvector.hxx

© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de) Heidelberg Collaboratory for Image Processing, University of Heidelberg, Germany | html generated using doxygen and Python vigra 1.12.1