Skip to content

Commit dfb21f5

Browse files
committed
clarify docs
1 parent be6b54a commit dfb21f5

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/src/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
The source repository is [https://github.com/jlapeyre/InverseLaplace.jl](https://github.com/jlapeyre/InverseLaplace.jl).
66

7+
This package provides three numerical algorithms for numerically inverting Laplace transforms.
8+
79
## Contents
810

911
```@contents

src/InverseLaplace.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,19 @@ Compute the inverse transform of the transform of `cos` at argument `pi/2`.
2828
julia> ft = Talbot(s -> s/(s^2+1), 80);
2929
3030
julia> ft(pi/2)
31-
0.0
31+
-3.5366510684573195e-5
3232
```
3333
3434
Note that given `Float64` input, the precision of the returned value may not be satisfactory.
3535
```julia-repl
36-
julia> ft(pi/2)
37-
-3.5366510684573195e-5
38-
3936
julia> Float64(ft(big(pi)/2))
4037
2.114425886215604e-49
4138
```
39+
40+
!!! note
41+
This function uses the fixed Talbot method. It evaluates the Laplace transform
42+
function for complex arguments. The GWR method is, in general, less accurate and
43+
less stable, but does not evaluate the Laplace transform function for complex arguments.
4244
"""
4345
type Talbot{T<:Base.Callable} <: AbstractILt
4446
LSfunc::T # Laplace space function

0 commit comments

Comments
 (0)