Skip to content

Commit d18ee5a

Browse files
author
Rogerluo
authored
Merge branch 'master' into roger/multiargs
2 parents c43f01e + 593ade3 commit d18ee5a

File tree

16 files changed

+275
-166
lines changed

16 files changed

+275
-166
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
*.jl.mem
44
docs/build/
55
docs/site/
6-
Manifest.toml
6+
/Manifest.toml

‎.travis.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@ language: julia
33
os:
44
- linux
55
- osx
6+
- windows
67
julia:
7-
- 0.7
88
- 1.0
9+
- 1.1
10+
- 1.2
11+
- 1.3
912
- nightly
1013
notifications:
1114
email: false
1215
matrix:
1316
allow_failures:
17+
- julia: 1.3
1418
- julia: nightly
1519
fast_finish: true
1620
after_success:
@@ -22,6 +26,6 @@ jobs:
2226
julia: 1.0
2327
os: linux
2428
script:
25-
- julia --project=docs/ -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'
29+
- julia --project=docs/ -e 'using Pkg; Pkg.instantiate()'
2630
- julia --project=docs/ docs/make.jl
2731
after_success: skip

‎Project.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
name = "FDM"
2-
uuid = "e25cca7e-83ef-51fa-be6c-dfe2a3123128"
3-
version = "0.6.1"
1+
name = "FiniteDifferences"
2+
uuid = "26cc04aa-876d-5657-8c51-4c34ba976000"
3+
version = "0.7.2"
44

55
[deps]
66
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
77
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
88

99
[compat]
10-
julia = "0.7, 1.0"
10+
julia = "1"
1111

1212
[extras]
1313
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

‎README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# FDM.jl: Finite Difference Methods
1+
# FiniteDifferences.jl: Finite Difference Methods
22

3-
[![Build Status](https://travis-ci.org/invenia/FDM.jl.svg?branch=master)](https://travis-ci.org/invenia/FDM.jl)
4-
[![Windows Build status](https://ci.appveyor.com/api/projects/status/g0gun5dxbkt631am/branch/master?svg=true)](https://ci.appveyor.com/project/invenia/fdm-jl/branch/master)
5-
[![codecov.io](http://codecov.io/github/invenia/FDM.jl/coverage.svg?branch=master)](http://codecov.io/github/invenia/FDM.jl?branch=master)
6-
[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.github.io/FDM.jl/latest/)
3+
[![Build Status](https://travis-ci.org/JuliaDiff/FiniteDifferences.jl.svg?branch=master)](https://travis-ci.org/JuliaDiff/FiniteDifferences.jl)
4+
[![codecov.io](https://codecov.io/github/JuliaDiff/FiniteDifferences.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaDiff/FiniteDifferences.jl?branch=master)
5+
[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliadiff.github.io/FiniteDifferences.jl/latest/)
76

8-
FDM.jl estimates derivatives with finite differences.
7+
FiniteDifferences.jl estimates derivatives with [finite differences](https://en.wikipedia.org/wiki/Finite_difference).
98

10-
See also [FDM](https://github.com/wesselb/fdm).
9+
See also the Python package [FDM](https://github.com/wesselb/fdm).
1110

1211
## Examples
1312

@@ -24,11 +23,11 @@ julia> central_fdm(5, 2)(sin, 1) + sin(1)
2423
9.747314066999024e-12
2524
```
2625

27-
Construct a FDM on a custom grid:
26+
Construct a FiniteDifferences on a custom grid:
2827

2928
```julia
3029
julia> method, report = fdm([-2, 0, 5], 1, report=true)
31-
(FDM.method, FDMReport:
30+
(FiniteDifferences.method, FiniteDifferencesReport:
3231
order of method: 3
3332
order of derivative: 1
3433
grid: [-2, 0, 5]
@@ -52,3 +51,7 @@ f (generic function with 1 method)
5251
julia> central_fdm(5, 1)(ε -> f([1, 1, 1] + ε * [1, 2, 3]), 0) - 6
5352
-2.922107000813412e-13
5453
```
54+
55+
## FDM.jl
56+
57+
This package was formerly called FDM.jl. We recommend users of FDM.jl [update to FiniteDifferences.jl](https://github.com/JuliaDiff/FiniteDifferences.jl/issues/37).

‎appveyor.yml

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎docs/Manifest.toml

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[Base64]]
4+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
5+
6+
[[Dates]]
7+
deps = ["Printf"]
8+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
9+
10+
[[Distributed]]
11+
deps = ["Random", "Serialization", "Sockets"]
12+
uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
13+
14+
[[DocStringExtensions]]
15+
deps = ["LibGit2", "Markdown", "Pkg", "Test"]
16+
git-tree-sha1 = "0513f1a8991e9d83255e0140aace0d0fc4486600"
17+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
18+
version = "0.8.0"
19+
20+
[[Documenter]]
21+
deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
22+
git-tree-sha1 = "c61d6eedbc3c4323c08b64af12d29c8ee0fcbb5f"
23+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
24+
version = "0.23.2"
25+
26+
[[FiniteDifferences]]
27+
deps = ["LinearAlgebra", "Printf"]
28+
path = ".."
29+
uuid = "26cc04aa-876d-5657-8c51-4c34ba976000"
30+
version = "0.7.1"
31+
32+
[[InteractiveUtils]]
33+
deps = ["Markdown"]
34+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
35+
36+
[[JSON]]
37+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
38+
git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e"
39+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
40+
version = "0.21.0"
41+
42+
[[LibGit2]]
43+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
44+
45+
[[Libdl]]
46+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
47+
48+
[[LinearAlgebra]]
49+
deps = ["Libdl"]
50+
uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
51+
52+
[[Logging]]
53+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
54+
55+
[[Markdown]]
56+
deps = ["Base64"]
57+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
58+
59+
[[Mmap]]
60+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
61+
62+
[[Parsers]]
63+
deps = ["Dates", "Test"]
64+
git-tree-sha1 = "db2b35dedab3c0e46dc15996d170af07a5ab91c9"
65+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
66+
version = "0.3.6"
67+
68+
[[Pkg]]
69+
deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
70+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
71+
72+
[[Printf]]
73+
deps = ["Unicode"]
74+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
75+
76+
[[REPL]]
77+
deps = ["InteractiveUtils", "Markdown", "Sockets"]
78+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
79+
80+
[[Random]]
81+
deps = ["Serialization"]
82+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
83+
84+
[[SHA]]
85+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
86+
87+
[[Serialization]]
88+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
89+
90+
[[Sockets]]
91+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
92+
93+
[[Test]]
94+
deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
95+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
96+
97+
[[UUIDs]]
98+
deps = ["Random", "SHA"]
99+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
100+
101+
[[Unicode]]
102+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

‎docs/Project.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
FiniteDifferences = "26cc04aa-876d-5657-8c51-4c34ba976000"
34

45
[compat]
5-
Documenter = "~0.19"
6+
Documenter = "~0.23"

‎docs/make.jl

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
1-
using Documenter, FDM
1+
using Documenter, FiniteDifferences
22

33
makedocs(
4-
modules=[FDM],
5-
format=:html,
6-
pages=[
7-
"Home" => "index.md",
8-
"API" => "pages/api.md"
9-
],
10-
sitename="FDM.jl",
4+
modules=[FiniteDifferences],
5+
format=Documenter.HTML(prettyurls=get(ENV, "CI", nothing) == "true"),
6+
pages=["Home" => "index.md", "API" => "pages/api.md"],
117
authors="Invenia Labs",
12-
assets=[
13-
"assets/invenia.css",
14-
],
8+
checkdocs=:exports,
9+
linkcheck=true,
10+
repo="https://github.com/JuliaDiff/FiniteDifferences.jl/blob/{commit}{path}#L{line}",
11+
sitename="FiniteDifferences.jl",
12+
strict=true,
1513
)
1614

17-
deploydocs(
18-
repo = "github.com/invenia/FDM.jl.git",
19-
julia = "1.0",
20-
target = "build",
21-
deps = nothing,
22-
make = nothing,
23-
)
15+
deploydocs(repo="github.com/JuliaDiff/FiniteDifferences.jl.git")

‎docs/src/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# FDM.jl: Finite Difference Methods
1+
# FiniteDifferences.jl: Finite Difference Methods
22

3-
[![Build Status](https://travis-ci.org/invenia/FDM.jl.svg?branch=master)](https://travis-ci.org/invenia/FDM.jl)
4-
[![codecov.io](http://codecov.io/github/invenia/FDM.jl/coverage.svg?branch=master)](http://codecov.io/github/invenia/FDM.jl?branch=master)
5-
[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.github.io/FDM.jl/latest/)
3+
[![Build Status](https://travis-ci.org/JuliaDiff/FiniteDifferences.jl.svg?branch=master)](https://travis-ci.org/JuliaDiff/FiniteDifferences.jl)
4+
[![codecov.io](https://codecov.io/github/JuliaDiff/FiniteDifferences.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaDiff/FiniteDifferences.jl?branch=master)
5+
[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://www.juliadiff.org/FiniteDifferences.jl/latest/)
66

7-
FDM.jl approximates derivatives of functions using finite difference methods.
7+
FiniteDifferences.jl approximates derivatives of functions using finite difference methods.
88

99
## Examples
1010

@@ -21,11 +21,11 @@ julia> central_fdm(5, 2)(sin, 1) + sin(1)
2121
9.747314066999024e-12
2222
```
2323

24-
Construct a FDM on a custom grid:
24+
Construct a FiniteDifferences on a custom grid:
2525

2626
```julia
2727
julia> method, report = fdm([-2, 0, 5], 1, report=true)
28-
(FDM.method, FDMReport:
28+
(FiniteDifferences.method, FiniteDifferencesReport:
2929
order of method: 3
3030
order of derivative: 1
3131
grid: [-2, 0, 5]

‎docs/src/pages/api.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
```@autodocs
2-
Modules = [FDM]
3-
Private = false
1+
## Finite Differences
2+
3+
```@docs
4+
FiniteDifferenceMethod
5+
fdm
6+
backward_fdm
7+
central_fdm
8+
forward_fdm
9+
assert_approx_equal
10+
FiniteDifferences.DEFAULT_CONDITION
11+
FiniteDifferences.TINY
12+
```
13+
14+
## Gradients
15+
16+
```@docs
17+
grad
18+
jacobian
19+
jvp
20+
j′vp
21+
to_vec
422
```

0 commit comments

Comments
 (0)