Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
RainerHeintzmann committed Jul 12, 2024
1 parent 1bc9e04 commit a6a2828
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ SeparableFunctions
## Generic Ways to Create Seperable and Radial Functions
```@docs
calculate_broadcasted
calculate_separables
calculate_separables_nokw
separable_view
separable_create
copy_corners!
Expand Down
5 changes: 5 additions & 0 deletions docs/src/radial.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,9 @@ propagator_col
propagator_col!
phase_kz_col
phase_kz_col!
SeparableFunctions.calc_radial2_symm
SeparableFunctions.kwargs_to_args
SeparableFunctions.radial_speedup
SeparableFunctions.calc_radial2_symm!
SeparableFunctions.radial_speedup_ifa
```
7 changes: 7 additions & 0 deletions docs/src/separables.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,24 @@ They all possess a similar interface and exist in three variants:
```@docs
gaussian_sep
gaussian_col
SeparableFunctions.gaussian_lz
normal_sep
normal_col
SeparableFunctions.normal_lz
ramp_sep
ramp_col
SeparableFunctions.ramp_lz
rr2_sep
rr2_col
SeparableFunctions.rr2_lz
box_sep
box_col
SeparableFunctions.box_lz
sinc_sep
sinc_col
SeparableFunctions.sinc_lz
exp_ikx_sep
exp_ikx_col
SeparableFunctions.exp_ikx_lz
```

2 changes: 1 addition & 1 deletion src/SeparableFunctions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ using ChainRulesCore # for adjoint definition
# using ZygoteRules
# using Zygote # to use rrule_via_ad

export calculate_separables, separable_view, separable_create
export calculate_separables_nokw, separable_view, separable_create
export calculate_broadcasted
export copy_corners!
export propagator_col, propagator_col!, phase_kz_col, phase_kz_col!
Expand Down

0 comments on commit a6a2828

Please sign in to comment.