Vector3 Class Reference

#include <Vector3.hh>

Inheritance diagram for Vector3:

[legend]

Collaboration diagram for Vector3:

[legend]

List of all members.

Detailed Description

Definition at line 26 of file Vector3.hh.


Public Member Functions
	Vector3 ()
template<typename V3>
	Vector3 (const V3 &other)
	Vector3 (const Vector< 3 > &other)
	Vector3 (double x, double y, double z)
	~Vector3 ()
double	x () const
double	y () const
double	z () const
Vector3 &	setX (double x)
Vector3 &	setY (double y)
Vector3 &	setZ (double z)
double	dot (const Vector3 &v) const
Vector3	cross (const Vector3 &v) const
double	angle (const Vector3 &v) const
Vector3	unit () const
double	polarRadius2 () const
double	perp2 () const
	Synonym for polarRadius2.
double	rho2 () const
	Synonym for polarRadius2.
double	polarRadius () const
double	perp () const
	Synonym for polarRadius.
double	rho () const
	Synonym for polarRadius.
double	azimuthalAngle (const PhiMapping mapping=ZERO_2PI) const
	Angle subtended by the vector's projection in x-y and the x-axis.
double	phi (const PhiMapping mapping=ZERO_2PI) const
	Synonym for azimuthalAngle.
double	polarAngle () const
	Angle subtended by the vector and the z-axis.
double	theta () const
	Synonym for polarAngle.
double	pseudorapidity () const
double	eta () const
	Synonym for pseudorapidity.
Vector3 &	operator*= (const double a)
Vector3 &	operator/= (const double a)
Vector3 &	operator+= (const Vector3 &v)
Vector3 &	operator-= (const Vector3 &v)
Vector3	operator- () const
	Invert the vector.
const double &	get (const size_t index) const
const double &	operator[] (const size_t index) const
	Direct access to vector elements by index.
double &	operator[] (const size_t index)
	Direct access to vector elements by index.
Vector< N > &	set (const size_t index, const double value)
	Set indexed value.
size_t	size () const
	Vector dimensionality.
bool	isZero (double tolerance=1E-5) const
	Check for nullness, allowing for numerical precision.
double	mod2 () const
	Calculate the modulus-squared of a vector. $\sum_{i=1}^N x_i^2$ .
double	mod () const
	Calculate the modulus of a vector. $\sqrt{\sum_{i=1}^N x_i^2}$ .
bool	operator== (const Vector< N > &a) const
bool	operator!= (const Vector< N > &a) const
bool	operator< (const Vector< N > &a) const
bool	operator<= (const Vector< N > &a) const
bool	operator> (const Vector< N > &a) const
bool	operator>= (const Vector< N > &a) const
Static Public Member Functions
static Vector3	mkX ()
static Vector3	mkY ()
static Vector3	mkZ ()
Protected Member Functions
double &	get (const size_t index)
Protected Attributes
Eigen::Vector< double, N >	_vec
	Vector.
Friends
class	Matrix3
Vector3	multiply (const double, const Vector3 &)
Vector3	multiply (const Vector3 &, const double)
Vector3	add (const Vector3 &, const Vector3 &)
Vector3	subtract (const Vector3 &, const Vector3 &)

Constructor & Destructor Documentation

Vector3 ( ) [inline]

Definition at line 35 of file Vector3.hh.

Referenced by Vector3::mkX(), Vector3::mkY(), and Vector3::mkZ().

00035 : Vector<3>() { }

Vector3 ( const V3 & other ) [inline]

Definition at line 38 of file Vector3.hh.

References Vector3::setX(), Vector3::setY(), and Vector3::setZ().

00038                              {
00039       this->setX(other.x());
00040       this->setY(other.y());
00041       this->setZ(other.z());
00042     }

Vector3 ( const Vector< 3 > & other ) [inline]

Definition at line 44 of file Vector3.hh.

References Vector::get(), Vector3::setX(), Vector3::setY(), and Vector3::setZ().

00044                                     {
00045       this->setX(other.get(0));
00046       this->setY(other.get(1));
00047       this->setZ(other.get(2));
00048     }

Vector3	(	double	x,
		double	y,
		double	z
	)			`[inline]`

Definition at line 50 of file Vector3.hh.

References Vector3::setX(), Vector3::setY(), and Vector3::setZ().

00050                                           {
00051       this->setX(x);
00052       this->setY(y);
00053       this->setZ(z);
00054     }

~Vector3 ( ) [inline]

Definition at line 56 of file Vector3.hh.

00056 { }

Member Function Documentation

static Vector3 mkX ( ) [inline, static]

Definition at line 59 of file Vector3.hh.

References Vector3::Vector3().

Referenced by DISKinematics::project(), and LorentzTransform::setBoost().

00059 { return Vector3(1,0,0); }

static Vector3 mkY ( ) [inline, static]

Definition at line 60 of file Vector3.hh.

References Vector3::Vector3().

Referenced by DISKinematics::project().

00060 { return Vector3(0,1,0); }

static Vector3 mkZ ( ) [inline, static]

Definition at line 61 of file Vector3.hh.

References Vector3::Vector3().

Referenced by DISKinematics::project().

00061 { return Vector3(0,0,1); }

double x ( ) const [inline]

Definition at line 64 of file Vector3.hh.

Referenced by Thrust::_calcThrust(), Vector3::azimuthalAngle(), Rivet::get2dClosestApproach(), Rivet::get2dDecayLength(), Rivet::get3dClosestApproach(), Rivet::get3dDecayLength(), and Vector3::polarRadius2().

00064 { return get(0); }

double y ( ) const [inline]

Definition at line 65 of file Vector3.hh.

Referenced by Vector3::azimuthalAngle(), Rivet::get2dClosestApproach(), Rivet::get2dDecayLength(), Rivet::get3dClosestApproach(), Rivet::get3dDecayLength(), and Vector3::polarRadius2().

00065 { return get(1); }

double z ( ) const [inline]

Definition at line 66 of file Vector3.hh.

Referenced by Thrust::_calcThrust(), Rivet::get2dClosestApproach(), Rivet::get3dClosestApproach(), Rivet::get3dDecayLength(), and Vector3::polarAngle().

00066 { return get(2); }

Vector3& setX ( double x ) [inline]

Definition at line 67 of file Vector3.hh.

Referenced by Vector3::Vector3().

00067 { set(0, x); return *this; }

Vector3& setY ( double y ) [inline]

Definition at line 68 of file Vector3.hh.

Referenced by Vector3::Vector3().

00068 { set(1, y); return *this; }

Vector3& setZ ( double z ) [inline]

Definition at line 69 of file Vector3.hh.

Referenced by Vector3::Vector3().

00069 { set(2, z); return *this; }

double dot ( const Vector3 & v ) const [inline]

Definition at line 71 of file Vector3.hh.

References Vector::_vec, and Vector< 3 >::_vec.

Referenced by Rivet::_calcT(), CDF_1996_S3349578::_fiveJetAnalysis(), D0_1996_S3214044::_fourJetAnalysis(), CDF_1996_S3349578::_fourJetAnalysis(), CDF_1997_S3541940::_psi(), CDF_1996_S3349578::_psi(), D0_1996_S3214044::_threeJetAnalysis(), CDF_1996_S3349578::_threeJetAnalysis(), CDF_1997_S3541940::analyze(), Vector3::angle(), Rivet::dot(), and FoxWolframMoments::project().

00071                                        {
00072       return _vec.dot(v._vec);
00073     }

Vector3 cross ( const Vector3 & v ) const [inline]

Definition at line 75 of file Vector3.hh.

References Vector< 3 >::_vec, and Vector::_vec.

Referenced by Thrust::_calcThrust(), D0_1996_S3214044::_fourJetAnalysis(), CDF_1997_S3541940::_psi(), CDF_1996_S3349578::_psi(), D0_1996_S3214044::_threeJetAnalysis(), and Rivet::cross().

00075                                           {
00076       Vector3 result;
00077       result._vec = _vec.cross(v._vec);
00078       return result;
00079     }

double angle ( const Vector3 & v ) const [inline]

Definition at line 81 of file Vector3.hh.

References Vector3::dot(), Rivet::isZero(), and Vector3::unit().

Referenced by FourVector::angle(), and Rivet::angle().

00081                                          {
00082       double localDotOther = unit().dot(v.unit());
00083       if(Rivet::isZero(localDotOther - 1.0)) return 0.0;
00084       return acos( localDotOther );
00085     }

Vector3 unit ( ) const [inline]

Todo:: What to do in this situation?

Definition at line 87 of file Vector3.hh.

References Vector< 3 >::isZero(), and Vector< 3 >::mod().

Referenced by Rivet::_calcT(), Thrust::_calcThrust(), CDF_1996_S3349578::_fiveJetAnalysis(), CDF_1996_S3349578::_fourJetAnalysis(), CDF_1997_S3541940::_psi(), CDF_1996_S3349578::_psi(), CDF_1996_S3349578::_threeJetAnalysis(), CDF_1997_S3541940::analyze(), Vector3::angle(), LorentzTransform::boost(), Matrix3::Matrix3(), and Matrix3::setAsRotation().

00087                          {
00088       /// @todo What to do in this situation?
00089       if (isZero()) return *this;
00090       else return *this * 1.0/this->mod();
00091     }

double polarRadius2 ( ) const [inline]

Definition at line 93 of file Vector3.hh.

References Vector3::x(), and Vector3::y().

Referenced by Vector3::perp2(), Vector3::polarRadius(), FourVector::polarRadius2(), Rivet::polarRadius2(), FourMomentum::pT2(), and Vector3::rho2().

00093                                 {
00094       return x()*x() + y()*y();
00095     }

double perp2 ( ) const [inline]

Synonym for polarRadius2.

Definition at line 98 of file Vector3.hh.

References Vector3::polarRadius2().

Referenced by FourVector::perp2(), and Rivet::perp2().

00098                          {
00099       return polarRadius2();
00100     }

double rho2 ( ) const [inline]

Synonym for polarRadius2.

Definition at line 103 of file Vector3.hh.

References Vector3::polarRadius2().

Referenced by FourVector::rho2(), and Rivet::rho2().

00103                         {
00104       return polarRadius2();
00105     }

double polarRadius ( ) const [inline]

Definition at line 107 of file Vector3.hh.

References Vector3::polarRadius2().

Referenced by Vector3::perp(), Vector3::polarAngle(), FourVector::polarRadius(), Rivet::polarRadius(), and Vector3::rho().

00107                                {
00108       return sqrt(polarRadius2());
00109     }

double perp ( ) const [inline]

Synonym for polarRadius.

Definition at line 112 of file Vector3.hh.

References Vector3::polarRadius().

Referenced by FourVector::perp(), and Rivet::perp().

00112                         {
00113       return polarRadius();
00114     }

double rho ( ) const [inline]

Synonym for polarRadius.

Definition at line 117 of file Vector3.hh.

References Vector3::polarRadius().

Referenced by FourVector::rho(), and Rivet::rho().

00117                        {
00118       return polarRadius();
00119     }

double azimuthalAngle ( const PhiMapping mapping = ZERO_2PI ) const [inline]

Angle subtended by the vector's projection in x-y and the x-axis.

Definition at line 122 of file Vector3.hh.

References Rivet::isZero(), Rivet::MINUSPI_PLUSPI, Vector< 3 >::mod2(), Rivet::PI, Vector3::x(), Vector3::y(), and Rivet::ZERO_2PI.

Referenced by FourVector::azimuthalAngle(), Rivet::azimuthalAngle(), Rivet::deltaR(), Vector3::phi(), and DISKinematics::project().

00122                                                                      {
00123       // If this is a null vector, return zero rather than let atan2 set an error state
00124       if (Rivet::isZero(mod2())) return 0.0;
00125 
00126       // Calculate the arctan and correct for numerical boundary cases
00127       double value = atan2( y(), x() );
00128       if (value > 2*PI || value < -2*PI){
00129         value = fmod(value, 2*PI);
00130       }
00131       if (value <= -PI) value += 2*PI;
00132       if (value >   PI) value -= 2*PI;
00133 
00134       // Return in the requested range
00135       switch (mapping) {
00136       case MINUSPI_PLUSPI:
00137         assert(value > -PI && value <= PI);
00138         return value;
00139       case ZERO_2PI:
00140         if (value >= 0) {
00141           assert(value >= 0 && value < 2*PI);
00142           return value;
00143         } else if (Rivet::isZero(value)) {
00144           value = 0.0;
00145           return value;
00146         } else {
00147           value = 2*PI + value;
00148           assert(value >= 0 && value < 2*PI);
00149           return value;
00150         }
00151       default:
00152         throw std::runtime_error("The specified phi mapping scheme is not yet implemented");
00153       }
00154     }

double phi ( const PhiMapping mapping = ZERO_2PI ) const [inline]

Synonym for azimuthalAngle.

Definition at line 157 of file Vector3.hh.

References Vector3::azimuthalAngle().

Referenced by FourVector::phi(), and Rivet::phi().

00157                                                           {
00158       return azimuthalAngle(mapping);
00159     }

double polarAngle ( ) const [inline]

Angle subtended by the vector and the z-axis.

Definition at line 162 of file Vector3.hh.

References Rivet::PI, Vector3::polarRadius(), and Vector3::z().

Referenced by FourVector::polarAngle(), Rivet::polarAngle(), Vector3::pseudorapidity(), and Vector3::theta().

00162                               {
00163       // Get number beween [0,PI]
00164       double polarangle = atan2(polarRadius(), z());
00165       assert(polarangle >= -PI && polarangle <= PI);
00166       return polarangle;
00167     }

double theta ( ) const [inline]

Synonym for polarAngle.

Definition at line 170 of file Vector3.hh.

References Vector3::polarAngle().

Referenced by ALEPH_1996_S3196992::analyze(), FourVector::theta(), and Rivet::theta().

00170                          {
00171       return polarAngle();
00172     }

double pseudorapidity ( ) const [inline]

Purely geometric approximation to rapidity; exact for massless particles and in the central region.

Definition at line 176 of file Vector3.hh.

References Vector3::polarAngle().

Referenced by Rivet::deltaR(), Vector3::eta(), FourVector::pseudorapidity(), and Rivet::pseudorapidity().

00176                                   {
00177       return -std::log(tan( 0.5 * polarAngle() ));
00178     }

double eta ( ) const [inline]

Synonym for pseudorapidity.

Definition at line 181 of file Vector3.hh.

References Vector3::pseudorapidity().

Referenced by FourVector::eta(), and Rivet::eta().

00181                        {
00182       return pseudorapidity();
00183     }

Vector3& operator*= ( const double a ) [inline]

Definition at line 186 of file Vector3.hh.

References Vector::_vec, Vector< 3 >::_vec, and Vector3::multiply.

00186                                         {
00187       _vec = multiply(a, *this)._vec;
00188       return *this;
00189     }

Vector3& operator/= ( const double a ) [inline]

Definition at line 191 of file Vector3.hh.

References Vector::_vec, Vector< 3 >::_vec, and Vector3::multiply.

00191                                         {
00192       _vec = multiply(1.0/a, *this)._vec;
00193       return *this;
00194     }

Vector3& operator+= ( const Vector3 & v ) [inline]

Definition at line 196 of file Vector3.hh.

References Vector< 3 >::_vec.

00196                                           {
00197       _vec = add(*this, v)._vec;
00198       return *this;
00199     }

Vector3& operator-= ( const Vector3 & v ) [inline]

Definition at line 201 of file Vector3.hh.

References Vector::_vec, Vector< 3 >::_vec, and Vector3::subtract.

00201                                           {
00202       _vec = subtract(*this, v)._vec;
00203       return *this;
00204     }

Vector3 operator- ( ) const [inline]

Invert the vector.

Reimplemented from Vector< 3 >.

Definition at line 206 of file Vector3.hh.

References Vector< 3 >::_vec, and Vector::_vec.

00206                               {
00207       Vector3 rtn;
00208       rtn._vec = -_vec;
00209       return rtn;
00210     }

const double& get ( const size_t index ) const [inline, inherited]

Definition at line 33 of file VectorN.hh.

00033                                                 {
00034       if (index >= N) {
00035         throw std::runtime_error("Tried to access an invalid vector index.");
00036       } else {
00037         return _vec(index);
00038       }
00039     }

double& get ( const size_t index ) [inline, protected, inherited]

Definition at line 126 of file VectorN.hh.

00126                                     {
00127       if (index >= N) {
00128         throw std::runtime_error("Tried to access an invalid vector index.");
00129       } else {
00130         return _vec(index);
00131       }
00132     }

const double& operator[] ( const size_t index ) const [inline, inherited]

Direct access to vector elements by index.

Definition at line 42 of file VectorN.hh.

00042                                                        {
00043       return get(index);
00044     }

double& operator[] ( const size_t index ) [inline, inherited]

Direct access to vector elements by index.

Definition at line 47 of file VectorN.hh.

00047                                            {
00048       return get(index);
00049     }

Vector<N>& set	(	const size_t	index,
		const double	value
	)			`[inline, inherited]`

Set indexed value.

Definition at line 52 of file VectorN.hh.

00052                                                            {
00053       if (index >= N) {
00054         throw std::runtime_error("Tried to access an invalid vector index.");
00055       } else {
00056         _vec[index] = value;
00057       }
00058       return *this;
00059     }

size_t size ( ) const [inline, inherited]

Vector dimensionality.

Definition at line 62 of file VectorN.hh.

00062                         {
00063       return N;
00064     }

bool isZero ( double tolerance = 1E-5 ) const [inline, inherited]

Check for nullness, allowing for numerical precision.

Definition at line 67 of file VectorN.hh.

Referenced by Vector3::unit().

00067                                              {
00068       for (size_t i=0; i < N; ++i) {
00069         if (! Rivet::isZero(_vec[i], tolerance) ) return false;
00070       }
00071       return true;
00072     }

double mod2 ( ) const [inline, inherited]

Calculate the modulus-squared of a vector. $\sum_{i=1}^N x_i^2$ .

Definition at line 76 of file VectorN.hh.

Referenced by Vector3::azimuthalAngle().

00076                         {
00077       double mod2 = 0.0;
00078       for (size_t i = 0; i < size(); ++i) {
00079         const double element = get(i);
00080         mod2 += element*element;
00081       }
00082       return mod2;
00083     }

double mod ( ) const [inline, inherited]

Calculate the modulus of a vector. $\sqrt{\sum_{i=1}^N x_i^2}$ .

Definition at line 87 of file VectorN.hh.

Referenced by Vector3::unit().

00087                        {
00088       const double norm = mod2();
00089       assert(norm >= 0);
00090       return sqrt(norm);
00091     }

bool operator== ( const Vector< N > & a ) const [inline, inherited]

Definition at line 100 of file VectorN.hh.

00100                                               {
00101       return _vec == a._vec;
00102     }

bool operator!= ( const Vector< N > & a ) const [inline, inherited]

Definition at line 104 of file VectorN.hh.

00104                                               {
00105       return _vec != a._vec;
00106     }

bool operator< ( const Vector< N > & a ) const [inline, inherited]

Definition at line 108 of file VectorN.hh.

00108                                              {
00109       return _vec < a._vec;
00110     }

bool operator<= ( const Vector< N > & a ) const [inline, inherited]

Definition at line 112 of file VectorN.hh.

00112                                               {
00113       return _vec <= a._vec;
00114     }

bool operator> ( const Vector< N > & a ) const [inline, inherited]

Definition at line 116 of file VectorN.hh.

00116                                              {
00117       return _vec > a._vec;
00118     }

bool operator>= ( const Vector< N > & a ) const [inline, inherited]

Definition at line 120 of file VectorN.hh.

00120                                               {
00121       return _vec >= a._vec;
00122     }

Friends And Related Function Documentation

friend class Matrix3 [friend]

Definition at line 28 of file Vector3.hh.

Vector3 multiply	(	const	double,
		const Vector3 &	v
	)			`[friend]`

Referenced by Vector3::operator*=(), and Vector3::operator/=().

Vector3 multiply	(	const Vector3 &	v,
		const	double
	)			`[friend]`

Vector3 add	(	const Vector3 &	a,
		const Vector3 &	b
	)			`[friend]`

Vector3 subtract	(	const Vector3 &	a,
		const Vector3 &	b
	)			`[friend]`

Definition at line 252 of file Vector3.hh.

Referenced by Vector3::operator-=().

00252                                                               {
00253     Vector3 result;
00254     result._vec = a._vec - b._vec;
00255     return result;
00256   }

Member Data Documentation

Eigen::Vector<double,N> _vec [protected, inherited]

Vector.

Definition at line 135 of file VectorN.hh.

Referenced by Vector3::cross(), Vector3::dot(), Vector3::operator*=(), Vector3::operator+=(), Vector3::operator-(), Vector3::operator-=(), and Vector3::operator/=().

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

Vector3.hh

Vector3 Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation