Skip to content

Commit bfaf2b7

Browse files
authored
Update signatures in readme to use AbstractVector (#154)
* Update signatures in readme to use AbstractVector This is follow up to #150 - we forgot to update readme 😁 * fix typo xd
1 parent 0f47837 commit bfaf2b7

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ algorithm and generalised $`k_\text{T}`$ for $`e^+e^-`$.
2727
The simplest interface is to call:
2828

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

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

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

9696
Note that there is no `strategy` option in these interfaces.

0 commit comments

Comments
 (0)