Jpp
18.1.0
the software that should make you happy
|
Data structure for range of PMT rates. More...
#include <JPMTRateRange.hh>
Public Types | |
typedef std::pair< T, T > | pair_type |
typedef JRange< T, JComparator_t > | range_type |
typedef JLANG::JClass< T > ::argument_type | argument_type |
typedef T | key_type |
typedef T | mapped_type |
Public Member Functions | |
JPMTRateRange () | |
Default constructor. More... | |
JPMTRateRange (const double Rmin_Hz, const double Rmax_Hz) | |
Constructor. More... | |
operator pair_type () const | |
Type conversion operator. More... | |
const range_type & | getRange () const |
Get range. More... | |
void | setRange (const range_type &range) |
Set range. More... | |
void | setRange (argument_type x, argument_type y) |
Set lower and upper limit. More... | |
template<class R > | |
void | setRange (R first, R second) |
Set range. More... | |
template<class JElement_t , class JAllocator_t > | |
void | setRange (const array_type< JElement_t, JAllocator_t > &buffer) |
Set lower and upper limit according to input data. More... | |
T | getLowerLimit () const |
Get lower limit. More... | |
T | getUpperLimit () const |
Get upper limit. More... | |
void | setLowerLimit (argument_type x) |
Set lower limit. More... | |
void | setUpperLimit (argument_type y) |
Set upper limit. More... | |
void | fixLowerLimit (argument_type x) |
Fix lower limit. More... | |
void | fixUpperLimit (argument_type y) |
Fix upper limit. More... | |
bool | equals (const range_type &range) const |
Equal method. More... | |
T | getLength () const |
Get length (difference between upper and lower limit). More... | |
void | setLength (argument_type length) |
Set length (difference between upper and lower limit). More... | |
bool | is_valid () const |
Check validity of range. More... | |
bool | in_range (argument_type x) const |
Test whether value is inside range. More... | |
bool | operator() (argument_type x) const |
Test whether value is inside range. More... | |
T | constrain (argument_type x) const |
Constrain value to range. More... | |
T | mod (argument_type x) const |
Modulo value with respect to range. More... | |
bool | overlap (const range_type &range) const |
Test overlap with given range. More... | |
range_type & | include (argument_type x) |
Include given value to range. More... | |
range_type & | join (const range_type &range) |
Join ranges. More... | |
range_type & | combine (const range_type &range) |
Combine ranges. More... | |
range_type & | add (argument_type x) |
Add offset. More... | |
range_type & | add (const range_type &range) |
Add offsets. More... | |
range_type & | sub (argument_type x) |
Subtract offset. More... | |
range_type & | sub (const range_type &range) |
Subtract offsets. More... | |
range_type & | mul (const double factor) |
Multiply range. More... | |
JFirst_t & | mul (const JSecond_t &object) |
Multiply with object. More... | |
range_type & | div (const double factor) |
Divide range. More... | |
const key_type & | getKey () const |
const mapped_type & | getValue () const |
mapped_type & | getValue () |
Static Public Member Functions | |
static const JPMTRateRange & | getInstance () |
Get reference to unique instance of this class object. More... | |
static T | getMinimum () |
Get minimum possible value. More... | |
static T | getMaximum () |
Get maximum possible value. More... | |
static JRange< T, JComparator_t > | DEFAULT_RANGE () |
Default range. More... | |
Public Attributes | |
JComparator_t | compare |
Function object for comparisons. More... | |
T | first |
T | second |
Protected Member Functions | |
template<class R > | |
void | setRange (R first, R second, const JLANG::JBool< false > &option) |
Set range. More... | |
template<class R > | |
void | setRange (R first, R second, const JLANG::JBool< true > &option) |
Set range. More... | |
Data structure for range of PMT rates.
Definition at line 22 of file JPMTRateRange.hh.
|
inherited |
|
inherited |
|
inherited |
|
inline |
|
inline |
Constructor.
Rmin_Hz | minimal PMT rate [Hz] |
Rmax_Hz | maximal PMT rate [Hz] |
Definition at line 38 of file JPMTRateRange.hh.
|
inlinestatic |
Get reference to unique instance of this class object.
This method returns an object with default values.
Definition at line 51 of file JPMTRateRange.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Set range.
range | range |
Definition at line 146 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Set range.
The arguments could be values or iterators.
first | first |
second | second |
Definition at line 173 of file JRange.hh.
|
inlineinherited |
Set lower and upper limit according to input data.
buffer | input data |
Definition at line 187 of file JRange.hh.
|
inlineprotectedinherited |
Set range.
first | first |
second | second |
option | false |
Definition at line 576 of file JRange.hh.
|
inlineprotectedinherited |
Set range.
first | first |
second | second |
option | true |
Definition at line 590 of file JRange.hh.
|
inlineinherited |
Get lower limit.
|
inlineinherited |
Get upper limit.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Equal method.
range | range |
Definition at line 275 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Set length (difference between upper and lower limit).
length | length |
Definition at line 300 of file JRange.hh.
|
inlineinherited |
Check validity of range.
Definition at line 311 of file JRange.hh.
|
inlineinherited |
Test whether value is inside range.
x | value |
Definition at line 323 of file JRange.hh.
|
inlineinherited |
Test whether value is inside range.
x | value |
Definition at line 336 of file JRange.hh.
|
inlineinherited |
Constrain value to range.
This method returns the original value if it is in this range, else lower limit if value < lower limit or upper limit if value > upper limit.
x | value |
Definition at line 350 of file JRange.hh.
|
inlineinherited |
Modulo value with respect to range.
x | value |
Definition at line 365 of file JRange.hh.
|
inlineinherited |
Test overlap with given range.
range | range |
Definition at line 382 of file JRange.hh.
|
inlineinherited |
Include given value to range.
The new lower limit is the minimim of the original lower limit and given value and
the new upper limit is the maximum of the original upper limit and given value;
x | value |
Definition at line 397 of file JRange.hh.
|
inlineinherited |
Join ranges.
The new lower limit is the maximim of the two lower limits and
the new upper limit is the minimum of the two upper limits.
This operation results in an equal or smaller range and may result in an unphysical range (i.e. lower limit > upper limit).
range | range |
Definition at line 415 of file JRange.hh.
|
inlineinherited |
Combine ranges.
The new lower limit is the minimim of the two lower limits and
the new upper limit is the maximum of the two upper limits.
This operation results in an equal or larger range.
range | range |
Definition at line 432 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Add offsets.
The new lower limit is the sum of the two lower limits and
the new upper limit is the sum of the two upper limits.
range | offset |
Definition at line 476 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
Subtract offsets.
The new lower limit is the difference of the two lower limits and
the new upper limit is the difference of the two upper limits.
range | offset |
Definition at line 492 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlinestaticinherited |
Default range.
This range corresponds to an unphysical range.
Definition at line 555 of file JRange.hh.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |