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 <ignition/math/Interval.hh>
Public Member Functions | |
Interval ()=default | |
Constructor. More... | |
constexpr | Interval (T _leftValue, bool _leftClosed, T _rightValue, bool _rightClosed) |
Constructor. More... | |
bool | Contains (const Interval< T > &_other) const |
Check if the interval contains _other interval. More... | |
bool | Contains (const T &_value) const |
Check if the interval contains _value More... | |
bool | Empty () const |
Check if the interval is empty Some examples of empty intervals include (a, a), [a, a), and [a + 1, a]. More... | |
bool | Intersects (const Interval< T > &_other) const |
Check if the interval intersects _other interval. More... | |
bool | IsLeftClosed () const |
Check if the interval is left-closed. More... | |
bool | IsRightClosed () const |
Check if the interval is right-closed. More... | |
const T & | LeftValue () const |
Get the leftmost interval value. More... | |
bool | operator!= (const Interval< T > &_other) const |
Inequality test operator. More... | |
bool | operator== (const Interval< T > &_other) const |
Equality test operator. More... | |
const T & | RightValue () const |
Get the rightmost interval value. More... | |
Static Public Member Functions | |
static constexpr Interval< T > | Closed (T _leftValue, T _rightValue) |
Make a closed interval [_leftValue , _rightValue ]. More... | |
static constexpr Interval< T > | LeftClosed (T _leftValue, T _rightValue) |
Make a left-closed interval [_leftValue , _rightValue ) More... | |
static constexpr Interval< T > | Open (T _leftValue, T _rightValue) |
Make an open interval (_leftValue , _rightValue ) More... | |
static constexpr Interval< T > | RightClosed (T _leftValue, T _rightValue) |
Make a right-closed interval (_leftValue , _rightValue ]. More... | |
Static Public Attributes | |
static const Interval< T > & | Unbounded = detail::gUnboundedInterval<T> |
An unbounded interval (-∞, ∞) More... | |
Detailed Description
template<typename T>
class ignition::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
Constructor & Destructor Documentation
◆ Interval() [1/2]
|
default |
Constructor.
◆ Interval() [2/2]
|
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()
|
inlinestaticconstexpr |
Make a closed interval [_leftValue
, _rightValue
].
- Parameters
-
[in] _leftValue leftmost interval value [in] _rightValue rightmost interval value
- Returns
- the closed interval
◆ Contains() [1/2]
|
inline |
Check if the interval contains _other
interval.
- Parameters
-
[in] _other interval to check for membership
- Returns
- true if it is contained, false otherwise
◆ Contains() [2/2]
|
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 Polynomial3< T >::Minimum(), Interval< ScalarT >::operator!=(), and Interval< ScalarT >::operator==().
◆ Empty()
|
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< ScalarT >::Contains(), Interval< ScalarT >::Intersects(), and Polynomial3< T >::Minimum().
◆ Intersects()
|
inline |
Check if the interval intersects _other
interval.
- Parameters
-
[in] _other interval to check for intersection
- Returns
- true if both intervals intersect, false otherwise
◆ IsLeftClosed()
|
inline |
Check if the interval is left-closed.
- Returns
- true if the interval is left-closed, false otherwise
◆ IsRightClosed()
|
inline |
Check if the interval is right-closed.
- Returns
- true if the interval is right-closed, false otherwise
◆ LeftClosed()
|
inlinestaticconstexpr |
Make a left-closed interval [_leftValue
, _rightValue
)
- Parameters
-
[in] _leftValue leftmost interval value [in] _rightValue rightmost interval value
- Returns
- the left-closed interval
◆ LeftValue()
|
inline |
Get the leftmost interval value.
- Returns
- the leftmost interval value
Referenced by Polynomial3< T >::Minimum().
◆ Open()
|
inlinestaticconstexpr |
Make an open interval (_leftValue
, _rightValue
)
- Parameters
-
[in] _leftValue leftmost interval value [in] _rightValue rightmost interval value
- Returns
- the open interval
◆ operator!=()
|
inline |
Inequality test operator.
- Parameters
-
_other interval to check for inequality
- Returns
- true if intervals are unequal, false otherwise
◆ operator==()
|
inline |
Equality test operator.
- Parameters
-
_other interval to check for equality
- Returns
- true if intervals are equal, false otherwise
◆ RightClosed()
|
inlinestaticconstexpr |
Make a right-closed interval (_leftValue
, _rightValue
].
- Parameters
-
[in] _leftValue leftmost interval value [in] _rightValue rightmost interval value
- Returns
- the left-closed interval
◆ RightValue()
|
inline |
Get the rightmost interval value.
- Returns
- the rightmost interval value
Referenced by Polynomial3< T >::Minimum().
Member Data Documentation
◆ Unbounded
|
static |
An unbounded interval (-∞, ∞)
The documentation for this class was generated from the following file: