JTOOLS::JGridCollection< JElement_t, JDistance_t > Class Template Reference

General purpose class for collection of equidistant elements. More...

#include <JGridCollection.hh>

Inheritance diagram for JTOOLS::JGridCollection< JElement_t, JDistance_t >:

Public Types
typedef JCollection< JElement_t, JDistance_t >	collection_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 collection_type::pair_type	pair_type
typedef JDistance_t	distance_type
typedef std::vector< value_type >	container_type
typedef JCollectionElementTransformer< value_type >	transformer_type
typedef JElement_t::abscissa_type	key_type
typedef JElement_t::ordinate_type	mapped_type

Public Member Functions
	JGridCollection ()
	Default constructor.
int	getIndex (typename JClass< abscissa_type >::argument_type x) const
	Get index of given abscissa value.
const_iterator	lower_bound (typename JClass< abscissa_type >::argument_type x) const
	Get first position of element i, where x >= i->getX().
iterator	lower_bound (typename JClass< abscissa_type >::argument_type x)
	Get first position of element i, where x >= i->getX().
virtual void	clear () override
	Clear.
virtual const ordinate_type &	get (typename JClass< abscissa_type >::argument_type x) const override
	Get ordinate value.
virtual ordinate_type &	get (typename JClass< abscissa_type >::argument_type x) override
	Get ordinate value.
virtual int	getSize () const override
	Get number of elements.
virtual abscissa_type	getX (int index) const override
	Get abscissa value.
virtual abscissa_type	getXmin () const override
	Get minimal abscissa value.
virtual abscissa_type	getXmax () const override
	Get maximal abscissa value.
const ordinate_type &	getY (int index) const
	Get ordinate value.
ordinate_type &	getY (int index)
	Get ordinate value.
void	transform (const transformer_type &transformer)
	Transform collection.
void	sort ()
	Sort elements.
pair_type	insert (const value_type &element)
	Insert element.
void	configure (const JAbstractCollection< abscissa_type > &bounds)
	Configure collection.
void	configure (const JAbstractCollection< abscissa_type > &bounds, typename JClass< ordinate_type >::argument_type value)
	Configure collection.
template<class JFunction1D_t >
void	configure (const JAbstractCollection< abscissa_type > &bounds, const JFunction1D_t &function)
	Configure collection.
bool	is_compatible (const JCollection &collection) const
	Test whether collections are compatible.
bool	in_range (typename JClass< abscissa_type >::argument_type x) const
	Check if given abscissa is in range of this collection.
JCollection &	negate ()
	Negate collection.
JCollection &	add (const JCollection &collection)
	Add collection.
JCollection &	add (typename JClass< ordinate_type >::argument_type value)
	Add offset.
template<class JFunction1D_t >
JCollection &	add (const JFunction1D_t &function)
	Add function.
JCollection &	sub (const JCollection &collection)
	Subtract collection.
JCollection &	sub (typename JClass< ordinate_type >::argument_type value)
	Subtract offset.
template<class JFunction1D_t >
JCollection &	sub (const JFunction1D_t &function)
	Subtract function.
JCollection &	mul (const double value)
	Scale contents.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.
JCollection &	div (const double value)
	Scale contents.
const JComparator &	getComparator () const
	Get comparator.
const mapped_type &	operator[] (typename JClass< key_type >::argument_type key) const
	Get mapped value.
mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value.
void	put (typename JClass< key_type > ::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection.
bool	is_equal (const JAbstractCollection &collection) const
	Test whether abstract collections are equal.

Public Attributes
JDistance_t	getDistance
	Function object for distance evaluation.

Protected Member Functions
void	resize (typename container_type::size_type size)
	Resize collection.

Protected Attributes
JComparator	compare
	Function object for comparison.

Private Member Functions
void	erase ()
void	push_back ()
void	pop_back ()

Detailed Description

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

General purpose class for collection of equidistant elements.

For a collection with equidistant elements, the index of the nearest element can directly be computed based on the minimal abscissa value, the maximal abscissa value and the number of elements in the collection. The lower_bound methods are re-implemented in this class which otherwise simply derives from JCollection.

For convenience, the implementation of the standard map operator [] of the JCollection class is maintained.

Definition at line 30 of file JGridCollection.hh.

Member Typedef Documentation

collection_type

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

JCollection<JElement_t, JDistance_t> JTOOLS::JGridCollection< JElement_t, JDistance_t >::collection_type

Definition at line 35 of file JGridCollection.hh.

abscissa_type

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

collection_type::abscissa_type JTOOLS::JGridCollection< JElement_t, JDistance_t >::abscissa_type

Definition at line 37 of file JGridCollection.hh.

ordinate_type

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

collection_type::ordinate_type JTOOLS::JGridCollection< JElement_t, JDistance_t >::ordinate_type

Definition at line 38 of file JGridCollection.hh.

value_type

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

collection_type::value_type JTOOLS::JGridCollection< JElement_t, JDistance_t >::value_type

Definition at line 39 of file JGridCollection.hh.

const_iterator

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

collection_type::const_iterator JTOOLS::JGridCollection< JElement_t, JDistance_t >::const_iterator

Definition at line 41 of file JGridCollection.hh.

const_reverse_iterator

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

collection_type::const_reverse_iterator JTOOLS::JGridCollection< JElement_t, JDistance_t >::const_reverse_iterator

Definition at line 42 of file JGridCollection.hh.

iterator

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

collection_type::iterator JTOOLS::JGridCollection< JElement_t, JDistance_t >::iterator

Definition at line 43 of file JGridCollection.hh.

reverse_iterator

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

collection_type::reverse_iterator JTOOLS::JGridCollection< JElement_t, JDistance_t >::reverse_iterator

Definition at line 44 of file JGridCollection.hh.

pair_type

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

collection_type::pair_type JTOOLS::JGridCollection< JElement_t, JDistance_t >::pair_type

Definition at line 46 of file JGridCollection.hh.

distance_type

template<class JElement_t , class JDistance_t >

JDistance_t JTOOLS::JCollection< JElement_t, JDistance_t >::distance_type

inherited

Definition at line 85 of file JCollection.hh.

container_type

template<class JElement_t , class JDistance_t >

std::vector<value_type> JTOOLS::JCollection< JElement_t, JDistance_t >::container_type

inherited

Definition at line 89 of file JCollection.hh.

transformer_type

template<class JElement_t , class JDistance_t >

JCollectionElementTransformer<value_type> JTOOLS::JCollection< JElement_t, JDistance_t >::transformer_type

inherited

Definition at line 96 of file JCollection.hh.

key_type

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

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

JGridCollection()

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

JTOOLS::JGridCollection< JElement_t, JDistance_t >::JGridCollection ( )

inline

Default constructor.

Definition at line 52 of file JGridCollection.hh.

    {}

Member Function Documentation

getIndex()

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

int JTOOLS::JGridCollection< JElement_t, JDistance_t >::getIndex ( typename JClass< abscissa_type >::argument_type x ) const

inline

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

x	abscissa value

Returns

index

Definition at line 66 of file JGridCollection.hh.

    {
      return (int) ((this->size() - 1) * (x - this->begin()->getX()) / (this->rbegin()->getX() - this->begin()->getX()));
    }

lower_bound() [1/2]

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

const_iterator JTOOLS::JGridCollection< 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 78 of file JGridCollection.hh.

    {
      const int index = getIndex(x) + 1;
 
      if      (index <= 0)
        return this->begin();
      else if (index >= (int) this->size())
        return this->end();
      else
        return this->begin() + index;
    }

lower_bound() [2/2]

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

iterator JTOOLS::JGridCollection< 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 97 of file JGridCollection.hh.

    {
      const int index = getIndex(x) + 1;
 
      if      (index <= 0)
        return this->begin();
      else if (index >= (int) this->size())
        return this->end();
      else
        return this->begin() + index;
    }

clear()

template<class JElement_t , class JDistance_t >

virtual void JTOOLS::JCollection< JElement_t, JDistance_t >::clear ( )

inlineoverridevirtualinherited

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 >

virtual const ordinate_type & JTOOLS::JCollection< JElement_t, JDistance_t >::get ( typename JClass< abscissa_type >::argument_type x ) const

inlineoverridevirtualinherited

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 >

virtual ordinate_type & JTOOLS::JCollection< JElement_t, JDistance_t >::get ( typename JClass< abscissa_type >::argument_type x )

inlineoverridevirtualinherited

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 >

virtual int JTOOLS::JCollection< JElement_t, JDistance_t >::getSize ( ) const

inlineoverridevirtualinherited

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 >

virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getX ( int index ) const

inlineoverridevirtualinherited

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 >

virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getXmin ( ) const

inlineoverridevirtualinherited

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 >

virtual abscissa_type JTOOLS::JCollection< JElement_t, JDistance_t >::getXmax ( ) const

inlineoverridevirtualinherited

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 >

const ordinate_type & JTOOLS::JCollection< JElement_t, JDistance_t >::getY ( int index ) const

inlineinherited

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 >

ordinate_type & JTOOLS::JCollection< JElement_t, JDistance_t >::getY ( int index )

inlineinherited

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 >

void JTOOLS::JCollection< JElement_t, JDistance_t >::transform ( const transformer_type & transformer )

inlineinherited

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 >

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

inlineinherited

Sort elements.

Definition at line 280 of file JCollection.hh.

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

insert()

template<class JElement_t , class JDistance_t >

pair_type JTOOLS::JCollection< JElement_t, JDistance_t >::insert ( const value_type & element )

inlineinherited

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 >

void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > & bounds )

inlineinherited

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 >

void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > & bounds, typename JClass< ordinate_type >::argument_type value )

inlineinherited

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 >

template<class JFunction1D_t >

void JTOOLS::JCollection< JElement_t, JDistance_t >::configure ( const JAbstractCollection< abscissa_type > & bounds, const JFunction1D_t & function )

inlineinherited

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 >

bool JTOOLS::JCollection< JElement_t, JDistance_t >::is_compatible ( const JCollection< JElement_t, JDistance_t > & collection ) const

inlineinherited

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;
      }
    }

in_range()

template<class JElement_t , class JDistance_t >

bool JTOOLS::JCollection< JElement_t, JDistance_t >::in_range ( typename JClass< abscissa_type >::argument_type x ) const

inlineinherited

Check if given abscissa is in range of this collection.

Parameters

x	abscissa value

Returns

true if in tange: else false

Definition at line 437 of file JCollection.hh.

    {
      if (!this->empty())
        return (this->getDistance(this->getXmin(), x) >= 0.0 &&
                this->getDistance(this->getXmax(), x) <= 0.0);
      else
        return false;
    }

negate()

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::negate ( )

inlineinherited

Negate collection.

Returns

this collection

Definition at line 452 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 >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::add ( const JCollection< JElement_t, JDistance_t > & collection )

inlineinherited

Add collection.

Parameters

collection

collection

Returns

this collection

Definition at line 468 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;
    }

add() [2/3]

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::add ( typename JClass< ordinate_type >::argument_type value )

inlineinherited

Add 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 >

template<class JFunction1D_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::add ( const JFunction1D_t & function )

inlineinherited

Add function.

Parameters

function

function

Returns

this collection

Definition at line 649 of file JCollection.hh.

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

sub() [1/3]

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( const JCollection< JElement_t, JDistance_t > & collection )

inlineinherited

Subtract collection.

Parameters

collection

collection

Returns

this collection

Definition at line 524 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;
    }

sub() [2/3]

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( typename JClass< ordinate_type >::argument_type value )

inlineinherited

Subtract offset.

Parameters

value

offset

Returns

this collection

Definition at line 632 of file JCollection.hh.

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

sub() [3/3]

template<class JElement_t , class JDistance_t >

template<class JFunction1D_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::sub ( const JFunction1D_t & function )

inlineinherited

Subtract function.

Parameters

function

function

Returns

this collection

Definition at line 666 of file JCollection.hh.

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

mul() [1/2]

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::mul ( const double value )

inlineinherited

Scale contents.

Parameters

value

multiplication 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;
    }

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);
    }

div()

template<class JElement_t , class JDistance_t >

JCollection & JTOOLS::JCollection< JElement_t, JDistance_t >::div ( const double value )

inlineinherited

Scale contents.

Parameters

value

division factor

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;
    }

getComparator()

template<class JElement_t , class JDistance_t >

const JComparator & JTOOLS::JCollection< JElement_t, JDistance_t >::getComparator ( ) const

inlineinherited

Get comparator.

Returns

comparator

Definition at line 780 of file JCollection.hh.

    {
      return compare;
    }

resize()

template<class JElement_t , class JDistance_t >

void JTOOLS::JCollection< JElement_t, JDistance_t >::resize ( typename container_type::size_type size )

inlineprotectedinherited

Resize collection.

Parameters

size

size

Definition at line 804 of file JCollection.hh.

    {
      container_type::resize(size);
    }

erase()

template<class JElement_t , class JDistance_t >

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

privateinherited

push_back()

template<class JElement_t , class JDistance_t >

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

privateinherited

pop_back()

template<class JElement_t , class JDistance_t >

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

privateinherited

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;
    }

Member Data Documentation

getDistance

template<class JElement_t , class JDistance_t >

JDistance_t JTOOLS::JCollection< JElement_t, JDistance_t >::getDistance

inherited

Function object for distance evaluation.

Definition at line 789 of file JCollection.hh.

compare

template<class JElement_t , class JDistance_t >

JComparator JTOOLS::JCollection< JElement_t, JDistance_t >::compare

protectedinherited

Function object for comparison.

Definition at line 796 of file JCollection.hh.

---

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

• JGridCollection.hh