Add AllocCheck.jl

Author: avik-pal

test/Project.toml

@@ -1,4 +1,5 @@
 [deps]
+AllocCheck = "9b6a8646-10ed-4001-bbdc-1d2f46dfbb1a"
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"

test/basictests.jl

@@ -1,4 +1,4 @@
-using BenchmarkTools, LinearSolve, SimpleNonlinearSolve, StaticArrays, Random,
+using AllocCheck, BenchmarkTools, LinearSolve, SimpleNonlinearSolve, StaticArrays, Random,
     LinearAlgebra, Test, ForwardDiff, DiffEqBase
 
 _nameof(x) = applicable(nameof, x) ? nameof(x) : _nameof(typeof(x))
@@ -255,6 +255,39 @@ end
     end
 end
 
+# --- Allocation Checks ---
+
+## SimpleDFSane needs to allocate a history vector
+@testset "Allocation Checks: $(_nameof(alg))" for alg in (
+        SimpleNewtonRaphson(; autodiff = AutoForwardDiff(; chunksize = 2)),
+        SimpleHalley(; autodiff = AutoForwardDiff(; chunksize = 2)),
+        SimpleBroyden(), SimpleKlement(), SimpleLimitedMemoryBroyden(),
+        SimpleTrustRegion(; autodiff = AutoForwardDiff(; chunksize = 2)))
+    @check_allocs nlsolve(prob, alg) = DiffEqBase.__solve(prob, alg; abstol = 1e-9)
+
+    nlprob_scalar = NonlinearProblem{false}(quadratic_f, 1.0, 2.0)
+    nlprob_sa = NonlinearProblem{false}(quadratic_f, @SVector[1.0, 1.0], 2.0)
+
+    try
+        nlsolve(nlprob_scalar, alg)
+        @test true
+    catch e
+        @error e
+        @test false
+    end
+
+    # ForwardDiff allocates for hessian since we don't propagate the chunksize
+    # SimpleLimitedMemoryBroyden needs to do views on the low rank matrices so the sizes
+    # are dynamic. This can be fixed but no without maintaining the simplicity of the code
+    try
+        nlsolve(nlprob_sa, alg)
+        @test true
+    catch e
+        @error e
+        @test false broken=(alg isa SimpleHalley || alg isa SimpleLimitedMemoryBroyden)
+    end
+end
+
 # --- Interval Nonlinear Problems ---
 
 @testset "Interval Nonlinear Problem: $(alg)" for alg in (Bisection(), Falsi(), Ridder(),