CLHEP::HepAxisAngle Class Reference

#include <AxisAngle.h>

Public Types
typedef double	Scalar

Public Member Functions
Hep3Vector	axis () const
int	compare (const AA &aa) const
double	delta () const
Hep3Vector	getAxis () const
double	getDelta () const
	HepAxisAngle ()
	HepAxisAngle (const Hep3Vector axis, Scalar delta)
double	howNear (const AA &aa) const
bool	isNear (const AA &aa, Scalar epsilon=tolerance) 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
AA &	set (const Hep3Vector axis, Scalar delta)
AA &	setAxis (const Hep3Vector axis)
AA &	setDelta (Scalar delta)

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 = Hep3Vector::ToleranceTicks * 1.0e-08

Private Attributes
Hep3Vector	axis_
double	delta_

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

Detailed Description

Author

Definition at line 36 of file AxisAngle.h.

Member Typedef Documentation

AA

typedef HepAxisAngle CLHEP::HepAxisAngle::AA

protected

Definition at line 42 of file AxisAngle.h.

Scalar

typedef double CLHEP::HepAxisAngle::Scalar

Definition at line 39 of file AxisAngle.h.

Constructor & Destructor Documentation

HepAxisAngle() [1/2]

CLHEP::HepAxisAngle::HepAxisAngle ( )

inline

HepAxisAngle() [2/2]

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

inline

Member Function Documentation

axis()

Hep3Vector CLHEP::HepAxisAngle::axis ( ) const

inline

Referenced by CLHEP::HepRotation::HepRotation(), and CLHEP::HepRotation::set().

compare()

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

inline

delta()

double CLHEP::HepAxisAngle::delta ( ) const

inline

Referenced by CLHEP::HepRotation::HepRotation(), CLHEP::Hep3Vector::rotate(), CLHEP::HepRotation::set(), and CLHEP::ZMpvAxisAngleRep().

distance()

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

protected

Definition at line 49 of file AxisAngle.cc.

                                                    {
 
  double thisRep[9];
  double aaRep[9];
 
  ZMpvAxisAngleRep( *this, thisRep );
  ZMpvAxisAngleRep( aa,    aaRep );
 
  double sum = 0.0;
  for ( int i = 0; i < 9; i++ )  {
    sum += thisRep[i] * aaRep[i];
  }
 
  double d = 3.0 - sum;     // NaN-proofing: 
  return  (d >= 0) ? d : 0;             // std::sqrt(distance) is used in howNear()
 
}  // HepAxisAngle::distance()

References CLHEP::ZMpvAxisAngleRep().

Referenced by howNear(), and isNear().

getAxis()

Hep3Vector CLHEP::HepAxisAngle::getAxis ( ) const

inline

Referenced by CLHEP::Hep3Vector::rotate(), and CLHEP::ZMpvAxisAngleRep().

getDelta()

double CLHEP::HepAxisAngle::getDelta ( ) const

inline

getTolerance()

static double CLHEP::HepAxisAngle::getTolerance ( )

inlinestatic

howNear()

double CLHEP::HepAxisAngle::howNear

(

const AA &

aa

)

const

Definition at line 75 of file AxisAngle.cc.

                                                   {
 
  return  std::sqrt( distance( aa ) );
 
}  // HepAxisAngle::howNear()

References distance().

isNear()

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

Definition at line 68 of file AxisAngle.cc.

                                                                {
 
  return  distance( aa ) <= epsilon * epsilon;
 
}  // HepAxisAngle::isNear()

References distance(), and epsilon().

operator!=()

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

inline

operator<()

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

inline

operator<=()

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

inline

operator==()

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

inline

operator>()

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

inline

operator>=()

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

inline

set()

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

inline

setAxis()

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

inline

setDelta()

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

inline

setTolerance()

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

inlinestatic

Friends And Related Function Documentation

operator<<

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

friend

Definition at line 89 of file AxisAngle.cc.

                                                                  {
  os << '(' << aa.axis() << ", " << aa.delta() << ')';
  return  os;
}  // operator<<()

operator>>

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

friend

Definition at line 99 of file AxisAngle.cc.

                                                            {
  Hep3Vector axis;
  double delta;
  double x,y,z;
  ZMinputAxisAngle ( is, x, y, z, delta );
  axis.set(x,y,z);
  aa.set ( axis, delta );
  return  is;
}  // operator>>()

Field Documentation

axis_

Hep3Vector CLHEP::HepAxisAngle::axis_

private

Definition at line 96 of file AxisAngle.h.

delta_

double CLHEP::HepAxisAngle::delta_

private

Definition at line 97 of file AxisAngle.h.

tolerance

double CLHEP::HepAxisAngle::tolerance = Hep3Vector::ToleranceTicks * 1.0e-08

staticprotected

Definition at line 43 of file AxisAngle.h.

---

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

• source/externals/clhep/include/CLHEP/Vector/AxisAngle.h
• source/externals/clhep/src/AxisAngle.cc