The Interval class represents a range of real numbers. Intervals may be open (a, b), left-closed [a, b), right-closed (a, b], or fully closed [a, b]. More...

#include <gz/math/Interval.hh>

Public Member Functions
	Interval ()=default
	Constructor.

constexpr	Interval (T _leftValue, bool _leftClosed, T _rightValue, bool _rightClosed)
	Constructor.

bool	Contains (const Interval< T > &_other) const
	Check if the interval contains `_other` interval.

bool	Contains (const T &_value) const
	Check if the interval contains `_value`

bool	Empty () const
	Check if the interval is empty Some examples of empty intervals include (a, a), [a, a), and [a + 1, a].

bool	Intersects (const Interval< T > &_other) const
	Check if the interval intersects `_other` interval.

bool	IsLeftClosed () const
	Check if the interval is left-closed.

bool	IsRightClosed () const
	Check if the interval is right-closed.

const T &	LeftValue () const
	Get the leftmost interval value.

bool	operator!= (const Interval< T > &_other) const
	Inequality test operator.

bool	operator== (const Interval< T > &_other) const
	Equality test operator.

const T &	RightValue () const
	Get the rightmost interval value.

Static Public Member Functions
static constexpr Interval< T >	Closed (T _leftValue, T _rightValue)
	Make a closed interval [`_leftValue`, `_rightValue`].

static constexpr Interval< T >	LeftClosed (T _leftValue, T _rightValue)
	Make a left-closed interval [`_leftValue`, `_rightValue`)

static constexpr Interval< T >	Open (T _leftValue, T _rightValue)
	Make an open interval (`_leftValue`, `_rightValue`)

static constexpr Interval< T >	RightClosed (T _leftValue, T _rightValue)
	Make a right-closed interval (`_leftValue`, `_rightValue`].

Static Public Attributes
static const Interval< T > &	Unbounded = detail::gUnboundedInterval<T>
	An unbounded interval (-∞, ∞)

Detailed Description

template<typename T>
class gz::math::Interval< T >

The Interval class represents a range of real numbers. Intervals may be open (a, b), left-closed [a, b), right-closed (a, b], or fully closed [a, b].

Example

#include <iostream>
#include <gz/math/Interval.hh>
 
int main(int argc, char **argv)
{
  std::cout << std::boolalpha;
 
  const gz::math::Intervald defaultInterval;
  // A default constructed interval should be empty.
  std::cout << "The " << defaultInterval << " interval is empty: "
            << defaultInterval.Empty() << std::endl;
 
  const gz::math::Intervald openInterval =
      gz::math::Intervald::Open(-1., 1.);
  // An open interval should exclude its endpoints.
  std::cout << "The " << openInterval << " interval contains its endpoints: "
            << (openInterval.Contains(openInterval.LeftValue()) ||
                openInterval.Contains(openInterval.RightValue()))
            << std::endl;
 
  const gz::math::Intervald closedInterval =
      gz::math::Intervald::Closed(0., 1.);
 
  // A closed interval should include its endpoints.
  std::cout << "The " << closedInterval << " interval contains its endpoints: "
            << (closedInterval.Contains(closedInterval.LeftValue()) ||
                closedInterval.Contains(closedInterval.RightValue()))
            << std::endl;
 
  // Closed and open intervals may intersect.
  std::cout << "Intervals " << closedInterval << " and " << openInterval
            << " intersect: " << closedInterval.Intersects(openInterval)
            << std::endl;
 
  // The unbounded interval should include all non-empty intervals.
  std::cout << "The " << gz::math::Intervald::Unbounded
            << " interval contains all previous non-empty intervals: "
            << (gz::math::Intervald::Unbounded.Contains(openInterval) ||
                gz::math::Intervald::Unbounded.Contains(closedInterval))
            << std::endl;
 
}

Constructor & Destructor Documentation

◆ Interval() [1/2]

template<typename T >

Interval ( )

default

Constructor.

◆ Interval() [2/2]

template<typename T >

constexpr Interval	(	T	_leftValue,
		bool	_leftClosed,
		T	_rightValue,
		bool	_rightClosed
	)

inlineconstexpr

Constructor.

Parameters

[in]	_leftValue	leftmost interval value
[in]	_leftClosed	whether the interval is left-closed or not
[in]	_rightValue	rightmost interval value
[in]	_rightClosed	whether the interval is right-closed or not

Member Function Documentation

◆ Closed()

template<typename T >

static constexpr Interval< T > Closed	(	T	_leftValue,
		T	_rightValue
	)

inlinestaticconstexpr

Make a closed interval [_leftValue, _rightValue].

Parameters

[in]	_leftValue	leftmost interval value
[in]	_rightValue	rightmost interval value

Returns: the closed interval

References std::move().

◆ Contains() [1/2]

template<typename T >

bool Contains ( const Interval< T > & _other ) const

inline

Check if the interval contains _other interval.

Parameters

[in] _other interval to check for membership

Returns: true if it is contained, false otherwise

References Interval< T >::Empty().

◆ Contains() [2/2]

template<typename T >

bool Contains ( const T & _value ) const

inline

Check if the interval contains _value

Parameters

[in] _value value to check for membership

Returns: true if it is contained, false otherwise

Referenced by Interval< T >::operator!=(), and Interval< T >::operator==().

◆ Empty()

template<typename T >

bool Empty ( ) const

inline

Check if the interval is empty Some examples of empty intervals include (a, a), [a, a), and [a + 1, a].

Returns: true if it is empty, false otherwise

Referenced by Interval< T >::Contains(), and Interval< T >::Intersects().

◆ Intersects()

template<typename T >

bool Intersects ( const Interval< T > & _other ) const

inline

Check if the interval intersects _other interval.

Parameters

[in] _other interval to check for intersection

Returns: true if both intervals intersect, false otherwise

References Interval< T >::Empty().

◆ IsLeftClosed()

template<typename T >

bool IsLeftClosed ( ) const

inline

Check if the interval is left-closed.

Returns: true if the interval is left-closed, false otherwise

◆ IsRightClosed()

template<typename T >

bool IsRightClosed ( ) const

inline

Check if the interval is right-closed.

Returns: true if the interval is right-closed, false otherwise

◆ LeftClosed()

template<typename T >

static constexpr Interval< T > LeftClosed	(	T	_leftValue,
		T	_rightValue
	)

inlinestaticconstexpr

Make a left-closed interval [_leftValue, _rightValue)

Parameters

[in]	_leftValue	leftmost interval value
[in]	_rightValue	rightmost interval value

Returns: the left-closed interval

References std::move().

◆ LeftValue()

template<typename T >

const T & LeftValue ( ) const

inline

Get the leftmost interval value.

Returns: the leftmost interval value

◆ Open()

template<typename T >

static constexpr Interval< T > Open	(	T	_leftValue,
		T	_rightValue
	)

inlinestaticconstexpr

Make an open interval (_leftValue, _rightValue)

Parameters

[in]	_leftValue	leftmost interval value
[in]	_rightValue	rightmost interval value

Returns: the open interval

References std::move().

◆ operator!=()

template<typename T >

bool operator!= ( const Interval< T > & _other ) const

inline

Inequality test operator.

Parameters

_other interval to check for inequality

Returns: true if intervals are unequal, false otherwise

References Interval< T >::Contains().

◆ operator==()

template<typename T >

bool operator== ( const Interval< T > & _other ) const

inline

Equality test operator.

Parameters

_other interval to check for equality

Returns: true if intervals are equal, false otherwise

References Interval< T >::Contains().

◆ RightClosed()

template<typename T >

static constexpr Interval< T > RightClosed	(	T	_leftValue,
		T	_rightValue
	)

inlinestaticconstexpr

Make a right-closed interval (_leftValue, _rightValue].

Parameters

[in]	_leftValue	leftmost interval value
[in]	_rightValue	rightmost interval value

Returns: the left-closed interval

References std::move().

◆ RightValue()

template<typename T >

const T & RightValue ( ) const

inline

Get the rightmost interval value.

Returns: the rightmost interval value

Member Data Documentation

◆ Unbounded

template<typename T >

const Interval< T > & Unbounded = detail::gUnboundedInterval<T>

static

An unbounded interval (-∞, ∞)

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

Interval.hh

Gazebo Math

API Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Example

Constructor & Destructor Documentation

◆ Interval() [1/2]

◆ Interval() [2/2]

Member Function Documentation

◆ Closed()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ Empty()

◆ Intersects()

◆ IsLeftClosed()

◆ IsRightClosed()

◆ LeftClosed()

◆ LeftValue()

◆ Open()

◆ operator!=()

◆ operator==()

◆ RightClosed()

◆ RightValue()

Member Data Documentation

◆ Unbounded