xyze rename

Author: mmikhasenko

src/LorentzVectorBase.jl

@@ -3,7 +3,7 @@ module LorentzVectorBase
 export coordinate_system, coordinate_names
 
 include("interface.jl")
-include("coordinate_systems/exyz.jl")
+include("coordinate_systems/xyze.jl")
 include("coordinate_systems/PtEtaPhiM.jl")
 
 end

src/coordinate_systems/exyz.jl renamed to src/coordinate_systems/xyze.jl

@@ -1,6 +1,6 @@
 """
 
-    EXYZ <: AbstractCoordinateSystem  
+    XYZE <: AbstractCoordinateSystem  
 
 Cartesian coordinate system for four-momenta. Using this requires the implementation of the following interface functions:
 
@@ -12,8 +12,8 @@ energy(::CustomFourMomentum)
 ```
 
 """
-struct EXYZ <: AbstractCoordinateSystem end
-coordinate_names(::EXYZ) = (:px, :py, :pz, :energy)
+struct XYZE <: AbstractCoordinateSystem end
+coordinate_names(::XYZE) = (:px, :py, :pz, :energy)
 
 ####
 # Interface functions
@@ -53,7 +53,7 @@ function pz end
 
 """
     
-    spatial_magnitude2(::EXYZ, mom)
+    spatial_magnitude2(::XYZE, mom)
 
 Return the square of the spatial_magnitude of a given four-momentum, i.e. the sum of the squared spatial components. 
 
@@ -67,13 +67,13 @@ Return the square of the spatial_magnitude of a given four-momentum, i.e. the su
     This function differs from a similar function for the `TLorentzVector` used in the famous `ROOT` library.
 
 """
-@inline function spatial_magnitude2(::EXYZ, mom)
+@inline function spatial_magnitude2(::XYZE, mom)
     return px(mom)^2 + py(mom)^2 + pz(mom)^2
 end
 
 """
 
-    spatial_magnitude(::EXYZ,mom)
+    spatial_magnitude(::XYZE,mom)
 
 Return the spatial_magnitude of a given four-momentum, i.e. the euklidian norm spatial components. 
 
@@ -87,13 +87,13 @@ Return the spatial_magnitude of a given four-momentum, i.e. the euklidian norm s
     This function differs from a similar function for the `TLorentzVector` used in the famous `ROOT` library.
 
 """
-@inline function spatial_magnitude(cs::EXYZ, mom)
+@inline function spatial_magnitude(cs::XYZE, mom)
     return sqrt(spatial_magnitude2(mom))
 end
 
 """
 
-    mass2(::EXYZ,mom)
+    mass2(::XYZE,mom)
 
 Return the squared invariant mass of a given four-momentum, i.e. the minkowski dot with itself. 
 
@@ -103,13 +103,13 @@ Return the squared invariant mass of a given four-momentum, i.e. the minkowski d
 
 
 """
-@inline function mass2(::EXYZ, mom)
+@inline function mass2(::XYZE, mom)
     return energy(mom)^2 - px(mom)^2 - py(mom)^2 - pz(mom)^2
 end
 
 """
 
-    mass(::EXYZ,mom)
+    mass(::XYZE,mom)
 
 Return the the invariant mass of a given four-momentum, i.e. the square root of the minkowski dot with itself. 
 
@@ -123,7 +123,7 @@ Return the the invariant mass of a given four-momentum, i.e. the square root of
     If the squared invariant mass `m2` is negative, `-sqrt(-m2)` is returned. 
 
 """
-@inline function mass(::EXYZ, mom)
+@inline function mass(::XYZE, mom)
     m2 = mass2(mom)
     if m2 < zero(m2)
         # Think about including this waring, maybe optional with a global PRINT_WARINGS switch.
@@ -136,7 +136,7 @@ end
 
 """
 
-    boost_beta(::EXYZ, mom )
+    boost_beta(::XYZE, mom )
 
 Return spatial_magnitude of the beta vector for a given four-momentum, i.e. the spatial_magnitude of the four-momentum divided by its 0-component.
 
@@ -145,7 +145,7 @@ Return spatial_magnitude of the beta vector for a given four-momentum, i.e. the
     If `(E,px,py,pz)` is a four-momentum, this is equivalent to `sqrt(px^2 + py^2 + pz^2)/E`.
 
 """
-@inline function boost_beta(::EXYZ, mom)
+@inline function boost_beta(::XYZE, mom)
     en = energy(mom)
     rho = spatial_magnitude(mom)
     if !iszero(en)
@@ -163,7 +163,7 @@ end
 
 """
 
-    boost_gamma(::EXYZ,mom)
+    boost_gamma(::XYZE,mom)
 
 Return the relativistic gamma factor for a given four-momentum, i.e. the inverse square root of one minus the beta vector squared.
 
@@ -172,7 +172,7 @@ Return the relativistic gamma factor for a given four-momentum, i.e. the inverse
     If `(E,px,py,pz)` is a four-momentum with beta vector `β`, this is equivalent to `1/sqrt(1- β^2)`.
 
 """
-@inline function boost_gamma(::EXYZ, mom)
+@inline function boost_gamma(::XYZE, mom)
     return inv(sqrt(one(energy(mom)) - boost_beta(mom)^2))
 end
 
@@ -181,7 +181,7 @@ end
 ########################
 """
 
-    pt2(::EXYZ,mom)
+    pt2(::XYZE,mom)
 
 Return the squared transverse momentum for a given four-momentum, i.e. the sum of its squared 1- and 2-component.
 
@@ -194,13 +194,13 @@ Return the squared transverse momentum for a given four-momentum, i.e. the sum o
     The transverse components are defined w.r.t. to the 3-axis. 
 
 """
-@inline function pt2(::EXYZ, mom)
+@inline function pt2(::XYZE, mom)
     return px(mom)^2 + py(mom)^2
 end
 
 """
 
-    pt(::EXYZ, mom)
+    pt(::XYZE, mom)
 
 Return the transverse momentum for a given four-momentum, i.e. the spatial_magnitude of its transverse components.
 
@@ -214,13 +214,13 @@ Return the transverse momentum for a given four-momentum, i.e. the spatial_magni
     The transverse components are defined w.r.t. to the 3-axis. 
 
 """
-@inline function pt(::EXYZ, mom)
+@inline function pt(::XYZE, mom)
     return sqrt(pt2(mom))
 end
 
 """
 
-    mt2(::EXYZ, mom)
+    mt2(::XYZE, mom)
 
 Return the squared transverse mass for a given four-momentum, i.e. the difference of its squared 0- and 3-component.
 
@@ -235,13 +235,13 @@ Return the squared transverse mass for a given four-momentum, i.e. the differenc
 
 
 """
-@inline function mt2(::EXYZ, mom)
+@inline function mt2(::XYZE, mom)
     return energy(mom)^2 - pz(mom)^2
 end
 
 """
 
-    mt(::EXYZ,mom)
+    mt(::XYZE,mom)
 
 Return the transverse momentum for a given four-momentum, i.e. the square root of its squared transverse mass.
 
@@ -259,7 +259,7 @@ Return the transverse momentum for a given four-momentum, i.e. the square root o
     If the squared transverse mass `mt2` is negative, `-sqrt(-mt2)` is returned.
 
 """
-function mt(::EXYZ, mom)
+function mt(::XYZE, mom)
     mT2 = mt2(mom)
     if mT2 < zero(mT2)
         # add optional waring: negative transverse mass -> -sqrt(-mT2) is returned.
@@ -271,7 +271,7 @@ end
 
 """
 
-    rapidity(::EXYZ, mom)
+    rapidity(::XYZE, mom)
 
 Return the [rapidity](https://en.wikipedia.org/wiki/Rapidity) for a given four-momentum.
 
@@ -285,18 +285,18 @@ Return the [rapidity](https://en.wikipedia.org/wiki/Rapidity) for a given four-m
     The transverse components are defined w.r.t. to the 3-axis. 
 
 """
-@inline function rapidity(::EXYZ, mom)
+@inline function rapidity(::XYZE, mom)
     en = energy(mom)
     zcomp = pz(mom)
     return 0.5 * log((en + zcomp) / (en - zcomp))
 end
 
 """
-    eta(::EXYZ, mom)
+    eta(::XYZE, mom)
 
 TBW
 """
-function eta(::EXYZ, mom)
+function eta(::XYZE, mom)
     cth = cos_theta(mom)
 
     if cth^2 < one(cth)
@@ -321,7 +321,7 @@ end
 #######################
 """
 
-    polar_angle(::EXYZ,mom)
+    polar_angle(::XYZE,mom)
 
 Return the theta angle for a given four-momentum, i.e. the polar angle of its spatial components in [spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system).
 
@@ -334,7 +334,7 @@ Return the theta angle for a given four-momentum, i.e. the polar angle of its sp
     The [spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system) are defined w.r.t. to the 3-axis. 
 
 """
-@inline function polar_angle(::EXYZ, mom)
+@inline function polar_angle(::XYZE, mom)
     xcomp = px(mom)
     ycomp = py(mom)
     zcomp = pz(mom)
@@ -348,23 +348,23 @@ end
 
 """
 
-    cos_theta(::EXYZ, mom)
+    cos_theta(::XYZE, mom)
 
 Return the cosine of the theta angle for a given four-momentum. 
 
 !!! note 
 
-    This is an equivalent but faster version of `cos(polar_angle(::EXYZ, mom))`; see [`polar_angle`](@ref).
+    This is an equivalent but faster version of `cos(polar_angle(::XYZE, mom))`; see [`polar_angle`](@ref).
 
 """
-@inline function cos_theta(::EXYZ, mom)
+@inline function cos_theta(::XYZE, mom)
     r = spatial_magnitude(mom)
     return iszero(r) ? one(px(mom)) : pz(mom) / r
 end
 
 """
 
-    phi(::EXYZ, mom)
+    phi(::XYZE, mom)
 
 Return the phi angle for a given four-momentum, i.e. the azimuthal angle of its spatial components in [spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system).
 
@@ -377,15 +377,15 @@ Return the phi angle for a given four-momentum, i.e. the azimuthal angle of its
     The [spherical coordinates](https://en.wikipedia.org/wiki/Spherical_coordinate_system) are defined w.r.t. to the 3-axis. 
 
 """
-function phi(::EXYZ, mom)
+function phi(::XYZE, mom)
     xcomp = px(mom)
     ycomp = py(mom)
     return iszero(xcomp) && iszero(ycomp) ? zero(xcomp) : atan(ycomp, xcomp)
 end
 
 """
 
-    cos_phi(::EXYZ, mom)
+    cos_phi(::XYZE, mom)
 
 Return the cosine of the azimuthal angle for a given four-momentum. 
 
@@ -394,14 +394,14 @@ Return the cosine of the azimuthal angle for a given four-momentum.
     This is an equivalent but faster version of `cos(azimuthal_angle(mom))`; see [`azimuthal_angle`](@ref).
 
 """
-function cos_phi(::EXYZ, mom)
+function cos_phi(::XYZE, mom)
     pT = transverse_momentum(mom)
     return iszero(pT) ? one(pT) : px(mom) / pT
 end
 
 """
 
-    sin_phi(::EXYZ,mom)
+    sin_phi(::XYZE,mom)
 
 Return the sine of the azimuthal angle for a given four-momentum. 
 
@@ -410,7 +410,7 @@ Return the sine of the azimuthal angle for a given four-momentum.
     This is an equivalent but faster version of `sin(azimuthal_angle(mom))`; see [`azimuthal_angle`](@ref).
 
 """
-function sin_phi(::EXYZ, mom)
+function sin_phi(::XYZE, mom)
     pT = transverse_momentum(mom)
     return iszero(pT) ? zero(pT) : py(mom) / pT
 end
@@ -420,7 +420,7 @@ end
 ########################
 """
 
-    plus_component(::EXYZ, mom)
+    plus_component(::XYZE, mom)
 
 Return the plus component for a given four-momentum in [light-cone coordinates](https://en.wikipedia.org/wiki/Light-cone_coordinates).
 
@@ -437,13 +437,13 @@ Return the plus component for a given four-momentum in [light-cone coordinates](
     The definition ``p^+ := (E + p_z)/2` differs from the usual definition of [light-cone coordinates](https://en.wikipedia.org/wiki/Light-cone_coordinates) in general relativity.
 
 """
-@inline function plus_component(::EXYZ, mom)
+@inline function plus_component(::XYZE, mom)
     return 0.5 * (energy(mom) + pz(mom))
 end
 
 """
 
-    minus_component(::EXYZ, mom)
+    minus_component(::XYZE, mom)
 
 Return the minus component for a given four-momentum in [light-cone coordinates](https://en.wikipedia.org/wiki/Light-cone_coordinates).
 
@@ -460,6 +460,6 @@ Return the minus component for a given four-momentum in [light-cone coordinates]
     The definition ``p^- := (E - p_z)/2` differs from the usual definition of [light-cone coordinates](https://en.wikipedia.org/wiki/Light-cone_coordinates) in general relativity.
 
 """
-@inline function minus_component(::EXYZ, mom)
+@inline function minus_component(::XYZE, mom)
     return 0.5 * (energy(mom) - pz(mom))
 end

test/xyze.jl

@@ -6,13 +6,13 @@ const ATOL = 1e-15
 const RNG = MersenneTwister(137137)
 
 struct CustomMom
-    e
     x
     y
     z
+    e
 end
 
-LorentzVectorBase.coordinate_system(::CustomMom) = LorentzVectorBase.EXYZ()
+LorentzVectorBase.coordinate_system(::CustomMom) = LorentzVectorBase.XYZE()
 LorentzVectorBase.px(mom::CustomMom) = mom.x
 LorentzVectorBase.py(mom::CustomMom) = mom.y
 LorentzVectorBase.pz(mom::CustomMom) = mom.z
@@ -21,9 +21,9 @@ LorentzVectorBase.energy(mom::CustomMom) = mom.e
 x, y, z = rand(RNG, 3)
 m = rand(RNG)
 E = sqrt(x^2 + y^2 + z^2 + m^2)
-mom_onshell = CustomMom(E, x, y, z)
+mom_onshell = CustomMom(x, y, z, E)
 mom_zero = CustomMom(0.0, 0.0, 0.0, 0.0)
-mom_offshell = CustomMom(0.0, 0.0, 0.0, m)
+mom_offshell = CustomMom(0.0, 0.0, m, 0.0)
 
 @testset "spatial_magnitude consistence" for mom in [mom_onshell, mom_offshell, mom_zero]
     @test isapprox(LorentzVectorBase.spatial_magnitude(mom), sqrt(LorentzVectorBase.spatial_magnitude2(mom)))