/usr/include/CLHEP/Geometry/BasicVector3D.h is in libclhep-dev 2.1.4.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 | // -*- C++ -*-
// $Id: BasicVector3D.h,v 1.5 2010/06/16 16:21:27 garren Exp $
// ---------------------------------------------------------------------------
//
// This file is a part of the CLHEP - a Class Library for High Energy Physics.
//
// History:
// 12.06.01 E.Chernyaev - CLHEP-1.7: initial version
// 14.03.03 E.Chernyaev - CLHEP-1.9: template version
//
#ifndef BASIC_VECTOR3D_H
#define BASIC_VECTOR3D_H
#include <iosfwd>
#include "CLHEP/Geometry/defs.h"
#include "CLHEP/Vector/ThreeVector.h"
namespace HepGeom {
/**
* Base class for Point3D<T>, Vector3D<T> and Normal3D<T>.
* It defines only common functionality for those classes and
* should not be used as separate class.
*
* @author Evgeni Chernyaev <Evgueni.Tcherniaev@cern.ch>
* @ingroup geometry
*/
template<class T> class BasicVector3D {
protected:
T v_[3];
/**
* Default constructor.
* It is protected - this class should not be instantiated directly.
*/
BasicVector3D() { v_[0] = 0; v_[1] = 0; v_[2] = 0; }
public:
/**
* Safe indexing of the coordinates when using with matrices, arrays, etc.
*/
enum {
X = 0, /**< index for x-component */
Y = 1, /**< index for y-component */
Z = 2, /**< index for z-component */
NUM_COORDINATES = 3, /**< number of components */
SIZE = NUM_COORDINATES /**< number of components */
};
/**
* Constructor from three numbers. */
BasicVector3D(T x1, T y1, T z1) { v_[0] = x1; v_[1] = y1; v_[2] = z1; }
/**
* Copy constructor.
* Note: BasicVector3D<double> has constructors
* from BasicVector3D<double> (provided by compiler) and
* from BasicVector3D<float> (defined in this file);
* BasicVector3D<float> has only the last one.
*/
BasicVector3D(const BasicVector3D<float> & v) {
v_[0] = v.x(); v_[1] = v.y(); v_[2] = v.z();
}
/**
* Destructor. */
virtual ~BasicVector3D() {}
// -------------------------
// Interface to "good old C"
// -------------------------
/**
* Conversion (cast) to ordinary array. */
operator T * () { return v_; }
/**
* Conversion (cast) to ordinary const array. */
operator const T * () const { return v_; }
/**
* Conversion (cast) to CLHEP::Hep3Vector.
* This operator is needed only for backward compatibility and
* in principle should not exit.
*/
operator CLHEP::Hep3Vector () const { return CLHEP::Hep3Vector(x(),y(),z()); }
// -----------------------------
// General arithmetic operations
// -----------------------------
/**
* Assignment. */
BasicVector3D<T> & operator= (const BasicVector3D<T> & v) {
v_[0] = v.v_[0]; v_[1] = v.v_[1]; v_[2] = v.v_[2]; return *this;
}
/**
* Addition. */
BasicVector3D<T> & operator+=(const BasicVector3D<T> & v) {
v_[0] += v.v_[0]; v_[1] += v.v_[1]; v_[2] += v.v_[2]; return *this;
}
/**
* Subtraction. */
BasicVector3D<T> & operator-=(const BasicVector3D<T> & v) {
v_[0] -= v.v_[0]; v_[1] -= v.v_[1]; v_[2] -= v.v_[2]; return *this;
}
/**
* Multiplication by scalar. */
BasicVector3D<T> & operator*=(double a) {
v_[0] *= a; v_[1] *= a; v_[2] *= a; return *this;
}
/**
* Division by scalar. */
BasicVector3D<T> & operator/=(double a) {
v_[0] /= a; v_[1] /= a; v_[2] /= a; return *this;
}
// ------------
// Subscripting
// ------------
/**
* Gets components by index. */
T operator()(int i) const { return v_[i]; }
/**
* Gets components by index. */
T operator[](int i) const { return v_[i]; }
/**
* Sets components by index. */
T & operator()(int i) { return v_[i]; }
/**
* Sets components by index. */
T & operator[](int i) { return v_[i]; }
// ------------------------------------
// Cartesian coordinate system: x, y, z
// ------------------------------------
/**
* Gets x-component in cartesian coordinate system. */
T x() const { return v_[0]; }
/**
* Gets y-component in cartesian coordinate system. */
T y() const { return v_[1]; }
/**
* Gets z-component in cartesian coordinate system. */
T z() const { return v_[2]; }
/**
* Sets x-component in cartesian coordinate system. */
void setX(T a) { v_[0] = a; }
/**
* Sets y-component in cartesian coordinate system. */
void setY(T a) { v_[1] = a; }
/**
* Sets z-component in cartesian coordinate system. */
void setZ(T a) { v_[2] = a; }
/**
* Sets components in cartesian coordinate system. */
void set(T x1, T y1, T z1) { v_[0] = x1; v_[1] = y1; v_[2] = z1; }
// ------------------------------------------
// Cylindrical coordinate system: rho, phi, z
// ------------------------------------------
/**
* Gets transverse component squared. */
T perp2() const { return x()*x()+y()*y(); }
/**
* Gets transverse component. */
T perp() const { return std::sqrt(perp2()); }
/**
* Gets rho-component in cylindrical coordinate system */
T rho() const { return perp(); }
/**
* Sets transverse component keeping phi and z constant. */
void setPerp(T rh) {
T factor = perp();
if (factor > 0) {
factor = rh/factor; v_[0] *= factor; v_[1] *= factor;
}
}
// ------------------------------------------
// Spherical coordinate system: r, phi, theta
// ------------------------------------------
/**
* Gets magnitude squared of the vector. */
T mag2() const { return x()*x()+y()*y()+z()*z(); }
/**
* Gets magnitude of the vector. */
T mag() const { return std::sqrt(mag2()); }
/**
* Gets r-component in spherical coordinate system */
T r() const { return mag(); }
/**
* Gets azimuth angle. */
T phi() const {
return x() == 0 && y() == 0 ? 0 : std::atan2(y(),x());
}
/**
* Gets polar angle. */
T theta() const {
return x() == 0 && y() == 0 && z() == 0 ? 0 : std::atan2(perp(),z());
}
/**
* Gets cosine of polar angle. */
T cosTheta() const { T ma = mag(); return ma == 0 ? 1 : z()/ma; }
/**
* Gets r-component in spherical coordinate system */
T getR() const { return r(); }
/**
* Gets phi-component in spherical coordinate system */
T getPhi() const { return phi(); }
/**
* Gets theta-component in spherical coordinate system */
T getTheta() const { return theta(); }
/**
* Sets magnitude. */
void setMag(T ma) {
T factor = mag();
if (factor > 0) {
factor = ma/factor; v_[0] *= factor; v_[1] *= factor; v_[2] *= factor;
}
}
/**
* Sets r-component in spherical coordinate system. */
void setR(T ma) { setMag(ma); }
/**
* Sets phi-component in spherical coordinate system. */
void setPhi(T ph) { T xy = perp(); setX(xy*std::cos(ph)); setY(xy*std::sin(ph)); }
/**
* Sets theta-component in spherical coordinate system. */
void setTheta(T th) {
T ma = mag();
T ph = phi();
set(ma*std::sin(th)*std::cos(ph), ma*std::sin(th)*std::sin(ph), ma*std::cos(th));
}
// ---------------
// Pseudo rapidity
// ---------------
/**
* Gets pseudo-rapidity: -ln(std::tan(theta/2)) */
T pseudoRapidity() const;
/**
* Gets pseudo-rapidity. */
T eta() const { return pseudoRapidity(); }
/**
* Gets pseudo-rapidity. */
T getEta() const { return pseudoRapidity(); }
/**
* Sets pseudo-rapidity, keeping magnitude and phi fixed. */
void setEta(T a);
// -------------------
// Combine two vectors
// -------------------
/**
* Scalar product. */
T dot(const BasicVector3D<T> & v) const {
return x()*v.x()+y()*v.y()+z()*v.z();
}
/**
* Vector product. */
BasicVector3D<T> cross(const BasicVector3D<T> & v) const {
return BasicVector3D<T>(y()*v.z()-v.y()*z(),
z()*v.x()-v.z()*x(),
x()*v.y()-v.x()*y());
}
/**
* Returns transverse component w.r.t. given axis squared. */
T perp2(const BasicVector3D<T> & v) const {
T tot = v.mag2(), s = dot(v);
return tot > 0 ? mag2()-s*s/tot : mag2();
}
/**
* Returns transverse component w.r.t. given axis. */
T perp(const BasicVector3D<T> & v) const {
return std::sqrt(perp2(v));
}
/**
* Returns angle w.r.t. another vector. */
T angle(const BasicVector3D<T> & v) const;
// ---------------
// Related vectors
// ---------------
/**
* Returns unit vector parallel to this. */
BasicVector3D<T> unit() const {
T len = mag();
return (len > 0) ?
BasicVector3D<T>(x()/len, y()/len, z()/len) : BasicVector3D<T>();
}
/**
* Returns orthogonal vector. */
BasicVector3D<T> orthogonal() const {
T dx = x() < 0 ? -x() : x();
T dy = y() < 0 ? -y() : y();
T dz = z() < 0 ? -z() : z();
if (dx < dy) {
return dx < dz ?
BasicVector3D<T>(0,z(),-y()) : BasicVector3D<T>(y(),-x(),0);
}else{
return dy < dz ?
BasicVector3D<T>(-z(),0,x()) : BasicVector3D<T>(y(),-x(),0);
}
}
// ---------
// Rotations
// ---------
/**
* Rotates around x-axis. */
BasicVector3D<T> & rotateX(T a);
/**
* Rotates around y-axis. */
BasicVector3D<T> & rotateY(T a);
/**
* Rotates around z-axis. */
BasicVector3D<T> & rotateZ(T a);
/**
* Rotates around the axis specified by another vector. */
BasicVector3D<T> & rotate(T a, const BasicVector3D<T> & v);
};
/*************************************************************************
* *
* Non-member functions for BasicVector3D<float> *
* *
*************************************************************************/
/**
* Output to stream.
* @relates BasicVector3D
*/
std::ostream &
operator<<(std::ostream &, const BasicVector3D<float> &);
/**
* Input from stream.
* @relates BasicVector3D
*/
std::istream &
operator>>(std::istream &, BasicVector3D<float> &);
/**
* Unary plus.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator+(const BasicVector3D<float> & v) { return v; }
/**
* Addition of two vectors.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator+(const BasicVector3D<float> & a, const BasicVector3D<float> & b) {
return BasicVector3D<float>(a.x()+b.x(), a.y()+b.y(), a.z()+b.z());
}
/**
* Unary minus.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator-(const BasicVector3D<float> & v) {
return BasicVector3D<float>(-v.x(), -v.y(), -v.z());
}
/**
* Subtraction of two vectors.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator-(const BasicVector3D<float> & a, const BasicVector3D<float> & b) {
return BasicVector3D<float>(a.x()-b.x(), a.y()-b.y(), a.z()-b.z());
}
/**
* Multiplication vector by scalar.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator*(const BasicVector3D<float> & v, double a) {
return BasicVector3D<float>(v.x()*static_cast<float>(a), v.y()*static_cast<float>(a), v.z()*static_cast<float>(a));
}
/**
* Scalar product of two vectors.
* @relates BasicVector3D
*/
inline float
operator*(const BasicVector3D<float> & a, const BasicVector3D<float> & b) {
return a.dot(b);
}
/**
* Multiplication scalar by vector.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator*(double a, const BasicVector3D<float> & v) {
return BasicVector3D<float>(static_cast<float>(a)*v.x(), static_cast<float>(a)*v.y(), static_cast<float>(a)*v.z());
}
/**
* Division vector by scalar.
* @relates BasicVector3D
*/
inline BasicVector3D<float>
operator/(const BasicVector3D<float> & v, double a) {
return BasicVector3D<float>(v.x()/static_cast<float>(a), v.y()/static_cast<float>(a), v.z()/static_cast<float>(a));
}
/**
* Comparison of two vectors for equality.
* @relates BasicVector3D
*/
inline bool
operator==(const BasicVector3D<float> & a, const BasicVector3D<float> & b) {
return (a.x()==b.x() && a.y()==b.y() && a.z()==b.z());
}
/**
* Comparison of two vectors for inequality.
* @relates BasicVector3D
*/
inline bool
operator!=(const BasicVector3D<float> & a, const BasicVector3D<float> & b) {
return (a.x()!=b.x() || a.y()!=b.y() || a.z()!=b.z());
}
/*************************************************************************
* *
* Non-member functions for BasicVector3D<double> *
* *
*************************************************************************/
/**
* Output to stream.
* @relates BasicVector3D
*/
std::ostream &
operator<<(std::ostream &, const BasicVector3D<double> &);
/**
* Input from stream.
* @relates BasicVector3D
*/
std::istream &
operator>>(std::istream &, BasicVector3D<double> &);
/**
* Unary plus.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator+(const BasicVector3D<double> & v) { return v; }
/**
* Addition of two vectors.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator+(const BasicVector3D<double> & a,const BasicVector3D<double> & b) {
return BasicVector3D<double>(a.x()+b.x(), a.y()+b.y(), a.z()+b.z());
}
/**
* Unary minus.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator-(const BasicVector3D<double> & v) {
return BasicVector3D<double>(-v.x(), -v.y(), -v.z());
}
/**
* Subtraction of two vectors.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator-(const BasicVector3D<double> & a,const BasicVector3D<double> & b) {
return BasicVector3D<double>(a.x()-b.x(), a.y()-b.y(), a.z()-b.z());
}
/**
* Multiplication vector by scalar.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator*(const BasicVector3D<double> & v, double a) {
return BasicVector3D<double>(v.x()*a, v.y()*a, v.z()*a);
}
/**
* Scalar product of two vectors.
* @relates BasicVector3D
*/
inline double
operator*(const BasicVector3D<double> & a,const BasicVector3D<double> & b) {
return a.dot(b);
}
/**
* Multiplication scalar by vector.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator*(double a, const BasicVector3D<double> & v) {
return BasicVector3D<double>(a*v.x(), a*v.y(), a*v.z());
}
/**
* Division vector by scalar.
* @relates BasicVector3D
*/
inline BasicVector3D<double>
operator/(const BasicVector3D<double> & v, double a) {
return BasicVector3D<double>(v.x()/a, v.y()/a, v.z()/a);
}
/**
* Comparison of two vectors for equality.
* @relates BasicVector3D
*/
inline bool
operator==(const BasicVector3D<double> & a, const BasicVector3D<double> & b)
{
return (a.x()==b.x() && a.y()==b.y() && a.z()==b.z());
}
/**
* Comparison of two vectors for inequality.
* @relates BasicVector3D
*/
inline bool
operator!=(const BasicVector3D<double> & a, const BasicVector3D<double> & b)
{
return (a.x()!=b.x() || a.y()!=b.y() || a.z()!=b.z());
}
} /* namespace HepGeom */
#ifdef ENABLE_BACKWARDS_COMPATIBILITY
// backwards compatibility will be enabled ONLY in CLHEP 1.9
using namespace HepGeom;
#endif
#endif /* BASIC_VECTOR3D_H */
|