Jpp
19.0.0
the software that should make you happy
|
Simple data structure for histogram binning. More...
#include <JAbstractHistogram.hh>
Public Types | |
typedef JAbscissa_t | abscissa_type |
typedef JRange< abscissa_type > | range_type |
typedef std::pair< JAbscissa_t, JAbscissa_t > | pair_type |
typedef JLANG::JClass < JAbscissa_t >::argument_type | argument_type |
typedef JKey_t | key_type |
typedef JValue_t | mapped_type |
Public Member Functions | |
JAbstractHistogram () | |
Default constructor. More... | |
JAbstractHistogram (const int nx, const abscissa_type xmin, const abscissa_type xmax) | |
Constructor. More... | |
JAbstractHistogram (const abscissa_type xmin, const abscissa_type xmax) | |
Constructor. More... | |
int | getNumberOfBins () const |
Get number of bins. More... | |
double | getBinWidth () const |
Get bin width. More... | |
void | setBinWidth (const abscissa_type dx, int option=0) |
Set bin width. More... | |
bool | is_valid () const |
Check validity of histogram binning. More... | |
operator JGrid< abscissa_type > () const | |
Type conversion operator. 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... | |
void | setRange (R first, R second) |
Set range. More... | |
void | setRange (const array_type< JElement_t, JAllocator_t > &buffer) |
Set lower and upper limit according to input data. More... | |
JAbscissa_t | getLowerLimit () const |
Get lower limit. More... | |
JAbscissa_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... | |
JAbscissa_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 | 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... | |
JAbscissa_t | constrain (argument_type x) const |
Constrain value to range. More... | |
JAbscissa_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 JAbscissa_t | getMinimum () |
Get minimum possible value. More... | |
static JAbscissa_t | getMaximum () |
Get maximum possible value. More... | |
static JRange< JAbscissa_t, std::less< JAbscissa_t > > | DEFAULT_RANGE () |
Default range. More... | |
Public Attributes | |
std::less< JAbscissa_t > | compare |
Function object for comparisons. More... | |
JKey_t | first |
JValue_t | second |
Protected Member Functions | |
void | setRange (R first, R second, const JLANG::JBool< false > &option) |
Set range. More... | |
void | setRange (R first, R second, const JLANG::JBool< true > &option) |
Set range. More... | |
Protected Attributes | |
int | number_of_bins |
Friends | |
std::istream & | operator>> (std::istream &in, JAbstractHistogram< JAbscissa_t > &histogram) |
Read histogram from input. More... | |
std::ostream & | operator<< (std::ostream &out, const JAbstractHistogram< JAbscissa_t > &histogram) |
Write histogram to output. More... | |
Simple data structure for histogram binning.
Definition at line 24 of file JAbstractHistogram.hh.
typedef JAbscissa_t JTOOLS::JAbstractHistogram< JAbscissa_t >::abscissa_type |
Definition at line 28 of file JAbstractHistogram.hh.
typedef JRange<abscissa_type> JTOOLS::JAbstractHistogram< JAbscissa_t >::range_type |
Definition at line 29 of file JAbstractHistogram.hh.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inline |
|
inline |
Constructor.
nx | number of bins |
xmin | lower limit |
xmax | upper limit |
Definition at line 48 of file JAbstractHistogram.hh.
|
inline |
Constructor.
xmin | lower limit |
xmax | upper limit |
Definition at line 62 of file JAbstractHistogram.hh.
|
inline |
|
inline |
Get bin width.
Definition at line 85 of file JAbstractHistogram.hh.
|
inline |
Set bin width.
If option < 0
, adjust lower limit; if option > 0
, adjust upper limit; else no adjustments.
dx | bin width |
option | option |
Definition at line 99 of file JAbstractHistogram.hh.
|
inline |
Check validity of histogram binning.
Definition at line 113 of file JAbstractHistogram.hh.
|
inline |
Type conversion operator.
Definition at line 124 of file JAbstractHistogram.hh.
|
inlineinherited |
Type conversion operator.
Definition at line 124 of file JRange.hh.
|
inlineinherited |
Get range.
Definition at line 135 of file JRange.hh.
|
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 |
Get length (difference between upper and lower limit).
Definition at line 289 of file JRange.hh.
|
inlineinherited |
Set length (difference between upper and lower limit).
length | length |
Definition at line 300 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 |
|
friend |
Read histogram from input.
in | input stream |
histogram | histogram |
Definition at line 137 of file JAbstractHistogram.hh.
|
friend |
Write histogram to output.
out | output stream |
histogram | histogram |
Definition at line 150 of file JAbstractHistogram.hh.
|
protected |
Definition at line 156 of file JAbstractHistogram.hh.
|
inherited |
|
inherited |
|
inherited |