Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TVector2 Class Reference

Attention

TVector2 is a legacy class. It is slower and worse for serialization than the recommended superior alternative ROOT::Math::XYVector.

More details can be found in the documentation of the Physics Vectors package.

TVector2 is a general two vector class, which can be used for the description of different vectors in 2D.

Definition at line 18 of file TVector2.h.

Public Types

typedef Double_t Scalar
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

 TVector2 ()
 Constructor.
 
 TVector2 (const TVector2 &)=default
 
 TVector2 (Double_t *s)
 Constructor.
 
 TVector2 (Double_t x0, Double_t y0)
 Constructor.
 
 ~TVector2 () override
 
Double_t DeltaPhi (const TVector2 &v) const
 
TClassIsA () const override
 
Double_t Mod () const
 Return modulo of this vector.
 
Double_t Mod2 () const
 
TVector2 Norm (const TVector2 &v) const
 
TVector2operator*= (Double_t s)
 
Double_t operator*= (TVector2 const &v)
 
TVector2operator+= (TVector2 const &v)
 
TVector2operator-= (TVector2 const &v)
 
TVector2operator/= (Double_t s)
 
TVector2operator= (TVector2 const &v)
 
TVector2 Ort () const
 
Double_t Phi () const
 Return vector phi.
 
void Print (Option_t *option="") const override
 This method must be overridden when a class wants to print itself.
 
TVector2 Proj (const TVector2 &v) const
 
Double_t Px () const
 
Double_t Py () const
 
TVector2 Rotate (Double_t phi) const
 Rotation by phi.
 
void Set (const TVector2 &v)
 
void Set (Double_t x0, Double_t y0)
 
void Set (float x0, float y0)
 
void SetMagPhi (Double_t mag, Double_t phi)
 Set vector using mag and phi.
 
void SetX (Double_t x0)
 
void SetY (Double_t y0)
 
void Streamer (TBuffer &) override
 Stream an object of class TVector2.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
TVector2 Unit () const
 Return module normalized to 1.
 
Double_t X () const
 
Double_t Y () const
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Double_t Phi_0_2pi (Double_t x)
 Returns phi angle in the interval [0,2*PI)
 
static Double_t Phi_mpi_pi (Double_t x)
 Returns phi angle in the interval [-PI,PI)
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Attributes

Double_t fX
 
Double_t fY
 

Friends

Double_t operator* (const TVector2 &, const TVector2 &)
 
TVector2 operator* (const TVector2 &, Double_t)
 
TVector2 operator* (Double_t, const TVector2 &)
 
TVector2 operator+ (const TVector2 &, const TVector2 &)
 
TVector2 operator+ (const TVector2 &, Double_t)
 
TVector2 operator+ (Double_t, const TVector2 &)
 
TVector2 operator- (const TVector2 &, const TVector2 &)
 
TVector2 operator- (const TVector2 &, Double_t)
 
TVector2 operator/ (const TVector2 &, Double_t)
 
Double_t operator^ (const TVector2 &, const TVector2 &)
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TVector2.h>

Inheritance diagram for TVector2:
[legend]

Member Typedef Documentation

◆ Scalar

Definition at line 31 of file TVector2.h.

Constructor & Destructor Documentation

◆ TVector2() [1/4]

TVector2::TVector2 ( )

Constructor.

Definition at line 39 of file TVector2.cxx.

◆ TVector2() [2/4]

TVector2::TVector2 ( const TVector2 )
default

◆ TVector2() [3/4]

TVector2::TVector2 ( Double_t s)

Constructor.

Definition at line 48 of file TVector2.cxx.

◆ TVector2() [4/4]

TVector2::TVector2 ( Double_t  x0,
Double_t  y0 
)

Constructor.

Definition at line 57 of file TVector2.cxx.

◆ ~TVector2()

TVector2::~TVector2 ( )
override

Definition at line 65 of file TVector2.cxx.

Member Function Documentation

◆ Class()

static TClass * TVector2::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TVector2::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TVector2::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 108 of file TVector2.h.

◆ DeclFileName()

static const char * TVector2::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 108 of file TVector2.h.

◆ DeltaPhi()

Double_t TVector2::DeltaPhi ( const TVector2 v) const
inline

Definition at line 167 of file TVector2.h.

◆ IsA()

TClass * TVector2::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 108 of file TVector2.h.

◆ Mod()

Double_t TVector2::Mod ( ) const

Return modulo of this vector.

Definition at line 72 of file TVector2.cxx.

◆ Mod2()

Double_t TVector2::Mod2 ( ) const
inline

Definition at line 68 of file TVector2.h.

◆ Norm()

TVector2 TVector2::Norm ( const TVector2 v) const
inline

Definition at line 173 of file TVector2.h.

◆ operator*=() [1/2]

TVector2 & TVector2::operator*= ( Double_t  s)
inline

Definition at line 122 of file TVector2.h.

◆ operator*=() [2/2]

Double_t TVector2::operator*= ( TVector2 const &  v)
inline

Definition at line 120 of file TVector2.h.

◆ operator+=()

TVector2 & TVector2::operator+= ( TVector2 const &  v)
inline

Definition at line 115 of file TVector2.h.

◆ operator-=()

TVector2 & TVector2::operator-= ( TVector2 const &  v)
inline

Definition at line 116 of file TVector2.h.

◆ operator/=()

TVector2 & TVector2::operator/= ( Double_t  s)
inline

Definition at line 123 of file TVector2.h.

◆ operator=()

TVector2 & TVector2::operator= ( TVector2 const &  v)
inline

Definition at line 114 of file TVector2.h.

◆ Ort()

TVector2 TVector2::Ort ( ) const
inline

Definition at line 169 of file TVector2.h.

◆ Phi()

Double_t TVector2::Phi ( ) const

Return vector phi.

Definition at line 88 of file TVector2.cxx.

◆ Phi_0_2pi()

Double_t TVector2::Phi_0_2pi ( Double_t  x)
static

Returns phi angle in the interval [0,2*PI)

Definition at line 96 of file TVector2.cxx.

◆ Phi_mpi_pi()

Double_t TVector2::Phi_mpi_pi ( Double_t  x)
static

Returns phi angle in the interval [-PI,PI)

Definition at line 109 of file TVector2.cxx.

◆ Print()

void TVector2::Print ( Option_t option = "") const
overridevirtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 160 of file TVector2.cxx.

◆ Proj()

TVector2 TVector2::Proj ( const TVector2 v) const
inline

Definition at line 171 of file TVector2.h.

◆ Px()

Double_t TVector2::Px ( ) const
inline

Definition at line 71 of file TVector2.h.

◆ Py()

Double_t TVector2::Py ( ) const
inline

Definition at line 72 of file TVector2.h.

◆ Rotate()

TVector2 TVector2::Rotate ( Double_t  phi) const

Rotation by phi.

Definition at line 122 of file TVector2.cxx.

◆ Set() [1/3]

void TVector2::Set ( const TVector2 v)
inline

Definition at line 177 of file TVector2.h.

◆ Set() [2/3]

void TVector2::Set ( Double_t  x0,
Double_t  y0 
)
inline

Definition at line 178 of file TVector2.h.

◆ Set() [3/3]

void TVector2::Set ( float  x0,
float  y0 
)
inline

Definition at line 179 of file TVector2.h.

◆ SetMagPhi()

void TVector2::SetMagPhi ( Double_t  mag,
Double_t  phi 
)

Set vector using mag and phi.

Definition at line 130 of file TVector2.cxx.

◆ SetX()

void TVector2::SetX ( Double_t  x0)
inline

Definition at line 180 of file TVector2.h.

◆ SetY()

void TVector2::SetY ( Double_t  y0)
inline

Definition at line 181 of file TVector2.h.

◆ Streamer()

void TVector2::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TVector2.

Reimplemented from TObject.

Definition at line 139 of file TVector2.cxx.

◆ StreamerNVirtual()

void TVector2::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 108 of file TVector2.h.

◆ Unit()

TVector2 TVector2::Unit ( ) const

Return module normalized to 1.

Definition at line 80 of file TVector2.cxx.

◆ X()

Double_t TVector2::X ( ) const
inline

Definition at line 73 of file TVector2.h.

◆ Y()

Double_t TVector2::Y ( ) const
inline

Definition at line 74 of file TVector2.h.

Friends And Related Symbol Documentation

◆ operator* [1/3]

Double_t operator* ( const TVector2 v1,
const TVector2 v2 
)
friend

Definition at line 155 of file TVector2.h.

◆ operator* [2/3]

TVector2 operator* ( const TVector2 v,
Double_t  s 
)
friend

Definition at line 147 of file TVector2.h.

◆ operator* [3/3]

TVector2 operator* ( Double_t  s,
const TVector2 v 
)
friend

Definition at line 151 of file TVector2.h.

◆ operator+ [1/3]

TVector2 operator+ ( const TVector2 v1,
const TVector2 v2 
)
friend

Definition at line 127 of file TVector2.h.

◆ operator+ [2/3]

TVector2 operator+ ( const TVector2 v1,
Double_t  bias 
)
friend

Definition at line 131 of file TVector2.h.

◆ operator+ [3/3]

TVector2 operator+ ( Double_t  bias,
const TVector2 v1 
)
friend

Definition at line 135 of file TVector2.h.

◆ operator- [1/2]

TVector2 operator- ( const TVector2 v1,
const TVector2 v2 
)
friend

Definition at line 139 of file TVector2.h.

◆ operator- [2/2]

TVector2 operator- ( const TVector2 v1,
Double_t  bias 
)
friend

Definition at line 143 of file TVector2.h.

◆ operator/

TVector2 operator/ ( const TVector2 v,
Double_t  s 
)
friend

Definition at line 159 of file TVector2.h.

◆ operator^

Double_t operator^ ( const TVector2 v1,
const TVector2 v2 
)
friend

Definition at line 163 of file TVector2.h.

Member Data Documentation

◆ fX

Double_t TVector2::fX
protected

Definition at line 24 of file TVector2.h.

◆ fY

Double_t TVector2::fY
protected

Definition at line 25 of file TVector2.h.

Libraries for TVector2:

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