A basic mathematical interval class. More...

#include <interval.h>

Public Member Functions
bool	operator== (const GfInterval &rhs) const
	Equality operator.

bool	operator!= (const GfInterval &rhs) const
	Inequality operator.

bool	operator< (const GfInterval &rhs) const
	Less-than operator.

size_t	Hash () const
	Hash value.

double	GetMin () const
	Minimum value.

double	GetMax () const
	Maximum value.

void	SetMin (double v)
	Set minimum value.

void	SetMin (double v, bool minClosed)
	Set minimum value and boundary condition.

void	SetMax (double v)
	Set maximum value.

void	SetMax (double v, bool maxClosed)
	Set maximum value and boundary condition.

bool	IsMinClosed () const
	Minimum boundary condition.

bool	IsMaxClosed () const
	Maximum boundary condition.

bool	IsMinOpen () const
	Minimum boundary condition.

bool	IsMaxOpen () const
	Maximum boundary condition.

bool	IsMaxFinite () const
	Returns true if the maximum value is finite.

bool	IsMinFinite () const
	Returns true if the minimum value is finite.

bool	IsFinite () const
	Returns true if both the maximum and minimum value are finite.

bool	IsEmpty () const
	Return true iff the interval is empty.

double	GetSize () const
	Width of the interval.

double	Size () const

bool	Contains (double d) const
	Return true iff the value d is contained in the interval.

bool	In (double d) const

bool	Contains (const GfInterval &i) const
	Return true iff the interval i is entirely contained in the interval.

bool	Intersects (const GfInterval &i) const
	Return true iff the given interval i intersects this interval.

Constructors
	GfInterval ()
	Construct an empty open interval, (0,0).

	GfInterval (double val)
	Construct a closed interval representing the single point, as [val,val].

	GfInterval (double min, double max, bool minClosed=true, bool maxClosed=true)
	Construct an interval with the given arguments.

Math operations
GfInterval &	operator&= (const GfInterval &rhs)
	Boolean intersection.

GfInterval &	operator\|= (const GfInterval &rhs)
	Returns the interval that bounds the union of this interval and rhs.

GfInterval &	operator+= (const GfInterval &rhs)
	Interval addition.

GfInterval &	operator-= (const GfInterval &rhs)
	Interval subtraction.

GfInterval	operator- () const
	Interval unary minus.

GfInterval &	operator*= (const GfInterval &rhs)
	Interval multiplication.

bool	operator> (const GfInterval &rhs)
	Greater than operator.

bool	operator<= (const GfInterval &rhs)
	Less than or equal operator.

bool	operator>= (const GfInterval &rhs)
	Greater than or equal operator.

GfInterval	operator\| (const GfInterval &rhs) const
	Union operator.

GfInterval	operator& (const GfInterval &rhs) const
	Intersection operator.

GfInterval	operator+ (const GfInterval &rhs) const
	Addition operator.

GfInterval	operator- (const GfInterval &rhs) const
	Subtraction operator.

GfInterval	operator* (const GfInterval &rhs) const
	Multiplication operator.

Static Public Member Functions
static GfInterval	GetFullInterval ()
	Returns the full interval (-inf, inf).

Friends
size_t	hash_value (GfInterval const &i)

Detailed Description

A basic mathematical interval class.

Can represent intervals with either open or closed boundary conditions.

Definition at line 32 of file interval.h.

Constructor & Destructor Documentation

◆ GfInterval() [1/3]

GfInterval ( )

inline

Construct an empty open interval, (0,0).

Definition at line 39 of file interval.h.

◆ GfInterval() [2/3]

GfInterval ( double val )

inline

Construct a closed interval representing the single point, as [val,val].

Definition at line 45 of file interval.h.

◆ GfInterval() [3/3]

GfInterval	(	double	min,
		double	max,
		bool	minClosed = `true`,
		bool	maxClosed = `true`
	)

inline

Construct an interval with the given arguments.

Definition at line 51 of file interval.h.

Member Function Documentation

◆ Contains() [1/2]

bool Contains ( const GfInterval & i ) const

inline

Return true iff the interval i is entirely contained in the interval.

An empty interval contains no intervals, not even other empty intervals.

Definition at line 175 of file interval.h.

◆ Contains() [2/2]

bool Contains ( double d ) const

inline

Return true iff the value d is contained in the interval.

An empty interval contains no values.

Definition at line 164 of file interval.h.

◆ GetFullInterval()

static GfInterval GetFullInterval ( )

inlinestatic

Returns the full interval (-inf, inf).

Definition at line 325 of file interval.h.

◆ GetMax()

double GetMax ( ) const

inline

Maximum value.

Definition at line 95 of file interval.h.

◆ GetMin()

double GetMin ( ) const

inline

Minimum value.

Definition at line 92 of file interval.h.

◆ GetSize()

double GetSize ( ) const

inline

Width of the interval.

An empty interval has size 0.

Definition at line 155 of file interval.h.

◆ Hash()

size_t Hash ( ) const

inline

Hash value.

Just a basic hash function, not particularly high quality.

Definition at line 85 of file interval.h.

◆ In()

bool In ( double d ) const

inline

Definition at line 170 of file interval.h.

◆ Intersects()

bool Intersects ( const GfInterval & i ) const

inline

Return true iff the given interval i intersects this interval.

Definition at line 180 of file interval.h.

◆ IsEmpty()

bool IsEmpty ( ) const

inline

Return true iff the interval is empty.

Definition at line 147 of file interval.h.

◆ IsFinite()

bool IsFinite ( ) const

inline

Returns true if both the maximum and minimum value are finite.

Definition at line 142 of file interval.h.

◆ IsMaxClosed()

bool IsMaxClosed ( ) const

inline

Maximum boundary condition.

Definition at line 121 of file interval.h.

◆ IsMaxFinite()

bool IsMaxFinite ( ) const

inline

Returns true if the maximum value is finite.

Definition at line 130 of file interval.h.

◆ IsMaxOpen()

bool IsMaxOpen ( ) const

inline

Maximum boundary condition.

Definition at line 127 of file interval.h.

◆ IsMinClosed()

bool IsMinClosed ( ) const

inline

Minimum boundary condition.

Definition at line 118 of file interval.h.

◆ IsMinFinite()

bool IsMinFinite ( ) const

inline

Returns true if the minimum value is finite.

Definition at line 136 of file interval.h.

◆ IsMinOpen()

bool IsMinOpen ( ) const

inline

Minimum boundary condition.

Definition at line 124 of file interval.h.

◆ operator!=()

bool operator!= ( const GfInterval & rhs ) const

inline

Inequality operator.

Definition at line 65 of file interval.h.

◆ operator&()

GfInterval operator& ( const GfInterval & rhs ) const

inline

Intersection operator.

Definition at line 291 of file interval.h.

◆ operator&=()

GfInterval & operator&= ( const GfInterval & rhs )

inline

Boolean intersection.

Definition at line 188 of file interval.h.

◆ operator*()

GfInterval operator* ( const GfInterval & rhs ) const

inline

Multiplication operator.

Definition at line 315 of file interval.h.

◆ operator*=()

GfInterval & operator*= ( const GfInterval & rhs )

inline

Interval multiplication.

Definition at line 254 of file interval.h.

◆ operator+()

GfInterval operator+ ( const GfInterval & rhs ) const

inline

Addition operator.

Definition at line 299 of file interval.h.

◆ operator+=()

GfInterval & operator+= ( const GfInterval & rhs )

inline

Interval addition.

Definition at line 233 of file interval.h.

◆ operator-() [1/2]

GfInterval operator- ( ) const

inline

Interval unary minus.

Definition at line 249 of file interval.h.

◆ operator-() [2/2]

GfInterval operator- ( const GfInterval & rhs ) const

inline

Subtraction operator.

Definition at line 307 of file interval.h.

◆ operator-=()

GfInterval & operator-= ( const GfInterval & rhs )

inline

Interval subtraction.

Definition at line 244 of file interval.h.

◆ operator<()

bool operator< ( const GfInterval & rhs ) const

inline

Less-than operator.

Definition at line 70 of file interval.h.

◆ operator<=()

bool operator<= ( const GfInterval & rhs )

inline

Less than or equal operator.

Definition at line 271 of file interval.h.

◆ operator==()

bool operator== ( const GfInterval & rhs ) const

inline

Equality operator.

Definition at line 60 of file interval.h.

◆ operator>()

bool operator> ( const GfInterval & rhs )

inline

Greater than operator.

Definition at line 265 of file interval.h.

◆ operator>=()

bool operator>= ( const GfInterval & rhs )

inline

Greater than or equal operator.

Definition at line 277 of file interval.h.

◆ operator|()

GfInterval operator| ( const GfInterval & rhs ) const

inline

Union operator.

Definition at line 283 of file interval.h.

◆ operator|=()

GfInterval & operator|= ( const GfInterval & rhs )

inline

Returns the interval that bounds the union of this interval and rhs.

Definition at line 211 of file interval.h.

◆ SetMax() [1/2]

void SetMax ( double v )

inline

Set maximum value.

Definition at line 108 of file interval.h.

◆ SetMax() [2/2]

void SetMax	(	double	v,
		bool	maxClosed
	)

inline

Set maximum value and boundary condition.

Definition at line 113 of file interval.h.

◆ SetMin() [1/2]

void SetMin ( double v )

inline

Set minimum value.

Definition at line 98 of file interval.h.

◆ SetMin() [2/2]

void SetMin	(	double	v,
		bool	minClosed
	)

inline

Set minimum value and boundary condition.

Definition at line 103 of file interval.h.

◆ Size()

double Size ( ) const

inline

Definition at line 160 of file interval.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( GfInterval const & i )

friend

Definition at line 87 of file interval.h.

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

pxr/base/gf/interval.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GfInterval() [1/3]

◆ GfInterval() [2/3]

◆ GfInterval() [3/3]

Member Function Documentation

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ GetFullInterval()

◆ GetMax()

◆ GetMin()

◆ GetSize()

◆ Hash()

◆ In()

◆ Intersects()

◆ IsEmpty()

◆ IsFinite()

◆ IsMaxClosed()

◆ IsMaxFinite()

◆ IsMaxOpen()

◆ IsMinClosed()

◆ IsMinFinite()

◆ IsMinOpen()

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator|()

◆ operator|=()

◆ SetMax() [1/2]

◆ SetMax() [2/2]

◆ SetMin() [1/2]

◆ SetMin() [2/2]

◆ Size()

Friends And Related Function Documentation

◆ hash_value