Jpp  16.0.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t > Struct Template Referenceabstract

Type definition of a JHistogramMap based on JGridMap implementation. More...

#include <JHistogramMap_t.hh>

Inheritance diagram for JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t >:
JTOOLS::JHistogramMap< JKey_t, JHistogram_t, JGridMap, JDistance_t > JTOOLS::JGridMap< JKey_t, JHistogram_t, JDistance_t > JTOOLS::JHistogram< JKey_t, JHistogram_t::contents_type > JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > std::vector< JElement_t, JAllocator_t > JTOOLS::JMappableCollection< JKey_t, JValue_t > JTOOLS::JAbstractCollection< JAbscissa_t > JMATH::JMath< JFirst_t, JSecond_t >

Public Types

typedef JGridMap< JKey_t,
JHistogram_t, JDistance_t > 		collection_type
 
typedef JHistogram< JKey_t,
typename
JHistogram_t::contents_type > 		histogram_type
 
typedef
collection_type::abscissa_type 		abscissa_type
 
typedef
collection_type::ordinate_type 		ordinate_type
 
typedef collection_type::value_type value_type
 
typedef
collection_type::const_iterator 		const_iterator
 
typedef
collection_type::const_reverse_iterator 		const_reverse_iterator
 
typedef collection_type::iterator iterator
 
typedef
collection_type::reverse_iterator 		reverse_iterator
 
typedef
histogram_type::contents_type 		contents_type
 
typedef JKey_t key_type
 
typedef JHistogram_t mapped_type
 
typedef collection_type::pair_type pair_type
 
typedef JDistance_t distance_type
 
typedef std::vector< value_type > container_type
 
typedef
JCollectionElementTransformer
< value_type > 		transformer_type
 

Public Member Functions

virtual void evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)
 Fill histogram. More...
 
virtual void evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)=0
 Histogram filling. More...
 
JHistogramMap & mul (typename JLANG::JClass< contents_type >::argument_type factor)
 Scale contents. More...
 
JCollection & mul (const double value)
 Scale contents. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 
JHistogram & mul (const double value)
 Scale histogram. More...
 
JHistogramMap & div (typename JLANG::JClass< contents_type >::argument_type factor)
 Scale contents. More...
 
JCollection & div (const double value)
 Scale contents. More...
 
JHistogram & div (double value)
 Scale histogram. More...
 
int getIndex (typename JClass< abscissa_type >::argument_type x) const
 Get index of given abscissa value. More...
 
const_iterator lower_bound (typename JClass< abscissa_type >::argument_type x) const
 Get first position of element i, where x >= i->getX(). More...
 
iterator lower_bound (typename JClass< abscissa_type >::argument_type x)
 Get first position of element i, where x >= i->getX(). More...
 
virtual void clear () override
 Clear. More...
 
virtual const ordinate_type & get (typename JClass< abscissa_type >::argument_type x) const override
 Get ordinate value. More...
 
virtual ordinate_type & get (typename JClass< abscissa_type >::argument_type x) override
 Get ordinate value. More...
 
virtual const mapped_type & get (typename JClass< key_type >::argument_type key) const =0
 Get mapped value. More...
 
virtual mapped_type & get (typename JClass< key_type >::argument_type key)=0
 Get mapped value. More...
 
virtual int getSize () const override
 Get number of elements. More...
 
virtual abscissa_type getX (int index) const override
 Get abscissa value. More...
 
virtual abscissa_type getXmin () const override
 Get minimal abscissa value. More...
 
virtual abscissa_type getXmax () const override
 Get maximal abscissa value. More...
 
const ordinate_type & getY (int index) const
 Get ordinate value. More...
 
ordinate_type & getY (int index)
 Get ordinate value. More...
 
void transform (const transformer_type &transformer)
 Transform collection. More...
 
void sort ()
 Sort elements. More...
 
pair_type insert (const value_type &element)
 Insert element. More...
 
void configure (const JAbstractCollection< abscissa_type > &bounds)
 Configure collection. More...
 
void configure (const JAbstractCollection< abscissa_type > &bounds, typename JClass< ordinate_type >::argument_type value)
 Configure collection. More...
 
void configure (const JAbstractCollection< abscissa_type > &bounds, const JFunction1D_t &function)
 Configure collection. More...
 
bool is_compatible (const JCollection &collection) const
 Test whether collections are compatible. More...
 
JCollection & negate ()
 Negate collection. More...
 
JCollection & add (const JCollection &collection)
 Add collection. More...
 
JCollection & add (typename JClass< ordinate_type >::argument_type value)
 Add offset. More...
 
JCollection & add (const JFunction1D_t &function)
 Add function. More...
 
JHistogram & add (const JHistogram &histogram)
 Add histogram. More...
 
JCollection & sub (const JCollection &collection)
 Subtract collection. More...
 
JCollection & sub (typename JClass< ordinate_type >::argument_type value)
 Subtract offset. More...
 
JCollection & sub (const JFunction1D_t &function)
 Subtract function. More...
 
JHistogram & sub (const JHistogram &histogram)
 Subtract histogram. More...
 
const JComparator & getComparator () const
 Get comparator. More...
 
const mapped_type & operator[] (typename JClass< key_type >::argument_type key) const
 Get mapped value. More...
 
mapped_type & operator[] (typename JClass< key_type >::argument_type key)
 Get mapped value. More...
 
void put (typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
 Put pair-wise element (key,value) into collection. More...
 
bool is_equal (const JAbstractCollection &collection) const
 Test whether abstract collections are equal. More...
 
void reset ()
 Reset. More...
 
const contents_type & getUnderflow () const
 Get contents below lower limit. More...
 
const contents_type & getOverflow () const
 Get contents above upper limit. More...
 
const contents_type & getIntegral () const
 Get contents above upper limit. More...
 

Public Attributes

JDistance_t getDistance
 Function object for distance evaluation. More...
 

Protected Member Functions

void resize (typename container_type::size_type size)
 Resize collection. More...
 

Protected Attributes

JComparator compare
 Function object for comparison. More...
 
contents_type underflow
 
contents_type overflow
 
contents_type integral
 

Detailed Description

template<class JKey_t, class JHistogram_t, class JDistance_t = JDistance<JKey_t>>
struct JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t >

Type definition of a JHistogramMap based on JGridMap implementation.

Definition at line 34 of file JHistogramMap_t.hh.

Member Typedef Documentation

typedef JGridMap <JKey_t , JHistogram_t , JDistance_t> JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::collection_type
inherited

Definition at line 34 of file JHistogramMap.hh.

typedef JHistogram<JKey_t , typename JHistogram_t ::contents_type> JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::histogram_type
inherited

Definition at line 35 of file JHistogramMap.hh.

typedef collection_type::abscissa_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::abscissa_type
inherited

Definition at line 37 of file JHistogramMap.hh.

typedef collection_type::ordinate_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::ordinate_type
inherited

Definition at line 38 of file JHistogramMap.hh.

typedef collection_type::value_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::value_type
inherited

Definition at line 39 of file JHistogramMap.hh.

typedef collection_type::const_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::const_iterator
inherited

Definition at line 41 of file JHistogramMap.hh.

typedef collection_type::const_reverse_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::const_reverse_iterator
inherited

Definition at line 42 of file JHistogramMap.hh.

typedef collection_type::iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::iterator
inherited

Definition at line 43 of file JHistogramMap.hh.

typedef collection_type::reverse_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::reverse_iterator
inherited

Definition at line 44 of file JHistogramMap.hh.

typedef histogram_type::contents_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::contents_type
inherited

Definition at line 47 of file JHistogramMap.hh.

typedef JKey_t JTOOLS::JGridMap< JKey_t, JHistogram_t , JDistance_t >::key_type
inherited

Definition at line 32 of file JGridMap.hh.

typedef JHistogram_t JTOOLS::JGridMap< JKey_t, JHistogram_t , JDistance_t >::mapped_type
inherited

Definition at line 33 of file JGridMap.hh.

typedef collection_type::pair_type JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::pair_type
inherited

Definition at line 46 of file JGridCollection.hh.

typedef JDistance_t JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::distance_type
inherited

Definition at line 85 of file JCollection.hh.

typedef std::vector<value_type> JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::container_type
inherited

Definition at line 89 of file JCollection.hh.

typedef JCollectionElementTransformer<value_type> JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::transformer_type
inherited

Definition at line 96 of file JCollection.hh.

Member Function Documentation

virtual void JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::evaluate ( const abscissa_type *  pX,
typename JLANG::JClass< contents_type >::argument_type  w 
)
inlinevirtualinherited

Fill histogram.

Parameters
pXpointer to abscissa values
wweight

Definition at line 63 of file JHistogramMap.hh.

65  {
66  const abscissa_type x = *pX;
67 
68  iterator p = this->lower_bound(x);
69 
70  this->integral += w;
71 
72  if (p == this->begin())
73  this->underflow += w;
74  else if (p == this->end())
75  this->overflow += w;
76  else
77  (--p)->getY().evaluate(++pX, w);
78  }
JTOOLS::w
data_type w[N+1][M+1]
Definition: JPolint.hh:757
JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::lower_bound
const_iterator lower_bound(typename JClass< abscissa_type >::argument_type x) const
Get first position of element i, where x &gt;= i-&gt;getX().
Definition: JGridCollection.hh:78
virtual void JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::evaluate ( const abscissa_type *  pX,
typename JLANG::JClass< contents_type >::argument_type  w 
)
pure virtualinherited

Histogram filling.

Parameters
pXpointer to abscissa values
wweight
JHistogramMap& JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::mul ( typename JLANG::JClass< contents_type >::argument_type  factor)
inlineinherited

Scale contents.

Parameters
factormultiplication factor
Returns
this histogram

Definition at line 87 of file JHistogramMap.hh.

88  {
89  collection_type::mul(factor);
90  histogram_type ::mul(factor);
91 
92  return *this;
93  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::mul ( const double  value)
inlineinherited

Scale contents.

Parameters
valuemultiplication factor
Returns
this collection

Definition at line 570 of file JCollection.hh.

571  {
572  for (iterator i = this->begin(); i != this->end(); ++i) {
573  i->getY() *= value;
574  }
575 
576  return *this;
577  }
template<class JFirst_t, class JSecond_t = JNullType>
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 357 of file JMath.hh.

358  {
359  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
360  }
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18
JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::mul ( const double  value)
inlineinherited

Scale histogram.

Parameters
valuemultiplication factor
Returns
this histogram

Definition at line 112 of file JHistogram.hh.

113  {
114  this->underflow *= value;
115  this->overflow *= value;
116  this->integral *= value;
117 
118  return *this;
119  }
JHistogramMap& JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::div ( typename JLANG::JClass< contents_type >::argument_type  factor)
inlineinherited

Scale contents.

Parameters
factordivision factor
Returns
this histogram

Definition at line 102 of file JHistogramMap.hh.

103  {
104  collection_type::div(factor);
105  histogram_type ::div(factor);
106 
107  return *this;
108  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::div ( const double  value)
inlineinherited

Scale contents.

Parameters
valuedivision factor
Returns
this collection

Definition at line 586 of file JCollection.hh.

587  {
588  for (iterator i = this->begin(); i != this->end(); ++i) {
589  i->getY() /= value;
590  }
591 
592  return *this;
593  }
JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::div ( double  value)
inlineinherited

Scale histogram.

Parameters
valuedivision factor
Returns
this histogram

Definition at line 128 of file JHistogram.hh.

129  {
130  this->underflow /= value;
131  this->overflow /= value;
132  this->integral /= value;
133 
134  return *this;
135  }
int JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getIndex ( typename JClass< abscissa_type >::argument_type  x) const
inlineinherited

Get index of given abscissa value.

For values within the range of this collection, the index starts at zero and ends at number of elements minus one. Note that the index could be less than zero or larger than (or equal to) the number of elements, if the given abscissa value is outside the range of this collection.

Parameters
xabscissa value
Returns
index

Definition at line 66 of file JGridCollection.hh.

67  {
68  return (int) ((this->size() - 1) * (x - this->begin()->getX()) / (this->rbegin()->getX() - this->begin()->getX()));
69  }
const_iterator JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x) const
inlineinherited

Get first position of element i, where x >= i->getX().

Parameters
xabscissa value
Returns
position of corresponding element

Definition at line 78 of file JGridCollection.hh.

79  {
80  const int index = getIndex(x) + 1;
81 
82  if (index <= 0)
83  return this->begin();
84  else if (index >= (int) this->size())
85  return this->end();
86  else
87  return this->begin() + index;
88  }
JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getIndex
int getIndex(typename JClass< abscissa_type >::argument_type x) const
Get index of given abscissa value.
Definition: JGridCollection.hh:66
iterator JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x)
inlineinherited

Get first position of element i, where x >= i->getX().

Parameters
xabscissa value
Returns
position of corresponding element

Definition at line 97 of file JGridCollection.hh.

98  {
99  const int index = getIndex(x) + 1;
100 
101  if (index <= 0)
102  return this->begin();
103  else if (index >= (int) this->size())
104  return this->end();
105  else
106  return this->begin() + index;
107  }
JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getIndex
int getIndex(typename JClass< abscissa_type >::argument_type x) const
Get index of given abscissa value.
Definition: JGridCollection.hh:66
virtual void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::clear ( )
inlineoverridevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 150 of file JCollection.hh.

151  {
152  container_type::clear();
153  }
virtual const ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x) const
inlineoverridevirtualinherited

Get ordinate value.

Parameters
xabscissa value
Returns
ordinate value

Definition at line 162 of file JCollection.hh.

163  {
164  const_iterator i = this->lower_bound(x);
165 
166  if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
167  THROW(JValueOutOfRange, "Invalid abscissa value " << x);
168  }
169 
170  return i->getY();
171  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::lower_bound
const_iterator lower_bound(typename JClass< abscissa_type >::argument_type x) const
Get first position of element i, where x &gt;= i-&gt;getX().
Definition: JCollection.hh:294
JLANG::JValueOutOfRange
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:162
virtual ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x)
inlineoverridevirtualinherited

Get ordinate value.

Parameters
xabscissa value
Returns
ordinate value

Definition at line 180 of file JCollection.hh.

181  {
182  iterator i = this->lower_bound(x);
183 
184  if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
185  i = container_type::insert(i, value_type(x, ordinate_type()));
186  }
187 
188  return i->getY();
189  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::lower_bound
const_iterator lower_bound(typename JClass< abscissa_type >::argument_type x) const
Get first position of element i, where x &gt;= i-&gt;getX().
Definition: JCollection.hh:294
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::ordinate_type
JElement2D< JKey_t, JHistogram_t >::ordinate_type ordinate_type
Definition: JCollection.hh:83
template<class JKey_t, class JValue_t>
virtual const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::get ( typename JClass< key_type >::argument_type  key) const
pure virtualinherited

Get mapped value.

Parameters
keykey
Returns
value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleAnalogueSignalProcessor >, JTOOLS::JHashMap< int, int >, JTOOLS::JHashMap< int, function_type >, JTOOLS::JHashMap< int, JGEOMETRY3D::JQuaternion3D >, JTOOLS::JHashMap< JEKey, JEmitter >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JMODEL::JEmitter >, JTOOLS::JHashMap< int, JFloor >, and JTOOLS::JGarbageCollection< JKey_t, JValue_t >.

template<class JKey_t, class JValue_t>
virtual mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::get ( typename JClass< key_type >::argument_type  key)
pure virtualinherited

Get mapped value.

Parameters
keykey
Returns
value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleAnalogueSignalProcessor >, JTOOLS::JHashMap< int, int >, JTOOLS::JHashMap< int, function_type >, JTOOLS::JHashMap< int, JGEOMETRY3D::JQuaternion3D >, JTOOLS::JHashMap< JEKey, JEmitter >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JMODEL::JEmitter >, JTOOLS::JHashMap< int, JFloor >, and JTOOLS::JGarbageCollection< JKey_t, JValue_t >.

virtual int JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getSize ( ) const
inlineoverridevirtualinherited

Get number of elements.

Returns
number of elements

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 197 of file JCollection.hh.

198  {
199  return (int) this->size();
200  }
virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getX ( int  index) const
inlineoverridevirtualinherited

Get abscissa value.

Parameters
indexindex
Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 209 of file JCollection.hh.

210  {
211  return this->at(index).getX();
212  }
virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getXmin ( ) const
inlineoverridevirtualinherited

Get minimal abscissa value.

Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 220 of file JCollection.hh.

221  {
222  return this->begin()->getX();
223  }
virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getXmax ( ) const
inlineoverridevirtualinherited

Get maximal abscissa value.

Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 231 of file JCollection.hh.

232  {
233  return this->rbegin()->getX();
234  }
const ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getY ( int  index) const
inlineinherited

Get ordinate value.

Parameters
indexindex
Returns
ordinate value

Definition at line 244 of file JCollection.hh.

245  {
246  return this->at(index).getY();
247  }
ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getY ( int  index)
inlineinherited

Get ordinate value.

Parameters
indexindex
Returns
ordinate value

Definition at line 256 of file JCollection.hh.

257  {
258  return this->at(index).getY();
259  }
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::transform ( const transformer_type &  transformer)
inlineinherited

Transform collection.

Parameters
transformerelement transformer

Definition at line 267 of file JCollection.hh.

268  {
269  collection_type buffer;
270 
271  this->swap(buffer);
272 
273  for (const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
274  this->insert(transformer(*i));
275  }
276  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::collection_type
JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > collection_type
Definition: JCollection.hh:87
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::insert
pair_type insert(const value_type &element)
Insert element.
Definition: JCollection.hh:318
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sort ( )
inlineinherited

Sort elements.

Definition at line 282 of file JCollection.hh.

283  {
284  std::sort(this->begin(), this->end(), compare);
285  }
pair_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::insert ( const value_type &  element)
inlineinherited

Insert element.

Parameters
elementelement
Returns
(iterator, status), where status is true if inserted; else false

Definition at line 318 of file JCollection.hh.

319  {
320  iterator i = this->lower_bound(element.getX());
321 
322  if (i == this->end() || this->getDistance(element.getX(), i->getX()) > 0.0)
323  return pair_type(container_type::insert(i, element), true);
324  else
325  return pair_type(this->end(), false);
326  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::lower_bound
const_iterator lower_bound(typename JClass< abscissa_type >::argument_type x) const
Get first position of element i, where x &gt;= i-&gt;getX().
Definition: JCollection.hh:294
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds)
inlineinherited

Configure collection.

Parameters
boundsabscissa values

Definition at line 334 of file JCollection.hh.

335  {
336  configure(bounds, JMATH::getZero<ordinate_type>());
337  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::configure
void configure(const JAbstractCollection< abscissa_type > &bounds)
Configure collection.
Definition: JCollection.hh:334
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds,
typename JClass< ordinate_type >::argument_type  value 
)
inlineinherited

Configure collection.

Parameters
boundsabscissa values
valueordinate value

Definition at line 346 of file JCollection.hh.

348  {
349  this->resize(bounds.getSize());
350 
351  for (iterator i = this->begin(); i != this->end(); ++i) {
352 
353  const abscissa_type x = bounds.getX(std::distance(this->begin(),i));
354 
355  *i = value_type(x,value);
356  }
357  }
distance
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
Definition: PhysicsEvent.hh:434
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::resize
void resize(typename container_type::size_type size)
Resize collection.
Definition: JCollection.hh:789
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::abscissa_type
JElement2D< JKey_t, JHistogram_t >::abscissa_type abscissa_type
Definition: JCollection.hh:82
JTOOLS::JAbstractCollection::getX
virtual abscissa_type getX(int index) const =0
Get abscissa value.
JTOOLS::JAbstractCollection::getSize
virtual int getSize() const =0
Get number of elements.
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds,
const JFunction1D_t &  function 
)
inlineinherited

Configure collection.

Parameters
boundsabscissa values
functionfunction

Definition at line 367 of file JCollection.hh.

369  {
370  using namespace JLANG;
371 
372  collection_type* out = (is_identical(*this, function) ? new collection_type() : this);
373 
374  for (int i = 0; i != bounds.getSize(); ++i) {
375 
376  const abscissa_type x = bounds.getX(i);
377 
378  out->put(x, function(x));
379  }
380 
381  if (is_identical(*this, function)) {
382 
383  this->swap(*out);
384 
385  delete out;
386  }
387  }
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::collection_type
JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > collection_type
Definition: JCollection.hh:87
this
then usage $script< detector file >< detectorfile > nIf the range of floors is the first detector file is aligned to the second before the comparison nIn this
Definition: JCompareDetector.sh:31
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::abscissa_type
JElement2D< JKey_t, JHistogram_t >::abscissa_type abscissa_type
Definition: JCollection.hh:82
JLANG::is_identical
bool is_identical(JFirst_t &first, JSecond_t &second)
Check if two objects are indentical.
Definition: JLangToolkit.hh:46
JTOOLS::JAbstractCollection::getX
virtual abscissa_type getX(int index) const =0
Get abscissa value.
JTOOLS::JAbstractCollection::getSize
virtual int getSize() const =0
Get number of elements.
bool JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::is_compatible ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection) const
inlineinherited

Test whether collections are compatible.

Parameters
collectioncollection
Returns
true if collections are compatible; else false

Definition at line 396 of file JCollection.hh.

397  {
398  if (this->empty() || collection.empty()) {
399 
400  return true;
401 
402  } else {
403 
404  const double precision = JDistance<abscissa_type>::precision;
405 
406  const_iterator p = this->begin();
407  const_iterator q = collection.begin();
408 
409  if (getDistance(p->getX(), q->getX()) > precision) {
410 
411  do {
412  ++p;
413  } while (p != this->end() && getDistance(p->getX(), q->getX()) > precision);
414 
415  } else if (getDistance(q->getX(), p->getX()) > precision) {
416 
417  do {
418  ++q;
419  } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision);
420  }
421 
422  for ( ; p != this->end() && q != collection.end(); ++p, ++q) {
423  if (fabs(getDistance(p->getX(), q->getX())) > precision) {
424  return false;
425  }
426  }
427 
428  return true;
429  }
430  }
JTOOLS::JDistance
Template class for distance evaluation.
Definition: JDistance.hh:24
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::negate ( )
inlineinherited

Negate collection.

Returns
this collection

Definition at line 438 of file JCollection.hh.

439  {
440  for (iterator i = this->begin(); i != this->end(); ++i) {
441  i->getY() = -i->getY();
442  }
443 
444  return *this;
445  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection)
inlineinherited

Add collection.

Parameters
collectioncollection
Returns
this collection

Definition at line 454 of file JCollection.hh.

455  {
456  if (!collection.empty()) {
457 
458  if (this->empty()) {
459 
460  for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
461  this->put(i->getX(), +i->getY());
462  }
463 
464  } else if (this->is_compatible(collection)) {
465 
466  const double precision = JDistance<abscissa_type>::precision;
467 
468  iterator p = this->begin();
469  const_iterator q = collection.begin();
470 
471  if (getDistance(p->getX(), q->getX()) > precision) {
472 
473  do {
474  ++p;
475  } while (p != this->end() && getDistance(p->getX(), q->getX()) > precision);
476 
477  } else if (getDistance(q->getX(), p->getX()) > precision) {
478 
479  do {
480  ++q;
481  } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision);
482  }
483 
484  const_iterator i = q;
485 
486  for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
487  p->getY() += i->getY();
488  }
489 
490  for ( ; i != collection.end(); ++i) {
491  this->put(i->getX(), +i->getY());
492  }
493 
494  for (i = collection.begin(); i != q; ++i) {
495  this->put(i->getX(), +i->getY());
496  }
497  }
498  }
499 
500  return *this;
501  }
JTOOLS::JDistance
Template class for distance evaluation.
Definition: JDistance.hh:24
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::is_compatible
bool is_compatible(const JCollection &collection) const
Test whether collections are compatible.
Definition: JCollection.hh:396
JTOOLS::JMappableCollection::put
void put(typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
Put pair-wise element (key,value) into collection.
Definition: JMappableCollection.hh:97
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( typename JClass< ordinate_type >::argument_type  value)
inlineinherited

Add offset.

Parameters
valueoffset
Returns
this collection

Definition at line 602 of file JCollection.hh.

603  {
604  for (iterator i = this->begin(); i != this->end(); ++i) {
605  i->getY() += value;
606  }
607 
608  return *this;
609  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( const JFunction1D_t &  function)
inlineinherited

Add function.

Parameters
functionfunction
Returns
this collection

Definition at line 635 of file JCollection.hh.

636  {
637  for (iterator i = this->begin(); i != this->end(); ++i) {
638  i->getY() += function(i->getX());
639  }
640 
641  return *this;
642  }
JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::add ( const JHistogram< JKey_t, JHistogram_t::contents_type > &  histogram)
inlineinherited

Add histogram.

Parameters
histogramhistogram
Returns
this histogram

Definition at line 80 of file JHistogram.hh.

81  {
82  this->underflow += histogram.underflow;
83  this->overflow += histogram.overflow;
84  this->integral += histogram.integral;
85 
86  return *this;
87  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection)
inlineinherited

Subtract collection.

Parameters
collectioncollection
Returns
this collection

Definition at line 510 of file JCollection.hh.

511  {
512  if (!collection.empty()) {
513 
514  if (this->empty()) {
515 
516  for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
517  this->put(i->getX(), -i->getY());
518  }
519 
520  } else if (this->is_compatible(collection)) {
521 
522  const double precision = JDistance<abscissa_type>::precision;
523 
524  iterator p = this->begin();
525  const_iterator q = collection.begin();
526 
527  if (getDistance(p->getX(), q->getX()) > precision) {
528 
529  do {
530  ++p;
531  } while (p != this->end() && getDistance(p->getX(), q->getX()) > precision);
532 
533  } else if (getDistance(q->getX(), p->getX()) > precision) {
534 
535  do {
536  ++q;
537  } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision);
538  }
539 
540  const_iterator i = q;
541 
542  for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
543  p->getY() -= i->getY();
544  }
545 
546  for ( ; i != collection.end(); ++i) {
547  this->put(i->getX(), -i->getY());
548  }
549 
550  for (i = collection.begin(); i != q; ++i) {
551  this->put(i->getX(), -i->getY());
552  }
553 
554  } else {
555 
556  throw JException("JCollection::add() collections incompatible.");
557  }
558  }
559 
560  return *this;
561  }
JLANG::JException
General exception.
Definition: JException.hh:23
JTOOLS::JDistance
Template class for distance evaluation.
Definition: JDistance.hh:24
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t >::is_compatible
bool is_compatible(const JCollection &collection) const
Test whether collections are compatible.
Definition: JCollection.hh:396
JTOOLS::JMappableCollection::put
void put(typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
Put pair-wise element (key,value) into collection.
Definition: JMappableCollection.hh:97
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( typename JClass< ordinate_type >::argument_type  value)
inlineinherited

Subtract offset.

Parameters
valueoffset
Returns
this collection

Definition at line 618 of file JCollection.hh.

619  {
620  for (iterator i = this->begin(); i != this->end(); ++i) {
621  i->getY() -= value;
622  }
623 
624  return *this;
625  }
JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( const JFunction1D_t &  function)
inlineinherited

Subtract function.

Parameters
functionfunction
Returns
this collection

Definition at line 652 of file JCollection.hh.

653  {
654  for (iterator i = this->begin(); i != this->end(); ++i) {
655  i->getY() -= function(i->getX());
656  }
657 
658  return *this;
659  }
JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::sub ( const JHistogram< JKey_t, JHistogram_t::contents_type > &  histogram)
inlineinherited

Subtract histogram.

Parameters
histogramhistogram
Returns
this histogram

Definition at line 96 of file JHistogram.hh.

97  {
98  this->underflow -= histogram.underflow;
99  this->overflow -= histogram.overflow;
100  this->integral -= histogram.integral;
101 
102  return *this;
103  }
const JComparator& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getComparator ( ) const
inlineinherited

Get comparator.

Returns
comparator

Definition at line 765 of file JCollection.hh.

766  {
767  return compare;
768  }
void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::resize ( typename container_type::size_type  size)
inlineprotectedinherited

Resize collection.

Parameters
sizesize

Definition at line 789 of file JCollection.hh.

790  {
791  container_type::resize(size);
792  }
template<class JKey_t, class JValue_t>
const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type  key) const
inlineinherited

Get mapped value.

Parameters
keykey
Returns
value

Definition at line 73 of file JMappableCollection.hh.

74  {
75  return get(key);
76  }
template<class JKey_t, class JValue_t>
mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type  key)
inlineinherited

Get mapped value.

Parameters
keykey
Returns
value

Definition at line 85 of file JMappableCollection.hh.

86  {
87  return get(key);
88  }
template<class JKey_t, class JValue_t>
void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put ( typename JClass< key_type >::argument_type  key,
typename JClass< mapped_type >::argument_type  value 
)
inlineinherited

Put pair-wise element (key,value) into collection.

Parameters
keykey
valuevalue

Definition at line 97 of file JMappableCollection.hh.

99  {
100  get(key) = value;
101  }
template<class JAbscissa_t>
bool JTOOLS::JAbstractCollection< JAbscissa_t >::is_equal ( const JAbstractCollection< JAbscissa_t > &  collection) const
inlineinherited

Test whether abstract collections are equal.

Parameters
collectionabstract collection
Returns
true if collections are equals; else false

Definition at line 69 of file JAbstractCollection.hh.

70  {
71  if (this->getSize() == collection.getSize()) {
72 
73  for (int i = 0; i != this->getSize(); ++i) {
74 
75  if (this->getX(i) != collection.getX(i)) {
76  return false;
77  }
78  }
79 
80  return true;
81  }
82 
83  return false;
84  }
JTOOLS::JAbstractCollection::getX
virtual abscissa_type getX(int index) const =0
Get abscissa value.
JTOOLS::JAbstractCollection::getSize
virtual int getSize() const =0
Get number of elements.
void JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::reset ( )
inlineinherited

Reset.

Definition at line 56 of file JHistogram.hh.

57  {
58  this->underflow = JMATH::zero;
59  this->overflow = JMATH::zero;
60  this->integral = JMATH::zero;
61  }
JMATH::zero
static const JZero zero
Function object to assign zero value.
Definition: JZero.hh:105
const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getUnderflow ( ) const
inlineinherited

Get contents below lower limit.

Returns
contents

Definition at line 143 of file JHistogram.hh.

144  {
145  return underflow;
146  }
const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getOverflow ( ) const
inlineinherited

Get contents above upper limit.

Returns
contents

Definition at line 154 of file JHistogram.hh.

155  {
156  return overflow;
157  }
const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getIntegral ( ) const
inlineinherited

Get contents above upper limit.

Returns
contents

Definition at line 165 of file JHistogram.hh.

166  {
167  return integral;
168  }

Member Data Documentation

JDistance_t JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getDistance
inherited

Function object for distance evaluation.

Definition at line 774 of file JCollection.hh.

JComparator JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::compare
protectedinherited

Function object for comparison.

Definition at line 781 of file JCollection.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::underflow
protectedinherited

Definition at line 206 of file JHistogram.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::overflow
protectedinherited

Definition at line 207 of file JHistogram.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::integral
protectedinherited

Definition at line 208 of file JHistogram.hh.

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.5