rename magnitude => spatial_magnitude (#5)

Author: TheFibonacciEffect

src/coordinate_systems/exyz.jl

@@ -53,9 +53,9 @@ function pz end
 
 """
     
-    magnitude2(::EXYZ, mom)
+    spatial_magnitude2(::EXYZ, mom)
 
-Return the square of the magnitude of a given four-momentum, i.e. the sum of the squared spatial components. 
+Return the square of the spatial_magnitude of a given four-momentum, i.e. the sum of the squared spatial components. 
 
 !!! example 
 
@@ -67,15 +67,15 @@ Return the square of the magnitude of a given four-momentum, i.e. the sum of the
     This function differs from a similar function for the `TLorentzVector` used in the famous `ROOT` library.
 
 """
-@inline function magnitude2(::EXYZ, mom)
+@inline function spatial_magnitude2(::EXYZ, mom)
     return px(mom)^2 + py(mom)^2 + pz(mom)^2
 end
 
 """
 
-    magnitude(::EXYZ,mom)
+    spatial_magnitude(::EXYZ,mom)
 
-Return the magnitude of a given four-momentum, i.e. the euklidian norm spatial components. 
+Return the spatial_magnitude of a given four-momentum, i.e. the euklidian norm spatial components. 
 
 !!! example 
 
@@ -87,8 +87,8 @@ Return the magnitude of a given four-momentum, i.e. the euklidian norm spatial c
     This function differs from a similar function for the `TLorentzVector` used in the famous `ROOT` library.
 
 """
-@inline function magnitude(cs::EXYZ, mom)
-    return sqrt(magnitude2(mom))
+@inline function spatial_magnitude(cs::EXYZ, mom)
+    return sqrt(spatial_magnitude2(mom))
 end
 
 """
@@ -138,7 +138,7 @@ end
 
     boost_beta(::EXYZ, mom )
 
-Return magnitude of the beta vector for a given four-momentum, i.e. the magnitude of the four-momentum divided by its 0-component.
+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.
 
 !!! example
 
@@ -147,7 +147,7 @@ Return magnitude of the beta vector for a given four-momentum, i.e. the magnitud
 """
 @inline function boost_beta(::EXYZ, mom)
     en = energy(mom)
-    rho = magnitude(mom)
+    rho = spatial_magnitude(mom)
     if !iszero(en)
         rho / en
     elseif iszero(rho)
@@ -202,7 +202,7 @@ end
 
     transverse_momentum(::EXYZ, mom)
 
-Return the transverse momentum for a given four-momentum, i.e. the magnitude of its transverse components.
+Return the transverse momentum for a given four-momentum, i.e. the spatial_magnitude of its transverse components.
 
 !!! example
 
@@ -327,7 +327,7 @@ Return the theta angle for a given four-momentum, i.e. the polar angle of its sp
 
 !!! example
 
-    If `(E,px,py,pz)` is a four-momentum with magnitude `rho`, this is equivalent to `arccos(pz/rho)`, which is also equivalent to `arctan(sqrt(px^2+py^2)/pz)`.
+    If `(E,px,py,pz)` is a four-momentum with spatial_magnitude `rho`, this is equivalent to `arccos(pz/rho)`, which is also equivalent to `arctan(sqrt(px^2+py^2)/pz)`.
 
 !!! note
 
@@ -358,7 +358,7 @@ Return the cosine of the theta angle for a given four-momentum.
 
 """
 @inline function cos_theta(::EXYZ, mom)
-    r = magnitude(mom)
+    r = spatial_magnitude(mom)
     return iszero(r) ? one(px(mom)) : pz(mom) / r
 end
 

src/interface.jl

@@ -19,8 +19,8 @@ const FOURMOMENTUM_GETTER_FUNCTIONS = (
     :px,
     :py,
     :pz,
-    :magnitude2,
-    :magnitude,
+    :spatial_magnitude2,
+    :spatial_magnitude,
     :invariant_mass2,
     :invariant_mass,
     :boost_beta,
@@ -49,8 +49,8 @@ for func in FOURMOMENTUM_GETTER_FUNCTIONS
 end
 
 const FOURMOMENTUM_GETTER_ALIASSES = Dict(
-    :mag2 => :magnitude2,
-    :mag => :magnitude,
+    :mag2 => :spatial_magnitude2,
+    :mag => :spatial_magnitude,
     :mass2 => :invariant_mass2,
     :mass => :invariant_mass,
     :pt2 => :transverse_momentum2,

test/xyze.jl

@@ -25,15 +25,15 @@ mom_onshell = CustomMom(E, x, y, z)
 mom_zero = CustomMom(0.0, 0.0, 0.0, 0.0)
 mom_offshell = CustomMom(0.0, 0.0, 0.0, m)
 
-@testset "magnitude consistence" for mom in [mom_onshell, mom_offshell, mom_zero]
-    @test FourMomentumBase.magnitude2(mom) == FourMomentumBase.mag2(mom)
-    @test FourMomentumBase.magnitude(mom) == FourMomentumBase.mag(mom)
-    @test isapprox(FourMomentumBase.magnitude(mom), sqrt(FourMomentumBase.magnitude2(mom)))
+@testset "spatial_magnitude consistence" for mom in [mom_onshell, mom_offshell, mom_zero]
+    @test FourMomentumBase.spatial_magnitude2(mom) == FourMomentumBase.mag2(mom)
+    @test FourMomentumBase.spatial_magnitude(mom) == FourMomentumBase.mag(mom)
+    @test isapprox(FourMomentumBase.spatial_magnitude(mom), sqrt(FourMomentumBase.spatial_magnitude2(mom)))
 end
 
-@testset "magnitude values" begin
-    @test isapprox(FourMomentumBase.magnitude2(mom_onshell), x^2 + y^2 + z^2)
-    @test isapprox(FourMomentumBase.magnitude(mom_onshell), sqrt(x^2 + y^2 + z^2))
+@testset "spatial_magnitude values" begin
+    @test isapprox(FourMomentumBase.spatial_magnitude2(mom_onshell), x^2 + y^2 + z^2)
+    @test isapprox(FourMomentumBase.spatial_magnitude(mom_onshell), sqrt(x^2 + y^2 + z^2))
 end
 
 @testset "mass consistence" for mom_on in [mom_onshell, mom_zero]