template<class CoordSystem, class Tag = DefaultCoordinateSystemTag>
class ROOT::Math::DisplacementVector3D< CoordSystem, Tag >

Class describing a generic displacement vector in 3 dimensions.

Class template describing a 3D displacement vector.

This class is templated on the type of Coordinate system. One example is the XYZVector which is a vector based on double precision x,y,z data members by using the ROOT::Math::Cartesian3D<double> Coordinate system. The class is having also an extra template parameter, the coordinate system tag, to be able to identify (tag) vector described in different reference coordinate system, like global or local coordinate systems.

See also: Overview of the physics vector library

Definition at line 58 of file DisplacementVector3D.h.

Public Types
typedef Tag	CoordinateSystemTag

typedef CoordSystem	CoordinateType

typedef CoordSystem::Scalar	Scalar

Public Member Functions
constexpr	DisplacementVector3D ()
	Default constructor.

template<class OtherCoords >
constexpr	DisplacementVector3D (const DisplacementVector3D< OtherCoords, Tag > &v)
	Construct from a displacement vector expressed in different coordinates, or using a different Scalar type, but with same coordinate system tag.

template<class ForeignVector >
constexpr	DisplacementVector3D (const ForeignVector &v)
	Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()

template<class OtherCoords >
constexpr	DisplacementVector3D (const PositionVector3D< OtherCoords, Tag > &p)
	Construct from a position vector expressed in different coordinates but with the same coordinate system tag.

constexpr	DisplacementVector3D (Scalar a, Scalar b, Scalar c)
	Construct from three values of type Scalar.

CoordSystem	Coordinates () const
	Retrieve a copy of the coordinates object.

template<class OtherCoords >
DisplacementVector3D	Cross (const DisplacementVector3D< OtherCoords, Tag > &v) const
	Return vector (cross) product of two displacement vectors, as a vector in the coordinate system of this class.

template<class OtherVector >
DisplacementVector3D	Cross (const OtherVector &v) const
	Return vector (cross) product of two vectors, as a vector in the coordinate system of this class.

unsigned int	Dimension () const
	Dimension.

template<class OtherCoords >
Scalar	Dot (const DisplacementVector3D< OtherCoords, Tag > &v) const
	Return the scalar (dot) product of two displacement vectors.

template<class OtherVector >
Scalar	Dot (const OtherVector &v) const
	Return the scalar (dot) product of two vectors.

Scalar	Eta () const
	Polar eta, converting if necessary from internal coordinate system.

Scalar	eta () const

template<class IT >
void	GetCoordinates (IT begin) const
	get internal data into 3 Scalars starting at *begin

template<class IT >
void	GetCoordinates (IT begin, IT end) const
	get internal data into 3 Scalars at begin to end (3 past begin)

void	GetCoordinates (Scalar &a, Scalar &b, Scalar &c) const
	get internal data into 3 Scalar numbers

void	GetCoordinates (Scalar dest[]) const
	get internal data into a C-style array of 3 Scalar numbers

Scalar	Mag2 () const
	Magnitute squared ( r^2 in spherical coordinate)

Scalar	mag2 () const

bool	operator!= (const DisplacementVector3D &rhs) const

DisplacementVector3D	operator* (Scalar a) const
	Multiply a vector by a real number.

DisplacementVector3D &	operator*= (Scalar a)
	multiply this vector by a scalar quantity

DisplacementVector3D	operator+ () const
	Positive of the vector, return itself.

template<class OtherCoords >
DisplacementVector3D &	operator+= (const DisplacementVector3D< OtherCoords, Tag > &v)
	Self Addition with a displacement vector.

DisplacementVector3D	operator- () const
	Negative of the vector.

template<class OtherCoords >
DisplacementVector3D &	operator-= (const DisplacementVector3D< OtherCoords, Tag > &v)
	Self Difference with a displacement vector.

DisplacementVector3D	operator/ (Scalar a) const
	Division of a vector with a real number.

DisplacementVector3D &	operator/= (Scalar a)
	divide this vector by a scalar quantity

template<class OtherCoords >
DisplacementVector3D &	operator= (const DisplacementVector3D< OtherCoords, Tag > &v)
	Assignment operator from a displacement vector of arbitrary type.

template<class ForeignVector >
DisplacementVector3D &	operator= (const ForeignVector &v)
	Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()

template<class OtherCoords >
DisplacementVector3D &	operator= (const PositionVector3D< OtherCoords, Tag > &rhs)
	Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian)

bool	operator== (const DisplacementVector3D &rhs) const
	Exact equality.

Scalar	Perp2 () const
	Transverse component squared (rho^2 in cylindrical coordinates.

Scalar	perp2 () const

Scalar	Phi () const
	Polar phi, converting if necessary from internal coordinate system.

Scalar	phi () const

Scalar	R () const
	Polar R, converting if necessary from internal coordinate system.

Scalar	r () const

Scalar	Rho () const
	Cylindrical transverse component rho.

Scalar	rho () const

DisplacementVector3D< CoordSystem, Tag > &	SetCoordinates (const Scalar src[])
	Set internal data based on a C-style array of 3 Scalar numbers.

template<class IT >
DisplacementVector3D< CoordSystem, Tag > &	SetCoordinates (IT begin, IT end)
	Set internal data based on 3 Scalars at begin to end.

DisplacementVector3D< CoordSystem, Tag > &	SetCoordinates (Scalar a, Scalar b, Scalar c)
	Set internal data based on 3 Scalar numbers.

DisplacementVector3D< CoordSystem, Tag > &	SetEta (Scalar etaval)
	Change Eta - CylindricalEta3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetPhi (Scalar ang)
	Change Phi - Polar3D or CylindricalEta3D coordinates.

DisplacementVector3D< CoordSystem, Tag > &	SetR (Scalar rr)
	Change R - Polar3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetRho (Scalar rr)
	Change Rho - CylindricalEta3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetTheta (Scalar ang)
	Change Theta - Polar3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetX (Scalar xx)
	Change X - Cartesian3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetXYZ (Scalar a, Scalar b, Scalar c)
	set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form)

DisplacementVector3D< CoordSystem, Tag > &	SetY (Scalar yy)
	Change Y - Cartesian3D coordinates only.

DisplacementVector3D< CoordSystem, Tag > &	SetZ (Scalar zz)
	Change Z - Cartesian3D coordinates only.

Scalar	Theta () const
	Polar theta, converting if necessary from internal coordinate system.

Scalar	theta () const

template<typename SCALAR = Scalar, typename std::enable_if< std::is_arithmetic< SCALAR >::value >::type * = nullptr>
DisplacementVector3D	Unit () const
	return unit vector parallel to this (scalar)

template<typename SCALAR = Scalar, typename std::enable_if<!std::is_arithmetic< SCALAR >::value >::type * = nullptr>
DisplacementVector3D	Unit () const
	return unit vector parallel to this (vector)

DisplacementVector3D	unit () const

Scalar	X () const
	Cartesian X, converting if necessary from internal coordinate system.

Scalar	x () const

Scalar	Y () const
	Cartesian Y, converting if necessary from internal coordinate system.

Scalar	y () const

Scalar	Z () const
	Cartesian Z, converting if necessary from internal coordinate system.

Scalar	z () const

Private Member Functions
template<class OtherCoords , class OtherTag >
constexpr	DisplacementVector3D (const DisplacementVector3D< OtherCoords, OtherTag > &)

template<class OtherCoords , class OtherTag >
constexpr	DisplacementVector3D (const PositionVector3D< OtherCoords, OtherTag > &)

template<class OtherCoords , class OtherTag >
DisplacementVector3D	Cross (const DisplacementVector3D< OtherCoords, OtherTag > &) const

template<class OtherCoords , class OtherTag >
Scalar	Dot (const DisplacementVector3D< OtherCoords, OtherTag > &) const

template<class OtherCoords , class OtherTag >
DisplacementVector3D &	operator+= (const DisplacementVector3D< OtherCoords, OtherTag > &)

template<class OtherCoords , class OtherTag >
DisplacementVector3D &	operator-= (const DisplacementVector3D< OtherCoords, OtherTag > &)

template<class OtherCoords , class OtherTag >
DisplacementVector3D &	operator= (const DisplacementVector3D< OtherCoords, OtherTag > &)

template<class OtherCoords , class OtherTag >
DisplacementVector3D &	operator= (const PositionVector3D< OtherCoords, OtherTag > &)

Private Attributes
CoordSystem	fCoordinates

Static Private Attributes
static constexpr unsigned int	fDimension = CoordinateType::Dimension

#include <Math/GenVector/DisplacementVector3D.h>

Member Typedef Documentation

◆ CoordinateSystemTag

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

typedef Tag ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::CoordinateSystemTag

Definition at line 64 of file DisplacementVector3D.h.

◆ CoordinateType

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

typedef CoordSystem ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::CoordinateType

Definition at line 63 of file DisplacementVector3D.h.

◆ Scalar

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

typedef CoordSystem::Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Scalar

Definition at line 62 of file DisplacementVector3D.h.

Constructor & Destructor Documentation

◆ DisplacementVector3D() [1/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( )

inlineconstexpr

Default constructor.

Construct an empty object with zero values

Definition at line 71 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [2/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D	(	Scalar	a,
		Scalar	b,
		Scalar	c
	)

inlineconstexpr

Construct from three values of type Scalar.

In the case of a XYZVector the values are x,y,z In the case of a polar vector they are r,theta, phi

Definition at line 79 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [3/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( const DisplacementVector3D< OtherCoords, Tag > & v )

inlineexplicitconstexpr

Construct from a displacement vector expressed in different coordinates, or using a different Scalar type, but with same coordinate system tag.

Definition at line 87 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [4/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( const PositionVector3D< OtherCoords, Tag > & p )

inlineexplicitconstexpr

Construct from a position vector expressed in different coordinates but with the same coordinate system tag.

Definition at line 96 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [5/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class ForeignVector >

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( const ForeignVector & v )

inlineexplicitconstexpr

Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()

Definition at line 105 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [6/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( const DisplacementVector3D< OtherCoords, OtherTag > & )

inlineexplicitconstexprprivate

Definition at line 550 of file DisplacementVector3D.h.

◆ DisplacementVector3D() [7/7]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

constexpr ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::DisplacementVector3D ( const PositionVector3D< OtherCoords, OtherTag > & )

inlineexplicitconstexprprivate

Definition at line 553 of file DisplacementVector3D.h.

Member Function Documentation

◆ Coordinates()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

CoordSystem ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Coordinates ( ) const

inline

Retrieve a copy of the coordinates object.

Definition at line 182 of file DisplacementVector3D.h.

◆ Cross() [1/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Cross ( const DisplacementVector3D< OtherCoords, OtherTag > & ) const

private

◆ Cross() [2/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Cross ( const DisplacementVector3D< OtherCoords, Tag > & v ) const

inline

Return vector (cross) product of two displacement vectors, as a vector in the coordinate system of this class.

It is possible to perform the product for any type of vector coordinates, but they must have the same coordinate system tag

Definition at line 423 of file DisplacementVector3D.h.

◆ Cross() [3/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherVector >

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Cross ( const OtherVector & v ) const

inline

Return vector (cross) product of two vectors, as a vector in the coordinate system of this class.

It is possible to perform the product for any classes implementing X(), Y() and Z() member functions

Definition at line 437 of file DisplacementVector3D.h.

◆ Dimension()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

unsigned int ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Dimension ( ) const

inline

Dimension.

Definition at line 273 of file DisplacementVector3D.h.

◆ Dot() [1/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Dot ( const DisplacementVector3D< OtherCoords, OtherTag > & ) const

private

◆ Dot() [2/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Dot ( const DisplacementVector3D< OtherCoords, Tag > & v ) const

inline

Return the scalar (dot) product of two displacement vectors.

It is possible to perform the product for any type of vector coordinates, but they must have the same coordinate system tag

Definition at line 403 of file DisplacementVector3D.h.

◆ Dot() [3/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherVector >

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Dot ( const OtherVector & v ) const

inline

Return the scalar (dot) product of two vectors.

It is possible to perform the product for any classes implementing x(), y() and z() member functions

Definition at line 412 of file DisplacementVector3D.h.

◆ Eta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Eta ( ) const

inline

Polar eta, converting if necessary from internal coordinate system.

Definition at line 311 of file DisplacementVector3D.h.

◆ eta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::eta ( ) const

inline

Definition at line 526 of file DisplacementVector3D.h.

◆ GetCoordinates() [1/4]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class IT >

void ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::GetCoordinates ( IT begin ) const

inline

get internal data into 3 Scalars starting at *begin

Definition at line 236 of file DisplacementVector3D.h.

◆ GetCoordinates() [2/4]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class IT >

void ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::GetCoordinates	(	IT	begin,
		IT	end
	)		const

inline

get internal data into 3 Scalars at *begin to *end (3 past begin)

Definition at line 226 of file DisplacementVector3D.h.

◆ GetCoordinates() [3/4]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

void ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::GetCoordinates	(	Scalar &	a,
		Scalar &	b,
		Scalar &	c
	)		const

inline

get internal data into 3 Scalar numbers

Definition at line 213 of file DisplacementVector3D.h.

◆ GetCoordinates() [4/4]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

void ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::GetCoordinates ( Scalar dest[] ) const

inline

get internal data into a C-style array of 3 Scalar numbers

Definition at line 219 of file DisplacementVector3D.h.

◆ Mag2()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Mag2 ( ) const

inline

Magnitute squared ( r^2 in spherical coordinate)

Definition at line 323 of file DisplacementVector3D.h.

◆ mag2()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::mag2 ( ) const

inline

Definition at line 528 of file DisplacementVector3D.h.

◆ operator!=()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

bool ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator!= ( const DisplacementVector3D< CoordSystem, Tag > & rhs ) const

inline

Definition at line 264 of file DisplacementVector3D.h.

◆ operator*()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator* ( Scalar a ) const

inline

Multiply a vector by a real number.

Definition at line 490 of file DisplacementVector3D.h.

◆ operator*=()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator*= ( Scalar a )

inline

multiply this vector by a scalar quantity

Definition at line 471 of file DisplacementVector3D.h.

◆ operator+()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator+ ( ) const

inline

Positive of the vector, return itself.

Definition at line 506 of file DisplacementVector3D.h.

◆ operator+=() [1/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator+= ( const DisplacementVector3D< OtherCoords, OtherTag > & )

private

◆ operator+=() [2/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator+= ( const DisplacementVector3D< OtherCoords, Tag > & v )

inline

Self Addition with a displacement vector.

Definition at line 451 of file DisplacementVector3D.h.

◆ operator-()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator- ( ) const

inline

Negative of the vector.

Definition at line 499 of file DisplacementVector3D.h.

◆ operator-=() [1/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator-= ( const DisplacementVector3D< OtherCoords, OtherTag > & )

private

◆ operator-=() [2/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator-= ( const DisplacementVector3D< OtherCoords, Tag > & v )

inline

Self Difference with a displacement vector.

Definition at line 461 of file DisplacementVector3D.h.

◆ operator/()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator/ ( Scalar a ) const

inline

Division of a vector with a real number.

Definition at line 511 of file DisplacementVector3D.h.

◆ operator/=()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator/= ( Scalar a )

inline

divide this vector by a scalar quantity

Definition at line 479 of file DisplacementVector3D.h.

◆ operator=() [1/5]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator= ( const DisplacementVector3D< OtherCoords, OtherTag > & )

private

◆ operator=() [2/5]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator= ( const DisplacementVector3D< OtherCoords, Tag > & v )

inline

Assignment operator from a displacement vector of arbitrary type.

Definition at line 132 of file DisplacementVector3D.h.

◆ operator=() [3/5]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class ForeignVector >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator= ( const ForeignVector & v )

inline

Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()

Definition at line 155 of file DisplacementVector3D.h.

◆ operator=() [4/5]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords , class OtherTag >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator= ( const PositionVector3D< OtherCoords, OtherTag > & )

private

◆ operator=() [5/5]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class OtherCoords >

DisplacementVector3D & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator= ( const PositionVector3D< OtherCoords, Tag > & rhs )

inline

Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian)

Definition at line 143 of file DisplacementVector3D.h.

◆ operator==()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

bool ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::operator== ( const DisplacementVector3D< CoordSystem, Tag > & rhs ) const

inline

Exact equality.

Definition at line 261 of file DisplacementVector3D.h.

◆ Perp2()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Perp2 ( ) const

inline

Transverse component squared (rho^2 in cylindrical coordinates.

Definition at line 328 of file DisplacementVector3D.h.

◆ perp2()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::perp2 ( ) const

inline

Definition at line 529 of file DisplacementVector3D.h.

◆ Phi()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Phi ( ) const

inline

Polar phi, converting if necessary from internal coordinate system.

Definition at line 306 of file DisplacementVector3D.h.

◆ phi()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::phi ( ) const

inline

Definition at line 525 of file DisplacementVector3D.h.

◆ R()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::R ( ) const

inline

Polar R, converting if necessary from internal coordinate system.

Definition at line 296 of file DisplacementVector3D.h.

◆ r()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::r ( ) const

inline

Definition at line 523 of file DisplacementVector3D.h.

◆ Rho()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Rho ( ) const

inline

Cylindrical transverse component rho.

Definition at line 316 of file DisplacementVector3D.h.

◆ rho()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::rho ( ) const

inline

Definition at line 527 of file DisplacementVector3D.h.

◆ SetCoordinates() [1/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetCoordinates ( const Scalar src[] )

inline

Set internal data based on a C-style array of 3 Scalar numbers.

Definition at line 189 of file DisplacementVector3D.h.

◆ SetCoordinates() [2/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<class IT >

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetCoordinates	(	IT	begin,
		IT	end
	)

inline

Set internal data based on 3 Scalars at *begin to *end.

Definition at line 202 of file DisplacementVector3D.h.

◆ SetCoordinates() [3/3]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetCoordinates	(	Scalar	a,
		Scalar	b,
		Scalar	c
	)

inline

Set internal data based on 3 Scalar numbers.

Definition at line 195 of file DisplacementVector3D.h.

◆ SetEta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetEta ( Scalar etaval )

inline

Change Eta - CylindricalEta3D coordinates only.

Definition at line 391 of file DisplacementVector3D.h.

◆ SetPhi()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetPhi ( Scalar ang )

inline

Change Phi - Polar3D or CylindricalEta3D coordinates.

Definition at line 381 of file DisplacementVector3D.h.

◆ SetR()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetR ( Scalar rr )

inline

Change R - Polar3D coordinates only.

Definition at line 371 of file DisplacementVector3D.h.

◆ SetRho()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetRho ( Scalar rr )

inline

Change Rho - CylindricalEta3D coordinates only.

Definition at line 386 of file DisplacementVector3D.h.

◆ SetTheta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetTheta ( Scalar ang )

inline

Change Theta - Polar3D coordinates only.

Definition at line 376 of file DisplacementVector3D.h.

◆ SetX()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetX ( Scalar xx )

inline

Change X - Cartesian3D coordinates only.

Definition at line 356 of file DisplacementVector3D.h.

◆ SetXYZ()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetXYZ	(	Scalar	a,
		Scalar	b,
		Scalar	c
	)

inline

set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form)

Definition at line 251 of file DisplacementVector3D.h.

◆ SetY()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetY ( Scalar yy )

inline

Change Y - Cartesian3D coordinates only.

Definition at line 361 of file DisplacementVector3D.h.

◆ SetZ()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D< CoordSystem, Tag > & ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::SetZ ( Scalar zz )

inline

Change Z - Cartesian3D coordinates only.

Definition at line 366 of file DisplacementVector3D.h.

◆ Theta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Theta ( ) const

inline

Polar theta, converting if necessary from internal coordinate system.

Definition at line 301 of file DisplacementVector3D.h.

◆ theta()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::theta ( ) const

inline

Definition at line 524 of file DisplacementVector3D.h.

◆ Unit() [1/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<typename SCALAR = Scalar, typename std::enable_if< std::is_arithmetic< SCALAR >::value >::type * = nullptr>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Unit ( ) const

inline

return unit vector parallel to this (scalar)

Definition at line 334 of file DisplacementVector3D.h.

◆ Unit() [2/2]

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

template<typename SCALAR = Scalar, typename std::enable_if<!std::is_arithmetic< SCALAR >::value >::type * = nullptr>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Unit ( ) const

inline

return unit vector parallel to this (vector)

Definition at line 344 of file DisplacementVector3D.h.

◆ unit()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

DisplacementVector3D ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::unit ( ) const

inline

Definition at line 530 of file DisplacementVector3D.h.

◆ X()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::X ( ) const

inline

Cartesian X, converting if necessary from internal coordinate system.

Definition at line 281 of file DisplacementVector3D.h.

◆ x()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::x ( ) const

inline

Definition at line 520 of file DisplacementVector3D.h.

◆ Y()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Y ( ) const

inline

Cartesian Y, converting if necessary from internal coordinate system.

Definition at line 286 of file DisplacementVector3D.h.

◆ y()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::y ( ) const

inline

Definition at line 521 of file DisplacementVector3D.h.

◆ Z()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Z ( ) const

inline

Cartesian Z, converting if necessary from internal coordinate system.

Definition at line 291 of file DisplacementVector3D.h.

◆ z()

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::z ( ) const

inline

Definition at line 522 of file DisplacementVector3D.h.

Member Data Documentation

◆ fCoordinates

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

CoordSystem ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::fCoordinates

private

Definition at line 535 of file DisplacementVector3D.h.

◆ fDimension

template<class CoordSystem , class Tag = DefaultCoordinateSystemTag>

constexpr unsigned int ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::fDimension = CoordinateType::Dimension

staticconstexprprivate

Definition at line 536 of file DisplacementVector3D.h.

math/genvector/inc/Math/GenVector/DisplacementVector3D.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Member Typedef Documentation

◆ CoordinateSystemTag

◆ CoordinateType

◆ Scalar

Constructor & Destructor Documentation

◆ DisplacementVector3D() [1/7]

◆ DisplacementVector3D() [2/7]

◆ DisplacementVector3D() [3/7]

◆ DisplacementVector3D() [4/7]

◆ DisplacementVector3D() [5/7]

◆ DisplacementVector3D() [6/7]

◆ DisplacementVector3D() [7/7]

Member Function Documentation

◆ Coordinates()

◆ Cross() [1/3]

◆ Cross() [2/3]

◆ Cross() [3/3]

◆ Dimension()

◆ Dot() [1/3]

◆ Dot() [2/3]

◆ Dot() [3/3]

◆ Eta()

◆ eta()

◆ GetCoordinates() [1/4]

◆ GetCoordinates() [2/4]

◆ GetCoordinates() [3/4]

◆ GetCoordinates() [4/4]

◆ Mag2()

◆ mag2()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-()

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/()

◆ operator/=()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator==()

◆ Perp2()

◆ perp2()

◆ Phi()

◆ phi()

◆ R()

◆ r()

◆ Rho()

◆ rho()

◆ SetCoordinates() [1/3]

◆ SetCoordinates() [2/3]

◆ SetCoordinates() [3/3]

◆ SetEta()

◆ SetPhi()

◆ SetR()

◆ SetRho()

◆ SetTheta()

◆ SetX()

◆ SetXYZ()

◆ SetY()

◆ SetZ()

◆ Theta()

◆ theta()

◆ Unit() [1/2]

◆ Unit() [2/2]

◆ unit()

◆ X()

◆ x()

◆ Y()

◆ y()