JTOOLS::JSet< JAbscissa_t > Struct Template Reference

Simple data structure for an abstract collection of non-equidistant abscissa values. More...

#include <JSet.hh>

Inheritance diagram for JTOOLS::JSet< JAbscissa_t >:

Public Types
typedef JAbstractCollection< JAbscissa_t >::abscissa_type	abscissa_type

Public Member Functions
	JSet ()
	Default constructor.
	JSet (const JAbstractCollection< abscissa_type > &collection)
	Constructor.
template<class T >
	JSet (T __begin, T __end)
	Constructor.
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.
template<class JElement_t , class JDistance_t >
const JSet &	operator() (JCollection< JElement_t, JDistance_t > &collection) const
	Configure collection.
bool	is_equal (const JAbstractCollection &collection) const
	Test whether abstract collections are equal.

Friends
std::istream &	operator>> (std::istream &in, JSet< JAbscissa_t > &object)
	Read set from input.
std::ostream &	operator<< (std::ostream &out, const JSet< JAbscissa_t > &object)
	Write set to output.

Detailed Description

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

Simple data structure for an abstract collection of non-equidistant abscissa values.

This class implements the JAbstractCollection interface.

Definition at line 31 of file JSet.hh.

Member Typedef Documentation

abscissa_type

template<class JAbscissa_t >

JAbstractCollection<JAbscissa_t>::abscissa_type JTOOLS::JSet< JAbscissa_t >::abscissa_type

Definition at line 35 of file JSet.hh.

Constructor & Destructor Documentation

JSet() [1/3]

template<class JAbscissa_t >

JTOOLS::JSet< JAbscissa_t >::JSet ( )

inline

Default constructor.

Definition at line 41 of file JSet.hh.

    {}

JSet() [2/3]

template<class JAbscissa_t >

JTOOLS::JSet< JAbscissa_t >::JSet ( const JAbstractCollection< abscissa_type > & collection )

inline

Constructor.

Parameters

collection

abstract collection

Definition at line 50 of file JSet.hh.

    {
      for (int i = 0; i != collection.getSize(); ++i) {
        this->insert(collection.getX(i));
      }
    }

JSet() [3/3]

template<class JAbscissa_t >

template<class T >

JTOOLS::JSet< JAbscissa_t >::JSet ( T __begin, T __end )

inline

Constructor.

Parameters

__begin	begin of abscissa values
__end	end of abscissa values

Definition at line 65 of file JSet.hh.

    {
      for (T i = __begin; i != __end; ++i) {
        this->insert(*i);
      }
    }

Member Function Documentation

getSize()

template<class JAbscissa_t >

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

inlineoverridevirtual

Get number of elements.

Returns

number of elements

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 78 of file JSet.hh.

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

getX()

template<class JAbscissa_t >

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

inlineoverridevirtual

Get abscissa value.

Parameters

index

index

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 90 of file JSet.hh.

    {
      typename std::set<abscissa_type>::const_iterator i = this->begin();
 
      std::advance(i, index);
 
      return *i;
    }

getXmin()

template<class JAbscissa_t >

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

inlineoverridevirtual

Get minimal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 105 of file JSet.hh.

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

getXmax()

template<class JAbscissa_t >

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

inlineoverridevirtual

Get maximal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 116 of file JSet.hh.

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

operator()()

template<class JAbscissa_t >

template<class JElement_t , class JDistance_t >

const JSet & JTOOLS::JSet< JAbscissa_t >::operator() ( JCollection< JElement_t, JDistance_t > & collection ) const

inline

Configure collection.

Parameters

collection

collection

Returns

this set

Definition at line 129 of file JSet.hh.

    {
      collection.configure(*this);
 
      return *this;
    }

is_equal()

template<class JAbscissa_t >

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

inlineinherited

Test whether abstract collections are equal.

Parameters

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 >

std::istream & operator>> ( std::istream & in, JSet< JAbscissa_t > & object )

friend

Read set from input.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 144 of file JSet.hh.

    {
      for (JAbscissa_t value; in >> value; ) {
        object.insert(value);
      }
 
      return in;
    }

operator<<

template<class JAbscissa_t >

std::ostream & operator<< ( std::ostream & out, const JSet< JAbscissa_t > & object )

friend

Write set to output.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 161 of file JSet.hh.

    {
      for (typename JSet<JAbscissa_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
        out << ' ' << *i;
      }
 
      return out;
    }

---

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

• JSet.hh