Skip to content

Commit

Permalink
Fix images in benchmark section of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jipolanco committed Nov 29, 2024
1 parent ecf5ab5 commit 3c29d64
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion benchmarks/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Benchmarks
# Performance benchmarks

This directory contains scripts for executing benchmarks (`run_benchmarks.jl`)
and generated plotting results (`plots/plot_benchmarks.jl`).
Expand Down
15 changes: 9 additions & 6 deletions docs/src/benchmarks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Benchmarks
# Performance benchmarks

```@contents
Pages = ["benchmarks.md"]
Expand Down Expand Up @@ -64,29 +64,32 @@ at large point densities.

### Type-1 transforms

![Benchmark of type-1 transforms of ComplexF64 data.](benchmarks/benchmark_ComplexF64_type1.svg)
![](benchmarks/benchmark_ComplexF64_type1.svg)

### [Type-2 transforms](@id benchmarks-complex-type2)

![Benchmark of type-2 transforms of ComplexF64 data.](benchmarks/benchmark_ComplexF64_type2.svg)
![](benchmarks/benchmark_ComplexF64_type2.svg)

## [Real non-uniform data](@id benchmarks-real)

These tests are of interest for applications where **non-uniform data is
real-valued** (imaginary part is zero).
This enables the use of real-to-complex (type-1) and complex-to-real (type-2)
In NonuniformFFTs.jl, this enables the use of real-to-complex (type-1) and complex-to-real (type-2)
FFTs and also allows to halve the amount of data processed during the spreading
(type-1) and interpolation (type-2) procedures.
The benchmarks showcase the important gains which can be obtained by using real-data
transforms, which are not available in other libraries like FINUFFT or NFFT.jl.

In the plots below, the (Cu)FINUFFT curves are exactly the same as in the
[complex-data](@ref benchmarks-complex) benchmarks.

### Type-1 transforms

![Benchmark of type-1 transforms of Float64 data.](benchmarks/benchmark_Float64_type1.svg)
![](benchmarks/benchmark_Float64_type1.svg)

### Type-2 transforms

![Benchmark of type-2 transforms of Float64 data.](benchmarks/benchmark_Float64_type2.svg)
![](benchmarks/benchmark_Float64_type2.svg)

## FINUFFT set-up

Expand Down

0 comments on commit 3c29d64

Please sign in to comment.