SourcePro® C++ 13.2 |
SourcePro® C++ API Reference Guide |
Product Documentation: SourcePro C++ Documentation Home |
A class template for describing an interval of values. More...
#include <rw/analytics/interval.h>
Public Types | |
enum | Type { open, closed, openClosed, closedOpen } |
Public Member Functions | |
RWInterval () | |
RWInterval (T a, T b, Type t) | |
RWInterval (const RWInterval< T > &i) | |
bool | contains (T x) |
T | lowerBound () const |
RWInterval< T > & | operator= (const RWInterval< T > &rhs) |
void | setBound (T x) |
void | setBounds (T a, T b) |
void | setType (Type t) |
Type | type () const |
T | upperBound () const |
Related Functions | |
(Note that these are not member functions.) | |
template<class T > | |
bool | operator== (const RWInterval< T > &lhs, const RWInterval< T > &rhs) |
RWInterval<T> is a general-purpose class for describing an interval of values. The values in the interval are of type T
. An interval may be considered a set of contiguous values where the interval endpoints are either included or excluded from the set. If an interval's endpoints are excluded, it is said to be open; if the endpoints are included, the interval is said to be closed.
In Linear Algebra Module, the class RWInterval<T> is used to describe confidence intervals for regression predictions and parameter estimates.
The following example prints the linear regression prediction interval for the first pattern in the predictor matrix at a confidence level of 99 percent.
enum RWInterval::Type |
If the left endpoint is a
and the right endpoint is b
, and \(a \leq b\)
then the values of the Type enumeration have the following meanings:
Enumerator | |
---|---|
open |
(a,b) |
closed |
[a,b] |
openClosed |
(a,b] |
closedOpen |
[a,b) |
|
inline |
Constructs an empty interval.
|
inline |
Constructs an interval of type t with endpoints a and b.
|
inline |
Constructs a copy of i.
|
inline |
Returns true
if the interval contains x, otherwise returns false
.
|
inline |
Returns the interval's lower bound.
|
inline |
Sets self equal to rhs.
|
inline |
Sets the interval's upper bound to x if x is greater than the current upper bound. Otherwise, sets the lower bound to x.
|
inline |
Sets the interval's lower bound to the smaller of the two values and the upper bound to the larger of the two values.
|
inline |
Sets the interval's type to t.
|
inline |
Returns the interval's type.
|
inline |
Returns the interval's upper bound.
|
related |
Returns true
if the intervals have the same endpoints and type.
Copyright © 2015 Rogue Wave Software, Inc. All Rights Reserved. |