Skip to content

Update signatures in readme to use AbstractVector #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update signatures in readme to use AbstractVector #154

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23464e2
Update signatures in readme to use AbstractVector
m-fila May 16, 2025
8089065
fix typo xd
m-fila May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ algorithm and generalised $`k_\text{T}`$ for $`e^+e^-`$.
The simplest interface is to call:

```julia
cs = jet_reconstruct(particles::Vector{T}; algorithm = JetAlgorithm.AntiKt, R = 1.0, [p = -1,] [recombine = +,] [strategy = RecoStrategy.Best])
cs = jet_reconstruct(particles::AbstractVector{T}; algorithm = JetAlgorithm.AntiKt, R = 1.0, [p = -1,] [recombine = +,] [strategy = RecoStrategy.Best])
```

- `particles` - a one dimensional array (vector) of input particles for the clustering
Expand Down Expand Up @@ -90,7 +90,7 @@ Another option, if one wishes to use a specific strategy, is to call that strate

```julia
# For N2Plain strategy called directly
plain_jet_reconstruct(particles::Vector{T}; algorithm = JetAlgorithm.AntiKt, R = 1.0, recombine = +)
plain_jet_reconstruct(particles::AbstractVector{T}; algorithm = JetAlgorithm.AntiKt, R = 1.0, recombine = +)
```

Note that there is no `strategy` option in these interfaces.
Expand Down
Loading