BasicVector3D< T > Class Template Reference

Inheritance diagram for BasicVector3D< T >:

Public Types
enum	{   X = 0, Y = 1, Z = 2, NUM_COORDINATES = 3,   SIZE = NUM_COORDINATES }

Public Member Functions
	BasicVector3D (T x1, T y1, T z1)
	BasicVector3D (const BasicVector3D< float > &v)
virtual	~BasicVector3D ()
	operator T * ()
	operator const T * () const
	operator CLHEP::Hep3Vector () const
BasicVector3D< T > &	operator= (const BasicVector3D< T > &v)
BasicVector3D< T > &	operator+= (const BasicVector3D< T > &v)
BasicVector3D< T > &	operator-= (const BasicVector3D< T > &v)
BasicVector3D< T > &	operator*= (double a)
BasicVector3D< T > &	operator/= (double a)
T	operator() (int i) const
T	operator[] (int i) const
T &	operator() (int i)
T &	operator[] (int i)
T	x () const
T	y () const
T	z () const
void	setX (T a)
void	setY (T a)
void	setZ (T a)
void	set (T x1, T y1, T z1)
T	perp2 () const
T	perp () const
T	rho () const
void	setPerp (T rh)
T	mag2 () const
T	mag () const
T	r () const
T	phi () const
T	theta () const
T	cosTheta () const
T	getR () const
T	getPhi () const
T	getTheta () const
void	setMag (T ma)
void	setR (T ma)
void	setPhi (T ph)
void	setTheta (T th)
T	pseudoRapidity () const
T	eta () const
T	getEta () const
void	setEta (T a)
T	dot (const BasicVector3D< T > &v) const
BasicVector3D< T >	cross (const BasicVector3D< T > &v) const
T	perp2 (const BasicVector3D< T > &v) const
T	perp (const BasicVector3D< T > &v) const
T	angle (const BasicVector3D< T > &v) const
BasicVector3D< T >	unit () const
BasicVector3D< T >	orthogonal () const
BasicVector3D< T > &	rotateX (T a)
BasicVector3D< T > &	rotateY (T a)
BasicVector3D< T > &	rotateZ (T a)
BasicVector3D< T > &	rotate (T a, const BasicVector3D< T > &v)

Protected Member Functions
	BasicVector3D ()

Protected Attributes
T	v_ [3]

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &, const BasicVector3D< float > &)
std::istream &	operator>> (std::istream &, BasicVector3D< float > &)
BasicVector3D< float >	operator+ (const BasicVector3D< float > &v)
BasicVector3D< float >	operator+ (const BasicVector3D< float > &a, const BasicVector3D< float > &b)
BasicVector3D< float >	operator- (const BasicVector3D< float > &v)
BasicVector3D< float >	operator- (const BasicVector3D< float > &a, const BasicVector3D< float > &b)
BasicVector3D< float >	operator* (const BasicVector3D< float > &v, double a)
float	operator* (const BasicVector3D< float > &a, const BasicVector3D< float > &b)
BasicVector3D< float >	operator* (double a, const BasicVector3D< float > &v)
BasicVector3D< float >	operator/ (const BasicVector3D< float > &v, double a)
bool	operator== (const BasicVector3D< float > &a, const BasicVector3D< float > &b)
bool	operator!= (const BasicVector3D< float > &a, const BasicVector3D< float > &b)
std::ostream &	operator<< (std::ostream &, const BasicVector3D< double > &)
std::istream &	operator>> (std::istream &, BasicVector3D< double > &)
BasicVector3D< double >	operator+ (const BasicVector3D< double > &v)
BasicVector3D< double >	operator+ (const BasicVector3D< double > &a, const BasicVector3D< double > &b)
BasicVector3D< double >	operator- (const BasicVector3D< double > &v)
BasicVector3D< double >	operator- (const BasicVector3D< double > &a, const BasicVector3D< double > &b)
BasicVector3D< double >	operator* (const BasicVector3D< double > &v, double a)
double	operator* (const BasicVector3D< double > &a, const BasicVector3D< double > &b)
BasicVector3D< double >	operator* (double a, const BasicVector3D< double > &v)
BasicVector3D< double >	operator/ (const BasicVector3D< double > &v, double a)
bool	operator== (const BasicVector3D< double > &a, const BasicVector3D< double > &b)
bool	operator!= (const BasicVector3D< double > &a, const BasicVector3D< double > &b)

Detailed Description

template<class T>
class HepGeom::BasicVector3D< T >

Base class for Point3D<T>, Vector3D<T> and Normal3D<T>. It defines only common functionality for those classes and should not be used as separate class.

Author

Evgeni Chernyaev Evgue.nosp@m.ni.T.nosp@m.chern.nosp@m.iaev.nosp@m.@cern.nosp@m..ch

Member Enumeration Documentation

anonymous enum

Safe indexing of the coordinates when using with matrices, arrays, etc.

Enumerator
X	index for x-component
Y	index for y-component
Z	index for z-component
NUM_COORDINATES	number of components
SIZE	number of components

Constructor & Destructor Documentation

BasicVector3D ( )

protected

Default constructor. It is protected - this class should not be instantiated directly.

BasicVector3D	(	T	x1,
		T	y1,
		T	z1
	)

Constructor from three numbers.

BasicVector3D

(

const BasicVector3D< float > &

v

)

Copy constructor. Note: BasicVector3D<double> has constructors from BasicVector3D<double> (provided by compiler) and from BasicVector3D<float> (defined in this file); BasicVector3D<float> has only the last one.

virtual ~BasicVector3D ( )

virtual

Destructor.

Member Function Documentation

operator T *

(

)

Conversion (cast) to ordinary array.

References BasicVector3D< T >::v_.

operator const T *

(

)

const

Conversion (cast) to ordinary const array.

References BasicVector3D< T >::v_.

operator CLHEP::Hep3Vector

(

)

const

Conversion (cast) to CLHEP::Hep3Vector. This operator is needed only for backward compatibility and in principle should not exit.

BasicVector3D<T>& operator=

(

const BasicVector3D< T > &

v

)

Assignment.

BasicVector3D<T>& operator+=

(

const BasicVector3D< T > &

v

)

Addition.

BasicVector3D<T>& operator-=

(

const BasicVector3D< T > &

v

)

Subtraction.

BasicVector3D<T>& operator*=

(

double

a

)

Multiplication by scalar.

BasicVector3D<T>& operator/=

(

double

a

)

Division by scalar.

T operator()

(

int

i

)

const

Gets components by index.

T operator[]

(

int

i

)

const

Gets components by index.

T& operator()

(

int

i

)

Sets components by index.

T& operator[]

(

int

i

)

Sets components by index.

T x

(

)

const

Gets x-component in cartesian coordinate system.

Referenced by BasicVector3D< G4double >::BasicVector3D(), BasicVector3D< G4double >::cross(), Plane3D< G4double >::distance(), Point3D< float >::distance2(), Point3D< double >::distance2(), BasicVector3D< G4double >::dot(), BasicVector3D< G4double >::mag2(), BasicVector3D< G4double >::operator CLHEP::Hep3Vector(), Normal3D< double >::operator CLHEP::Hep3Vector(), Vector3D< double >::operator CLHEP::Hep3Vector(), Point3D< double >::operator CLHEP::Hep3Vector(), BasicVector3D< T >::operator!=(), BasicVector3D< T >::operator*(), BasicVector3D< T >::operator+(), BasicVector3D< T >::operator-(), BasicVector3D< T >::operator/(), Point3D< float >::operator=(), Normal3D< float >::operator=(), Vector3D< float >::operator=(), Normal3D< double >::operator=(), Vector3D< double >::operator=(), Point3D< double >::operator=(), BasicVector3D< T >::operator==(), BasicVector3D< G4double >::orthogonal(), BasicVector3D< G4double >::perp2(), BasicVector3D< G4double >::phi(), Plane3D< G4double >::Plane3D(), Plane3D< G4double >::point(), BasicVector3D< G4double >::theta(), Plane3D< G4double >::transform(), and BasicVector3D< G4double >::unit().

T y

(

)

const

Gets y-component in cartesian coordinate system.

Referenced by BasicVector3D< G4double >::BasicVector3D(), BasicVector3D< G4double >::cross(), Plane3D< G4double >::distance(), Point3D< float >::distance2(), Point3D< double >::distance2(), BasicVector3D< G4double >::dot(), BasicVector3D< G4double >::mag2(), BasicVector3D< G4double >::operator CLHEP::Hep3Vector(), Normal3D< double >::operator CLHEP::Hep3Vector(), Vector3D< double >::operator CLHEP::Hep3Vector(), Point3D< double >::operator CLHEP::Hep3Vector(), BasicVector3D< T >::operator!=(), BasicVector3D< T >::operator*(), BasicVector3D< T >::operator+(), BasicVector3D< T >::operator-(), BasicVector3D< T >::operator/(), Point3D< float >::operator=(), Normal3D< float >::operator=(), Vector3D< float >::operator=(), Normal3D< double >::operator=(), Vector3D< double >::operator=(), Point3D< double >::operator=(), BasicVector3D< T >::operator==(), BasicVector3D< G4double >::orthogonal(), BasicVector3D< G4double >::perp2(), BasicVector3D< G4double >::phi(), Plane3D< G4double >::Plane3D(), Plane3D< G4double >::point(), BasicVector3D< G4double >::theta(), Plane3D< G4double >::transform(), and BasicVector3D< G4double >::unit().

T z

(

)

const

Gets z-component in cartesian coordinate system.

Referenced by BasicVector3D< G4double >::BasicVector3D(), BasicVector3D< G4double >::cosTheta(), BasicVector3D< G4double >::cross(), Plane3D< G4double >::distance(), Point3D< float >::distance2(), Point3D< double >::distance2(), BasicVector3D< G4double >::dot(), BasicVector3D< G4double >::mag2(), BasicVector3D< G4double >::operator CLHEP::Hep3Vector(), Normal3D< double >::operator CLHEP::Hep3Vector(), Vector3D< double >::operator CLHEP::Hep3Vector(), Point3D< double >::operator CLHEP::Hep3Vector(), BasicVector3D< T >::operator!=(), BasicVector3D< T >::operator*(), BasicVector3D< T >::operator+(), BasicVector3D< T >::operator-(), BasicVector3D< T >::operator/(), Point3D< float >::operator=(), Normal3D< float >::operator=(), Vector3D< float >::operator=(), Normal3D< double >::operator=(), Vector3D< double >::operator=(), Point3D< double >::operator=(), BasicVector3D< T >::operator==(), BasicVector3D< G4double >::orthogonal(), Plane3D< G4double >::Plane3D(), Plane3D< G4double >::point(), BasicVector3D< G4double >::theta(), Plane3D< G4double >::transform(), and BasicVector3D< G4double >::unit().

void setX

(

T

a

)

Sets x-component in cartesian coordinate system.

Referenced by BasicVector3D< G4double >::setPhi().

void setY

(

T

a

)

Sets y-component in cartesian coordinate system.

Referenced by BasicVector3D< G4double >::setPhi().

void setZ

(

T

a

)

Sets z-component in cartesian coordinate system.

void set	(	T	x1,
		T	y1,
		T	z1
	)

Sets components in cartesian coordinate system.

Referenced by Normal3D< float >::operator=(), Point3D< float >::operator=(), Vector3D< float >::operator=(), Vector3D< double >::operator=(), Normal3D< double >::operator=(), Point3D< double >::operator=(), and BasicVector3D< G4double >::setTheta().

T perp2

(

)

const

Gets transverse component squared.

Referenced by BasicVector3D< G4double >::perp().

T perp

(

)

const

Gets transverse component.

Referenced by BasicVector3D< G4double >::rho(), BasicVector3D< G4double >::setPerp(), BasicVector3D< G4double >::setPhi(), and BasicVector3D< G4double >::theta().

T rho

(

)

const

Gets rho-component in cylindrical coordinate system

void setPerp

(

T

rh

)

Sets transverse component keeping phi and z constant.

T mag2

(

)

const

Gets magnitude squared of the vector.

Referenced by Point3D< float >::distance2(), Point3D< double >::distance2(), BasicVector3D< G4double >::mag(), and BasicVector3D< G4double >::perp2().

T mag

(

)

const

Gets magnitude of the vector.

Referenced by BasicVector3D< G4double >::cosTheta(), BasicVector3D< G4double >::r(), BasicVector3D< G4double >::setMag(), BasicVector3D< G4double >::setTheta(), and BasicVector3D< G4double >::unit().

T r

(

)

const

Gets r-component in spherical coordinate system

Referenced by BasicVector3D< G4double >::getR().

T phi

(

)

const

Gets azimuth angle.

Referenced by BasicVector3D< G4double >::getPhi(), and BasicVector3D< G4double >::setTheta().

T theta

(

)

const

Gets polar angle.

Referenced by BasicVector3D< G4double >::getTheta().

T cosTheta

(

)

const

Gets cosine of polar angle.

T getR

(

)

const

Gets r-component in spherical coordinate system

T getPhi

(

)

const

Gets phi-component in spherical coordinate system

T getTheta

(

)

const

Gets theta-component in spherical coordinate system

void setMag

(

T

ma

)

Sets magnitude.

Referenced by BasicVector3D< G4double >::setR().

void setR

(

T

ma

)

Sets r-component in spherical coordinate system.

void setPhi

(

T

ph

)

Sets phi-component in spherical coordinate system.

void setTheta

(

T

th

)

Sets theta-component in spherical coordinate system.

T pseudoRapidity

(

)

const

Gets pseudo-rapidity: -ln(tan(theta/2))

Referenced by BasicVector3D< G4double >::eta(), and BasicVector3D< G4double >::getEta().

T eta

(

)

const

Gets pseudo-rapidity.

T getEta

(

)

const

Gets pseudo-rapidity.

void setEta

(

T

a

)

Sets pseudo-rapidity, keeping magnitude and phi fixed.

T dot

(

const BasicVector3D< T > &

v

)

const

Scalar product.

Referenced by BasicVector3D< T >::operator*(), and BasicVector3D< G4double >::perp2().

BasicVector3D<T> cross

(

const BasicVector3D< T > &

v

)

const

Vector product.

Referenced by G4ErrorSurfaceTrajParam::GetPlaneNormal().

T perp2

(

const BasicVector3D< T > &

v

)

const

Returns transverse component w.r.t. given axis squared.

T perp

(

const BasicVector3D< T > &

v

)

const

Returns transverse component w.r.t. given axis.

T angle

(

const BasicVector3D< T > &

v

)

const

Returns angle w.r.t. another vector.

BasicVector3D<T> unit

(

)

const

Returns unit vector parallel to this.

BasicVector3D<T> orthogonal

(

)

const

Returns orthogonal vector.

BasicVector3D<T>& rotateX

(

T

a

)

Rotates around x-axis.

BasicVector3D<T>& rotateY

(

T

a

)

Rotates around y-axis.

BasicVector3D<T>& rotateZ

(

T

a

)

Rotates around z-axis.

BasicVector3D<T>& rotate	(	T	a,
		const BasicVector3D< T > &	v
	)

Rotates around the axis specified by another vector.

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  , const BasicVector3D< float > &    )

related

Output to stream.

std::istream & operator>> ( std::istream &  , BasicVector3D< float > &    )

related

Input from stream.

BasicVector3D< float > operator+ ( const BasicVector3D< float > &  v )

related

Unary plus.

BasicVector3D< float > operator+ ( const BasicVector3D< float > &  a, const BasicVector3D< float > &  b  )

related

Addition of two vectors.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< float > operator- ( const BasicVector3D< float > &  v )

related

Unary minus.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< float > operator- ( const BasicVector3D< float > &  a, const BasicVector3D< float > &  b  )

related

Subtraction of two vectors.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< float > operator* ( const BasicVector3D< float > &  v, double  a  )

related

Multiplication vector by scalar.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

float operator* ( const BasicVector3D< float > &  a, const BasicVector3D< float > &  b  )

related

Scalar product of two vectors.

References BasicVector3D< T >::dot().

BasicVector3D< float > operator* ( double  a, const BasicVector3D< float > &  v  )

related

Multiplication scalar by vector.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< float > operator/ ( const BasicVector3D< float > &  v, double  a  )

related

Division vector by scalar.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

bool operator== ( const BasicVector3D< float > &  a, const BasicVector3D< float > &  b  )

related

Comparison of two vectors for equality.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

bool operator!= ( const BasicVector3D< float > &  a, const BasicVector3D< float > &  b  )

related

Comparison of two vectors for inequality.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

std::ostream & operator<< ( std::ostream &  , const BasicVector3D< double > &    )

related

Output to stream.

std::istream & operator>> ( std::istream &  , BasicVector3D< double > &    )

related

Input from stream.

BasicVector3D< double > operator+ ( const BasicVector3D< double > &  v )

related

Unary plus.

BasicVector3D< double > operator+ ( const BasicVector3D< double > &  a, const BasicVector3D< double > &  b  )

related

Addition of two vectors.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< double > operator- ( const BasicVector3D< double > &  v )

related

Unary minus.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< double > operator- ( const BasicVector3D< double > &  a, const BasicVector3D< double > &  b  )

related

Subtraction of two vectors.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< double > operator* ( const BasicVector3D< double > &  v, double  a  )

related

Multiplication vector by scalar.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

double operator* ( const BasicVector3D< double > &  a, const BasicVector3D< double > &  b  )

related

Scalar product of two vectors.

References BasicVector3D< T >::dot().

BasicVector3D< double > operator* ( double  a, const BasicVector3D< double > &  v  )

related

Multiplication scalar by vector.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

BasicVector3D< double > operator/ ( const BasicVector3D< double > &  v, double  a  )

related

Division vector by scalar.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

bool operator== ( const BasicVector3D< double > &  a, const BasicVector3D< double > &  b  )

related

Comparison of two vectors for equality.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

bool operator!= ( const BasicVector3D< double > &  a, const BasicVector3D< double > &  b  )

related

Comparison of two vectors for inequality.

References BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Member Data Documentation

T v_[3]

protected

Referenced by BasicVector3D< G4double >::BasicVector3D(), BasicVector3D< T >::operator const T *(), BasicVector3D< T >::operator T *(), BasicVector3D< G4double >::operator()(), BasicVector3D< G4double >::operator*=(), BasicVector3D< G4double >::operator+=(), BasicVector3D< G4double >::operator-=(), BasicVector3D< G4double >::operator/=(), BasicVector3D< G4double >::operator=(), BasicVector3D< G4double >::operator[](), BasicVector3D< G4double >::set(), BasicVector3D< G4double >::setMag(), BasicVector3D< G4double >::setPerp(), BasicVector3D< G4double >::setX(), BasicVector3D< G4double >::setY(), BasicVector3D< G4double >::setZ(), BasicVector3D< G4double >::x(), BasicVector3D< G4double >::y(), and BasicVector3D< G4double >::z().