icl::core::DataSegment< T, 1 > Struct Template Reference

template specialization for data-segments, where each entry is just 1D More...

#include <DataSegment.h>

Inheritance diagram for icl::core::DataSegment< T, 1 >:

List of all members.

Public Types
typedef T	VectorType
	vector typedef
Public Member Functions
	DataSegment (T *data=0, size_t stride=0, size_t numElements=0, icl32s organizedWidth=-1)
	Constructor (basically passes all parameters to the Base class)
T &	operator[] (int idx)
	linear index operator (specialized to return a T& directly)
const T &	operator[] (int idx) const
	linear index operator (specialized to return a T& directly, const)
T &	operator() (int x, int y)
	2D-index operator (only for organized data segments, specialized to return a T& directly)
const T &	operator() (int x, int y) const
	2D-index operator (only for organized data segments, specialized to return a T& directly, const)
template<class OtherT >
void	deepCopy (DataSegment< OtherT, 1 > dst) const throw (utils::ICLException)
	copies the data segment to into another element-wise
template<class OtherT >
bool	equals (DataSegment< OtherT, 1 > dst, float tollerance=1.0e-5) const
template<class Fill >
void	fillScalar (Fill scalarValue)
	fills each scalar value of each entry with given value
template<class Fill >
void	fill (Fill vecValue)
	fills each vector entry with given value

---

Detailed Description

template<class T>
struct icl::core::DataSegment< T, 1 >

template specialization for data-segments, where each entry is just 1D

If the vector entries are 1D only, no extra vector struct is created and returned for the single vector elements. Instead, all access functions operator[idx] and operator(x,y) are will just return T-references instead of math::FixedColVector<T,1>

---

Member Typedef Documentation

template<class T >

typedef T icl::core::DataSegment< T, 1 >::VectorType

vector typedef

---

Constructor & Destructor Documentation

template<class T >

icl::core::DataSegment< T, 1 >::DataSegment	(	T *	data = 0,
		size_t	stride = 0,
		size_t	numElements = 0,
		icl32s	organizedWidth = -1
	)		[inline]

Constructor (basically passes all parameters to the Base class)

---

Member Function Documentation

template<class T >

template<class OtherT >

void icl::core::DataSegment< T, 1 >::deepCopy

(

DataSegment< OtherT, 1 >

dst

)

const throw (utils::ICLException) [inline]

copies the data segment to into another element-wise

template<class T >

template<class OtherT >

bool icl::core::DataSegment< T, 1 >::equals	(	DataSegment< OtherT, 1 >	dst,
		float	tollerance = 1.0e-5
	)		const [inline]

template<class T >

template<class Fill >

void icl::core::DataSegment< T, 1 >::fill

(

Fill

vecValue

)

[inline]

fills each vector entry with given value

template<class T >

template<class Fill >

void icl::core::DataSegment< T, 1 >::fillScalar

(

Fill

scalarValue

)

[inline]

fills each scalar value of each entry with given value

equal to fill in this specialization

template<class T >

T& icl::core::DataSegment< T, 1 >::operator()	(	int	x,
		int	y
	)		[inline]

2D-index operator (only for organized data segments, specialized to return a T& directly)

Reimplemented from icl::core::DataSegmentBase.

template<class T >

const T& icl::core::DataSegment< T, 1 >::operator()	(	int	x,
		int	y
	)		const [inline]

2D-index operator (only for organized data segments, specialized to return a T& directly, const)

Reimplemented from icl::core::DataSegmentBase.

template<class T >

T& icl::core::DataSegment< T, 1 >::operator[]

(

int

idx

)

[inline]

linear index operator (specialized to return a T& directly)

Reimplemented from icl::core::DataSegmentBase.

template<class T >

const T& icl::core::DataSegment< T, 1 >::operator[]

(

int

idx

)

const [inline]

linear index operator (specialized to return a T& directly, const)

Reimplemented from icl::core::DataSegmentBase.

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLCore/src/ICLCore/DataSegment.h