FreePOOMA  2.4.1
Public Member Functions
One< T > Struct Template Reference

The point of this class is to be a number of type T which is known at compile time to be one. More...

#include <One.h>

List of all members.

Public Member Functions

 operator T () const
 If you need to convert to an object of type T, just build one from one.
bool operator== (const One< T > &) const
 One ()
 Give it empty ctors and assignment operators to try and keep purify happy.
 One (const One< T > &)
One< T > & operator= (const One< T > &)

Detailed Description

template<class T>
struct One< T >

The point of this class is to be a number of type T which is known at compile time to be one.

This is reflected in the operations like multiplication and division that use it. If you return a One object, the compiler should be able to make better optimizations than if you just return one. One is templated on type T, to represent a one object of type T. Type T is required to be constructable from an integer one.


Constructor & Destructor Documentation

template<class T >
One< T >::One ( ) [inline]

Give it empty ctors and assignment operators to try and keep purify happy.

template<class T >
One< T >::One ( const One< T > &  ) [inline]

Member Function Documentation

template<class T >
One< T >::operator T ( ) const [inline]

If you need to convert to an object of type T, just build one from one.

This will be used in the cases where the operators below don't match.

template<class T >
bool One< T >::operator== ( const One< T > &  ) const [inline]
template<class T >
One<T>& One< T >::operator= ( const One< T > &  ) [inline]

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