Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ makedocs(
"StreamSampling.jl" => "index.md",
"Basics" => "basics.md",
"An Illustrative Example" => "example.md",
"API" => "api.md",
"Performance Tips" => "perf_tips.md",
"Benchmarks" => "benchmark.md"
"Benchmarks" => "benchmark.md",
"API" => "api.md",
],
warnonly = [:doctest, :missing_docs, :cross_references],
)
Expand All @@ -31,4 +31,4 @@ if CI
devbranch = "main",
)
end
println("Finished building and deploying docs.")
println("Finished building and deploying docs.")
9 changes: 8 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@

# StreamSampling.jl
# Introduction

```@docs
StreamSampling
```

## Installation

```julia
using Pkg
Pkg.add("StreamSampling")
```

## Reproducibility

```@raw html
Expand Down
4 changes: 2 additions & 2 deletions docs/src/perf_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ iter = 1:10^7;
Running with both version we get

```@example 1
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true))
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true));
```

```@example 1
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false))
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false));
```

As you can see, the immutable version is 50% faster than
Expand Down
Loading