A bin index with special values for underflow and overflow bins.
Objects of this type should be passed by value.
Definition at line 22 of file RBinIndex.hxx.
Public Member Functions | |
RBinIndex ()=default | |
Construct an invalid bin index. | |
RBinIndex (std::size_t index) | |
Construct a bin index for a normal bin. | |
std::size_t | GetIndex () const |
Return the index for a normal bin. | |
bool | IsInvalid () const |
bool | IsNormal () const |
A bin index is normal iff it is not one of the special values. | |
bool | IsOverflow () const |
bool | IsUnderflow () const |
RBinIndex | operator+ (std::size_t a) const |
RBinIndex & | operator++ () |
RBinIndex | operator++ (int) |
RBinIndex & | operator+= (std::size_t a) |
RBinIndex | operator- (std::size_t a) const |
RBinIndex & | operator-- () |
RBinIndex | operator-- (int) |
RBinIndex & | operator-= (std::size_t a) |
Static Public Member Functions | |
static RBinIndex | Overflow () |
static RBinIndex | Underflow () |
Private Attributes | |
std::size_t | fIndex = InvalidIndex |
Static Private Attributes | |
static constexpr std::size_t | InvalidIndex = -1 |
static constexpr std::size_t | OverflowIndex = -2 |
static constexpr std::size_t | UnderflowIndex = -3 |
Friends | |
bool | operator!= (RBinIndex lhs, RBinIndex rhs) |
bool | operator< (RBinIndex lhs, RBinIndex rhs) |
bool | operator<= (RBinIndex lhs, RBinIndex rhs) |
bool | operator== (RBinIndex lhs, RBinIndex rhs) |
bool | operator> (RBinIndex lhs, RBinIndex rhs) |
bool | operator>= (RBinIndex lhs, RBinIndex rhs) |
#include <ROOT/RBinIndex.hxx>
|
default |
Construct an invalid bin index.
|
inline |
Construct a bin index for a normal bin.
Definition at line 34 of file RBinIndex.hxx.
|
inline |
Return the index for a normal bin.
Definition at line 37 of file RBinIndex.hxx.
|
inline |
Definition at line 49 of file RBinIndex.hxx.
|
inline |
A bin index is normal iff it is not one of the special values.
Note that a normal bin index may not actually be valid for a given axis if it is outside its range.
Definition at line 46 of file RBinIndex.hxx.
|
inline |
Definition at line 48 of file RBinIndex.hxx.
|
inline |
Definition at line 47 of file RBinIndex.hxx.
|
inline |
Definition at line 67 of file RBinIndex.hxx.
|
inline |
Definition at line 74 of file RBinIndex.hxx.
Definition at line 80 of file RBinIndex.hxx.
|
inline |
Definition at line 51 of file RBinIndex.hxx.
|
inline |
Definition at line 101 of file RBinIndex.hxx.
|
inline |
Definition at line 108 of file RBinIndex.hxx.
Definition at line 114 of file RBinIndex.hxx.
|
inline |
Definition at line 87 of file RBinIndex.hxx.
Definition at line 149 of file RBinIndex.hxx.
Definition at line 142 of file RBinIndex.hxx.
Definition at line 122 of file RBinIndex.hxx.
Definition at line 124 of file RBinIndex.hxx.
Definition at line 131 of file RBinIndex.hxx.
Definition at line 121 of file RBinIndex.hxx.
Definition at line 133 of file RBinIndex.hxx.
Definition at line 140 of file RBinIndex.hxx.
|
private |
Definition at line 27 of file RBinIndex.hxx.
|
staticconstexprprivate |
Definition at line 25 of file RBinIndex.hxx.
|
staticconstexprprivate |
Definition at line 24 of file RBinIndex.hxx.
|
staticconstexprprivate |
Definition at line 23 of file RBinIndex.hxx.