BALL::Triple

BALL::Triple< T1, T2, T3 > Class Template Reference
[Miscellaneous]

#include <BALL/DATATYPE/triple.h>

List of all members.


Public Member Functions

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

Public Attributes

Attributes
T1 first
T2 second
T3 third

Detailed Description

template<typename T1, typename T2, typename T3>
class BALL::Triple< T1, T2, T3 >

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

See also:
Quadruple

Constructor & Destructor Documentation

template<typename T1 , typename T2 , typename T3 >
BALL::Triple< T1, T2, T3 >::Triple (  )  [inline]

Default constructor. Creates a new Triple object.

template<typename T1 , typename T2 , typename T3 >
BALL::Triple< T1, T2, T3 >::Triple ( const Triple< T1, T2, T3 > &  triple,
bool  deep = true 
) [inline]

Copy constructor. Creates a new Triple object from another.

Parameters:
triple the Triple object to be copied
deep not used (needed for a consistent interface only)
template<typename T1 , typename T2 , typename T3 >
BALL::Triple< T1, T2, T3 >::Triple ( const T1 &  new_first,
const T2 &  new_second,
const T3 &  new_third 
) [inline]

Detailed constructor. Creates a new Triple object from the triple's three members.

Parameters:
new_first the first triple member
new_second the second triple member
new_third the third triple member
template<typename T1 , typename T2 , typename T3 >
BALL::Triple< T1, T2, T3 >::~Triple (  )  [inline, virtual]

Destructor. Destructs the Triple object.

Member Function Documentation

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE void BALL::Triple< T1, T2, T3 >::clear (  )  [inline, virtual]

Clear method.

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE void BALL::Triple< T1, T2, T3 >::get ( T1 &  first,
T2 &  second,
T3 &  third 
) const [inline]

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator!= ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

Inequality operator

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator< ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

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 threeth is less.

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator<= ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

Lesser or equal than operator.

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE const Triple< T1, T2, T3 > & BALL::Triple< T1, T2, T3 >::operator= ( const Triple< T1, T2, T3 > &  triple  )  [inline]

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

Parameters:
triple the triple to be copied

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator== ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

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

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator> ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

Greater than operator.

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE bool BALL::Triple< T1, T2, T3 >::operator>= ( const Triple< T1, T2, T3 > &  triple  )  const [inline]

Greater or equal than operator.

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

template<typename T1 , typename T2 , typename T3 >
BALL_INLINE void BALL::Triple< T1, T2, T3 >::set ( const T1 &  t1,
const T2 &  t2,
const T3 &  t3 
) [inline]

References BALL::Triple< T1, T2, T3 >::first, BALL::Triple< T1, T2, T3 >::second, and BALL::Triple< T1, T2, T3 >::third.

Member Data Documentation

template<typename T1, typename T2, typename T3>
T1 BALL::Triple< T1, T2, T3 >::first

The first triple member

Referenced by BALL::Triple< T1, T2, T3 >::clear(), BALL::Triple< T1, T2, T3 >::get(), BALL::Triple< T1, T2, T3 >::operator!=(), BALL::Triple< T1, T2, T3 >::operator<(), BALL::Triple< T1, T2, T3 >::operator<=(), BALL::Triple< T1, T2, T3 >::operator=(), BALL::Triple< T1, T2, T3 >::operator==(), BALL::Triple< T1, T2, T3 >::operator>(), BALL::Triple< T1, T2, T3 >::operator>=(), and BALL::Triple< T1, T2, T3 >::set().

template<typename T1, typename T2, typename T3>
T2 BALL::Triple< T1, T2, T3 >::second

The second triple member

Referenced by BALL::Triple< T1, T2, T3 >::clear(), BALL::Triple< T1, T2, T3 >::get(), BALL::Triple< T1, T2, T3 >::operator!=(), BALL::Triple< T1, T2, T3 >::operator<(), BALL::Triple< T1, T2, T3 >::operator<=(), BALL::Triple< T1, T2, T3 >::operator=(), BALL::Triple< T1, T2, T3 >::operator==(), BALL::Triple< T1, T2, T3 >::operator>(), BALL::Triple< T1, T2, T3 >::operator>=(), and BALL::Triple< T1, T2, T3 >::set().

template<typename T1, typename T2, typename T3>
T3 BALL::Triple< T1, T2, T3 >::third

The third triple member

Referenced by BALL::Triple< T1, T2, T3 >::clear(), BALL::Triple< T1, T2, T3 >::get(), BALL::Triple< T1, T2, T3 >::operator!=(), BALL::Triple< T1, T2, T3 >::operator<(), BALL::Triple< T1, T2, T3 >::operator<=(), BALL::Triple< T1, T2, T3 >::operator=(), BALL::Triple< T1, T2, T3 >::operator==(), BALL::Triple< T1, T2, T3 >::operator>(), BALL::Triple< T1, T2, T3 >::operator>=(), and BALL::Triple< T1, T2, T3 >::set().