CLHEP 2.4.7.1
C++ Class Library for High Energy Physics
CLHEP::HepAxisAngle Class Reference

#include <CLHEP/Vector/AxisAngle.h>

Public Types

typedef double Scalar
 

Public Member Functions

 HepAxisAngle ()
 
 HepAxisAngle (const Hep3Vector axis, Scalar delta)
 
Hep3Vector getAxis () const
 
Hep3Vector axis () const
 
AAsetAxis (const Hep3Vector axis)
 
double getDelta () const
 
double delta () const
 
AAsetDelta (Scalar delta)
 
AAset (const Hep3Vector axis, Scalar delta)
 
int compare (const AA &aa) const
 
bool operator== (const AA &aa) const
 
bool operator!= (const AA &aa) const
 
bool operator< (const AA &aa) const
 
bool operator<= (const AA &aa) const
 
bool operator> (const AA &aa) const
 
bool operator>= (const AA &aa) const
 
bool isNear (const AA &aa, Scalar epsilon=tolerance) const
 
double howNear (const AA &aa) const
 

Static Public Member Functions

static double getTolerance ()
 
static double setTolerance (Scalar tol)
 

Protected Types

typedef HepAxisAngle AA
 

Protected Member Functions

double distance (const HepAxisAngle &aa) const
 

Static Protected Attributes

static Scalar tolerance
 

Friends

std::ostream & operator<< (std::ostream &os, const AA &aa)
 
std::istream & operator>> (std::istream &is, AA &aa)
 

Detailed Description

Author

Definition at line 37 of file AxisAngle.h.

Member Typedef Documentation

◆ AA

Definition at line 43 of file AxisAngle.h.

◆ Scalar

Definition at line 40 of file AxisAngle.h.

Constructor & Destructor Documentation

◆ HepAxisAngle() [1/2]

CLHEP::HepAxisAngle::HepAxisAngle ( )
inline

Definition at line 21 of file AxisAngle.icc.

Referenced by distance(), set(), setAxis(), and setDelta().

◆ HepAxisAngle() [2/2]

CLHEP::HepAxisAngle::HepAxisAngle ( const Hep3Vector axis,
Scalar delta )
inline

Definition at line 25 of file AxisAngle.icc.

Member Function Documentation

◆ axis()

Hep3Vector CLHEP::HepAxisAngle::axis ( ) const
inline

Definition at line 34 of file AxisAngle.icc.

◆ compare()

int CLHEP::HepAxisAngle::compare ( const AA & aa) const
inline

Definition at line 67 of file AxisAngle.icc.

Referenced by operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

◆ delta()

double CLHEP::HepAxisAngle::delta ( ) const
inline

Definition at line 49 of file AxisAngle.icc.

◆ distance()

double CLHEP::HepAxisAngle::distance ( const HepAxisAngle & aa) const
protected

References HepAxisAngle().

◆ getAxis()

Hep3Vector CLHEP::HepAxisAngle::getAxis ( ) const
inline

Definition at line 30 of file AxisAngle.icc.

◆ getDelta()

double CLHEP::HepAxisAngle::getDelta ( ) const
inline

Definition at line 45 of file AxisAngle.icc.

◆ getTolerance()

double CLHEP::HepAxisAngle::getTolerance ( )
inlinestatic

Definition at line 108 of file AxisAngle.icc.

References tolerance.

◆ howNear()

double CLHEP::HepAxisAngle::howNear ( const AA & aa) const

◆ isNear()

bool CLHEP::HepAxisAngle::isNear ( const AA & aa,
Scalar epsilon = tolerance ) const

References tolerance.

◆ operator!=()

bool CLHEP::HepAxisAngle::operator!= ( const AA & aa) const
inline

Definition at line 83 of file AxisAngle.icc.

References compare().

◆ operator<()

bool CLHEP::HepAxisAngle::operator< ( const AA & aa) const
inline

Definition at line 88 of file AxisAngle.icc.

References compare().

◆ operator<=()

bool CLHEP::HepAxisAngle::operator<= ( const AA & aa) const
inline

Definition at line 93 of file AxisAngle.icc.

References compare().

◆ operator==()

bool CLHEP::HepAxisAngle::operator== ( const AA & aa) const
inline

Definition at line 78 of file AxisAngle.icc.

References compare().

◆ operator>()

bool CLHEP::HepAxisAngle::operator> ( const AA & aa) const
inline

Definition at line 98 of file AxisAngle.icc.

References compare().

◆ operator>=()

bool CLHEP::HepAxisAngle::operator>= ( const AA & aa) const
inline

Definition at line 103 of file AxisAngle.icc.

References compare().

◆ set()

HepAxisAngle & CLHEP::HepAxisAngle::set ( const Hep3Vector axis,
Scalar delta )
inline

Definition at line 60 of file AxisAngle.icc.

References HepAxisAngle(), and CLHEP::Hep3Vector::unit().

◆ setAxis()

HepAxisAngle & CLHEP::HepAxisAngle::setAxis ( const Hep3Vector axis)
inline

Definition at line 39 of file AxisAngle.icc.

References HepAxisAngle(), and CLHEP::Hep3Vector::unit().

◆ setDelta()

HepAxisAngle & CLHEP::HepAxisAngle::setDelta ( Scalar delta)
inline

Definition at line 54 of file AxisAngle.icc.

References HepAxisAngle().

◆ setTolerance()

double CLHEP::HepAxisAngle::setTolerance ( Scalar tol)
inlinestatic

Definition at line 113 of file AxisAngle.icc.

References tolerance.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
const AA & aa )
friend

◆ operator>>

std::istream & operator>> ( std::istream & is,
AA & aa )
friend

Member Data Documentation

◆ tolerance

Scalar CLHEP::HepAxisAngle::tolerance
staticprotected

Definition at line 44 of file AxisAngle.h.

Referenced by getTolerance(), isNear(), and setTolerance().


The documentation for this class was generated from the following files: