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

#include <JCollection.hh>

Inheritance diagram for JTOOLS::JCollection< 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

◆ abscissa_type

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.

◆ ordinate_type

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.

◆ value_type

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.

◆ distance_type

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.

◆ collection_type

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.

◆ container_type

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.

◆ const_iterator

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.

◆ const_reverse_iterator

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.

◆ iterator

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.

◆ reverse_iterator

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.

◆ transformer_type

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.

◆ pair_type

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.

◆ key_type

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.

◆ mapped_type

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

◆ JCollection()

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

◆ clear()

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.

     {
       container_type::clear();
     }

◆ get() [1/2]

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

x	abscissa value

Returns: ordinate value

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

Definition at line 162 of file JCollection.hh.

     {
       const_iterator i = this->lower_bound(x);
  
       if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
         THROW(JValueOutOfRange, "Invalid abscissa value " << x);
       }
  
       return i->getY();
     }

◆ get() [2/2]

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

x	abscissa value

Returns: ordinate value

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

Definition at line 180 of file JCollection.hh.

     {
       iterator i = this->lower_bound(x);
  
       if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
         i = container_type::insert(i, value_type(x, JMATH::getZero<ordinate_type>()));
       }
  
       return i->getY();
     }

◆ getSize()

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.

     {
       return (int) this->size();
     }

◆ getX()

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

index index

Returns: abscissa value

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

Definition at line 209 of file JCollection.hh.

     {
       return this->at(index).getX();
     }

◆ getXmin()

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.

     {
       return this->begin()->getX();
     }

◆ getXmax()

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.

     {
       return this->rbegin()->getX();
     }

◆ getY() [1/2]

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

index index

Returns: ordinate value

Definition at line 244 of file JCollection.hh.

     {
       return this->at(index).getY();
     }

◆ getY() [2/2]

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

index index

Returns: ordinate value

Definition at line 256 of file JCollection.hh.

     {
       return this->at(index).getY();
     }

◆ transform()

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

transformer element transformer

Definition at line 267 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         *i = transformer(*i);
       }
       
       sort();
     }

◆ sort()

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 280 of file JCollection.hh.

     {
       std::sort(this->begin(), this->end(), compare);
     }

◆ lower_bound() [1/2]

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

x	abscissa value

Returns: position of corresponding element

Definition at line 292 of file JCollection.hh.

     {
       return std::lower_bound(this->begin(), this->end(), x, compare);
     }

◆ lower_bound() [2/2]

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

x	abscissa value

Returns: position of corresponding element

Definition at line 304 of file JCollection.hh.

     {
       return std::lower_bound(this->begin(), this->end(), x, compare);
     }

◆ insert()

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

element element

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

Definition at line 316 of file JCollection.hh.

     {
       iterator i = this->lower_bound(element.getX());
  
       if (i == this->end() || this->getDistance(element.getX(), i->getX()) > 0.0)
         return pair_type(container_type::insert(i, element), true);
       else
         return pair_type(this->end(), false);
     }

◆ configure() [1/3]

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

bounds abscissa values

Definition at line 332 of file JCollection.hh.

     {
       configure(bounds, JMATH::getZero<ordinate_type>());
     }

◆ configure() [2/3]

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

bounds	abscissa values
value	ordinate value

Definition at line 344 of file JCollection.hh.

     {
       this->resize(bounds.getSize());
  
       for (iterator i = this->begin(); i != this->end(); ++i) {
  
         const abscissa_type x = bounds.getX(std::distance(this->begin(),i));
  
         *i = value_type(x,value);
       }
     }

◆ configure() [3/3]

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

bounds	abscissa values
function	function

Definition at line 365 of file JCollection.hh.

     {
       using namespace JLANG;
  
       collection_type* out = (is_identical(*this, function) ? new collection_type() : this);
  
       for (int i = 0; i != bounds.getSize(); ++i) {
  
         const abscissa_type x = bounds.getX(i);
  
         out->put(x, function(x));
       }
  
       if (is_identical(*this, function)) {
         
         this->swap(*out);
  
         delete out;
       }
     }

◆ is_compatible()

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

collection collection

Returns: true if collections are compatible; else false

Definition at line 394 of file JCollection.hh.

     {
       if (this->empty() || collection.empty()) {
  
         return true;
  
       } else {
  
         const double precision = JDistance<abscissa_type>::precision;
         
         const_iterator p = this->begin();
         const_iterator q = collection.begin();
         
         if        (getDistance(p->getX(), q->getX()) > precision) { 
  
           do { 
             ++p; 
           } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 
  
         } else if (getDistance(q->getX(), p->getX()) > precision) { 
  
           do { 
             ++q; 
           } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
         }
  
         for ( ; p != this->end() && q != collection.end(); ++p, ++q) {
           if (fabs(getDistance(p->getX(), q->getX())) > precision) {
             return false;
           }
         }
  
         return true;
       }
     }

◆ negate()

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 436 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() = -i->getY();
       }
  
       return *this;
     }

◆ add() [1/3]

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

collection collection

Returns: this collection

Definition at line 452 of file JCollection.hh.

     {
       if (!collection.empty()) {
  
         if (this->empty()) {
  
           for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
             this->put(i->getX(), +i->getY());
           }
  
         } else if (this->is_compatible(collection)) {
  
           const double precision = JDistance<abscissa_type>::precision;
  
           iterator       p = this->begin();
           const_iterator q = collection.begin();
  
           if        (getDistance(p->getX(), q->getX()) > precision) { 
  
             do {
               ++p; 
             } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 
  
           } else if (getDistance(q->getX(), p->getX()) > precision) { 
  
             do { 
               ++q; 
             } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
           }
  
           const_iterator i = q;
  
           for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
             p->getY() += i->getY();
           }
  
           for ( ; i != collection.end(); ++i) {
             this->put(i->getX(), +i->getY());
           }
  
           for (i = collection.begin(); i != q; ++i) {
             this->put(i->getX(), +i->getY());
           }
         }
       }
       
       return *this;
     }

◆ sub() [1/3]

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

collection collection

Returns: this collection

Definition at line 508 of file JCollection.hh.

     {
       if (!collection.empty()) {
  
         if (this->empty()) {
  
           for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
             this->put(i->getX(), -i->getY());
           }
  
         } else if (this->is_compatible(collection)) {
  
           const double precision = JDistance<abscissa_type>::precision;
  
           iterator       p = this->begin();
           const_iterator q = collection.begin();
  
           if        (getDistance(p->getX(), q->getX()) > precision) { 
  
             do {
               ++p; 
             } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 
  
           } else if (getDistance(q->getX(), p->getX()) > precision) { 
  
             do { 
               ++q; 
             } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
           }
  
           const_iterator i = q;
  
           for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
             p->getY() -= i->getY();
           }
  
           for ( ; i != collection.end(); ++i) {
             this->put(i->getX(), -i->getY());
           }
  
           for (i = collection.begin(); i != q; ++i) {
             this->put(i->getX(), -i->getY());
           }
  
         } else {
  
           THROW(JException, "JCollection::add() collections incompatible.");
         }
       }
       
       return *this;
     }

◆ mul() [1/2]

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

value multiplication factor

Returns: this collection

Definition at line 568 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() *= value;
       }
  
       return *this;
     }

◆ div()

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

value division factor

Returns: this collection

Definition at line 584 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() /= value;
       }
  
       return *this;
     }

◆ add() [2/3]

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

value offset

Returns: this collection

Definition at line 600 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() += value;
       }
  
       return *this;
     }

◆ sub() [2/3]

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

value offset

Returns: this collection

Definition at line 616 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() -= value;
       }
  
       return *this;
     }

◆ add() [3/3]

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

function function

Returns: this collection

Definition at line 633 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() += function(i->getX());
       }
  
       return *this;
     }

◆ sub() [3/3]

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

function function

Returns: this collection

Definition at line 650 of file JCollection.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->getY() -= function(i->getX());
       }
  
       return *this;
     }

◆ getComparator()

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 764 of file JCollection.hh.

     {
       return compare;
     }

◆ resize()

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

size size

Definition at line 788 of file JCollection.hh.

     {
       container_type::resize(size);
     }

◆ erase()

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

void JTOOLS::JCollection< JElement_t, JDistance_t >::erase ( )

private

◆ push_back()

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

void JTOOLS::JCollection< JElement_t, JDistance_t >::push_back ( )

private

◆ pop_back()

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

void JTOOLS::JCollection< JElement_t, JDistance_t >::pop_back ( )

private

◆ operator[]() [1/2]

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

key key

Returns: value

Definition at line 73 of file JMappableCollection.hh.

     {
       return get(key);
     }

◆ operator[]() [2/2]

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

key key

Returns: value

Definition at line 85 of file JMappableCollection.hh.

     {
       return get(key);
     }

◆ put()

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

key	key
value	value

Definition at line 97 of file JMappableCollection.hh.

     {
       get(key) = value;
     }

◆ is_equal()

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

collection abstract collection

Returns: true if collections are equals; else false

Definition at line 72 of file JAbstractCollection.hh.

     {
       if (this->getSize() == collection.getSize()) {
  
         for (int i = 0; i != this->getSize(); ++i) {
  
           if (this->getX(i) != collection.getX(i)) {
             return false;
           }
         }
  
         return true;
       }
  
       return false;
     }

◆ 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

object object

Returns: result object

Definition at line 354 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
     }

Friends And Related Function Documentation

◆ operator+= [1/2]

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

collection	collection
value	offset

Returns: collection

Definition at line 667 of file JCollection.hh.

     {
       return collection.add(value);
     }

◆ operator-= [1/2]

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

collection	collection
value	offset

Returns: collection

Definition at line 680 of file JCollection.hh.

     {
       return collection.sub(value);
     }

◆ operator+= [2/2]

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

collection	collection
function	function

Returns: this collection

Definition at line 694 of file JCollection.hh.

     {
       return collection.add(function);
     }

◆ operator-= [2/2]

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

collection	collection
function	function

Returns: this collection

Definition at line 708 of file JCollection.hh.

     {
       return collection.sub(function);
     }

◆ operator>>

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

in	reader
collection	collection

Returns: reader

Definition at line 721 of file JCollection.hh.

     {
       int n;
  
       if (in >> n) {
  
         collection.resize(n);
  
         for (typename JCollection::iterator i = collection.begin(); i != collection.end(); ++i) {
           in >> *i;
         }
       }
  
       return in;
     }

◆ operator<<

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

out	writer
collection	collection

Returns: writer

Definition at line 745 of file JCollection.hh.

     {
       const int n = collection.size();
  
       out << n;
  
       for (typename JCollection::const_iterator i = collection.begin(); i != collection.end(); ++i) {
         out << *i;
       }
  
       return out;
     }

Member Data Documentation

◆ getDistance

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 773 of file JCollection.hh.

◆ compare

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 780 of file JCollection.hh.

The documentation for this class was generated from the following file:

JCollection.hh

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ collection_type

◆ container_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ transformer_type

◆ pair_type

◆ key_type

◆ mapped_type

Constructor & Destructor Documentation

◆ JCollection()

Member Function Documentation

◆ clear()

◆ get() [1/2]

◆ get() [2/2]

◆ getSize()

◆ getX()

◆ getXmin()

◆ getXmax()

◆ getY() [1/2]

◆ getY() [2/2]

◆ transform()

◆ sort()

◆ lower_bound() [1/2]

◆ lower_bound() [2/2]

◆ insert()

◆ configure() [1/3]

◆ configure() [2/3]

◆ configure() [3/3]

◆ is_compatible()

◆ negate()

◆ add() [1/3]

◆ sub() [1/3]

◆ mul() [1/2]

◆ div()

◆ add() [2/3]

◆ sub() [2/3]

◆ add() [3/3]

◆ sub() [3/3]

◆ getComparator()

◆ resize()

◆ erase()

◆ push_back()

◆ pop_back()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ put()

◆ is_equal()

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator+= [1/2]

◆ operator-= [1/2]

◆ operator+= [2/2]

◆ operator-= [2/2]

◆ operator>>

◆ operator<<

Member Data Documentation

◆ getDistance

◆ compare

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