sseBasic3DVector.h File Reference

#include "DataFormats/GeometryVector/interface/Basic2DVector.h"
#include "DataFormats/GeometryVector/interface/Theta.h"
#include "DataFormats/GeometryVector/interface/Phi.h"
#include "DataFormats/GeometryVector/interface/PreciseFloatType.h"
#include "DataFormats/GeometryVector/interface/CoordinateSets.h"
#include "DataFormats/Math/interface/SSEVec.h"
#include <iosfwd>
#include <cmath>
#include "Basic3DVectorLD.h"

Go to the source code of this file.

Classes
class	Basic3DVector< T >

Namespaces
	detailsBasic3DVector
	geometryDetails

Typedefs
typedef Basic3DVector< double >	Basic3DVectorD
typedef Basic3DVector< float >	Basic3DVectorF
typedef Geom::Cylindrical2Cartesian< T >	Cylindrical
typedef mathSSE::Vec4< T >	MathVector
typedef Spherical	Polar
typedef T	ScalarType
typedef Geom::Spherical2Cartesian< T >	Spherical
typedef mathSSE::Vec4< T >	VectorType

Functions
float	detailsBasic3DVector::__attribute__ ((always_inline)) __attribute__((pure)) eta(float x
template<typename T >
class Basic3DVector	__attribute__ ((aligned(16)))
T	barePhi () const
T	bareTheta () const
	Basic3DVector ()
	Basic3DVector (const Basic3DVector &p)
	Copy constructor from same type. Should not be needed but for gcc bug 12685. More...
template<class U >
	Basic3DVector (const Basic3DVector< U > &p)
	Copy constructor and implicit conversion from Basic3DVector of different precision. More...
	Basic3DVector (const Basic2DVector< T > &p)
	constructor from 2D vector (X and Y from 2D vector, z set to zero) More...
template<class OtherPoint >
	Basic3DVector (const OtherPoint &p)
template<class U >
	Basic3DVector (mathSSE::Vec4< U > const &iv)
	Basic3DVector (const T &x, const T &y, const T &z, const T &w=0)
	construct from cartesian coordinates More...
template<typename U >
	Basic3DVector (const Geom::Theta< U > &theta, const Geom::Phi< U > &phi, const T &r)
Basic3DVector	cross (const Basic3DVector &lh) const
	Vector product, or "cross" product, with a vector of same type. More...
template<class U >
Basic3DVector< typename PreciseFloatType< T, U >::Type >	cross (const Basic3DVector< U > &lh) const
T	dot (const Basic3DVector &rh) const
	Scalar product, or "dot" product, with a vector of same type. More...
template<class U >
PreciseFloatType< T, U >::Type	dot (const Basic3DVector< U > &lh) const
T	eta () const
T	mag () const
	The vector magnitude. Equivalent to sqrt(vec.mag2()) More...
T	mag2 () const
	The vector magnitude squared. Equivalent to vec.dot(vec) More...
MathVector const &	mathVector () const
template<class T >
T	operator* (const Basic3DVector< T > &v1, const Basic3DVector< T > &v2)
	scalar product of vectors of same precision More...
template<class T , class U >
PreciseFloatType< T, U >::Type	operator* (const Basic3DVector< T > &v1, const Basic3DVector< U > &v2)
	scalar product of vectors of different precision More...
template<class T >
Basic3DVector< T >	operator* (const Basic3DVector< T > &v, T t)
template<class T >
Basic3DVector< T >	operator* (T t, const Basic3DVector< T > &v)
	Same as operator*( Vector, Scalar) More...
template<class T , typename S >
Basic3DVector< T >	operator* (S t, const Basic3DVector< T > &v)
template<class T , typename S >
Basic3DVector< T >	operator* (const Basic3DVector< T > &v, S t)
Basic3DVector &	operator*= (T t)
	Scaling by a scalar value (multiplication) More...
template<class T >
Basic3DVector< T >	operator+ (const Basic3DVector< T > &a, const Basic3DVector< T > &b)
	vector sum and subtraction of vectors of possibly different precision More...
template<class T , class U >
Basic3DVector< typename PreciseFloatType< T, U >::Type >	operator+ (const Basic3DVector< T > &a, const Basic3DVector< U > &b)
template<class U >
Basic3DVector &	operator+= (const Basic3DVector< U > &p)
template<class T >
Basic3DVector< T >	operator- (const Basic3DVector< T > &a, const Basic3DVector< T > &b)
template<class T , class U >
Basic3DVector< typename PreciseFloatType< T, U >::Type >	operator- (const Basic3DVector< T > &a, const Basic3DVector< U > &b)
Basic3DVector	operator- () const
	Unary minus, returns a vector with components (-x(),-y(),-z()) More...
template<class U >
Basic3DVector &	operator-= (const Basic3DVector< U > &p)
template<class T >
Basic3DVector< T >	operator/ (const Basic3DVector< T > &v, T t)
template<class T , typename S >
Basic3DVector< T >	operator/ (const Basic3DVector< T > &v, S s)
Basic3DVector &	operator/= (T t)
	Scaling by a scalar value (division) More...
template<class T >
std::ostream &	operator<< (std::ostream &s, const Basic3DVector< T > &v)
	simple text output to standard streams More...
bool	operator== (const Basic3DVector &rh) const
T	operator[] (int i) const
T	perp () const
	Magnitude of transverse component. More...
T	perp2 () const
	Squared magnitude of transverse component. More...
Geom::Phi< T >	phi () const
std::ostream &	geometryDetails::print3D (std::ostream &s, double x, double y, double z)
Geom::Theta< T >	theta () const
T	transverse () const
	Another name for perp() More...
Basic3DVector	unit () const
T	w () const
T	x () const
	Cartesian x coordinate. More...
Basic2DVector< T >	xy () const
T	y () const
	Cartesian y coordinate. More...
T	z () const
	Cartesian z coordinate. More...

Variables
mathSSE::Vec4< T >	v

Typedef Documentation

Basic3DVectorD

typedef Basic3DVector<double> Basic3DVectorD

Definition at line 301 of file sseBasic3DVector.h.

Basic3DVectorF

typedef Basic3DVector<float> Basic3DVectorF

Definition at line 300 of file sseBasic3DVector.h.

Cylindrical

typedef Geom::Cylindrical2Cartesian<T> Cylindrical

Definition at line 157 of file sseBasic3DVector.h.

MathVector

typedef mathSSE::Vec4<T> MathVector

Definition at line 156 of file sseBasic3DVector.h.

Polar

typedef Spherical Polar

Definition at line 159 of file sseBasic3DVector.h.

ScalarType

typedef T ScalarType

Definition at line 154 of file sseBasic3DVector.h.

Spherical

typedef Geom::Spherical2Cartesian<T> Spherical

Definition at line 158 of file sseBasic3DVector.h.

VectorType

typedef mathSSE::Vec4<T> VectorType

Definition at line 155 of file sseBasic3DVector.h.

Function Documentation

__attribute__()

template<typename T >

class Basic3DVector __attribute__

(

(aligned(16))

)

barePhi()

T __attribute__::barePhi

(

)

const

Azimuthal angle. The value is returned in radians, in the range (-pi,pi]. Same precision as the system atan2(x,y) function. The return type is Geom::Phi<T>, see it's documentation.

Definition at line 248 of file sseBasic3DVector.h.

{

bareTheta()

T __attribute__::bareTheta

(

)

const

Polar angle. The value is returned in radians, in the range [0,pi] Same precision as the system atan2(x,y) function. The return type is Geom::Phi<T>, see it's documentation.

Definition at line 255 of file sseBasic3DVector.h.

Basic3DVector() [1/8]

__attribute__::Basic3DVector

(

)

default constructor uses default constructor of T to initialize the components. For built-in floating-point types this means initialization to zero??? (force init to 0)

Definition at line 165 of file sseBasic3DVector.h.

{ return Basic3DVector(-v); }

Basic3DVector() [2/8]

__attribute__::Basic3DVector

(

const Basic3DVector &

p

)

Copy constructor from same type. Should not be needed but for gcc bug 12685.

Definition at line 168 of file sseBasic3DVector.h.

References Basic3DVector< T >::Basic3DVector(), and Basic3DVector< T >::v.

{ return Basic3DVector(-v); }

Basic3DVector() [3/8]

template<class U >

__attribute__::Basic3DVector

(

const Basic3DVector< U > &

p

)

Copy constructor and implicit conversion from Basic3DVector of different precision.

Definition at line 172 of file sseBasic3DVector.h.

{

Basic3DVector() [4/8]

__attribute__::Basic3DVector

(

const Basic2DVector< T > &

p

)

constructor from 2D vector (X and Y from 2D vector, z set to zero)

Definition at line 175 of file sseBasic3DVector.h.

{

Basic3DVector() [5/8]

template<class OtherPoint >

__attribute__::Basic3DVector ( const OtherPoint &  p )

explicit

Explicit constructor from other (possibly unrelated) vector classes The only constraint on the argument type is that it has methods x(), y() and z(), and that these methods return a type convertible to T. Examples of use are
construction from a Basic3DVector with different precision
construction from a Hep3Vector
construction from a coordinate system converter

Definition at line 186 of file sseBasic3DVector.h.

Basic3DVector() [6/8]

template<class U >

__attribute__::Basic3DVector

(

mathSSE::Vec4< U > const &

iv

)

Definition at line 190 of file sseBasic3DVector.h.

Basic3DVector() [7/8]

__attribute__::Basic3DVector	(	const T &	x,
		const T &	y,
		const T &	z,
		const T &	w = 0
	)

construct from cartesian coordinates

Definition at line 193 of file sseBasic3DVector.h.

Basic3DVector() [8/8]

template<typename U >

__attribute__::Basic3DVector	(	const Geom::Theta< U > &	theta,
		const Geom::Phi< U > &	phi,
		const T &	r
	)

Deprecated construct from polar coordinates, use
Basic3DVector<T>( Basic3DVector<T>::Polar( theta, phi, r)) instead.

Definition at line 200 of file sseBasic3DVector.h.

cross() [1/2]

Basic3DVector __attribute__::cross

(

const Basic3DVector &

lh

)

const

Vector product, or "cross" product, with a vector of same type.

Definition at line 320 of file sseBasic3DVector.h.

Referenced by Basic3DVector< align::Scalar >::cross().

cross() [2/2]

template<class U >

Basic3DVector<typename PreciseFloatType<T, U>::Type> __attribute__::cross

(

const Basic3DVector< U > &

lh

)

const

Vector (or cross) product with a vector of different precision. The product is computed without loss of precision. The type of the returned vector is the more precise of the types of the two vectors.

Definition at line 328 of file sseBasic3DVector.h.

dot() [1/2]

T __attribute__::dot

(

const Basic3DVector &

rh

)

const

Scalar product, or "dot" product, with a vector of same type.

Definition at line 306 of file sseBasic3DVector.h.

Referenced by Basic3DVector< align::Scalar >::dot(), and Basic3DVector< align::Scalar >::mag2().

dot() [2/2]

template<class U >

PreciseFloatType<T, U>::Type __attribute__::dot

(

const Basic3DVector< U > &

lh

)

const

Scalar (or dot) product with a vector of different precision. The product is computed without loss of precision. The type of the returned scalar is the more precise of the scalar types of the two vectors.

Definition at line 314 of file sseBasic3DVector.h.

eta()

T __attribute__::eta

(

)

const

Pseudorapidity. Does not check for zero transverse component; in this case the behavior is as for divide-by zero, i.e. system-dependent.

Definition at line 263 of file sseBasic3DVector.h.

Referenced by Basic3DVector< align::Scalar >::eta().

{

mag()

T __attribute__::mag

(

)

const

The vector magnitude. Equivalent to sqrt(vec.mag2())

Definition at line 233 of file sseBasic3DVector.h.

mag2()

T __attribute__::mag2

(

)

const

The vector magnitude squared. Equivalent to vec.dot(vec)

Definition at line 230 of file sseBasic3DVector.h.

{

mathVector()

MathVector const& __attribute__::mathVector

(

)

const

Definition at line 207 of file sseBasic3DVector.h.

operator*() [1/6]

template<class T >

T operator* ( const Basic3DVector< T > &  v1, const Basic3DVector< T > &  v2  )

inline

scalar product of vectors of same precision

Definition at line 251 of file sseBasic3DVector.h.

                                                                           {
  return v1.dot(v2);
}

operator*() [2/6]

template<class T , class U >

PreciseFloatType<T, U>::Type operator* ( const Basic3DVector< T > &  v1, const Basic3DVector< U > &  v2  )

inline

scalar product of vectors of different precision

Definition at line 257 of file sseBasic3DVector.h.

                                                                                                             {
  return v1.dot(v2);
}

operator*() [3/6]

template<class T >

Basic3DVector<T> operator* ( const Basic3DVector< T > &  v, T  t  )

inline

Multiplication by scalar, does not change the precision of the vector. The return type is the same as the type of the vector argument.

Definition at line 265 of file sseBasic3DVector.h.

References submitPVValidationJobs::t, and v.

                                                                  {
  return v.v * t;
}

operator*() [4/6]

template<class T >

Basic3DVector<T> operator* ( T  t, const Basic3DVector< T > &  v  )

inline

Same as operator*( Vector, Scalar)

Definition at line 271 of file sseBasic3DVector.h.

References submitPVValidationJobs::t, and v.

                                                                  {
  return v.v * t;
}

operator*() [5/6]

template<class T , typename S >

Basic3DVector<T> operator* ( S  t, const Basic3DVector< T > &  v  )

inline

Definition at line 276 of file sseBasic3DVector.h.

                                                                  {
  return static_cast<T>(t) * v;
}

operator*() [6/6]

template<class T , typename S >

Basic3DVector<T> operator* ( const Basic3DVector< T > &  v, S  t  )

inline

Definition at line 281 of file sseBasic3DVector.h.

References submitPVValidationJobs::t, and v.

                                                                  {
  return static_cast<T>(t) * v;
}

operator*=()

Basic3DVector& __attribute__::operator*=

(

T

t

)

Scaling by a scalar value (multiplication)

Definition at line 293 of file sseBasic3DVector.h.

                                                                  {
  //  T t = S(1)/s; return v*t;
  T t = s;

operator+() [1/2]

template<class T >

Basic3DVector<T> operator+ ( const Basic3DVector< T > &  a, const Basic3DVector< T > &  b  )

inline

vector sum and subtraction of vectors of possibly different precision

Definition at line 227 of file sseBasic3DVector.h.

                                                                                        {
  return a.v + b.v;
}

operator+() [2/2]

template<class T , class U >

Basic3DVector<typename PreciseFloatType<T, U>::Type> operator+ ( const Basic3DVector< T > &  a, const Basic3DVector< U > &  b  )

inline

Definition at line 236 of file sseBasic3DVector.h.

                                                                                                 {
  typedef Basic3DVector<typename PreciseFloatType<T, U>::Type> RT;
  return RT(a).v + RT(b).v;
}

operator+=()

template<class U >

Basic3DVector& __attribute__::operator+=

(

const Basic3DVector< U > &

p

)

Operator += with a Basic3DVector of possibly different precision.

Definition at line 276 of file sseBasic3DVector.h.

References submitPVValidationJobs::t, and v.

                                                                  {
  return static_cast<T>(t) * v;
}

operator-() [1/3]

template<class T >

Basic3DVector<T> operator- ( const Basic3DVector< T > &  a, const Basic3DVector< T > &  b  )

inline

Definition at line 231 of file sseBasic3DVector.h.

References a, and b.

                                                                                        {
  return a.v - b.v;
}

operator-() [2/3]

template<class T , class U >

Basic3DVector<typename PreciseFloatType<T, U>::Type> operator- ( const Basic3DVector< T > &  a, const Basic3DVector< U > &  b  )

inline

Definition at line 243 of file sseBasic3DVector.h.

References a, b, and Basic3DVector< T >::v.

                                                                                                 {
  typedef Basic3DVector<typename PreciseFloatType<T, U>::Type> RT;
  return RT(a).v - RT(b).v;
}

operator-() [3/3]

Basic3DVector __attribute__::operator-

(

)

const

Unary minus, returns a vector with components (-x(),-y(),-z())

Definition at line 290 of file sseBasic3DVector.h.

{

operator-=()

template<class U >

Basic3DVector& __attribute__::operator-=

(

const Basic3DVector< U > &

p

)

Operator -= with a Basic3DVector of possibly different precision.

Definition at line 284 of file sseBasic3DVector.h.

                                                                  {

operator/() [1/2]

template<class T >

Basic3DVector<T> operator/ ( const Basic3DVector< T > &  v, T  t  )

inline

Division by scalar, does not change the precision of the vector. The return type is the same as the type of the vector argument.

Definition at line 289 of file sseBasic3DVector.h.

                                                                  {
  return v.v / t;
}

operator/() [2/2]

template<class T , typename S >

Basic3DVector<T> operator/ ( const Basic3DVector< T > &  v, S  s  )

inline

Definition at line 294 of file sseBasic3DVector.h.

References alignCSCRings::s, submitPVValidationJobs::t, and v.

                                                                  {
  //  T t = S(1)/s; return v*t;
  T t = s;
  return v / t;
}

operator/=()

Basic3DVector& __attribute__::operator/=

(

T

t

)

Scaling by a scalar value (division)

Definition at line 299 of file sseBasic3DVector.h.

operator<<()

template<class T >

std::ostream& operator<< ( std::ostream &  s, const Basic3DVector< T > &  v  )

inline

simple text output to standard streams

Definition at line 221 of file sseBasic3DVector.h.

                                                                        {
  return geometryDetails::print3D(s, v.x(), v.y(), v.z());
}

operator==()

bool __attribute__::operator==

(

const Basic3DVector &

rh

)

const

Definition at line 227 of file sseBasic3DVector.h.

References a, and b.

{

operator[]()

T __attribute__::operator[]

(

int

i

)

const

Definition at line 210 of file sseBasic3DVector.h.

:
  mathSSE::Vec4<T> v;

perp()

T __attribute__::perp

(

)

const

Magnitude of transverse component.

Definition at line 239 of file sseBasic3DVector.h.

perp2()

T __attribute__::perp2

(

)

const

Squared magnitude of transverse component.

Definition at line 236 of file sseBasic3DVector.h.

{

phi()

Geom::Phi<T> __attribute__::phi

(

)

const

Definition at line 249 of file sseBasic3DVector.h.

{

theta()

Geom::Theta<T> __attribute__::theta

(

)

const

Definition at line 256 of file sseBasic3DVector.h.

transverse()

T __attribute__::transverse

(

)

const

Another name for perp()

Definition at line 242 of file sseBasic3DVector.h.

unit()

Basic3DVector __attribute__::unit

(

)

const

Unit vector parallel to this. If mag() is zero, a zero vector is returned.

Definition at line 268 of file sseBasic3DVector.h.

                                                                  {

w()

T __attribute__::w

(

)

const

Definition at line 222 of file sseBasic3DVector.h.

{

x()

T __attribute__::x

(

)

const

Cartesian x coordinate.

Definition at line 214 of file sseBasic3DVector.h.

References geometryDetails::print3D(), alignCSCRings::s, and x.

{

xy()

Basic2DVector<T> __attribute__::xy

(

)

const

Definition at line 224 of file sseBasic3DVector.h.

{

y()

T __attribute__::y

(

)

const

Cartesian y coordinate.

Definition at line 217 of file sseBasic3DVector.h.

z()

T __attribute__::z

(

)

const

Cartesian z coordinate.

Definition at line 220 of file sseBasic3DVector.h.

Variable Documentation

v

mathSSE::Vec4<T> v

Definition at line 334 of file sseBasic3DVector.h.

Referenced by operator*(), operator+=(), and operator/().