From 3a17ce2e9bf721b0af1bab81d545e0eecc559a39 Mon Sep 17 00:00:00 2001 From: Charles Kawczynski Date: Mon, 7 Dec 2020 18:57:00 -0800 Subject: [PATCH] Change name to NonlinearSolvers --- Project.toml | 2 +- README.md | 14 +++++++------- bors.toml | 2 +- docs/Project.toml | 2 +- docs/make.jl | 8 ++++---- docs/src/API.md | 4 ++-- docs/src/index.md | 2 +- src/{NLSolvers.jl => NonlinearSolvers.jl} | 16 ++++++++-------- src/newton_method.jl | 2 +- src/newton_method_ad.jl | 2 +- test/runtests.jl | 4 ++-- 11 files changed, 29 insertions(+), 29 deletions(-) rename src/{NLSolvers.jl => NonlinearSolvers.jl} (77%) diff --git a/Project.toml b/Project.toml index 456290a..bb48033 100644 --- a/Project.toml +++ b/Project.toml @@ -1,4 +1,4 @@ -name = "NLSolvers" +name = "NonlinearSolvers" uuid = "f4b8ab15-8e73-4e04-9661-b5912071d22b" authors = ["Climate Modeling Alliance"] version = "0.1.0" diff --git a/README.md b/README.md index b4e5a8b..277883f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# NLSolvers.jl +# NonlinearSolvers.jl A simple GPU-friendly package for solving systems of non-linear equations. @@ -11,16 +11,16 @@ A simple GPU-friendly package for solving systems of non-linear equations. | **Bors** | [![Bors enabled][bors-img]][bors-url] | [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg -[docs-dev-url]: https://CliMA.github.io/NLSolvers.jl/dev/ +[docs-dev-url]: https://CliMA.github.io/NonlinearSolvers.jl/dev/ -[docs-bld-img]: https://github.com/CliMA/NLSolvers.jl/workflows/Documentation/badge.svg -[docs-bld-url]: https://github.com/CliMA/NLSolvers.jl/actions?query=workflow%3ADocumentation +[docs-bld-img]: https://github.com/CliMA/NonlinearSolvers.jl/workflows/Documentation/badge.svg +[docs-bld-url]: https://github.com/CliMA/NonlinearSolvers.jl/actions?query=workflow%3ADocumentation [bkci-img]: https://badge.buildkite.com/663724467d2dc86a8a0fd7a5e7148329bb986a127d25cc5fda.svg -[bkci-url]: https://buildkite.com/clima/nlsolvers-ci +[bkci-url]: https://buildkite.com/clima/nonlinearsolvers-ci -[codecov-img]: https://codecov.io/gh/CliMA/NLSolvers.jl/branch/master/graph/badge.svg -[codecov-url]: https://codecov.io/gh/CliMA/NLSolvers.jl +[codecov-img]: https://codecov.io/gh/CliMA/NonlinearSolvers.jl/branch/master/graph/badge.svg +[codecov-url]: https://codecov.io/gh/CliMA/NonlinearSolvers.jl [bors-img]: https://bors.tech/images/badge_small.svg [bors-url]: https://app.bors.tech/repositories/25128 diff --git a/bors.toml b/bors.toml index b1e3027..a5c44dc 100644 --- a/bors.toml +++ b/bors.toml @@ -1,5 +1,5 @@ status = [ - "buildkite/nlsolvers-ci", + "buildkite/nonlinearsolvers-ci", "docs-build" ] delete_merged_branches = true diff --git a/docs/Project.toml b/docs/Project.toml index 85e8240..b19b30b 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,3 +1,3 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -NLSolvers = "f4b8ab15-8e73-4e04-9661-b5912071d22b" +NonlinearSolvers = "f4b8ab15-8e73-4e04-9661-b5912071d22b" diff --git a/docs/make.jl b/docs/make.jl index e48dc18..09c178c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,4 +1,4 @@ -using NLSolvers, Documenter +using NonlinearSolvers, Documenter pages = Any["Home" => "index.md", "API" => "API.md"] @@ -16,18 +16,18 @@ format = Documenter.HTML( ) makedocs( - sitename = "NLSolvers.jl", + sitename = "NonlinearSolvers.jl", doctest = true, strict = true, format = format, clean = true, checkdocs = :exports, - modules = [NLSolvers], + modules = [NonlinearSolvers], pages = pages, ) deploydocs( - repo = "github.com/CliMA/NLSolvers.jl.git", + repo = "github.com/CliMA/NonlinearSolvers.jl.git", target = "build", push_preview = true, ) diff --git a/docs/src/API.md b/docs/src/API.md index d66e875..f3903e2 100644 --- a/docs/src/API.md +++ b/docs/src/API.md @@ -1,11 +1,11 @@ # API ```@meta -CurrentModule = NLSolvers +CurrentModule = NonlinearSolvers ``` ```@docs -NLSolvers +NonlinearSolvers ``` ## Numerical Methods diff --git a/docs/src/index.md b/docs/src/index.md index 3c77b30..bcd1ecf 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,3 +1,3 @@ -# NLSolvers.jl +# NonlinearSolvers.jl A simple GPU-friendly package for solving systems of non-linear equations. diff --git a/src/NLSolvers.jl b/src/NonlinearSolvers.jl similarity index 77% rename from src/NLSolvers.jl rename to src/NonlinearSolvers.jl index 3cd7081..4a2b4fb 100644 --- a/src/NLSolvers.jl +++ b/src/NonlinearSolvers.jl @@ -1,9 +1,9 @@ """ - NLSolvers + NonlinearSolvers A set of solvers for systems of non-linear equations """ -module NLSolvers +module NonlinearSolvers using DocStringExtensions using ForwardDiff @@ -13,16 +13,16 @@ export solve! const FTypes = Union{AbstractFloat, AbstractArray} """ - AbstractNLSolverMethod + AbstractNonlinearSolverMethod A super type for non-linear systems """ -abstract type AbstractNLSolverMethod{FTypes} end +abstract type AbstractNonlinearSolverMethod{FTypes} end """ - method_args(method::AbstractNLSolverMethod) + method_args(method::AbstractNonlinearSolverMethod) -Return tuple of positional args for `AbstractNLSolverMethod`. +Return tuple of positional args for `AbstractNonlinearSolverMethod`. """ function method_args end @@ -35,7 +35,7 @@ include("newton_method_ad.jl") # Main entry point: Dispatch to specific method """ solve!( - method::AbstractNLSolverMethod{FT}, + method::AbstractNonlinearSolverMethod{FT}, soltype::SolutionType = CompactSolution(), tol::Union{Nothing, AbstractTolerance} = nothing, maxiters::Union{Nothing, Int} = 10_000, @@ -48,7 +48,7 @@ Solve the non-linear system given - `maxiters` the maximum number of iterations to perform """ function solve!( - method::AbstractNLSolverMethod{FT}, + method::AbstractNonlinearSolverMethod{FT}, soltype::SolutionType = CompactSolution(), tol::Union{Nothing, AbstractTolerance} = nothing, maxiters::Union{Nothing, Int} = 10_000, diff --git a/src/newton_method.jl b/src/newton_method.jl index 03acd2c..a0feede 100644 --- a/src/newton_method.jl +++ b/src/newton_method.jl @@ -14,7 +14,7 @@ A non-linear system of equations type. # Fields $(DocStringExtensions.FIELDS) """ -struct NewtonsMethod{FT, F!, J!, A, JA} <: AbstractNLSolverMethod{FT} +struct NewtonsMethod{FT, F!, J!, A, JA} <: AbstractNonlinearSolverMethod{FT} "Function to find the root of" f!::F! "Jacobian of `f!`" diff --git a/src/newton_method_ad.jl b/src/newton_method_ad.jl index a3686d0..cfac1fc 100644 --- a/src/newton_method_ad.jl +++ b/src/newton_method_ad.jl @@ -10,7 +10,7 @@ A non-linear system of equations type. # Fields $(DocStringExtensions.FIELDS) """ -struct NewtonsMethodAD{FT, F!, A, JA} <: AbstractNLSolverMethod{FT} +struct NewtonsMethodAD{FT, F!, A, JA} <: AbstractNonlinearSolverMethod{FT} "Function to find the root of" f!::F! "Initial guess" diff --git a/test/runtests.jl b/test/runtests.jl index db38430..6a383c8 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -7,9 +7,9 @@ else end using Test -using NLSolvers +using NonlinearSolvers -@testset "NLSolvers tests" begin +@testset "NonlinearSolvers tests" begin function f!(F, x) t = Tuple(x) F_nt = ntuple(Val(length(F))) do i