Skip to content

Commit 1b4b1b9

Browse files
Small comment/doc updates
1 parent bc2684e commit 1b4b1b9

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

src/ClusterSequence.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,9 @@ add_step_to_history!(clusterseq::ClusterSequence, parent1, parent2, jetp_index,
208208
clusterseq.history[parent2] = @set hist_elem.child = local_step
209209
end
210210

211-
# Get cross-referencing right
211+
# Cross referencing has to be correct by construction now, these asserts
212+
# can be used to check that when debugging - they do cost a bit of time
213+
# which is why they are commented out for production
212214
# if jetp_index != Invalid
213215
# @assert jetp_index >= 1
214216
# @assert clusterseq.jets[jetp_index]._cluster_hist_index == local_step

src/CommonJetStructs.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ abstract type Jet <: FourMomentum end
2424
"""
2525
struct PlainJet <: FourMomentum
2626
27-
Simple jet structure without cluster history, used as an intermediate
27+
Simple four momentum structure without cluster history, used as an intermediate
2828
type during jet merging.
2929
"""
3030
struct PlainJet <: FourMomentum
@@ -73,6 +73,8 @@ Return the energy component of the four-momentum vector of `j`.
7373
"""
7474
energy(j::FourMomentum) = j.E
7575

76+
"""Alias for `energy` function"""
77+
const E = energy
7678

7779
"""
7880
p2(j::FourMomentum)
@@ -89,15 +91,15 @@ Return the squared transverse momentum of the four-momentum vector of `j`.
8991
"""
9092
pt2(j::FourMomentum) = j.px^2 + j.py^2
9193

94+
"""Alias for `pt2` function"""
95+
const kt2 = pt2
96+
9297
"""
9398
pt(j::FourMomentum)
9499
Return the momentum of the four-momentum vector of `j`.
95100
"""
96101
pt(j::FourMomentum) = sqrt(pt2(j))
97102

98-
const kt2 = pt2
99-
const E = energy
100-
101103
"""
102104
mass2(j::FourMomentum)
103105

0 commit comments

Comments
 (0)