UVector2 Class Reference

#include <UVector2.hh>

Public Types
enum	{ X = 0, Y = 1, NUM_COORDINATES = 2, SIZE = NUM_COORDINATES }
enum	{ ZMpvToleranceTicks = 100 }

Public Member Functions
	UVector2 (double x=0.0, double y=0.0)
	UVector2 (const UVector2 &p)
	UVector2 (const UVector3 &s)
	~UVector2 ()
double	operator() (int i) const
double	operator[] (int i) const
double &	operator() (int i)
double &	operator[] (int i)
void	setX (double x)
void	setY (double y)
void	set (double x, double y)
double	phi () const
double	mag2 () const
double	mag () const
double	r () const
void	setPhi (double phi)
void	setMag (double r)
void	setR (double r)
void	setPolar (double r, double phi)
UVector2 &	operator= (const UVector2 &p)
bool	operator== (const UVector2 &v) const
bool	operator!= (const UVector2 &v) const
int	compare (const UVector2 &v) const
bool	operator> (const UVector2 &v) const
bool	operator< (const UVector2 &v) const
bool	operator>= (const UVector2 &v) const
bool	operator<= (const UVector2 &v) const
double	howNear (const UVector2 &p) const
bool	isNear (const UVector2 &p, double epsilon=tolerance) const
double	howParallel (const UVector2 &p) const
bool	isParallel (const UVector2 &p, double epsilon=tolerance) const
double	howOrthogonal (const UVector2 &p) const
bool	isOrthogonal (const UVector2 &p, double epsilon=tolerance) const
UVector2 &	operator+= (const UVector2 &p)
UVector2 &	operator-= (const UVector2 &p)
UVector2	operator- () const
UVector2 &	operator*= (double a)
UVector2	unit () const
UVector2	orthogonal () const
double	dot (const UVector2 &p) const
double	angle (const UVector2 &) const
void	rotate (double)
	operator UVector3 () const

Static Public Member Functions
static double	getTolerance ()
static double	setTolerance (double tol)

Data Fields
double	x
double	y

Friends
std::ostream &	operator<< (std::ostream &, const UVector2 &)
double	operator* (const UVector2 &a, const UVector2 &b)
UVector2	operator* (const UVector2 &p, double a)
UVector2	operator* (double a, const UVector2 &p)
UVector2	operator/ (const UVector2 &p, double a)
UVector2	operator+ (const UVector2 &a, const UVector2 &b)
UVector2	operator- (const UVector2 &a, const UVector2 &b)

Detailed Description

Author

Definition at line 45 of file UVector2.hh.

Member Enumeration Documentation

anonymous enum

Enumerator
X
Y
NUM_COORDINATES
SIZE

Definition at line 50 of file UVector2.hh.

{ X = 0, Y = 1, NUM_COORDINATES = 2, SIZE = NUM_COORDINATES };

anonymous enum

Enumerator
ZMpvToleranceTicks

Definition at line 193 of file UVector2.hh.

{ ZMpvToleranceTicks = 100 };

Constructor & Destructor Documentation

UVector2::UVector2 ( double  x = 0.0, double  y = 0.0  )

inline

Definition at line 220 of file UVector2.hh.

Referenced by operator-(), orthogonal(), and unit().

  : x(x1), y(y1) {}

UVector2::UVector2 ( const UVector2 &  p )

inline

Definition at line 251 of file UVector2.hh.

  : x(p.x), y(p.y) {}

UVector2::UVector2 ( const UVector3 &  s )

inlineexplicit

Definition at line 223 of file UVector2.hh.

  : x(s.x), y(s.y) {}

UVector2::~UVector2 ( )

inline

Definition at line 254 of file UVector2.hh.

{}

Member Function Documentation

double UVector2::angle ( const UVector2 &  q ) const

inline

Definition at line 345 of file UVector2.hh.

References dot(), and mag2().

{
  double ptot2 = mag2() * q.mag2();
  return ptot2 <= 0.0 ? 0.0 : std::acos(dot(q) / std::sqrt(ptot2));
}

int UVector2::compare

(

const UVector2 &

v

)

const

Definition at line 105 of file UVector2.cc.

References x, and y.

Referenced by operator<(), operator<=(), operator>(), and operator>=().

{
  if (y > v.y)
  {
    return 1;
  }
  else if (y < v.y)
  {
    return -1;
  }
  else if (x > v.x)
  {
    return 1;
  }
  else if (x < v.x)
  {
    return -1;
  }
  else
  {
    return 0;
  }
} /* Compare */

double UVector2::dot ( const UVector2 &  p ) const

inline

Definition at line 300 of file UVector2.hh.

References x, and y.

Referenced by angle(), howNear(), howOrthogonal(), howParallel(), isNear(), isOrthogonal(), isParallel(), and operator*().

{
  return x * p.x + y * p.y;
}

double UVector2::getTolerance ( )

inlinestatic

Definition at line 401 of file UVector2.hh.

{
  return tolerance;
}

double UVector2::howNear

(

const UVector2 &

p

)

const

Definition at line 153 of file UVector2.cc.

References dot(), and mag2().

{
  double d   = (*this - p).mag2();
  double pdp = dot(p);
  if ((pdp > 0) && (d < pdp))
  {
    return std::sqrt(d / pdp);
  }
  else if ((pdp == 0) && (d == 0))
  {
    return 0;
  }
  else
  {
    return 1;
  }
} /* howNear */

double UVector2::howOrthogonal

(

const UVector2 &

p

)

const

Definition at line 207 of file UVector2.cc.

References dot(), x, and y.

{
  // | V1 dot V2 | / | V1 x V2 |
  // Of course, the "cross product" is fictitious but the math is valid
  double v1v2 = std::fabs(dot(v));
  if (v1v2 == 0)
  {
    return 0; // Even if one or both are 0, they are considered orthogonal
  }
  double abscross = std::fabs(x * v.y - y - v.x);
  if (v1v2 >= abscross)
  {
    return 1;
  }
  else
  {
    return v1v2 / abscross;
  }
} /* howOrthogonal() */

double UVector2::howParallel

(

const UVector2 &

p

)

const

Definition at line 171 of file UVector2.cc.

References dot(), mag2(), x, and y.

{
  // | V1 x V2 | / | V1 dot V2 |
  // Of course, the "cross product" is fictitious but the math is valid
  double v1v2 = std::fabs(dot(v));
  if (v1v2 == 0)
  {
    // Zero is parallel to no other vector except for zero.
    return ((mag2() == 0) && (v.mag2() == 0)) ? 0 : 1;
  }
  double abscross = std::fabs(x * v.y - y - v.x);
  if (abscross >= v1v2)
  {
    return 1;
  }
  else
  {
    return abscross / v1v2;
  }
} /* howParallel() */

bool UVector2::isNear	(	const UVector2 &	p,
		double	epsilon = tolerance
	)		const

Definition at line 147 of file UVector2.cc.

References dot(), and mag2().

{
  double limit = dot(p) * epsilon * epsilon;
  return ((*this - p).mag2() <= limit);
} /* isNear() */

bool UVector2::isOrthogonal	(	const UVector2 &	p,
		double	epsilon = tolerance
	)		const

Definition at line 227 of file UVector2.cc.

References dot(), x, and y.

{
  // | V1 dot V2 | <= epsilon * | V1 x V2 |
  // Of course, the "cross product" is fictitious but the math is valid
  double v1v2 = std::fabs(dot(v));
  double abscross = std::fabs(x * v.y - y - v.x);
  return (v1v2 <= epsilon * abscross);
} /* isOrthogonal() */

bool UVector2::isParallel	(	const UVector2 &	p,
		double	epsilon = tolerance
	)		const

Definition at line 192 of file UVector2.cc.

References dot(), mag2(), x, and y.

{
  // | V1 x V2 | <= epsilon * | V1 dot V2 |
  // Of course, the "cross product" is fictitious but the math is valid
  double v1v2 = std::fabs(dot(v));
  if (v1v2 == 0)
  {
    // Zero is parallel to no other vector except for zero.
    return ((mag2() == 0) && (v.mag2() == 0));
  }
  double abscross = std::fabs(x * v.y - y - v.x);
  return (abscross <= epsilon * v1v2);
} /* isParallel() */

double UVector2::mag ( ) const

inline

Definition at line 310 of file UVector2.hh.

References mag2().

Referenced by setPhi().

{
  return std::sqrt(mag2());
}

double UVector2::mag2 ( ) const

inline

Definition at line 305 of file UVector2.hh.

References x, and y.

Referenced by angle(), howNear(), howParallel(), isNear(), isParallel(), mag(), r(), and unit().

{
  return x * x + y * y;
}

UVector2::operator UVector3

(

)

const

Definition at line 100 of file UVector2.cc.

References test::x.

{
  return UVector3(x, y, 0.0);
}

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

inline

Definition at line 269 of file UVector2.hh.

References x, and y.

{
  return (v.x != x || v.y != y) ? true : false;
}

double UVector2::operator()

(

int

i

)

const

Definition at line 31 of file UVector2.cc.

References x, and y.

Referenced by operator[]().

{
  if (i == 0)
  {
    return x;
  }
  else if (i == 1)
  {
    return y;
  }
  else
  {
    // ZMthrowA(ZMxpvIndexRange("UVector2::operator(): bad index"));
    return 0.0;
  }
}

double & UVector2::operator()

(

int

i

)

Definition at line 48 of file UVector2.cc.

References X, x, Y, and y.

{
  static double dummy;

  switch (i)
  {
    case X:
      return x;
    case Y:
      return y;
    default:
      // ZMthrowA (ZMxpvIndexRange("UVector2::operator() : bad index"));
      return dummy;
  }
}

UVector2 & UVector2::operator*= ( double  a )

inline

Definition at line 293 of file UVector2.hh.

References test::a, x, and y.

{
  x *= a;
  y *= a;
  return *this;
}

UVector2 & UVector2::operator+= ( const UVector2 &  p )

inline

Definition at line 274 of file UVector2.hh.

References x, and y.

{
  x += p.x;
  y += p.y;
  return *this;
}

UVector2 UVector2::operator- ( ) const

inline

Definition at line 288 of file UVector2.hh.

References UVector2(), x, and y.

{
  return UVector2(-x, -y);
}

UVector2 & UVector2::operator-= ( const UVector2 &  p )

inline

Definition at line 281 of file UVector2.hh.

References x, and y.

{
  x -= p.x;
  y -= p.y;
  return *this;
}

bool UVector2::operator<

(

const UVector2 &

v

)

const

Definition at line 134 of file UVector2.cc.

References compare().

{
  return (compare(v)  < 0);
}

bool UVector2::operator<=

(

const UVector2 &

v

)

const

Definition at line 142 of file UVector2.cc.

References compare().

{
  return (compare(v) <= 0);
}

UVector2 & UVector2::operator= ( const UVector2 &  p )

inline

Definition at line 256 of file UVector2.hh.

References x, and y.

{
  if (this == &p)  { return *this; }
  x = p.x;
  y = p.y;
  return *this;
}

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

inline

Definition at line 264 of file UVector2.hh.

References x, and y.

{
  return (v.x == x && v.y == y) ? true : false;
}

bool UVector2::operator>

(

const UVector2 &

v

)

const

Definition at line 130 of file UVector2.cc.

References compare().

{
  return (compare(v)  > 0);
}

bool UVector2::operator>=

(

const UVector2 &

v

)

const

Definition at line 138 of file UVector2.cc.

References compare().

{
  return (compare(v) >= 0);
}

double UVector2::operator[] ( int  i ) const

inline

Definition at line 246 of file UVector2.hh.

References operator()().

{
  return operator()(i);
}

double & UVector2::operator[] ( int  i )

inline

Definition at line 242 of file UVector2.hh.

References operator()().

{
  return operator()(i);
}

UVector2 UVector2::orthogonal ( ) const

inline

Definition at line 327 of file UVector2.hh.

References UVector2(), x, and y.

{
  double x1 = std::fabs(x), y1 = std::fabs(y);
  if (x1 < y1)
  {
    return UVector2(y, -x);
  }
  else
  {
    return UVector2(-y, x);
  }
}

double UVector2::phi ( ) const

inline

Definition at line 340 of file UVector2.hh.

References x, and y.

Referenced by setMag().

{
  return x == 0.0 && y == 0.0 ? 0.0 : std::atan2(y, x);
}

double UVector2::r ( ) const

inline

Definition at line 315 of file UVector2.hh.

References mag2().

{
  return std::sqrt(mag2());
}

void UVector2::rotate

(

double

angler

)

Definition at line 64 of file UVector2.cc.

References test::c, x, and y.

{
  double s = std::sin(angler);
  double c = std::cos(angler);
  double xx = x;
  x = c * xx - s * y;
  y = s * xx + c * y;
}

void UVector2::set ( double  x, double  y  )

inline

Definition at line 236 of file UVector2.hh.

References x, and y.

{
  x = x1;
  y = y1;
}

void UVector2::setMag ( double  r )

inline

Definition at line 351 of file UVector2.hh.

References phi(), setX(), and setY().

Referenced by setR().

{
  double ph = phi();
  setX(r1 * std::cos(ph));
  setY(r1 * std::sin(ph));
}

void UVector2::setPhi ( double  phi )

inline

Definition at line 363 of file UVector2.hh.

References mag(), setX(), and setY().

{
  double ma = mag();
  setX(ma * std::cos(phi1));
  setY(ma * std::sin(phi1));
}

void UVector2::setPolar ( double  r, double  phi  )

inline

Definition at line 370 of file UVector2.hh.

References setX(), and setY().

{
  setX(r1 * std::cos(phi1));
  setY(r1 * std::sin(phi1));
}

void UVector2::setR ( double  r )

inline

Definition at line 358 of file UVector2.hh.

References setMag().

{
  setMag(r1);
}

double UVector2::setTolerance ( double  tol )

static

Definition at line 23 of file UVector2.cc.

{
  // Set the tolerance for UVector2s to be considered near one another
  double oldTolerance(tolerance);
  tolerance = tol;
  return oldTolerance;
}

void UVector2::setX ( double  x )

inline

Definition at line 226 of file UVector2.hh.

References x.

Referenced by setMag(), setPhi(), and setPolar().

{
  x = x1;
}

void UVector2::setY ( double  y )

inline

Definition at line 231 of file UVector2.hh.

References y.

Referenced by setMag(), setPhi(), and setPolar().

{
  y = y1;
}

UVector2 UVector2::unit ( ) const

inline

Definition at line 320 of file UVector2.hh.

References mag2(), and UVector2().

{
  double tot = mag2();
  UVector2 p(*this);
  return tot > 0.0 ? p *= (1.0 / std::sqrt(tot)) : UVector2(1, 0);
}

Friends And Related Function Documentation

double operator* ( const UVector2 &  a, const UVector2 &  b  )

friend

Definition at line 396 of file UVector2.hh.

{
  return a.dot(b);
}

UVector2 operator* ( const UVector2 &  p, double  a  )

friend

Definition at line 386 of file UVector2.hh.

{
  return UVector2(a * p.x, a * p.y);
}

UVector2 operator* ( double  a, const UVector2 &  p  )

friend

Definition at line 391 of file UVector2.hh.

{
  return UVector2(a * p.x, a * p.y);
}

UVector2 operator+ ( const UVector2 &  a, const UVector2 &  b  )

friend

Definition at line 376 of file UVector2.hh.

{
  return UVector2(a.x + b.x, a.y + b.y);
}

UVector2 operator- ( const UVector2 &  a, const UVector2 &  b  )

friend

Definition at line 381 of file UVector2.hh.

{
  return UVector2(a.x - b.x, a.y - b.y);
}

UVector2 operator/ ( const UVector2 &  p, double  a  )

friend

Definition at line 73 of file UVector2.cc.

{
  if (a == 0)
  {
    // ZMthrowA(ZMxpvInfiniteVector( "Division of UVector2 by zero"));
  }
  return UVector2(p.x / a, p.y / a);
}

std::ostream& operator<< ( std::ostream &  os, const UVector2 &  q  )

friend

Definition at line 82 of file UVector2.cc.

{
  os << "(" << q.x << ", " << q.y << ")";
  return os;
}

Field Documentation

double UVector2::x

Definition at line 195 of file UVector2.hh.

Referenced by UPolyPhiFace::Area2(), UPolyPhiFace::Between(), compare(), dot(), howOrthogonal(), howParallel(), isOrthogonal(), isParallel(), mag2(), operator!=(), operator()(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator<<(), operator=(), operator==(), orthogonal(), phi(), rotate(), set(), and setX().

double UVector2::y

Definition at line 196 of file UVector2.hh.

Referenced by UPolyPhiFace::Area2(), UPolyPhiFace::Between(), compare(), dot(), howOrthogonal(), howParallel(), isOrthogonal(), isParallel(), mag2(), operator!=(), operator()(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator<<(), operator=(), operator==(), orthogonal(), phi(), rotate(), set(), and setY().

---

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

• UVector2.hh
• UVector2.cc