Skip to content

Commit f52aa36

Browse files
Remove non-parametrised outer constructor
At the full constructor level the type parameter really should be known, the use case for the non-explicit parametrised version is weak, so it is removed. (This was also causing a docstring warning.)
1 parent 3bbe3fb commit f52aa36

File tree

1 file changed

+15
-26
lines changed

1 file changed

+15
-26
lines changed

src/Pseudojet.jl

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -55,31 +55,6 @@ Return the element type of the `PseudoJet` struct.
5555
"""
5656
Base.eltype(::Type{PseudoJet{T}}) where {T} = T
5757

58-
"""
59-
PseudoJet(px::T, py::T, pz::T, E::T,
60-
_cluster_hist_index::Int,
61-
pt2::T) where {T <: Real}
62-
63-
Constructs a PseudoJet object with the given momentum components and energy and
64-
history index.
65-
66-
# Arguments
67-
- `px::T`: The x-component of the momentum.
68-
- `py::T`: The y-component of the momentum.
69-
- `pz::T`: The z-component of the momentum.
70-
- `E::T`: The energy.
71-
- `_cluster_hist_index::Int`: The cluster history index.
72-
- `pt2::T`: The transverse momentum squared.
73-
74-
# Returns
75-
A `PseudoJet` object.
76-
"""
77-
PseudoJet(px::T, py::T, pz::T, E::T,
78-
_cluster_hist_index::Int,
79-
pt2::T) where {T <: Real} = PseudoJet{T}(px,
80-
py, pz, E, _cluster_hist_index,
81-
pt2, 1.0 / pt2, _invalid_rap, _invalid_phi)
82-
8358
"""
8459
PseudoJet{T}(px::T, py::T, pz::T, E::T,
8560
_cluster_hist_index::Int,
@@ -120,10 +95,24 @@ Constructs a PseudoJet object with the given momentum components and energy.
12095
A PseudoJet object, with type parameter `T`.
12196
"""
12297
PseudoJet(px::T, py::T,
123-
pz::T, E::T) where {T <: Real} = PseudoJet(px, py, pz, E, 0, px^2 + py^2)
98+
pz::T, E::T) where {T <: Real} = PseudoJet{T}(px, py, pz, E, 0, px^2 + py^2)
12499

125100
"""
126101
PseudoJet{U}(px::T, py::T, pz::T, E::T) where T <: Real, U <: Real
102+
103+
Constructs a PseudoJet object with the given momentum components and energy,
104+
parameterised by `U`.
105+
106+
# Arguments
107+
- `px::T`: The x-component of the momentum.
108+
- `py::T`: The y-component of the momentum.
109+
- `pz::T`: The z-component of the momentum.
110+
- `E::T`: The energy.
111+
112+
- U <: Real: The type parameter for the PseudoJet object.
113+
114+
# Returns
115+
A PseudoJet object, with type parameter `U`.
127116
"""
128117
PseudoJet{U}(px::T, py::T, pz::T, E::T) where {T <: Real, U <: Real} = PseudoJet{U}(U(px),
129118
U(py),

0 commit comments

Comments
 (0)