Geom::Phi< T > Class Template Reference

#include <Phi.h>

Public Member Functions
T	degrees () const
template<class T1 >
	operator Phi< T1 > ()
	Template argument conversion. More...
	operator T () const
	conversion operator makes transparent use possible. More...
Phi &	operator*= (const T &a)
Phi &	operator+= (const T &a)
	Standard arithmetics. More...
Phi &	operator+= (const Phi &a)
Phi &	operator-= (const T &a)
Phi &	operator-= (const Phi &a)
Phi &	operator/= (const T &a)
	Phi ()
	Default constructor does not initialise - just as double. More...
	Phi (const T &val)
T	value () const
	Explicit access to value in case implicit conversion not OK. More...

Private Member Functions
void	normalize ()

Private Attributes
T	theValue

Detailed Description

template<class T>
class Geom::Phi< T >

A class for azimuthal angle represantation and algebra. The use of Phi<T> is tranparant due to the implicit conversion to T Constructs like cos(phi) work as with float or double. The difference with respect to built-in types is that Phi is kept in the range (-pi, pi], and this is consistently implemented in aritmetic operations. In other words, Phi implements "modulo(2 pi)" arithmetics.

Definition at line 20 of file Phi.h.

Constructor & Destructor Documentation

template<class T>

Geom::Phi< T >::Phi ( )

inline

Default constructor does not initialise - just as double.

Definition at line 24 of file Phi.h.

{}

template<class T>

Geom::Phi< T >::Phi ( const T &  val )

inlineexplicit

Constructor from T, does not provide automatic conversion. The constructor provides range checking and normalization, e.g. the value of Pi(2*pi()+1) is 1

Definition at line 29 of file Phi.h.

: theValue(val) { normalize();}

Member Function Documentation

template<class T>

T Geom::Phi< T >::degrees ( ) const

inline

Definition at line 51 of file Phi.h.

Referenced by CSCRecHit2DValidation::analyze(), TrackerHitAnalyzer::analyze(), and Geant4ePropagator::propagate().

{ return theValue*180./pi();}

template<class T>

void Geom::Phi< T >::normalize ( )

inlineprivate

Definition at line 57 of file Phi.h.

Referenced by Geom::Phi< float >::operator*=(), Geom::Phi< float >::operator+=(), Geom::Phi< float >::operator-=(), Geom::Phi< float >::operator/=(), and Geom::Phi< float >::Phi().

                     { 
      if( theValue > twoPi() || theValue < -twoPi()) {
    theValue = fmod( theValue, (T) twoPi());
      }
      if (theValue <= -pi()) theValue += twoPi();
      if (theValue >  pi()) theValue -= twoPi();
    }

template<class T>

template<class T1 >

Geom::Phi< T >::operator Phi< T1 > ( )

inline

Template argument conversion.

Definition at line 35 of file Phi.h.

{ return Phi<T1>(theValue);}

template<class T>

Geom::Phi< T >::operator T ( ) const

inline

conversion operator makes transparent use possible.

Definition at line 32 of file Phi.h.

References Geom::Phi< T >::theValue.

{ return theValue;}

template<class T>

Phi& Geom::Phi< T >::operator*= ( const T &  a )

inline

Definition at line 47 of file Phi.h.

{theValue*=a; normalize(); return *this;}

template<class T>

Phi& Geom::Phi< T >::operator+= ( const T &  a )

inline

Standard arithmetics.

Definition at line 41 of file Phi.h.

{theValue+=a; normalize(); return *this;}

template<class T>

Phi& Geom::Phi< T >::operator+= ( const Phi< T > &  a )

inline

Definition at line 42 of file Phi.h.

Referenced by Geom::Phi< float >::operator+=().

{return operator+=(a.value());}

template<class T>

Phi& Geom::Phi< T >::operator-= ( const T &  a )

inline

Definition at line 44 of file Phi.h.

{theValue-=a; normalize(); return *this;}

template<class T>

Phi& Geom::Phi< T >::operator-= ( const Phi< T > &  a )

inline

Definition at line 45 of file Phi.h.

Referenced by Geom::Phi< float >::operator-=().

{return operator-=(a.value());}

template<class T>

Phi& Geom::Phi< T >::operator/= ( const T &  a )

inline

Definition at line 49 of file Phi.h.

{theValue/=a; normalize(); return *this;}

template<class T>

T Geom::Phi< T >::value ( ) const

inline

Explicit access to value in case implicit conversion not OK.

Definition at line 38 of file Phi.h.

Referenced by reco::WMuNuCandidate::acop(), EwkMuDQM::analyze(), Basic3DVector< long double >::Basic3DVector(), Basic3DVector< align::Scalar >::Basic3DVector(), Vispa.Views.PropertyView.FileProperty::buttonClicked(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), WMuNuValidator::filter(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Mixins.UsingBlock::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), Vispa.Views.PropertyView.FileProperty::labelDoubleClicked(), Geom::Phi< float >::operator+=(), Geom::operator-(), Geom::Phi< float >::operator-=(), Geom::operator/(), and PhiBorderFinder::PhiBorderFinder().

{ return theValue;}

Member Data Documentation

template<class T>

T Geom::Phi< T >::theValue

private

Definition at line 55 of file Phi.h.

Referenced by Geom::Phi< float >::degrees(), Geom::Phi< float >::normalize(), Geom::Phi< float >::operator Phi< T1 >(), Geom::Phi< T >::operator T(), Geom::Phi< float >::operator*=(), Geom::Phi< float >::operator+=(), Geom::Phi< float >::operator-=(), Geom::Phi< float >::operator/=(), and Geom::Phi< float >::value().