Jpp  15.0.0-rc.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
JTOOLS::JCollection< JElement_t, JDistance_t > Class Template Reference

General purpose class for collection of elements, see: Collection of elements. . More...

#include <JCollection.hh>

Inheritance diagram for JTOOLS::JCollection< JElement_t, JDistance_t >:
std::vector< JElement_t > JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type > JTOOLS::JAbstractCollection< JElement_t::abscissa_type > JMATH::JMath< JFirst_t, JSecond_t > JTOOLS::JGridCollection< JElement_t, JDistance_t > JTOOLS::JMapCollection< JMap >::collection_type< JElement_t, JDistance_t > JTOOLS::JMapCollection< JGridMap >::collection_type< JElement_t, JDistance_t >

Classes

struct  JComparator
 Auxiliary class for ordering of objects in the collection by their abscissa values. More...
 

Public Types

typedef JElement_t::abscissa_type abscissa_type
 
typedef JElement_t::ordinate_type ordinate_type
 
typedef JElement_t value_type
 
typedef JDistance_t distance_type
 
typedef JCollection
< JElement_t, JDistance_t > 		collection_type
 
typedef std::vector< value_type > container_type
 
typedef
container_type::const_iterator 		const_iterator
 
typedef
container_type::const_reverse_iterator 		const_reverse_iterator
 
typedef container_type::iterator iterator
 
typedef
container_type::reverse_iterator 		reverse_iterator
 
typedef
JCollectionElementTransformer
< value_type > 		transformer_type
 
typedef std::pair
< const_iterator, bool > 		pair_type
 
typedef JElement_t::abscissa_type key_type
 
typedef JElement_t::ordinate_type mapped_type
 

Public Member Functions

 JCollection ()
 Default constructor. 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 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...
 
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...
 
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...
 
template<class JFunction1D_t >
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 & sub (const JCollection &collection)
 Subtract collection. More...
 
JCollection & mul (const double value)
 Scale contents. More...
 
JCollection & div (const double value)
 Scale contents. More...
 
JCollection & add (typename JClass< ordinate_type >::argument_type value)
 Add offset. More...
 
JCollection & sub (typename JClass< ordinate_type >::argument_type value)
 Subtract offset. More...
 
template<class JFunction1D_t >
JCollection & add (const JFunction1D_t &function)
 Add function. More...
 
template<class JFunction1D_t >
JCollection & sub (const JFunction1D_t &function)
 Subtract function. 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...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. 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...
 

Private Member Functions

void erase ()
 
void push_back ()
 
void pop_back ()
 

Friends

JCollection & operator+= (JCollection &collection, typename JClass< ordinate_type >::argument_type value)
 Add offset to collaction. More...
 
JCollection & operator-= (JCollection &collection, typename JClass< ordinate_type >::argument_type value)
 Subtract offset from collaction. More...
 
template<class JFunction1D_t >
JCollection & operator+= (JCollection &collection, const JFunction1D_t &function)
 Add function. More...
 
template<class JFunction1D_t >
JCollection & operator-= (JCollection &collection, const JFunction1D_t &function)
 Subtract function. More...
 
JReader & operator>> (JReader &in, JCollection &collection)
 Read collection from input. More...
 
JWriter & operator<< (JWriter &out, const JCollection &collection)
 Write collection to output. More...
 

Detailed Description

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
class JTOOLS::JCollection< JElement_t, JDistance_t >

General purpose class for collection of elements, see: Collection of elements. .

This class implements the JMappableCollection and JAbstractCollection interfaces.

The data type of the elements of the collection should have the following policy type definition and member methods. 

     typedef <abscissa type>   abscissa_type;
     typedef <ordinate type>   ordinate_type;
     (constructor)(abscissa_type, ordinate_type);
     abscissa_type  getX() const;
     ordinate_type  getY() const;
     ordinate_type& getY();

The elements in a collection are sorted according to their abscissa values and the given distance operator. The distance operator constitues a binary method returning the distance between two abscissa values; The default distance operator is JDistance.

For the binary I/O of a collection of elements, the data structure of the elements should provide for an implementation of the following operators: 

        JReader& operator>>(JReader& in);
        JWriter& operator<<(JWriter& out);

Definition at line 73 of file JCollection.hh.

Member Typedef Documentation

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JElement_t::abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::abscissa_type

Definition at line 82 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JElement_t::ordinate_type JTOOLS::JCollection< JElement_t, JDistance_t >::ordinate_type

Definition at line 83 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JElement_t JTOOLS::JCollection< JElement_t, JDistance_t >::value_type

Definition at line 84 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JDistance_t JTOOLS::JCollection< JElement_t, JDistance_t >::distance_type

Definition at line 85 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JCollection<JElement_t, JDistance_t> JTOOLS::JCollection< JElement_t, JDistance_t >::collection_type

Definition at line 87 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef std::vector<value_type> JTOOLS::JCollection< JElement_t, JDistance_t >::container_type

Definition at line 89 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef container_type::const_iterator JTOOLS::JCollection< JElement_t, JDistance_t >::const_iterator

Definition at line 91 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef container_type::const_reverse_iterator JTOOLS::JCollection< JElement_t, JDistance_t >::const_reverse_iterator

Definition at line 92 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef container_type::iterator JTOOLS::JCollection< JElement_t, JDistance_t >::iterator

Definition at line 93 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef container_type::reverse_iterator JTOOLS::JCollection< JElement_t, JDistance_t >::reverse_iterator

Definition at line 94 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JCollectionElementTransformer<value_type> JTOOLS::JCollection< JElement_t, JDistance_t >::transformer_type

Definition at line 96 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef std::pair<const_iterator, bool> JTOOLS::JCollection< JElement_t, JDistance_t >::pair_type

Definition at line 97 of file JCollection.hh.

typedef JElement_t::abscissa_type JTOOLS::JMappableCollection< JElement_t::abscissa_type , JElement_t::ordinate_type >::key_type
inherited

Definition at line 33 of file JMappableCollection.hh.

typedef JElement_t::ordinate_type JTOOLS::JMappableCollection< JElement_t::abscissa_type , JElement_t::ordinate_type >::mapped_type
inherited

Definition at line 34 of file JMappableCollection.hh.

Constructor & Destructor Documentation

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JTOOLS::JCollection< JElement_t, JDistance_t >::JCollection ( )
inline

Default constructor.

Definition at line 143 of file JCollection.hh.

144  {}

Member Function Documentation

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual void JTOOLS::JCollection< JElement_t, JDistance_t >::clear ( )
inlineoverridevirtual

Clear.

Implements JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type >.

Definition at line 150 of file JCollection.hh.

151  {
152  container_type::clear();
153  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual const ordinate_type& JTOOLS::JCollection< JElement_t, JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x) const
inlineoverridevirtual

Get ordinate value.

Parameters
xabscissa value
Returns
ordinate value

Implements JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type >.

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::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:670
JTOOLS::JCollection::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::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91
JLANG::JValueOutOfRange
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:162
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual ordinate_type& JTOOLS::JCollection< JElement_t, JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x)
inlineoverridevirtual

Get ordinate value.

Parameters
xabscissa value
Returns
ordinate value

Implements JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type >.

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::value_type
JElement_t value_type
Definition: JCollection.hh:84
JTOOLS::JCollection::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection::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::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
JTOOLS::JCollection::ordinate_type
JElement_t::ordinate_type ordinate_type
Definition: JCollection.hh:83
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual int JTOOLS::JCollection< JElement_t, JDistance_t >::getSize ( ) const
inlineoverridevirtual

Get number of elements.

Returns
number of elements

Implements JTOOLS::JAbstractCollection< JElement_t::abscissa_type >.

Definition at line 197 of file JCollection.hh.

198  {
199  return (int) this->size();
200  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getX ( int  index) const
inlineoverridevirtual

Get abscissa value.

Parameters
indexindex
Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JElement_t::abscissa_type >.

Definition at line 209 of file JCollection.hh.

210  {
211  return this->at(index).getX();
212  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getXmin ( ) const
inlineoverridevirtual

Get minimal abscissa value.

Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JElement_t::abscissa_type >.

Definition at line 220 of file JCollection.hh.

221  {
222  return this->begin()->getX();
223  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getXmax ( ) const
inlineoverridevirtual

Get maximal abscissa value.

Returns
abscissa value

Implements JTOOLS::JAbstractCollection< JElement_t::abscissa_type >.

Definition at line 231 of file JCollection.hh.

232  {
233  return this->rbegin()->getX();
234  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
const ordinate_type& JTOOLS::JCollection< JElement_t, JDistance_t >::getY ( int  index) const
inline

Get ordinate value.

Parameters
indexindex
Returns
ordinate value

Definition at line 244 of file JCollection.hh.

245  {
246  return this->at(index).getY();
247  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
ordinate_type& JTOOLS::JCollection< JElement_t, JDistance_t >::getY ( int  index)
inline

Get ordinate value.

Parameters
indexindex
Returns
ordinate value

Definition at line 256 of file JCollection.hh.

257  {
258  return this->at(index).getY();
259  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::transform ( const transformer_type &  transformer)
inline

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::collection_type
JCollection< JElement_t, JDistance_t > collection_type
Definition: JCollection.hh:87
JTOOLS::JCollection::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91
JTOOLS::JCollection::insert
pair_type insert(const value_type &element)
Insert element.
Definition: JCollection.hh:318
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::sort ( )
inline

Sort elements.

Definition at line 282 of file JCollection.hh.

283  {
284  std::sort(this->begin(), this->end(), compare);
285  }
JTOOLS::JCollection::compare
JComparator compare
Function object for comparison.
Definition: JCollection.hh:781
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
const_iterator JTOOLS::JCollection< JElement_t, JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x) const
inline

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

Parameters
xabscissa value
Returns
position of corresponding element

Definition at line 294 of file JCollection.hh.

295  {
296  return std::lower_bound(this->begin(), this->end(), x, compare);
297  }
JTOOLS::JCollection::compare
JComparator compare
Function object for comparison.
Definition: JCollection.hh:781
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
iterator JTOOLS::JCollection< JElement_t, JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x)
inline

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

Parameters
xabscissa value
Returns
position of corresponding element

Definition at line 306 of file JCollection.hh.

307  {
308  return std::lower_bound(this->begin(), this->end(), x, compare);
309  }
JTOOLS::JCollection::compare
JComparator compare
Function object for comparison.
Definition: JCollection.hh:781
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
pair_type JTOOLS::JCollection< JElement_t, JDistance_t >::insert ( const value_type &  element)
inline

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::pair_type
std::pair< const_iterator, bool > pair_type
Definition: JCollection.hh:97
JTOOLS::JCollection::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection::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::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds)
inline

Configure collection.

Parameters
boundsabscissa values

Definition at line 334 of file JCollection.hh.

335  {
336  configure(bounds, JMATH::getZero<ordinate_type>());
337  }
JTOOLS::JCollection::configure
void configure(const JAbstractCollection< abscissa_type > &bounds)
Configure collection.
Definition: JCollection.hh:334
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds,
typename JClass< ordinate_type >::argument_type  value 
)
inline

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  }
JTOOLS::JCollection::value_type
JElement_t value_type
Definition: JCollection.hh:84
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::resize
void resize(typename container_type::size_type size)
Resize collection.
Definition: JCollection.hh:789
JTOOLS::JCollection::abscissa_type
JElement_t::abscissa_type abscissa_type
Definition: JCollection.hh:82
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
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.
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
template<class JFunction1D_t >
void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds,
const JFunction1D_t &  function 
)
inline

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::collection_type
JCollection< JElement_t, JDistance_t > collection_type
Definition: JCollection.hh:87
JTOOLS::JCollection::abscissa_type
JElement_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.
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
bool JTOOLS::JCollection< JElement_t, JDistance_t >::is_compatible ( const JCollection< JElement_t, JDistance_t > &  collection) const
inline

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::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::negate ( )
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::add ( const JCollection< JElement_t, JDistance_t > &  collection)
inline

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::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection::is_compatible
bool is_compatible(const JCollection &collection) const
Test whether collections are compatible.
Definition: JCollection.hh:396
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type >::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
JTOOLS::JCollection::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( const JCollection< JElement_t, JDistance_t > &  collection)
inline

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::getDistance
JDistance_t getDistance
Function object for distance evaluation.
Definition: JCollection.hh:774
JTOOLS::JCollection::is_compatible
bool is_compatible(const JCollection &collection) const
Test whether collections are compatible.
Definition: JCollection.hh:396
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
JTOOLS::JMappableCollection< JElement_t::abscissa_type, JElement_t::ordinate_type >::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
JTOOLS::JCollection::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::mul ( const double  value)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::div ( const double  value)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::add ( typename JClass< ordinate_type >::argument_type  value)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( typename JClass< ordinate_type >::argument_type  value)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
template<class JFunction1D_t >
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::add ( const JFunction1D_t &  function)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
template<class JFunction1D_t >
JCollection& JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( const JFunction1D_t &  function)
inline

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  }
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
const JComparator& JTOOLS::JCollection< JElement_t, JDistance_t >::getComparator ( ) const
inline

Get comparator.

Returns
comparator

Definition at line 765 of file JCollection.hh.

766  {
767  return compare;
768  }
JTOOLS::JCollection::compare
JComparator compare
Function object for comparison.
Definition: JCollection.hh:781
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::resize ( typename container_type::size_type  size)
inlineprotected

Resize collection.

Parameters
sizesize

Definition at line 789 of file JCollection.hh.

790  {
791  container_type::resize(size);
792  }
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::erase ( )
private
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::push_back ( )
private
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
void JTOOLS::JCollection< JElement_t, JDistance_t >::pop_back ( )
private
const mapped_type& JTOOLS::JMappableCollection< JElement_t::abscissa_type , JElement_t::ordinate_type >::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  }
mapped_type& JTOOLS::JMappableCollection< JElement_t::abscissa_type , JElement_t::ordinate_type >::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  }
void JTOOLS::JMappableCollection< JElement_t::abscissa_type , JElement_t::ordinate_type >::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  }
bool JTOOLS::JAbstractCollection< JElement_t::abscissa_type >::is_equal ( const JAbstractCollection< JElement_t::abscissa_type > &  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< JElement_t::abscissa_type >::getX
virtual abscissa_type getX(int index) const =0
Get abscissa value.
JTOOLS::JAbstractCollection< JElement_t::abscissa_type >::getSize
virtual int getSize() const =0
Get number of elements.
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

Friends And Related Function Documentation

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& operator+= ( JCollection< JElement_t, JDistance_t > &  collection,
typename JClass< ordinate_type >::argument_type  value 
)
friend

Add offset to collaction.

Parameters
collectioncollection
valueoffset
Returns
collection

Definition at line 669 of file JCollection.hh.

670  {
671  return collection.add(value);
672  }
JTOOLS::JCollection::add
JCollection & add(const JCollection &collection)
Add collection.
Definition: JCollection.hh:454
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JCollection& operator-= ( JCollection< JElement_t, JDistance_t > &  collection,
typename JClass< ordinate_type >::argument_type  value 
)
friend

Subtract offset from collaction.

Parameters
collectioncollection
valueoffset
Returns
collection

Definition at line 682 of file JCollection.hh.

683  {
684  return collection.sub(value);
685  }
JTOOLS::JCollection::sub
JCollection & sub(const JCollection &collection)
Subtract collection.
Definition: JCollection.hh:510
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
template<class JFunction1D_t >
JCollection& operator+= ( JCollection< JElement_t, JDistance_t > &  collection,
const JFunction1D_t &  function 
)
friend

Add function.

Parameters
collectioncollection
functionfunction
Returns
this collection

Definition at line 696 of file JCollection.hh.

697  {
698  return collection.add(function);
699  }
JTOOLS::JCollection::add
JCollection & add(const JCollection &collection)
Add collection.
Definition: JCollection.hh:454
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
template<class JFunction1D_t >
JCollection& operator-= ( JCollection< JElement_t, JDistance_t > &  collection,
const JFunction1D_t &  function 
)
friend

Subtract function.

Parameters
collectioncollection
functionfunction
Returns
this collection

Definition at line 710 of file JCollection.hh.

711  {
712  return collection.sub(function);
713  }
JTOOLS::JCollection::sub
JCollection & sub(const JCollection &collection)
Subtract collection.
Definition: JCollection.hh:510
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JReader& operator>> ( JReader &  in,
JCollection< JElement_t, JDistance_t > &  collection 
)
friend

Read collection from input.

Parameters
inreader
collectioncollection
Returns
reader

Definition at line 723 of file JCollection.hh.

724  {
725  int n;
726 
727  in >> n;
728 
729  collection.resize(n);
730 
731  for (typename JCollection::iterator i = collection.begin(); i != collection.end(); ++i) {
732  in >> *i;
733  }
734 
735  return in;
736  }
JTOOLS::JCollection::resize
void resize(typename container_type::size_type size)
Resize collection.
Definition: JCollection.hh:789
JTOOLS::n
const int n
Definition: JPolint.hh:660
JTOOLS::JCollection::iterator
container_type::iterator iterator
Definition: JCollection.hh:93
in
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JWriter& operator<< ( JWriter &  out,
const JCollection< JElement_t, JDistance_t > &  collection 
)
friend

Write collection to output.

Parameters
outwriter
collectioncollection
Returns
writer

Definition at line 746 of file JCollection.hh.

747  {
748  const int n = collection.size();
749 
750  out << n;
751 
752  for (typename JCollection::const_iterator i = collection.begin(); i != collection.end(); ++i) {
753  out << *i;
754  }
755 
756  return out;
757  }
JTOOLS::n
const int n
Definition: JPolint.hh:660
JTOOLS::JCollection::const_iterator
container_type::const_iterator const_iterator
Definition: JCollection.hh:91

Member Data Documentation

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JDistance_t JTOOLS::JCollection< JElement_t, JDistance_t >::getDistance

Function object for distance evaluation.

Definition at line 774 of file JCollection.hh.

template<class JElement_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
JComparator JTOOLS::JCollection< JElement_t, JDistance_t >::compare
protected

Function object for comparison.

Definition at line 781 of file JCollection.hh.

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