geoalgo::Vector Class Reference

#include "GeoVector.h"

Inheritance diagram for geoalgo::Vector:

Public Member Functions
	Vector ()
	Default ctor. More...
	Vector (size_t n)
	Ctor to instantiate with invalid value. More...
	Vector (const std::vector< double > &obj)
	Default ctor w/ a bare std::vector<double> More...
	Vector (const double x, const double y)
	ctor w/ x & y More...
	Vector (const double x, const double y, const double z)
	ctor w/ x, y & z More...
	Vector (const TVector3 &pt)
	ctor w/ TVector3 More...
	Vector (const TLorentzVector &pt)
	ctor w/ TLorentzVector More...
virtual	~Vector ()
	Default dtor. More...
void	Normalize ()
	Normalize itself. More...
bool	IsValid () const
	Check if point is valid. More...
double	SqLength () const
	Compute the squared length of the vector. More...
double	Length () const
	Compute the length of the vector. More...
Vector	Dir () const
	Return a direction unit vector. More...
double	Phi () const
	Compute the angle Phi. More...
double	Theta () const
	Compute the angle theta. More...
double	SqDist (const Vector &obj) const
	Compute the squared distance to another vector. More...
double	Dist (const Vector &obj) const
	Compute the distance to another vector. More...
double	Dot (const Vector &obj) const
Vector	Cross (const Vector &obj) const
	Compute a dot product of two vectors. More...
double	Angle (const Vector &obj) const
	Compute a cross product of two vectors. More...
TLorentzVector	ToTLorentzVector () const
	Compute an opening angle w.r.t. the given vector. More...
void	compat (const Vector &obj) const
	Dimensional check for a compatibility. More...
void	RotateX (const double &theta)
	rotation operations More...
void	RotateY (const double &theta)
void	RotateZ (const double &theta)
Vector &	operator+= (const Vector &rhs)
Vector &	operator-= (const Vector &rhs)
Vector &	operator*= (const double rhs)
Vector &	operator/= (const double rhs)
Vector &	operator= (const Vector &rhs)
Vector	operator+ (const Vector &rhs) const
Vector	operator- (const Vector &rhs) const
double	operator* (const Vector &rhs) const
Vector	operator* (const double &rhs) const
Vector	operator/ (const double &rhs) const
bool	operator< (const Vector &rhs) const
bool	operator< (const double &rhs) const
bool	operator== (const Vector &rhs) const
bool	operator!= (const Vector &rhs) const

Public Attributes
T	elements
	STL member. More...

Protected Member Functions
double	_SqDist_ (const Vector &obj) const
	Compute the squared-distance to another vector w/o dimension check. More...
double	_Dist_ (const Vector &obj) const
	Compute the distance to another vector w/o dimension check. More...
double	_Dot_ (const Vector &obj) const
	Compute a dot product w/o dimention check. More...
Vector	_Cross_ (const Vector &obj) const
	Compute a cross product w/o dimension check. More...
double	_Angle_ (const Vector &obj) const
	Compute the angle in degrees between 2 vectors w/o dimension check. More...

Friends
class	Trajectory
class	HalfLine
class	LineSegment
class	Sphere
class	GeoAlgo
std::ostream &	operator<< (std::ostream &o,::geoalgo::Vector const &a)
	Streamer. More...

Detailed Description

This class represents an n-dimensional vector

Definition at line 35 of file GeoVector.h.

Constructor & Destructor Documentation

geoalgo::Vector::Vector ( )

inline

Default ctor.

Definition at line 43 of file GeoVector.h.

Referenced by Vector().

             : std::vector<double>()
    {}

geoalgo::Vector::Vector ( size_t  n )

inline

Ctor to instantiate with invalid value.

Definition at line 47 of file GeoVector.h.

                     : std::vector<double>(n,kINVALID_DOUBLE)
    {}

geoalgo::Vector::Vector ( const std::vector< double > &  obj )

inline

Default ctor w/ a bare std::vector<double>

Definition at line 51 of file GeoVector.h.

References pt, Vector(), x, y, and z.

                                         : std::vector<double>(obj)
    {}

geoalgo::Vector::Vector	(	const double	x,
		const double	y
	)

ctor w/ x & y

Definition at line 14 of file GeoVector.cxx.

References x, and y.

                                               : Vector(2)
  { (*this)[0] = x; (*this)[1] = y; }

geoalgo::Vector::Vector	(	const double	x,
		const double	y,
		const double	z
	)

ctor w/ x, y & z

Definition at line 17 of file GeoVector.cxx.

References x, y, and z.

                                                               : Vector(3)
  { (*this)[0] = x; (*this)[1] = y; (*this)[2] = z; }

geoalgo::Vector::Vector

(

const TVector3 &

pt

)

ctor w/ TVector3

Definition at line 20 of file GeoVector.cxx.

                                   : Vector(3)
  { (*this)[0] = pt[0]; (*this)[1] = pt[1]; (*this)[2] = pt[2]; }

geoalgo::Vector::Vector

(

const TLorentzVector &

pt

)

ctor w/ TLorentzVector

Definition at line 23 of file GeoVector.cxx.

                                         : Vector(3)
  { (*this)[0] = pt[0]; (*this)[1] = pt[1]; (*this)[2] = pt[2]; }

virtual geoalgo::Vector::~Vector ( )

inlinevirtual

Default dtor.

Definition at line 60 of file GeoVector.h.

References _Angle_(), _Cross_(), _Dist_(), _Dot_(), _SqDist_(), Angle(), compat(), Cross(), Dir(), Dist(), Dot(), IsValid(), Length(), Normalize(), Phi(), RotateX(), RotateY(), RotateZ(), SqDist(), SqLength(), Theta(), and ToTLorentzVector().

Member Function Documentation

double geoalgo::Vector::_Angle_ ( const Vector &  obj ) const

protected

Compute the angle in degrees between 2 vectors w/o dimension check.

Definition at line 134 of file GeoVector.cxx.

References _Dot_(), and Length().

Referenced by Angle(), and ~Vector().

  { return acos( _Dot_(obj) / Length() / obj.Length() ); }

Vector geoalgo::Vector::_Cross_ ( const Vector &  obj ) const

protected

Compute a cross product w/o dimension check.

Definition at line 125 of file GeoVector.cxx.

Referenced by Cross(), and ~Vector().

  {
    Vector res(3);
    res[0] = (*this)[1] * obj[2] - obj[1] * (*this)[2];
    res[1] = (*this)[2] * obj[0] - obj[2] * (*this)[0];
    res[2] = (*this)[0] * obj[1] - obj[0] * (*this)[1];
    return res;
  }    

double geoalgo::Vector::_Dist_ ( const Vector &  obj ) const

protected

Compute the distance to another vector w/o dimension check.

Definition at line 119 of file GeoVector.cxx.

References _SqDist_().

Referenced by geoalgo::Sphere::Contain(), and ~Vector().

  { return sqrt(_SqDist_(obj)); }

double geoalgo::Vector::_Dot_ ( const Vector &  obj ) const

protected

Compute a dot product w/o dimention check.

Definition at line 122 of file GeoVector.cxx.

Referenced by _Angle_(), Dot(), and ~Vector().

    { return (*this) * obj; }

double geoalgo::Vector::_SqDist_ ( const Vector &  obj ) const

protected

Compute the squared-distance to another vector w/o dimension check.

Definition at line 112 of file GeoVector.cxx.

Referenced by _Dist_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoAlgo::Intersection(), SqDist(), and ~Vector().

  {
    double dist = 0;
    for(size_t i=0; i<size(); ++i) dist += ((*this)[i] - obj[i]) * ((*this)[i] - obj[i]);
      return dist;
  }

double geoalgo::Vector::Angle

(

const Vector &

obj

)

const

Compute a cross product of two vectors.

Definition at line 80 of file GeoVector.cxx.

References _Angle_(), and compat().

Referenced by geoalgo::Cylinder::Contain(), and ~Vector().

                                              {
    compat(obj);
    if(size()!=2 && size()!=3)
      throw GeoAlgoException("<<Angle>> only possible for 2 or 3-dimensional vectors!");
    return _Angle_(obj);
  }

void geoalgo::Vector::compat

(

const Vector &

obj

)

const

Dimensional check for a compatibility.

Definition at line 101 of file GeoVector.cxx.

Referenced by Angle(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::Sphere::Contain(), Dot(), operator<(), operator==(), SqDist(), geoalgo::GeoAlgo::SqDist(), and ~Vector().

                                             {
    if(size() != obj.size()) {
      std::ostringstream msg;
        msg << "<<" << __FUNCTION__ << ">>" 
            << " size mismatch: "
            << size() << " != " << obj.size()
            << std::endl;
        throw GeoAlgoException(msg.str());
    }
  }

Vector geoalgo::Vector::Cross

(

const Vector &

obj

)

const

Compute a dot product of two vectors.

Definition at line 60 of file GeoVector.cxx.

References _Cross_().

Referenced by ~Vector().

                                              {
    
    if(size()!=3 || obj.size()!=3)
      
      throw GeoAlgoException("<<Cross>> only possible for 3-dimensional vectors!");
    
    return _Cross_(obj);
  }

Vector geoalgo::Vector::Dir

(

)

const

Return a direction unit vector.

Definition at line 95 of file GeoVector.cxx.

References Length().

Referenced by ~Vector().

                           {
    Vector res(*this);
    res /= res.Length();
    return res;
  }

double geoalgo::Vector::Dist

(

const Vector &

obj

)

const

Compute the distance to another vector.

Definition at line 52 of file GeoVector.cxx.

References SqDist().

Referenced by geoalgo::Sphere::Sphere(), and ~Vector().

  { return sqrt(SqDist(obj)); }

double geoalgo::Vector::Dot

(

const Vector &

obj

)

const

Definition at line 55 of file GeoVector.cxx.

References _Dot_(), and compat().

Referenced by geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::Sphere::Sphere(), and ~Vector().

                                            {
    compat(obj);
    return _Dot_(obj);
  }

bool geoalgo::Vector::IsValid

(

)

const

Check if point is valid.

Definition at line 26 of file GeoVector.cxx.

References geoalgo::kINVALID_DOUBLE.

Referenced by geoalgo::GeoAlgo::Intersection(), and ~Vector().

                             {
    
    for (auto const &v : (*this)){
      // if any point is different from kINVALID_DOUBLE
      // then the point is valid
      if (v != kINVALID_DOUBLE)
        return true;
    }
    
    return false;
  }

double geoalgo::Vector::Length

(

)

const

Compute the length of the vector.

Definition at line 44 of file GeoVector.cxx.

References SqLength().

Referenced by _Angle_(), geoalgo::GeoAlgo::_ClosestPt_(), Dir(), geoalgo::HalfLine::Normalize(), Normalize(), operator<(), geoalgo::Sphere::Sphere(), and ~Vector().

  { return sqrt(SqLength()); }

void geoalgo::Vector::Normalize

(

)

Normalize itself.

Definition at line 93 of file GeoVector.cxx.

References Length().

Referenced by geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_RemainingPoints_(), and ~Vector().

{ (*this) /= this->Length(); }

bool geoalgo::Vector::operator!= ( const Vector &  rhs ) const

inline

Definition at line 184 of file GeoVector.h.

    { return !(*this == rhs); }

double geoalgo::Vector::operator* ( const Vector &  rhs ) const

inline

Definition at line 144 of file GeoVector.h.

    { 
      double res=0;
      for(size_t i=0; i<size(); ++i) res += (*this)[i] * rhs[i];
      return res;
    }

Vector geoalgo::Vector::operator* ( const double &  rhs ) const

inline

Definition at line 151 of file GeoVector.h.

    {
      Vector res((*this));
      res *= rhs;
      return res;
    }

Vector& geoalgo::Vector::operator*= ( const double  rhs )

inline

Definition at line 114 of file GeoVector.h.

                                                {
      for(auto &v : *this) v *= rhs;
      return *this;
    }

Vector geoalgo::Vector::operator+ ( const Vector &  rhs ) const

inline

Definition at line 130 of file GeoVector.h.

    { 
      Vector res((*this));
      res+=rhs;
      return res;
    }

Vector& geoalgo::Vector::operator+= ( const Vector &  rhs )

inline

Definition at line 104 of file GeoVector.h.

                                                 { 
      for(size_t i=0; i<size(); ++i) (*this)[i] += rhs[i];
      return *this;
    }

Vector geoalgo::Vector::operator- ( const Vector &  rhs ) const

inline

Definition at line 137 of file GeoVector.h.

    { 
      Vector res((*this));
      res-=rhs;
      return res;
    }

Vector& geoalgo::Vector::operator-= ( const Vector &  rhs )

inline

Definition at line 109 of file GeoVector.h.

                                                 {
      for(size_t i=0; i<size(); ++i) (*this)[i] -= rhs[i];
      return *this;
    }

Vector geoalgo::Vector::operator/ ( const double &  rhs ) const

inline

Definition at line 158 of file GeoVector.h.

    {
      Vector res((*this));
      res /= rhs;
      return res;
    }

Vector& geoalgo::Vector::operator/= ( const double  rhs )

inline

Definition at line 119 of file GeoVector.h.

                                                {
      for(auto &v : *this) v /= rhs;
      return *this;
    }

bool geoalgo::Vector::operator< ( const Vector &  rhs ) const

inline

Definition at line 165 of file GeoVector.h.

References compat().

    { 
      compat(rhs);
      for(size_t i=0; i<size(); ++i)
        if((*this)[i] < rhs[i]) return true;
      return false;
    }

bool geoalgo::Vector::operator< ( const double &  rhs ) const

inline

Definition at line 173 of file GeoVector.h.

References Length().

    { return Length() < rhs; }

Vector& geoalgo::Vector::operator= ( const Vector &  rhs )

inline

Definition at line 124 of file GeoVector.h.

                                                {
      this->resize(rhs.size());
      for(size_t i=0; i<rhs.size(); ++i) (*this)[i]=rhs[i];
      return (*this);
    }

bool geoalgo::Vector::operator== ( const Vector &  rhs ) const

inline

Definition at line 176 of file GeoVector.h.

References compat().

    { 
      compat(rhs); 
      for(size_t i=0; i<size(); ++i) 
        if((*this)[i] != rhs[i]) return false;
      return true;
    }

double geoalgo::Vector::Phi

(

)

const

Compute the angle Phi.

Definition at line 69 of file GeoVector.cxx.

Referenced by ~Vector().

                           {
    return (*this)[0] == 0.0 && (*this)[1] == 0.0 ? 0.0 : atan2((*this)[1],(*this)[0]);
  }

void geoalgo::Vector::RotateX

(

const double &

theta

)

rotation operations

Definition at line 138 of file GeoVector.cxx.

References s.

Referenced by ~Vector().

  {

    double c = cos(theta);
    double s = sin(theta);
    
    double ynew = (*this)[1] * c - (*this)[2] * s;
    double znew = (*this)[1] * s + (*this)[2] * c;

    (*this)[1] = ynew;
    (*this)[2] = znew;
    
    return;
  }

void geoalgo::Vector::RotateY

(

const double &

theta

)

Definition at line 154 of file GeoVector.cxx.

References s.

Referenced by ~Vector().

  {

    double c = cos(theta);
    double s = sin(theta);
    
    double xnew =   (*this)[0] * c + (*this)[2] * s;
    double znew = - (*this)[0] * s + (*this)[2] * c;
    
    (*this)[0] = xnew;
    (*this)[2] = znew;

    return;
  }

void geoalgo::Vector::RotateZ

(

const double &

theta

)

Definition at line 170 of file GeoVector.cxx.

References s.

Referenced by ~Vector().

  {

    double c = cos(theta);
    double s = sin(theta);
    
    double xnew = (*this)[0] * c - (*this)[1] * s;
    double ynew = (*this)[0] * s + (*this)[1] * c;

    (*this)[0] = xnew;
    (*this)[1] = ynew;
    
    return;
  }

double geoalgo::Vector::SqDist

(

const Vector &

obj

)

const

Compute the squared distance to another vector.

Definition at line 47 of file GeoVector.cxx.

References _SqDist_(), and compat().

Referenced by Dist(), and ~Vector().

                                               {
    compat(obj);
    return _SqDist_(obj);
  }

double geoalgo::Vector::SqLength

(

)

const

Compute the squared length of the vector.

Definition at line 38 of file GeoVector.cxx.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_SqDist_(), Length(), and ~Vector().

                                {
    double res=0;
    for(auto const &v : (*this)) res += v*v;
    return res;
  }

double geoalgo::Vector::Theta

(

)

const

Compute the angle theta.

Definition at line 73 of file GeoVector.cxx.

Referenced by ~Vector().

                             {
    if ( size() != 3 )
      throw GeoAlgoException("<<Theta>> Only possible for 3-dimensional vectors!");

    return (*this).Length() == 0.0 ? 0.0 : acos( (*this)[2] / (*this).Length() );
  }

TLorentzVector geoalgo::Vector::ToTLorentzVector

(

)

const

Compute an opening angle w.r.t. the given vector.

Convert geovector to TLorentzVector (with 4th element set equal to 0)

Definition at line 87 of file GeoVector.cxx.

Referenced by ~Vector().

                                                {
    if(size()!=3)
      throw GeoAlgoException("<<ToTLorentsVector>> only possible for 3-dimensional vectors!");
    return TLorentzVector((*this)[0],(*this)[1],(*this)[2],0.);
  }

Friends And Related Function Documentation

friend class GeoAlgo

friend

Definition at line 40 of file GeoVector.h.

friend class HalfLine

friend

Definition at line 37 of file GeoVector.h.

friend class LineSegment

friend

Definition at line 38 of file GeoVector.h.

std::ostream& operator<< ( std::ostream &  o, ::geoalgo::Vector const &  a  )

friend

Streamer.

Definition at line 189 of file GeoVector.h.

    { o << "Vector ("; for(auto const& v : a) o << v << " ";
      o << ")";
      return o;
    }

friend class Sphere

friend

Definition at line 39 of file GeoVector.h.

friend class Trajectory

friend

Definition at line 36 of file GeoVector.h.

Member Data Documentation

T std::vector< T >::elements

inherited

STL member.

---

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

• larcorealg/v1_24_01/source/larcorealg/GeoAlgo/GeoVector.h
• larcorealg/v1_24_01/source/larcorealg/GeoAlgo/GeoVector.cxx