BALL  1.4.79
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
BALL::Quadruple< T1, T2, T3, T4 > Class Template Reference
Miscellaneous

#include <BALL/DATATYPE/quadruple.h>

Public Member Functions

virtual void clear ()
 
Constructors and Destructors
 Quadruple ()
 
 Quadruple (const Quadruple &quadruple, bool deep=true)
 
 Quadruple (const T1 &new_first, const T2 &new_second, const T3 &new_third, const T4 &new_fourth)
 
virtual ~Quadruple ()
 
Assignment
const Quadruple & operator= (const Quadruple &quadruple)
 
void set (const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)
 
void get (T1 &first, T2 &second, T3 &third, T4 &fourth) const
 
Predicates
bool operator== (const Quadruple &quadruple) const
 
bool operator!= (const Quadruple &quadruple) const
 
bool operator< (const Quadruple &quadruple) const
 
bool operator<= (const Quadruple &quadruple) const
 
bool operator>= (const Quadruple &quadruple) const
 
bool operator> (const Quadruple &quadruple) const
 

Public Attributes

Attributes
T1 first
 
T2 second
 
T3 third
 
T4 fourth
 

Detailed Description

template<typename T1, typename T2, typename T3, typename T4>
class BALL::Quadruple< T1, T2, T3, T4 >

Quadruple Class. This template class is used to represent quadruples of arbitrary types (like the STL type pair).

Definition at line 22 of file quadruple.h.

Constructor & Destructor Documentation

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL::Quadruple< T1, T2, T3, T4 >::Quadruple ( )

Default constructor. Creates a new Quadruple object.

Definition at line 141 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL::Quadruple< T1, T2, T3, T4 >::Quadruple ( const Quadruple< T1, T2, T3, T4 > &  quadruple,
bool  deep = true 
)

Copy constructor. Creates a new Quadruple object from another.

Parameters
quadruplethe Quadruple object to be copied
deepnot used (needed for a consistent interface only)

Definition at line 147 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL::Quadruple< T1, T2, T3, T4 >::Quadruple ( const T1 &  new_first,
const T2 &  new_second,
const T3 &  new_third,
const T4 &  new_fourth 
)

Detailled constructor. Creates a new Quadruple object from the quadruple's four members.

Parameters
new_firstthe first quadruple member
new_secondthe second quadruple member
new_thirdthe third quadruple member
new_fourththe fourth quadruple member

Definition at line 157 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL::Quadruple< T1, T2, T3, T4 >::~Quadruple ( )
virtual

Destructor. Destructs the Quadruple object.

Definition at line 166 of file quadruple.h.

Member Function Documentation

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE void BALL::Quadruple< T1, T2, T3, T4 >::clear ( )
virtual

Clear method.

Definition at line 226 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE void BALL::Quadruple< T1, T2, T3, T4 >::get ( T1 &  first,
T2 &  second,
T3 &  third,
T4 &  fourth 
) const

Definition at line 196 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator!= ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Inequality operator

Definition at line 216 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator< ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Lesser than operator. One instance is lesser than an other if all members from first to third are equal or less than the members of the other instance and at least fourth is less.

Definition at line 237 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator<= ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Lesser or equal than operator.

Definition at line 249 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE const Quadruple< T1, T2, T3, T4 > & BALL::Quadruple< T1, T2, T3, T4 >::operator= ( const Quadruple< T1, T2, T3, T4 > &  quadruple)

Assignment operator. Assigns the contents of a quadruple to another.

Parameters
quadruplethe quadruple to be copied

Definition at line 184 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator== ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Equality operator Two instances are equal if they have the same members.

Definition at line 206 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator> ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Greater than operator.

Definition at line 273 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE bool BALL::Quadruple< T1, T2, T3, T4 >::operator>= ( const Quadruple< T1, T2, T3, T4 > &  quadruple) const

Greater or equal than operator.

Definition at line 261 of file quadruple.h.

template<typename T1 , typename T2 , typename T3 , typename T4 >
BALL_INLINE void BALL::Quadruple< T1, T2, T3, T4 >::set ( const T1 &  t1,
const T2 &  t2,
const T3 &  t3,
const T4 &  t4 
)

Definition at line 172 of file quadruple.h.

Member Data Documentation

template<typename T1, typename T2, typename T3, typename T4>
T1 BALL::Quadruple< T1, T2, T3, T4 >::first

The first quadruple member

Definition at line 124 of file quadruple.h.

template<typename T1, typename T2, typename T3, typename T4>
T4 BALL::Quadruple< T1, T2, T3, T4 >::fourth

The fourth quadruple member

Definition at line 136 of file quadruple.h.

template<typename T1, typename T2, typename T3, typename T4>
T2 BALL::Quadruple< T1, T2, T3, T4 >::second

The second quadruple member

Definition at line 128 of file quadruple.h.

template<typename T1, typename T2, typename T3, typename T4>
T3 BALL::Quadruple< T1, T2, T3, T4 >::third

The third quadruple member

Definition at line 132 of file quadruple.h.

Generated by   doxygen 1.8.7