VisionWorks Toolkit Reference

December 18, 2015 | 1.2 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvxio::Range< T > Struct Template Reference

Detailed Description

template<typename T>
struct nvxio::Range< T >

Range class.

See also
NVXIO APIs

Definition at line 56 of file Range.hpp.

Public Member Functions

bool contains (T x) const
 Determines if the range includes the particular point. More...
 
bool highConstrained () const
 Determines if the range is right-bounded. More...
 
bool lowConstrained () const
 Determines if the range is left-bounded. More...
 

Data Fields

high
 Holds the right bound of the range. More...
 
bool highInclusive
 Holds the flag that determines if the range includes the right bound. More...
 
low
 Holds the left bound of the range. More...
 
bool lowInclusive
 Holds the flag that determines if the range includes the left bound. More...
 

Member Function Documentation

template<typename T >
bool nvxio::Range< T >::lowConstrained ( ) const
inline

Determines if the range is left-bounded.

A range is left-bounded if there is a number that is smaller than all its elements.

Returns
true if the range is left-bounded; otherwise, returns false.

Definition at line 85 of file Range.hpp.

template<typename T >
bool nvxio::Range< T >::highConstrained ( ) const
inline

Determines if the range is right-bounded.

A range is right-bounded if there is a number that is larger than all its elements.

Returns
true if the range is right-bounded; otherwise, returns false.

Definition at line 91 of file Range.hpp.

template<typename T >
bool nvxio::Range< T >::contains ( x) const
inline

Determines if the range includes the particular point.

Returns
true if the range includes the particular poin; otherwise, returns false.

Definition at line 97 of file Range.hpp.

Field Documentation

template<typename T>
T nvxio::Range< T >::low

Holds the left bound of the range.

Definition at line 58 of file Range.hpp.

Referenced by nvxio::operator&().

template<typename T>
T nvxio::Range< T >::high

Holds the right bound of the range.

Definition at line 59 of file Range.hpp.

Referenced by nvxio::operator&().

template<typename T>
bool nvxio::Range< T >::lowInclusive

Holds the flag that determines if the range includes the left bound.

Definition at line 60 of file Range.hpp.

Referenced by nvxio::operator&().

template<typename T>
bool nvxio::Range< T >::highInclusive

Holds the flag that determines if the range includes the right bound.

Definition at line 61 of file Range.hpp.

Referenced by nvxio::operator&().


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