WireCell::D3Vector< T > Class Template Reference

#include <D3Vector.h>

Public Member Functions
	D3Vector (const T &a=0, const T &b=0, const T &c=0)
	Construct from elements. More...
	D3Vector (const D3Vector &o)
	D3Vector (const T d[3])
D3Vector &	operator= (const D3Vector &o)
void	set (const T &a=0, const T &b=0, const T &c=0)
	Set vector from elements;. More...
T	x (const T &val)
T	y (const T &val)
T	z (const T &val)
template<class TT >
	D3Vector (const D3Vector< TT > &o)
	Convert from other typed vector. More...
T	x () const
	Access elements by name. More...
T	y () const
T	z () const
T	operator[] (std::size_t index) const
	Access elements by copy. More...
T &	operator[] (std::size_t index)
	Access elements by reference. More...
T	dot (const D3Vector &rhs) const
	Return the dot product of this vector and the other. More...
T	magnitude () const
	Return the magnitude of this vector. More...
D3Vector	norm () const
	Return a normalized vector in the direction of this vector. More...
D3Vector	cross (const D3Vector &rhs) const
	Return the cross product of this vector and the other. More...
D3Vector	triplevec (D3Vector &a, D3Vector &b) const
	Return the triple cross product of this vector and the other two. More...
T	triplescal (D3Vector &a, D3Vector &b) const
	Return the dot-cross product of this vector and the other two. More...
bool	operator< (const D3Vector &rhs) const
D3Vector &	operator+= (const D3Vector &other)
bool	operator! () const
	operator bool () const
void	invalidate ()

Private Types
typedef std::vector< T >	D3VectorStore

Private Attributes
D3VectorStore	m_v

Friends
template<class U >
std::ostream &	operator<< (std::ostream &, const D3Vector< U > &)

Detailed Description

template<class T>
class WireCell::D3Vector< T >

Dimension-3 vector class.

Adapted in laziness from: http://rosettacode.org/wiki/Vector_products#C.2B.2B

Definition at line 23 of file D3Vector.h.

Member Typedef Documentation

template<class T>

typedef std::vector<T> WireCell::D3Vector< T >::D3VectorStore

private

Definition at line 28 of file D3Vector.h.

Constructor & Destructor Documentation

template<class T>

WireCell::D3Vector< T >::D3Vector ( const T &  a = 0, const T &  b = 0, const T &  c = 0  )

inline

Construct from elements.

Definition at line 35 of file D3Vector.h.

: m_v(3) { this->set(a,b,c); }

template<class T>

WireCell::D3Vector< T >::D3Vector ( const D3Vector< T > &  o )

inline

Definition at line 38 of file D3Vector.h.

: m_v(3) { this->set(o.x(), o.y(), o.z()); }

template<class T>

WireCell::D3Vector< T >::D3Vector ( const T  d[3] )

inline

Definition at line 40 of file D3Vector.h.

: m_v(3) { this->set(d[0], d[1], d[2]); }

template<class T>

template<class TT >

WireCell::D3Vector< T >::D3Vector ( const D3Vector< TT > &  o )

inline

Convert from other typed vector.

Definition at line 62 of file D3Vector.h.

: m_v(3) { this->set(o.x(), o.y(), o.z()); }

Member Function Documentation

template<class T>

D3Vector WireCell::D3Vector< T >::cross ( const D3Vector< T > &  rhs ) const

inline

Return the cross product of this vector and the other.

Definition at line 100 of file D3Vector.h.

                                                      {
            T a = y() * rhs.z() - z() * rhs.y() ;
            T b = z() * rhs.x() - x() * rhs.z() ;
            T c = x() * rhs.y() - y() * rhs.x() ;
            D3Vector product( a , b , c ) ;
            return product ;
        }

template<class T>

T WireCell::D3Vector< T >::dot ( const D3Vector< T > &  rhs ) const

inline

Return the dot product of this vector and the other.

Definition at line 80 of file D3Vector.h.

                                             {
            T scalar = x() * rhs.x() + y() * rhs.y() + z() * rhs.z() ;
            return scalar;
        }

template<class T>

void WireCell::D3Vector< T >::invalidate ( )

inline

Definition at line 136 of file D3Vector.h.

                          {
            m_v.clear();
            m_v.shrink_to_fit();
        }

template<class T>

T WireCell::D3Vector< T >::magnitude ( ) const

inline

Return the magnitude of this vector.

Definition at line 86 of file D3Vector.h.

                            {
            return std::sqrt(x()*x()+y()*y()+z()*z());
        }

template<class T>

D3Vector WireCell::D3Vector< T >::norm ( ) const

inline

Return a normalized vector in the direction of this vector.

Definition at line 91 of file D3Vector.h.

                              {
            T m = this->magnitude();
            if (m <= 0) {
                return D3Vector();
            }
            return D3Vector(x()/m, y()/m, z()/m);
        }           

template<class T>

WireCell::D3Vector< T >::operator bool ( ) const

inline

Definition at line 132 of file D3Vector.h.

                              {
            return m_v.size() == 3;
        }

template<class T>

bool WireCell::D3Vector< T >::operator! ( ) const

inline

Definition at line 129 of file D3Vector.h.

                               {
            return m_v.size() != 3;
        }

template<class T>

D3Vector& WireCell::D3Vector< T >::operator+= ( const D3Vector< T > &  other )

inline

Definition at line 124 of file D3Vector.h.

                                                     {
            this->set(x()+other.x(), y()+other.y(), z()+other.z());
            return *this;
        }

template<class T>

bool WireCell::D3Vector< T >::operator< ( const D3Vector< T > &  rhs ) const

inline

Definition at line 117 of file D3Vector.h.

                                                   {
            if (z() < rhs.z()) return true;
            if (y() < rhs.y()) return true;
            if (x() < rhs.x()) return true;
            return false;
        }

template<class T>

D3Vector& WireCell::D3Vector< T >::operator= ( const D3Vector< T > &  o )

inline

Definition at line 43 of file D3Vector.h.

                                               {
            this->set(o.x(), o.y(), o.z()); 
            return *this;
        }

template<class T>

T WireCell::D3Vector< T >::operator[] ( std::size_t  index ) const

inline

Access elements by copy.

Definition at line 70 of file D3Vector.h.

                                            {
            return m_v.at(index);
        }

template<class T>

T& WireCell::D3Vector< T >::operator[] ( std::size_t  index )

inline

Access elements by reference.

Definition at line 75 of file D3Vector.h.

                                       {
            return m_v.at(index);       // throw if out of bounds
        }

template<class T>

void WireCell::D3Vector< T >::set ( const T &  a = 0, const T &  b = 0, const T &  c = 0  )

inline

Set vector from elements;.

Definition at line 49 of file D3Vector.h.

                                                           {
            m_v.resize(3);
            m_v[0] = a;
            m_v[1] = b;
            m_v[2] = c;
        }

template<class T>

T WireCell::D3Vector< T >::triplescal ( D3Vector< T > &  a, D3Vector< T > &  b  ) const

inline

Return the dot-cross product of this vector and the other two.

Definition at line 113 of file D3Vector.h.

                                                         {
            return dot( a.cross( b ) ) ;
        }

template<class T>

D3Vector WireCell::D3Vector< T >::triplevec ( D3Vector< T > &  a, D3Vector< T > &  b  ) const

inline

Return the triple cross product of this vector and the other two.

Definition at line 109 of file D3Vector.h.

                                                                {
            return cross ( a.cross( b ) ) ;
        }

template<class T>

T WireCell::D3Vector< T >::x ( const T &  val )

inline

Definition at line 55 of file D3Vector.h.

{ return m_v[0] = val; }

template<class T>

T WireCell::D3Vector< T >::x ( ) const

inline

Access elements by name.

Definition at line 65 of file D3Vector.h.

{ return m_v[0]; }

template<class T>

T WireCell::D3Vector< T >::y ( const T &  val )

inline

Definition at line 56 of file D3Vector.h.

{ return m_v[1] = val; }

template<class T>

T WireCell::D3Vector< T >::y ( ) const

inline

Definition at line 66 of file D3Vector.h.

{ return m_v[1]; }

template<class T>

T WireCell::D3Vector< T >::z ( const T &  val )

inline

Definition at line 57 of file D3Vector.h.

{ return m_v[2] = val; }

template<class T>

T WireCell::D3Vector< T >::z ( ) const

inline

Definition at line 67 of file D3Vector.h.

{ return m_v[2]; }

Friends And Related Function Documentation

template<class T>

template<class U >

std::ostream& operator<< ( std::ostream &  , const D3Vector< U > &    )

friend

Member Data Documentation

template<class T>

D3VectorStore WireCell::D3Vector< T >::m_v

private

Definition at line 29 of file D3Vector.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/D3Vector.h