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

Triple Class. More...

#include <triple.h>

List of all members.


Public Member Functions

virtual void clear ()
Clear method.
Constructors and Destructors
Triple ()
Default constructor.
Triple (const Triple &triple, bool deep=true)
Copy constructor.
Triple (const T1 &new_first, const T2 &new_second, const T3 &new_third)
Detailed constructor.
virtual ~Triple ()
Destructor.
Assignment
const Triple & operator= (const Triple &triple)
Assignment operator.
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
Equality operator Two instances are equal if they have the same members.
bool operator!= (const Triple &triple) const
Inequality operator.
bool operator< (const Triple &triple) const
Lesser than operator.
bool operator<= (const Triple &triple) const
Lesser or equal than operator.
bool operator>= (const Triple &triple) const
Greater or equal than operator.
bool operator> (const Triple &triple) const
Greater than operator.

Public Attributes

Attributes
T1 first
The first triple member.
T2 second
The second triple member.
T3 third
The third triple member.

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 ( )

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
)

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
)

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 ( ) [virtual]

Destructor.

Destructs the Triple object.


Member Function Documentation

template<typename T1 , typename T2 , typename T3 >
bool BALL::Triple< T1, T2, T3 >::operator< ( const Triple< T1, T2, T3 > & triple ) 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 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 >
const Triple< T1, T2, T3 > & BALL::Triple< T1, T2, T3 >::operator= ( const Triple< T1, T2, T3 > & triple )

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.


Generated on Thu Aug 6 18:30:28 2009 for BALL by doxygen 1.5.8