agx::IndexRangeT< T > Class Template Reference

A range of indices. More...

#include <IndexRange.h>

Classes
class	iterator
	Index range iterator. More...

Public Types
typedef T	Type

Public Member Functions
	IndexRangeT ()
	IndexRangeT (T start, T end)
T &	begin ()
const T &	begin () const
void	clamp (const IndexRangeT< T > &other)
	Clamp range using another range as limits.
bool	contains (T index) const
bool	empty () const
T &	end ()
const T &	end () const
bool	hasOverlap (const IndexRangeT< agx::UInt32 > &other) const
bool	hasOverlap (const IndexRangeT< agx::UInt64 > &other) const
bool	hasOverlap (const IndexRangeT< T > &other) const
template<typename T2 >
	operator IndexRangeT< T2 > () const
bool	operator!= (const IndexRangeT< T > &other) const
IndexRangeT< T >	operator+ (T rhs) const
IndexRangeT< T > &	operator+= (T rhs)
IndexRangeT< T >	operator- (T rhs) const
IndexRangeT< T > &	operator-= (T rhs)
bool	operator== (const IndexRangeT< T > &other) const
T	operator[] (T localIndex) const
	[]-operator
void	set (T begin, T end)
	Set the range.
T	size () const
bool	valid () const

Detailed Description

template<typename T>
class agx::IndexRangeT< T >

A range of indices.

Definition at line 31 of file IndexRange.h.

Member Typedef Documentation

Type

template<typename T >

typedef T agx::IndexRangeT< T >::Type

Definition at line 35 of file IndexRange.h.

Constructor & Destructor Documentation

IndexRangeT() [1/2]

template<typename T >

agx::IndexRangeT< T >::IndexRangeT

Definition at line 150 of file IndexRange.h.

IndexRangeT() [2/2]

template<typename T >

agx::IndexRangeT< T >::IndexRangeT	(	T	start,
		T	end
	)

Definition at line 153 of file IndexRange.h.

References agxAssert, and agx::IndexRangeT< T >::end().

Member Function Documentation

begin() [1/2]

template<typename T >

T & agx::IndexRangeT< T >::begin

Returns

The beginning of the range.

Definition at line 213 of file IndexRange.h.

Referenced by agxData::AbstractArray::AbstractArray(), agxData::Array< T >::Array(), agx::operator<<(), agxData::EntityRange::operator[](), agxData::Array< T >::slice(), and agxData::AbstractArray::sync().

begin() [2/2]

template<typename T >

const T & agx::IndexRangeT< T >::begin

Definition at line 220 of file IndexRange.h.

clamp()

template<typename T >

void agx::IndexRangeT< T >::clamp

(

const IndexRangeT< T > &

other

)

Clamp range using another range as limits.

Definition at line 199 of file IndexRange.h.

contains()

template<typename T >

bool agx::IndexRangeT< T >::contains

(

T

index

)

const

Returns

True if the range contains a specified index.

Definition at line 173 of file IndexRange.h.

empty()

template<typename T >

bool agx::IndexRangeT< T >::empty

Returns

True if the range is empty.

Definition at line 170 of file IndexRange.h.

end() [1/2]

template<typename T >

T & agx::IndexRangeT< T >::end

Returns

The end of the range.

Definition at line 216 of file IndexRange.h.

Referenced by agxData::AbstractArray::AbstractArray(), agxData::Array< T >::Array(), agx::IndexListRange< T >::IndexListRange(), agx::IndexRangeT< T >::IndexRangeT(), agx::createCell(), agxData::AbstractArray::init(), agx::operator<<(), agxData::EntityRange::operator[](), agxData::AbstractArray::setRange(), agxData::Array< T >::slice(), and agxVehicle::utils::splitNonconsecutive().

end() [2/2]

template<typename T >

const T & agx::IndexRangeT< T >::end

Definition at line 223 of file IndexRange.h.

hasOverlap() [1/3]

bool agx::IndexRangeT< agx::UInt32 >::hasOverlap

(

const IndexRangeT< agx::UInt32 > &

other

)

const

Definition at line 191 of file IndexRange.h.

hasOverlap() [2/3]

bool agx::IndexRangeT< agx::UInt64 >::hasOverlap

(

const IndexRangeT< agx::UInt64 > &

other

)

const

Definition at line 183 of file IndexRange.h.

hasOverlap() [3/3]

template<typename T >

bool agx::IndexRangeT< T >::hasOverlap

(

const IndexRangeT< T > &

other

)

const

Returns

True if the range has overlap with another range.

Definition at line 176 of file IndexRange.h.

References agxAbort.

operator IndexRangeT< T2 >()

template<typename T >

template<typename T2 >

agx::IndexRangeT< T >::operator IndexRangeT< T2 >

Definition at line 156 of file IndexRange.h.

operator!=()

template<typename T >

bool agx::IndexRangeT< T >::operator!=

(

const IndexRangeT< T > &

other

)

const

Definition at line 236 of file IndexRange.h.

operator+()

template<typename T >

IndexRangeT< T > agx::IndexRangeT< T >::operator+

(

T

rhs

)

const

Definition at line 243 of file IndexRange.h.

operator+=()

template<typename T >

IndexRangeT< T > & agx::IndexRangeT< T >::operator+=

(

T

rhs

)

Definition at line 246 of file IndexRange.h.

operator-()

template<typename T >

IndexRangeT< T > agx::IndexRangeT< T >::operator-

(

T

rhs

)

const

Definition at line 249 of file IndexRange.h.

operator-=()

template<typename T >

IndexRangeT< T > & agx::IndexRangeT< T >::operator-=

(

T

rhs

)

Definition at line 252 of file IndexRange.h.

operator==()

template<typename T >

bool agx::IndexRangeT< T >::operator==

(

const IndexRangeT< T > &

other

)

const

Definition at line 230 of file IndexRange.h.

operator[]()

template<typename T >

T agx::IndexRangeT< T >::operator[]

(

T

localIndex

)

const

[]-operator

Definition at line 226 of file IndexRange.h.

set()

template<typename T >

void agx::IndexRangeT< T >::set	(	T	begin,
		T	end
	)

Set the range.

Definition at line 163 of file IndexRange.h.

References agxAssert, agx::begin(), and agx::end().

size()

template<typename T >

T agx::IndexRangeT< T >::size

Returns

The size of the range.

Definition at line 167 of file IndexRange.h.

Referenced by agxData::AbstractArray::AbstractArray(), agxData::AbstractArray::empty(), agx::RangeJob::init(), and agxData::AbstractArray::size().

valid()

template<typename T >

bool agx::IndexRangeT< T >::valid

Returns

false if begin > end

Definition at line 206 of file IndexRange.h.

---

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

• IndexRange.h