JTOOLS::JAbstractCollection< JAbscissa_t > Struct Template Reference

Abstract interface for abscissa values of a collection of elements. More...

#include <JAbstractCollection.hh>

Inheritance diagram for JTOOLS::JAbstractCollection< JAbscissa_t >:

Public Types
typedef JAbscissa_t	abscissa_type

Public Member Functions
virtual	~JAbstractCollection ()
	Virtual destructor.
virtual int	getSize () const =0
	Get number of elements.
virtual abscissa_type	getX (int index) const =0
	Get abscissa value.
virtual abscissa_type	getXmin () const =0
	Get minimal abscissa value.
virtual abscissa_type	getXmax () const =0
	Get maximal abscissa value.
bool	is_equal (const JAbstractCollection &collection) const
	Test whether abstract collections are equal.

Friends
bool	operator< (const JAbstractCollection &first, const JAbstractCollection &second)
	Less than method.

Detailed Description

template<class JAbscissa_t>
struct JTOOLS::JAbstractCollection< JAbscissa_t >

Abstract interface for abscissa values of a collection of elements.

Definition at line 21 of file JAbstractCollection.hh.

Member Typedef Documentation

abscissa_type

template<class JAbscissa_t >

JAbscissa_t JTOOLS::JAbstractCollection< JAbscissa_t >::abscissa_type

Definition at line 23 of file JAbstractCollection.hh.

Constructor & Destructor Documentation

~JAbstractCollection()

template<class JAbscissa_t >

virtual JTOOLS::JAbstractCollection< JAbscissa_t >::~JAbstractCollection ( )

inlinevirtual

Virtual destructor.

Definition at line 29 of file JAbstractCollection.hh.

    {}

Member Function Documentation

getSize()

template<class JAbscissa_t >

virtual int JTOOLS::JAbstractCollection< JAbscissa_t >::getSize ( ) const

pure virtual

Get number of elements.

Returns

number of elements

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D< JKey_t, JValue_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D_t >, JTOOLS::JCollection< JElement_t, JDistance< typename JElement_t::abscissa_type > >, JTOOLS::JGrid< JAbscissa_t >, JTOOLS::JGrid< double >, and JTOOLS::JSet< JAbscissa_t >.

getX()

template<class JAbscissa_t >

virtual abscissa_type JTOOLS::JAbstractCollection< JAbscissa_t >::getX ( int index ) const

pure virtual

Get abscissa value.

Parameters

index

index

Returns

abscissa value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D< JKey_t, JValue_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D_t >, JTOOLS::JCollection< JElement_t, JDistance< typename JElement_t::abscissa_type > >, JTOOLS::JGrid< JAbscissa_t >, JTOOLS::JGrid< double >, and JTOOLS::JSet< JAbscissa_t >.

getXmin()

template<class JAbscissa_t >

virtual abscissa_type JTOOLS::JAbstractCollection< JAbscissa_t >::getXmin ( ) const

pure virtual

Get minimal abscissa value.

Returns

abscissa value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D< JKey_t, JValue_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D_t >, JTOOLS::JCollection< JElement_t, JDistance< typename JElement_t::abscissa_type > >, JTOOLS::JGrid< JAbscissa_t >, JTOOLS::JGrid< double >, and JTOOLS::JSet< JAbscissa_t >.

getXmax()

template<class JAbscissa_t >

virtual abscissa_type JTOOLS::JAbstractCollection< JAbscissa_t >::getXmax ( ) const

pure virtual

Get maximal abscissa value.

Returns

abscissa value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D< JKey_t, JValue_t >, JDistance< JKey_t > >, JTOOLS::JCollection< JElement2D_t >, JTOOLS::JCollection< JElement_t, JDistance< typename JElement_t::abscissa_type > >, JTOOLS::JGrid< JAbscissa_t >, JTOOLS::JGrid< double >, and JTOOLS::JSet< JAbscissa_t >.

is_equal()

template<class JAbscissa_t >

bool JTOOLS::JAbstractCollection< JAbscissa_t >::is_equal ( const JAbstractCollection< JAbscissa_t > & collection ) const

inline

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

Friends And Related Symbol Documentation

operator<

template<class JAbscissa_t >

bool operator< ( const JAbstractCollection< JAbscissa_t > & first, const JAbstractCollection< JAbscissa_t > & second )

friend

Less than method.

Parameters

first	first abstract collection
second	second abstract collection

Returns

true if first collection is less than second collection; else false

Definition at line 97 of file JAbstractCollection.hh.

    {
      using namespace std;
      
      if (first.getSize() == second.getSize()) {
 
        if (fabs(first.getXmin() - second.getXmin()) > 0.0) {
          return first.getXmin() < second.getXmin();
        } else {
          return first.getXmax() < second.getXmax();
        }
        
      } else {
 
        return first.getSize() < second.getSize();
      }
    }

---

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

• JAbstractCollection.hh