Cleanup

Author: Deltadahl

src/SimpleNonlinearSolve.jl

@@ -4,7 +4,7 @@ using Reexport
 using FiniteDiff, ForwardDiff
 using ForwardDiff: Dual
 using StaticArraysCore
-using LinearAlgebra # TODO check if it is ok to add this
+using LinearAlgebra
 import ArrayInterfaceCore
 
 @reexport using SciMLBase

src/broyden.jl

@@ -1,14 +1,18 @@
-# TODO add docstrings
+"""
+```julia
+Broyden()
+```
+
+A low-overhead implementation of Broyden. This method is non-allocating on scalar
+and static array problems.
+"""
 
-# TODO check what the supertype should be
-# TODO check if this should be defined as in raphson.jl
 struct Broyden <: AbstractSimpleNonlinearSolveAlgorithm end
 
 function SciMLBase.solve(prob::NonlinearProblem,
-    alg::Broyden, args...; abstol = nothing,
-    reltol = nothing,
-    maxiters = 1000, kwargs...)
-
+                         alg::Broyden, args...; abstol = nothing,
+                         reltol = nothing,
+                         maxiters = 1000, kwargs...)
     f = Base.Fix2(prob.f, prob.p)
     x = float(prob.u0)
     fₙ = f(x)
@@ -30,8 +34,7 @@ function SciMLBase.solve(prob::NonlinearProblem,
     xₙ = x
     xₙ₋₁ = x
     fₙ₋₁ = fₙ
-    for n in 1:maxiters
-
+    for _ in 1:maxiters
         xₙ = xₙ₋₁ - J⁻¹ * fₙ₋₁
         fₙ = f(xₙ)
         Δxₙ = xₙ - xₙ₋₁

test/basictests.jl

@@ -57,16 +57,12 @@ end
 # Scalar
 f, u0 = (u, p) -> u * u - p, 1.0
 for alg in [SimpleNewtonRaphson(), Broyden()]
-
     g = function (p)
         probN = NonlinearProblem{false}(f, oftype(p, u0), p)
         sol = solve(probN, alg)
         return sol.u
     end
 
-    p = 1.1
-    @test ForwardDiff.derivative(g, p) ≈ 1 / (2 * sqrt(p))
-
     for p in 1.1:0.1:100.0
         @test g(p) ≈ sqrt(p)
         @test ForwardDiff.derivative(g, p) ≈ 1 / (2 * sqrt(p))
@@ -120,7 +116,7 @@ probN = NonlinearProblem(f, u0)
 @test solve(probN, SimpleNewtonRaphson(); immutable = false).u[end] ≈ sqrt(2.0)
 @test solve(probN, SimpleNewtonRaphson(; autodiff = false)).u[end] ≈ sqrt(2.0)
 @test solve(probN, SimpleNewtonRaphson(; autodiff = false)).u[end] ≈ sqrt(2.0)
-# TODO check why the 2 lines above are identical
+
 @test solve(probN, Broyden()).u[end] ≈ sqrt(2.0)
 @test solve(probN, Broyden(); immutable = false).u[end] ≈ sqrt(2.0)
 
@@ -130,10 +126,10 @@ for u0 in [1.0, [1, 1.0]]
     probN = NonlinearProblem(f, u0)
     sol = sqrt(2) * u0
 
-    # TODO check why the two lines below are identical
     @test solve(probN, SimpleNewtonRaphson()).u ≈ sol
     @test solve(probN, SimpleNewtonRaphson()).u ≈ sol
     @test solve(probN, SimpleNewtonRaphson(; autodiff = false)).u ≈ sol
+
     @test solve(probN, Broyden()).u ≈ sol
 end