Skip to content

Commit 4556ca5

Browse files
committed
Added definitions to docs
1 parent 5e986ed commit 4556ca5

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/src/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# FresnelIntegrals.jl
22

3-
```@index
3+
A quick Julia library for calculating Fresnel Integrals using the error function from [SpecialFunctions.jl](https://github.com/JuliaMath/SpecialFunctions.jl).
4+
5+
## Installation
6+
7+
Until this is added into Pkg's manifest, just add from the Github link
8+
9+
```julia
10+
Pkg.add("https://github.com/kiranshila/FresnelIntegrals.jl")
411
```
512

613
```@autodocs

src/FresnelIntegrals.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ export fresnel
66

77
"""
88
fresnelc(z)
9-
Calculates the Fresnel cosine integral for the number z
9+
Calculates the Fresnel cosine integral for the number z for
10+
``C(z) = \\int_{0}^{\\infty} \\cos{\\left(\\frac{\\pi t^2}{2}\\right)}``
1011
"""
1112
fresnelc(z::Number) = 0.25*(1-1im)*(1im*erf(0.5*(1-1im)*z*√(π)) + erf(0.5*(1+1im)*z*√(π)))
1213

1314
"""
1415
fresnels(z)
15-
Calculates the Fresnel sine integral for the number z
16+
Calculates the Fresnel sine integral for the number z for
17+
``S(z) = \\int_{0}^{\\infty} \\sin{\\left(\\frac{\\pi t^2}{2}\\right)}``
1618
"""
1719
fresnels(z::Number) = 0.25*(1+1im)*(-1im*erf(0.5*(1-1im)*z*√(π)) + erf(0.5*(1+1im)*z*√(π)))
1820

0 commit comments

Comments
 (0)