Simple real-valued range.
More...
Simple real-valued range.
It contains an upper and lower bound.
Definition at line 31 of file range.hpp.
mlpack::math::Range::Range |
( |
| ) |
|
|
inline |
The upper bound.
Initialize to an empty set (where lo > hi).
mlpack::math::Range::Range |
( |
const double |
point | ) |
|
|
inline |
mlpack::math::Range::Range |
( |
const double |
lo, |
|
|
const double |
hi |
|
) |
| |
|
inline |
Initializes to specified range.
- Parameters
-
lo | Lower bound of the range. |
hi | Upper bound of the range. |
bool mlpack::math::Range::Contains |
( |
const double |
d | ) |
const |
|
inline |
Determines if a point is contained within the range.
- Parameters
-
Referenced by Hi().
bool mlpack::math::Range::Contains |
( |
const Range & |
r | ) |
const |
|
inline |
Determines if another range overlaps with this one.
- Parameters
-
- Returns
- true if ranges overlap at all.
double mlpack::math::Range::Hi |
( |
| ) |
const |
|
inline |
Get the upper bound.
Definition at line 63 of file range.hpp.
References hi.
double& mlpack::math::Range::Hi |
( |
| ) |
|
|
inline |
Modify the upper bound.
Definition at line 65 of file range.hpp.
References Contains(), hi, Mid(), operator!=(), operator&(), operator&=(), operator*(), operator*=(), operator<(), operator==(), operator>(), operator|(), operator|=(), ToString(), and Width().
double mlpack::math::Range::Lo |
( |
| ) |
const |
|
inline |
Get the lower bound.
Definition at line 58 of file range.hpp.
References lo.
double& mlpack::math::Range::Lo |
( |
| ) |
|
|
inline |
Modify the lower bound.
Definition at line 60 of file range.hpp.
References lo.
double mlpack::math::Range::Mid |
( |
| ) |
const |
|
inline |
Gets the midpoint of this range.
Referenced by Hi().
bool mlpack::math::Range::operator!= |
( |
const Range & |
rhs | ) |
const |
|
inline |
Compare with another range for strict equality.
- Parameters
-
Referenced by Hi().
Range mlpack::math::Range::operator& |
( |
const Range & |
rhs | ) |
const |
|
inline |
Shrinks this range to be the overlap with another range; this makes an empty set if there is no overlap.
- Parameters
-
Referenced by Hi().
Range& mlpack::math::Range::operator&= |
( |
const Range & |
rhs | ) |
|
|
inline |
Shrinks this range to be the overlap with another range; this makes an empty set if there is no overlap.
- Parameters
-
Referenced by Hi().
Range mlpack::math::Range::operator* |
( |
const double |
d | ) |
const |
|
inline |
Scale the bounds by the given double.
- Parameters
-
Referenced by Hi().
Range& mlpack::math::Range::operator*= |
( |
const double |
d | ) |
|
|
inline |
Scale the bounds by the given double.
- Parameters
-
Referenced by Hi().
bool mlpack::math::Range::operator< |
( |
const Range & |
rhs | ) |
const |
|
inline |
Compare with another range.
For Range objects x and y, x < y means that x is strictly less than y and does not overlap at all.
- Parameters
-
Referenced by Hi().
bool mlpack::math::Range::operator== |
( |
const Range & |
rhs | ) |
const |
|
inline |
Compare with another range for strict equality.
- Parameters
-
Referenced by Hi().
bool mlpack::math::Range::operator> |
( |
const Range & |
rhs | ) |
const |
|
inline |
Compare with another range.
For Range objects x and y, x < y means that x is strictly less than y and does not overlap at all.
- Parameters
-
Referenced by Hi().
Range mlpack::math::Range::operator| |
( |
const Range & |
rhs | ) |
const |
|
inline |
Expands this range to include another range.
- Parameters
-
Referenced by Hi().
Range& mlpack::math::Range::operator|= |
( |
const Range & |
rhs | ) |
|
|
inline |
Expands this range to include another range.
- Parameters
-
Referenced by Hi().
std::string mlpack::math::Range::ToString |
( |
| ) |
const |
|
inline |
Returns a string representation of an object.
Referenced by Hi().
double mlpack::math::Range::Width |
( |
| ) |
const |
|
inline |
Gets the span of the range (hi - lo).
Referenced by Hi().
Range operator* |
( |
const double |
d, |
|
|
const Range & |
r |
|
) |
| |
|
friend |
Scale the bounds by the given double.
- Parameters
-
double mlpack::math::Range::hi |
|
private |
The lower bound.
Definition at line 35 of file range.hpp.
Referenced by Hi().
double mlpack::math::Range::lo |
|
private |
The documentation for this class was generated from the following file: