Jpp
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
JTOOLS::JQuantiles Class Reference

Quantile calculator for a given function. More...

#include <JQuantiles.hh>

Inheritance diagram for JTOOLS::JQuantiles:
JTOOLS::JRange< double > JTOOLS::JPair< double, double > JLANG::JEquals< JFirst_t, JSecond_t > JMATH::JMath< JFirst_t, JSecond_t >

Public Types

typedef JAbstractCollection< double > JAbscissa_t
 
typedef JRange< double, std::less< double > > range_type
 
typedef JLANG::JClass< double >::argument_type argument_type
 
typedef double key_type
 
typedef double mapped_type
 

Public Member Functions

 JQuantiles ()
 Default constructor. More...
 
template<class JFunction1D_t >
 JQuantiles (const JFunction1D_t &f1, const double Q=1.0, const double eps=1.0e-6)
 Constructor. More...
 
template<class JFunction1D_t >
 JQuantiles (const JAbscissa_t &abscissa, const JFunction1D_t &f1, const double Q=1.0, const double eps=1.0e-6)
 Constructor. More...
 
template<class JFunction1D_t >
void set (const JFunction1D_t &f1, const double Q=1.0, const double eps=1.0e-6)
 Set quantiles. More...
 
template<class JFunction1D_t >
void set (const JAbscissa_t &abscissa, const JFunction1D_t &f1, const double Q=1.0, const double eps=1.0e-6)
 Set quantiles. More...
 
double getX () const
 Get position of maximum. More...
 
double getY () const
 Get value of maximum. More...
 
double getFWHM () const
 Get Full Width at Half Maximum. More...
 
double getIntegral () const
 Get integral of function. More...
 
const range_typegetRange () 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 (iterator_type __begin, iterator_type __end, result_type value_type::*member)
 Set lower and upper limit according to minimal and maximal value in input data, respectively. More...
 
void setRange (iterator_type __begin, iterator_type __end, result_type(value_type::*function)() const)
 Set lower and upper limit according to minimal and maximal value in input data, respectively. More...
 
double getLowerLimit () const
 Get lower limit. More...
 
double 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...
 
double getLength () const
 Get length (difference between upper and lower limit). More...
 
bool is_valid () const
 Check validity of range. More...
 
bool operator() (argument_type x) const
 Test whether value is inside range. More...
 
double constrain (argument_type x) const
 Constrain value to range. More...
 
double 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_typejoin (const range_type &range)
 Join ranges. More...
 
range_typecombine (const range_type &range)
 Combine ranges. More...
 
range_typeadd (argument_type x)
 Add offset. More...
 
range_typeadd (const range_type &range)
 Add offsets. More...
 
range_typesub (argument_type x)
 Subtract offset. More...
 
range_typesub (const range_type &range)
 Subtract offsets. More...
 
range_typemul (const double factor)
 Multiply range. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 
range_typediv (const double factor)
 Divide range. More...
 
double getN (const double R) const
 Get expected number of occurances of given rate within this interval. More...
 
const key_typegetKey () const
 
const mapped_typegetValue () const
 
mapped_typegetValue ()
 

Static Public Member Functions

static double getMinimum ()
 Get minimum possible value. More...
 
static double getMaximum ()
 Get maximum possible value. More...
 

Public Attributes

std::less< double > compare
 Function object. More...
 
double first
 
double second
 

Static Public Attributes

static const JRange< double, std::less< double > > DEFAULT_RANGE
 Default range. More...
 

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

double Xmax
 
double Ymax
 
double fwhm
 
double sum
 

Detailed Description

Quantile calculator for a given function.

It is assumed that the function has a single maximum.

Definition at line 106 of file JQuantiles.hh.

Member Typedef Documentation

◆ JAbscissa_t

Definition at line 111 of file JQuantiles.hh.

◆ range_type

typedef JRange<double , std::less<double > > JTOOLS::JRange< double , std::less<double > >::range_type
inherited

Definition at line 41 of file JRange.hh.

◆ argument_type

typedef JLANG::JClass<double >::argument_type JTOOLS::JRange< double , std::less<double > >::argument_type
inherited

Definition at line 42 of file JRange.hh.

◆ key_type

typedef double JTOOLS::JPair< double , double >::key_type
inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

typedef double JTOOLS::JPair< double , double >::mapped_type
inherited

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

◆ JQuantiles() [1/3]

JTOOLS::JQuantiles::JQuantiles ( )
inline

Default constructor.

Definition at line 116 of file JQuantiles.hh.

116  :
117  Xmax(0.0),
118  Ymax(0.0),
119  fwhm(0.0),
120  sum (0.0)
121  {}

◆ JQuantiles() [2/3]

template<class JFunction1D_t >
JTOOLS::JQuantiles::JQuantiles ( const JFunction1D_t &  f1,
const double  Q = 1.0,
const double  eps = 1.0e-6 
)
inline

Constructor.

Parameters
f1functional collection
Qquantile
epsrelative precision

Definition at line 132 of file JQuantiles.hh.

134  :
135  Xmax(0.0),
136  Ymax(0.0),
137  fwhm(0.0),
138  sum (0.0)
139  {
140  set(f1, Q, eps);
141  }

◆ JQuantiles() [3/3]

template<class JFunction1D_t >
JTOOLS::JQuantiles::JQuantiles ( const JAbscissa_t abscissa,
const JFunction1D_t &  f1,
const double  Q = 1.0,
const double  eps = 1.0e-6 
)
inline

Constructor.

Parameters
abscissaabscissa
f1function
Qquantile
epsrelative precision

Definition at line 153 of file JQuantiles.hh.

156  :
157  Xmax(0.0),
158  Ymax(0.0),
159  fwhm(0.0),
160  sum (0.0)
161  {
162  set(abscissa, f1, Q, eps);
163  }

Member Function Documentation

◆ set() [1/2]

template<class JFunction1D_t >
void JTOOLS::JQuantiles::set ( const JFunction1D_t &  f1,
const double  Q = 1.0,
const double  eps = 1.0e-6 
)
inline

Set quantiles.

Parameters
f1functional collection
Qquantile
epsrelative precision

Definition at line 174 of file JQuantiles.hh.

177  {
178  typedef typename JFunction1D_t::const_iterator const_iterator;
179 
180  if (f1.empty()) {
181  throw JEmptyCollection("JQuantiles() no data.");
182  }
183 
184 
185  // maximum
186 
187  const_iterator p = f1.begin();
188 
189  for (const_iterator i = f1.begin(); i != f1.end(); ++i) {
190  if (i->getY() > p->getY()) {
191  p = i;
192  }
193  }
194 
195 
196  // x at maximum
197 
198  Xmax = p->getX();
199 
200  if (p != f1.begin()) {
201 
202  const double xa = (--p)->getX();
203  const double xb = (++p)->getX();
204 
205  if (++p != f1.end()) {
206 
207  const double xc = p->getX();
208 
209  Xmax = search(xa, xb, xc, f1, -1, eps);
210  }
211  }
212 
213  Ymax = get_value(f1(Xmax));
214 
215 
216  // integral & quantile
217 
218  if (Q > 0.0 && Q <= 1.0) {
219 
221 
222  try {
223 
224  sum = makeCDF(f1, buffer);
225 
226  setLowerLimit(buffer(0.5 * (1.0 - Q)));
227  setUpperLimit(buffer(0.5 * (1.0 + Q)));
228  }
229  catch(const JException& error) {
230  sum = 0.0;
231  }
232 
233  } else {
234 
235  sum = JTOOLS::getIntegral(f1);
236 
237  if (Q > 1.0) {
238  setLowerLimit(f1. begin()->getX());
239  setUpperLimit(f1.rbegin()->getX());
240  } else if (Q <= 0.0) {
243  }
244  }
245 
246 
247  // FWHM
248 
249  fwhm = 0.0;
250 
251  for (double xmin = f1.begin()->getX(), xmax = Xmax, v = 0.5*Ymax; ; ) {
252 
253  const double x = 0.5 * (xmin + xmax);
254  const double y = get_value(f1(x));
255 
256  if (fabs(y - v) < eps*v || xmax - xmin < eps) {
257  fwhm -= x;
258  break;
259  }
260 
261  if (y > v)
262  xmax = x;
263  else
264  xmin = x;
265  }
266 
267  for (double xmin = Xmax, xmax = f1.rbegin()->getX(), v = 0.5*Ymax; ; ) {
268 
269  const double x = 0.5 * (xmin + xmax);
270  const double y = get_value(f1(x));
271 
272  if (fabs(y - v) < eps*v || xmax - xmin < eps) {
273  fwhm += x;
274  break;
275  }
276 
277  if (y > v)
278  xmin = x;
279  else
280  xmax = x;
281  }
282  }

◆ set() [2/2]

template<class JFunction1D_t >
void JTOOLS::JQuantiles::set ( const JAbscissa_t abscissa,
const JFunction1D_t &  f1,
const double  Q = 1.0,
const double  eps = 1.0e-6 
)
inline

Set quantiles.

Parameters
abscissaabscissa
f1function
Qquantile
epsrelative precision

Definition at line 294 of file JQuantiles.hh.

298  {
300 
301  buffer.configure(abscissa, f1);
302  buffer.compile();
303 
304  set(buffer, Q, eps);
305  }

◆ getX()

double JTOOLS::JQuantiles::getX ( ) const
inline

Get position of maximum.

Returns
x value at maximum

Definition at line 313 of file JQuantiles.hh.

314  {
315  return Xmax;
316  }

◆ getY()

double JTOOLS::JQuantiles::getY ( ) const
inline

Get value of maximum.

Returns
y value at maximum

Definition at line 324 of file JQuantiles.hh.

325  {
326  return Ymax;
327  }

◆ getFWHM()

double JTOOLS::JQuantiles::getFWHM ( ) const
inline

Get Full Width at Half Maximum.

Returns
FWHM

Definition at line 335 of file JQuantiles.hh.

336  {
337  return fwhm;
338  }

◆ getIntegral()

double JTOOLS::JQuantiles::getIntegral ( ) const
inline

Get integral of function.

Returns
integral

Definition at line 346 of file JQuantiles.hh.

347  {
348  return sum;
349  }

◆ getRange()

const range_type& JTOOLS::JRange< double , std::less<double > >::getRange ( ) const
inlineinherited

Get range.

Returns
range

Definition at line 128 of file JRange.hh.

129  {
130  return static_cast<const range_type&>(*this);
131  }

◆ setRange() [1/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( const range_type range)
inlineinherited

Set range.

Parameters
rangerange

Definition at line 139 of file JRange.hh.

140  {
141  static_cast<range_type&>(*this) = range;
142  }

◆ setRange() [2/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( argument_type  x,
argument_type  y 
)
inlineinherited

Set lower and upper limit.

Parameters
xlower limit
yupper limit

Definition at line 151 of file JRange.hh.

152  {
153  this->first = x;
154  this->second = y;
155  }

◆ setRange() [3/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( first,
second 
)
inlineinherited

Set range.


The arguments could be values or iterators.

Parameters
firstfirst
secondsecond

Definition at line 166 of file JRange.hh.

167  {
168  using namespace JLANG;
169 
171  }

◆ setRange() [4/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( iterator_type  __begin,
iterator_type  __end,
result_type value_type::*  member 
)
inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters
__beginbegin of data
__endend of data
memberpointer to data member

Definition at line 182 of file JRange.hh.

183  {
185 
186  for (iterator_type i = __begin; i != __end; ++i) {
187  include((*i).*member);
188  }
189  }

◆ setRange() [5/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( iterator_type  __begin,
iterator_type  __end,
result_type(value_type::*)() const  function 
)
inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters
__beginbegin of data
__endend of data
functionpointer to member method

Definition at line 200 of file JRange.hh.

201  {
203 
204  for (iterator_type i = __begin; i != __end; ++i) {
205  include(((*i).*function)());
206  }
207  }

◆ setRange() [6/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( first,
second,
const JLANG::JBool< false > &  option 
)
inlineprotectedinherited

Set range.

Parameters
firstfirst
secondsecond
optionfalse

Definition at line 579 of file JRange.hh.

580  {
582  }

◆ setRange() [7/7]

void JTOOLS::JRange< double , std::less<double > >::setRange ( first,
second,
const JLANG::JBool< true > &  option 
)
inlineprotectedinherited

Set range.

Parameters
firstfirst
secondsecond
optiontrue

Definition at line 593 of file JRange.hh.

594  {
596 
597  for (R i = first; i != second; ++i) {
598  include(*i);
599  }
600  }

◆ getLowerLimit()

double JTOOLS::JRange< double , std::less<double > >::getLowerLimit ( ) const
inlineinherited

Get lower limit.

Returns
lower limit

Definition at line 215 of file JRange.hh.

216  {
217  return this->first;
218  }

◆ getUpperLimit()

double JTOOLS::JRange< double , std::less<double > >::getUpperLimit ( ) const
inlineinherited

Get upper limit.

Returns
upper limit

Definition at line 226 of file JRange.hh.

227  {
228  return this->second;
229  }

◆ setLowerLimit()

void JTOOLS::JRange< double , std::less<double > >::setLowerLimit ( argument_type  x)
inlineinherited

Set lower limit.

Parameters
xlower limit

Definition at line 237 of file JRange.hh.

238  {
239  this->first = x;
240  }

◆ setUpperLimit()

void JTOOLS::JRange< double , std::less<double > >::setUpperLimit ( argument_type  y)
inlineinherited

Set upper limit.

Parameters
yupper limit

Definition at line 248 of file JRange.hh.

249  {
250  this->second = y;
251  }

◆ fixLowerLimit()

void JTOOLS::JRange< double , std::less<double > >::fixLowerLimit ( argument_type  x)
inlineinherited

Fix lower limit.

The range is shifted to the given lower limit.

Parameters
xlower limit

Definition at line 261 of file JRange.hh.

262  {
263  this->second += x - this->first;
264  this->first = x;
265  }

◆ fixUpperLimit()

void JTOOLS::JRange< double , std::less<double > >::fixUpperLimit ( argument_type  y)
inlineinherited

Fix upper limit.

The range is shifted to the given upper limit.

Parameters
yupper limit

Definition at line 275 of file JRange.hh.

276  {
277  this->first += y - this->second;
278  this->second = y;
279  }

◆ equals()

bool JTOOLS::JRange< double , std::less<double > >::equals ( const range_type range) const
inlineinherited

Equal method.

Parameters
rangerange
Returns
true if this module range equal to given module range; else false

Definition at line 288 of file JRange.hh.

289  {
290  return (!this->compare(this->getLowerLimit(), range.getLowerLimit()) &&
291  !this->compare(range.getLowerLimit(), this->getLowerLimit()) &&
292  !this->compare(this->getUpperLimit(), range.getUpperLimit()) &&
293  !this->compare(range.getUpperLimit(), this->getUpperLimit()));
294  }

◆ getLength()

double JTOOLS::JRange< double , std::less<double > >::getLength ( ) const
inlineinherited

Get length (difference between upper and lower limit).

Returns
length

Definition at line 302 of file JRange.hh.

303  {
304  return getUpperLimit() - getLowerLimit();
305  }

◆ is_valid()

bool JTOOLS::JRange< double , std::less<double > >::is_valid ( ) const
inlineinherited

Check validity of range.

Returns
true if lower limit less than or equal to upper limit; else false

Definition at line 313 of file JRange.hh.

314  {
315  return !compare(getUpperLimit(), getLowerLimit());
316  }

◆ operator()()

bool JTOOLS::JRange< double , std::less<double > >::operator() ( argument_type  x) const
inlineinherited

Test whether value is inside range.

Parameters
xvalue
Returns
true if lower limit <= value <= upper limit; else false

Definition at line 325 of file JRange.hh.

326  {
327  return (!compare(x, getLowerLimit()) &&
328  !compare(getUpperLimit(), x));
329  }

◆ constrain()

double JTOOLS::JRange< double , std::less<double > >::constrain ( argument_type  x) const
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.

Parameters
xvalue
Returns
lower limit <= x <= upper limit

Definition at line 340 of file JRange.hh.

341  {
342  if (compare(x, getLowerLimit())) { return getLowerLimit(); }
343  if (compare(getUpperLimit(), x)) { return getUpperLimit(); }
344 
345  return x;
346  }

◆ mod()

double JTOOLS::JRange< double , std::less<double > >::mod ( argument_type  x) const
inlineinherited

Modulo value with respect to range.


Parameters
xvalue
Returns
lower limit <= x <= upper limit

Definition at line 355 of file JRange.hh.

356  {
357  if (compare(x, getLowerLimit()))
358  return x + getLength() * floor((getUpperLimit() - x) / getLength());
359  else if (compare(getUpperLimit(), x))
360  return x - getLength() * floor((x - getLowerLimit()) / getLength());
361  else
362  return x;
363  }

◆ overlap()

bool JTOOLS::JRange< double , std::less<double > >::overlap ( const range_type range) const
inlineinherited

Test overlap with given range.


The result is equivalent to join(range).is_valid().

Parameters
rangerange
Returns
true if there is a non-zero overlap; else false

Definition at line 373 of file JRange.hh.

374  {
375  return (compare(getLowerLimit(), range.getUpperLimit()) &&
376  compare(range.getLowerLimit(), getUpperLimit()));
377  }

◆ include()

range_type JTOOLS::JRange< double , std::less<double > >::include ( argument_type  x)
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;

Parameters
xvalue
Returns
range

Definition at line 388 of file JRange.hh.

389  {
390  if (compare(x, getLowerLimit())) { setLowerLimit(x); }
391  if (compare(getUpperLimit(), x)) { setUpperLimit(x); }
392 
393  return *this;
394  }

◆ join()

range_type& JTOOLS::JRange< double , std::less<double > >::join ( const range_type range)
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).

Parameters
rangerange

Definition at line 406 of file JRange.hh.

407  {
408  if (compare(getLowerLimit(), range.getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
409  if (compare(range.getUpperLimit(), getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
410 
411  return *this;
412  }

◆ combine()

range_type& JTOOLS::JRange< double , std::less<double > >::combine ( const range_type range)
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.

Parameters
rangerange

Definition at line 423 of file JRange.hh.

424  {
425  if (compare(range.getLowerLimit(), getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
426  if (compare(getUpperLimit(), range.getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
427 
428  return *this;
429  }

◆ add() [1/2]

range_type& JTOOLS::JRange< double , std::less<double > >::add ( argument_type  x)
inlineinherited

Add offset.

Parameters
xoffset

Definition at line 437 of file JRange.hh.

438  {
439  this->first += x;
440  this->second += x;
441 
442  return *this;
443  }

◆ add() [2/2]

range_type& JTOOLS::JRange< double , std::less<double > >::add ( const range_type range)
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.

Parameters
rangeoffset

Definition at line 467 of file JRange.hh.

468  {
469  this->first += range.getLowerLimit();
470  this->second += range.getUpperLimit();
471 
472  return *this;
473  }

◆ sub() [1/2]

range_type& JTOOLS::JRange< double , std::less<double > >::sub ( argument_type  x)
inlineinherited

Subtract offset.

Parameters
xoffset

Definition at line 451 of file JRange.hh.

452  {
453  this->first -= x;
454  this->second -= x;
455 
456  return *this;
457  }

◆ sub() [2/2]

range_type& JTOOLS::JRange< double , std::less<double > >::sub ( const range_type range)
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.

Parameters
rangeoffset

Definition at line 483 of file JRange.hh.

484  {
485  this->first -= range.getLowerLimit();
486  this->second -= range.getUpperLimit();
487 
488  return *this;
489  }

◆ mul() [1/2]

range_type& JTOOLS::JRange< double , std::less<double > >::mul ( const double  factor)
inlineinherited

Multiply range.

Parameters
factorfactor

Definition at line 497 of file JRange.hh.

498  {
499  this->first *= factor;
500  this->second *= factor;
501 
502  return *this;
503  }

◆ mul() [2/2]

template<class JFirst_t, class JSecond_t>
JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 273 of file JMath.hh.

274  {
275  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
276  }

◆ div()

range_type& JTOOLS::JRange< double , std::less<double > >::div ( const double  factor)
inlineinherited

Divide range.

Parameters
factorfactor

Definition at line 511 of file JRange.hh.

512  {
513  this->first /= factor;
514  this->second /= factor;
515 
516  return *this;
517  }

◆ getN()

double JTOOLS::JRange< double , std::less<double > >::getN ( const double  R) const
inlineinherited

Get expected number of occurances of given rate within this interval.

Parameters
Rrate
Returns
expectation value

Definition at line 526 of file JRange.hh.

527  {
528  return R * (getUpperLimit() - getLowerLimit());
529  }

◆ getMinimum()

static double JTOOLS::JRange< double , std::less<double > >::getMinimum ( )
inlinestaticinherited

Get minimum possible value.

Returns
minimum possible value

Definition at line 537 of file JRange.hh.

538  {
539  return JMATH::JLimits<T>::min();
540  }

◆ getMaximum()

static double JTOOLS::JRange< double , std::less<double > >::getMaximum ( )
inlinestaticinherited

Get maximum possible value.

Returns
maximum possible value

Definition at line 548 of file JRange.hh.

549  {
550  return JMATH::JLimits<T>::max();
551  }

◆ getKey()

const key_type& JTOOLS::JPair< double , double >::getKey ( ) const
inlineinherited

Definition at line 123 of file JPair.hh.

123 { return this->first; }

◆ getValue() [1/2]

const mapped_type& JTOOLS::JPair< double , double >::getValue ( ) const
inlineinherited

Definition at line 124 of file JPair.hh.

124 { return this->second; }

◆ getValue() [2/2]

mapped_type& JTOOLS::JPair< double , double >::getValue ( )
inlineinherited

Definition at line 126 of file JPair.hh.

126 { return this->second; }

Member Data Documentation

◆ Xmax

double JTOOLS::JQuantiles::Xmax
protected

Definition at line 353 of file JQuantiles.hh.

◆ Ymax

double JTOOLS::JQuantiles::Ymax
protected

Definition at line 354 of file JQuantiles.hh.

◆ fwhm

double JTOOLS::JQuantiles::fwhm
protected

Definition at line 355 of file JQuantiles.hh.

◆ sum

double JTOOLS::JQuantiles::sum
protected

Definition at line 356 of file JQuantiles.hh.

◆ DEFAULT_RANGE

const JRange< double , std::less<double > > JTOOLS::JRange< double , std::less<double > >::DEFAULT_RANGE
staticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 558 of file JRange.hh.

◆ compare

std::less<double > JTOOLS::JRange< double , std::less<double > >::compare
inherited

Function object.

Parameters
firstfirst argument
secondsecond argument
Returns
true if first < second; else false

Definition at line 568 of file JRange.hh.

◆ first

double JTOOLS::JPair< double , double >::first
inherited

Definition at line 128 of file JPair.hh.

◆ second

double JTOOLS::JPair< double , double >::second
inherited

Definition at line 129 of file JPair.hh.


The documentation for this class was generated from the following file:
JTOOLS::JRange< double >::getLowerLimit
double getLowerLimit() const
Get lower limit.
Definition: JRange.hh:215
JTOOLS::JRange< double >::include
range_type include(argument_type x)
Include given value to range.
Definition: JRange.hh:388
JTOOLS::JRange< double >::getUpperLimit
double getUpperLimit() const
Get upper limit.
Definition: JRange.hh:226
JTOOLS::JPair< double, double >::first
double first
Definition: JPair.hh:128
JLANG::is_iterator
Data structure to check whether given data type is an iterator.
Definition: JClass.hh:62
JTOOLS::JRange< double >::setRange
void setRange(const range_type &range)
Set range.
Definition: JRange.hh:139
JTOOLS::JRange< double >::getLength
double getLength() const
Get length (difference between upper and lower limit).
Definition: JRange.hh:302
JTOOLS::JQuantiles::sum
double sum
Definition: JQuantiles.hh:356
JTOOLS::JQuantiles::fwhm
double fwhm
Definition: JQuantiles.hh:355
JTOOLS::JQuantiles::set
void set(const JFunction1D_t &f1, const double Q=1.0, const double eps=1.0e-6)
Set quantiles.
Definition: JQuantiles.hh:174
JTOOLS::JRange< double >::getMinimum
static double getMinimum()
Get minimum possible value.
Definition: JRange.hh:537
JTOOLS::JRange< double >::setLowerLimit
void setLowerLimit(argument_type x)
Set lower limit.
Definition: JRange.hh:237
JTOOLS::getIntegral
JContainer_t::ordinate_type getIntegral(const JContainer_t &input)
Get integral of input data points.
Definition: JToolsToolkit.hh:133
JTOOLS::get_value
JResultEvaluator< JResult_t >::result_type get_value(const JResult_t &value)
Helper method to recursively evaluate a to function value.
Definition: JResult.hh:936
JTOOLS::JRange< double >::getMaximum
static double getMaximum()
Get maximum possible value.
Definition: JRange.hh:548
JTOOLS::JSplineFunction1D
Template class for spline interpolation in 1D.
Definition: JSpline.hh:657
JTOOLS::JQuantiles::Xmax
double Xmax
Definition: JQuantiles.hh:353
JTOOLS::JQuantiles::Ymax
double Ymax
Definition: JQuantiles.hh:354
JTOOLS::JRange< double >::setUpperLimit
void setUpperLimit(argument_type y)
Set upper limit.
Definition: JRange.hh:248
JMATH::JLimits::max
TTimeStamp max()
Get maximum possible value.
Definition: JMathSupportkit.hh:33
JTOOLS::JRange< double >::compare
std::less< double > compare
Function object.
Definition: JRange.hh:568
JLANG::JBool
Auxiliary template class for type bool.
Definition: JBool.hh:20
JTOOLS::v
data_type v[N+1][M+1]
Definition: JPolint.hh:707
JTOOLS::JRange< double >::argument_type
JLANG::JClass< double >::argument_type argument_type
Definition: JRange.hh:42
JTOOLS::search
double search(const double xa, const double xb, const double xc, const JFunction1D_t &f, const int is, const double eps=1.0e-6)
Locate maximum or minimun of function.
Definition: JQuantiles.hh:48
JTOOLS::makeCDF
JContainer_t::ordinate_type makeCDF(const JContainer_t &input, JMappableCollection< JKey_t, JValue_t > &output, const typename JContainer_t::ordinate_type eps=JMATH::zero)
Conversion of data points to cumulative probability distribition (CDF).
Definition: JToolsToolkit.hh:51
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18
JTOOLS::JQuantiles::getX
double getX() const
Get position of maximum.
Definition: JQuantiles.hh:313
JTOOLS::JCollection
General purpose class for collection of elements, see: <a href="JTools.PDF";>Collection of elements...
Definition: JCollection.hh:71
JTOOLS::JPair< double, double >::second
double second
Definition: JPair.hh:129
JLANG
Auxiliary classes and methods for language specific functionality.
Definition: JAbstractClass.hh:10
JMATH::JLimits::min
float min()
Get minimum possible value.
Definition: JLimits.hh:96