Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/externals/clhep/include/CLHEP/Vector/AxisAngle.h

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  1 // -*- C++ -*-
  2 // ---------------------------------------------------------------------------
  3 //
  4 // This file is a part of the CLHEP - a Class Library for High Energy Physics.
  5 // 
  6 // ----------------------------------------------------------------------
  7 // ----------------------------------------------------------------------
  8 //
  9 // AxisAngle.h - provide HepAxisAngle class
 10 //
 11 // History:
 12 //   23-Jan-1998  WEB  Initial draft
 13 //   15-Jun-1998  WEB  Added namespace support
 14 //   02-May-2000  WEB  No global using
 15 //   27-Jul-2000  MF   CLHEP version
 16 //
 17 // ----------------------------------------------------------------------
 18 
 19 #ifndef HEP_AXISANGLE_H
 20 #define HEP_AXISANGLE_H
 21 
 22 #include <iostream>
 23 #include "CLHEP/Vector/ThreeVector.h"
 24 
 25 namespace CLHEP {
 26 
 27 // Declarations of classes and global methods
 28 class HepAxisAngle;
 29 std::ostream & operator<<( std::ostream & os, const HepAxisAngle & aa );
 30 std::istream & operator>>( std::istream & is,       HepAxisAngle & aa );
 31 
 32 /**
 33  * @author
 34  * @ingroup vector
 35  */
 36 class HepAxisAngle {
 37 
 38 public:
 39   typedef double Scalar;
 40 
 41 protected:
 42   typedef HepAxisAngle AA;         // just an abbreviation
 43   static Scalar tolerance;      // to determine relative nearness
 44 
 45 public:
 46 
 47   // ----------  Constructors:
 48   inline HepAxisAngle();
 49   inline HepAxisAngle( const Hep3Vector axis, Scalar delta );
 50 
 51   // ----------  Destructor, copy constructor, assignment:
 52   // use C++ defaults
 53 
 54   // ----------  Accessors:
 55 
 56 public:
 57   inline Hep3Vector            getAxis() const;
 58   inline Hep3Vector            axis() const;
 59   inline AA &                  setAxis( const Hep3Vector axis );
 60 
 61   inline double             getDelta() const;
 62   inline double             delta() const ;
 63   inline AA &                  setDelta( Scalar delta );
 64 
 65   inline AA & set( const Hep3Vector axis, Scalar delta );
 66 
 67   // ----------  Operations:
 68 
 69   //   comparisons:
 70   inline int  compare   ( const AA & aa ) const;
 71 
 72   inline bool operator==( const AA & aa ) const;
 73   inline bool operator!=( const AA & aa ) const;
 74   inline bool operator< ( const AA & aa ) const;
 75   inline bool operator<=( const AA & aa ) const;
 76   inline bool operator> ( const AA & aa ) const;
 77   inline bool operator>=( const AA & aa ) const;
 78 
 79   //   relative comparison:
 80   inline static double getTolerance();
 81   inline static double setTolerance( Scalar tol );
 82 
 83 protected:
 84     double distance( const HepAxisAngle & aa ) const;
 85 public:
 86 
 87   bool isNear ( const AA & aa, Scalar epsilon = tolerance ) const;
 88   double  howNear( const AA & aa ) const;
 89 
 90   // ----------  I/O:
 91 
 92   friend std::ostream & operator<<( std::ostream & os, const AA & aa );
 93   friend std::istream & operator>>( std::istream & is,       AA & aa );
 94 
 95 private:
 96   Hep3Vector axis_;  // Note:  After construction, this is always of mag 1
 97   double  delta_;
 98 
 99 };  // HepAxisAngle
100 
101 
102 }  // namespace CLHEP
103 
104 #include "CLHEP/Vector/AxisAngle.icc"
105 
106 #endif  // HEP_AXISANGLE_H
107