Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tortar authored Oct 11, 2024
1 parent 5f288a8 commit 16166bd
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ julia> r
75
```

This has the advantage to require `O(1)` memory, while reservoir sample techniques requires `O(k)` memory where `k`
is the number of elements in the sample.
The advantage of `StreamSample` iterators in respect to `ReservoirSample` is that they require `O(1)`
memory if not collected, while reservoir techniques require `O(k)` memory where `k` is the number
of elements in the sample.

Consult the [API page](https://juliadynamics.github.io/StreamSampling.jl/stable/api) for more information about the
package interface.
Consult the [API page](https://juliadynamics.github.io/StreamSampling.jl/stable/api) for more information
about the package interface.

0 comments on commit 16166bd

Please sign in to comment.