Vec Struct Reference

The Vec class is a straightforward 3-d vector, which also works in pyroot. More...

#include <Vec.hh>

Inheritance diagram for Vec:

Public Member Functions
	Vec (double x_, double y_, double z_)
	Constructor. More...
	Vec ()
	Default constructor. More...
double	dot (const Vec &v) const
	Get dot product. More...
Vec	cross (const Vec r) const
	Get cross product. More...
Vec &	operator+= (const Vec &v)
	Add vector. More...
Vec &	operator-= (const Vec &v)
	Subtract vector. More...
Vec &	operator*= (double d)
	Multiply vector. More...
Vec &	operator/= (double d)
	Divide vector. More...
Vec	operator- () const
	Negate vector. More...
bool	operator== (const Vec &v) const
	Check equality with given vector. More...
bool	operator!= (const Vec &v) const
	Check in-equality with given vector. More...
Vec &	set (double xx, double yy, double zz)
	Set vector. More...
Vec &	set_angles (double theta, double phi)
	Set vector according given zenith and azimuth angles. More...
double	phi () const
	Get azimuth angle. More...
double	theta () const
	Get zenith angle. More...
double	len () const
	Get length. More...
double	lenxy () const
	Get length of (x,y) component. More...
Vec &	normalize ()
	Normalise this vector. More...
void	print (std::ostream &out=std::cout) const
	Print vector. More...
const char *	__repr__ () const
	Get string representation of this vector. More...
Vec	__add__ (const Vec &v) const
	Add vector. More...
Vec	__sub__ (const Vec &v) const
	Subtract vector. More...
Vec	__mul__ (double d) const
	Multiply vector. More...
Vec	__rmul__ (double d) const
	Multiply vector. More...
Vec	__div__ (double d) const
	Divide vector. More...
Vec &	rotate_z (double ang)
	Rotate around z-axis with given angle. More...
Vec &	rotate_x (double ang)
	Rotate around x-axis with given angle. More...
Vec &	rotate_y (double ang)
	Rotate around y-axis with given angle. More...

Public Attributes
double	x
double	y
double	z

Detailed Description

The Vec class is a straightforward 3-d vector, which also works in pyroot.

Definition at line 12 of file Vec.hh.

Constructor & Destructor Documentation

Vec::Vec ( double  x_, double  y_, double  z_  )

inline

Constructor.

Parameters

x_	x position
y_	y position
z_	z position

Definition at line 23 of file Vec.hh.

: x(x_), y(y_), z(z_) {}

Vec::Vec ( )

inline

Default constructor.

Definition at line 28 of file Vec.hh.

:x(0),y(0),z(0) {}

Member Function Documentation

double Vec::dot ( const Vec &  v ) const

inline

Get dot product.

Parameters

v

vector

Returns

dot product

Definition at line 36 of file Vec.hh.

{ return v.x*x + v.y*y+ v.z*z;}

Vec Vec::cross ( const Vec  r ) const

inline

Get cross product.

Parameters

r

vector

Returns

cross product

Definition at line 44 of file Vec.hh.

{ return Vec ( y*r.z-z*r.y, z*r.x-x*r.z, x*r.y-y*r.x);}

Vec& Vec::operator+= ( const Vec &  v )

inline

Add vector.

Parameters

v

vector

Returns

this vector

Definition at line 52 of file Vec.hh.

{ x+=v.x; y+=v.y; z+=v.z; return *this;}

Vec& Vec::operator-= ( const Vec &  v )

inline

Subtract vector.

Parameters

v

vector

Returns

this vector

Definition at line 60 of file Vec.hh.

{ x-=v.x; y-=v.y; z-=v.z; return *this;}

Vec& Vec::operator*= ( double  d )

inline

Multiply vector.

Parameters

d

factor

Returns

this vector

Definition at line 68 of file Vec.hh.

{ x*=d; y*=d; z*=d; return *this;}

Vec& Vec::operator/= ( double  d )

inline

Divide vector.

Parameters

d

factor

Returns

this vector

Definition at line 76 of file Vec.hh.

{ return operator*=( 1.0 / d ); }

Vec Vec::operator- ( ) const

inline

Negate vector.

Returns

vector

Definition at line 83 of file Vec.hh.

{ return Vec(-x,-y,-z); }

bool Vec::operator== ( const Vec &  v ) const

inline

Check equality with given vector.

Parameters

v

vector

Returns

true if (x,y,z) positions of two vectors are equal; else false

Definition at line 91 of file Vec.hh.

{ return x==v.x && y==v.y && z==v.z ; }

bool Vec::operator!= ( const Vec &  v ) const

inline

Check in-equality with given vector.

Parameters

v

vector

Returns

true if one of (x,y,z) positions of two vectors are not equal; else false

Definition at line 99 of file Vec.hh.

{ return x!=v.x || y!=v.y || z!=v.z ; }

Vec& Vec::set ( double  xx, double  yy, double  zz  )

inline

Set vector.

Parameters

xx	x position
yy	y position
zz	z position

Returns

this vector

Definition at line 109 of file Vec.hh.

{ x=xx; y=yy; z=zz; return *this;}

Vec& Vec::set_angles ( double  theta, double  phi  )

inline

Set vector according given zenith and azimuth angles.

Parameters

theta	zenith angle [rad]
phi	azimuth angle [rad]

Returns

this vector

Definition at line 118 of file Vec.hh.

  {
    x = sin ( theta ) * cos( phi );
    y = sin ( theta ) * sin( phi );
    z = cos ( theta );
    return *this;
  }

double Vec::phi ( ) const

inline

Get azimuth angle.

Returns

angle [rad]

Definition at line 131 of file Vec.hh.

{ return atan2( y,x ); }

double Vec::theta ( ) const

inline

Get zenith angle.

Returns

angle [rad]

Definition at line 138 of file Vec.hh.

{ return acos(z); }

double Vec::len ( ) const

inline

Get length.

Returns

length

Definition at line 145 of file Vec.hh.

{ double l = dot(*this); return (l > 0)? sqrt(l) : 0; }

double Vec::lenxy ( ) const

inline

Get length of (x,y) component.

Returns

length

Definition at line 152 of file Vec.hh.

{ const double r2 = x*x + y*y; return (r2>0) ? sqrt(r2) :0; }

Vec& Vec::normalize ( )

inline

Normalise this vector.

Returns

this vector

Definition at line 159 of file Vec.hh.

{ return operator/=( len() ); }

void Vec::print ( std::ostream &  out = std::cout ) const

inline

Print vector.

Parameters

out	output stream

Definition at line 166 of file Vec.hh.

  {
        out << "Vec:" << x << " " << y << " " << z;
  }

const char* Vec::__repr__ ( ) const

inline

Get string representation of this vector.

Returns

string

Definition at line 176 of file Vec.hh.

  {
    static std::string buffer;

    std::ostringstream s; 
  
    print(s);

    buffer = s.str();

    return buffer.c_str();
  }

Vec Vec::__add__ ( const Vec &  v ) const

inline

Add vector.

Parameters

v

vector

Returns

vector

Definition at line 195 of file Vec.hh.

{ Vec r=*this; return r+=v; }

Vec Vec::__sub__ ( const Vec &  v ) const

inline

Subtract vector.

Parameters

v

vector

Returns

vector

Definition at line 203 of file Vec.hh.

{ Vec r=*this; return r-=v; }

Vec Vec::__mul__ ( double  d ) const

inline

Multiply vector.

Parameters

d

factor

Returns

vector

Definition at line 211 of file Vec.hh.

{ Vec r=*this; return r*=d; }

Vec Vec::__rmul__ ( double  d ) const

inline

Multiply vector.

Parameters

d

factor

Returns

vector

Definition at line 219 of file Vec.hh.

{ return __mul__(d);        } 

Vec Vec::__div__ ( double  d ) const

inline

Divide vector.

Parameters

d

factor

Returns

vector

Definition at line 227 of file Vec.hh.

{ Vec r=*this; return r/=d; }

Vec& Vec::rotate_z ( double  ang )

inline

Rotate around z-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 235 of file Vec.hh.

  {
    const Vec o = *this; 
    x = o.x *cos(ang) - o.y * sin(ang);
    y = o.x *sin(ang) + o.y * cos(ang);
    z = o.z;
    return *this;
  }

Vec& Vec::rotate_x ( double  ang )

inline

Rotate around x-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 250 of file Vec.hh.

  {
    const Vec o = *this;
    x = o.x;
    y = o.y *cos(ang) + o.z * -sin(ang);
    z = o.y *sin(ang) + o.z * cos(ang);
    return *this;
  }

Vec& Vec::rotate_y ( double  ang )

inline

Rotate around y-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 265 of file Vec.hh.

  {
    const Vec o = *this;
    x = o.x *cos(ang) + o.z * sin(ang);
    y = o.y;
    z = -o.x *sin(ang) + o.z * cos(ang);
    return *this;
  }

Member Data Documentation

double Vec::x

Definition at line 14 of file Vec.hh.

double Vec::y

Definition at line 14 of file Vec.hh.

double Vec::z

Definition at line 14 of file Vec.hh.

---

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

• Vec.hh