Merge branch 'master' into implicit_solve

Author: avik-pal

.github/workflows/CI_BracketingNonlinearSolve.yml

@@ -2,8 +2,6 @@ name: CI (BracketingNonlinearSolve)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/BracketingNonlinearSolve/**"
       - ".github/workflows/CI_BracketingNonlinearSolve.yml"
@@ -31,7 +29,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolve.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolve)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "src/**"
       - "ext/**"
@@ -37,13 +35,13 @@ jobs:
           - core
           - downstream
           - wrappers
+          - misc
         version:
           - "1.10"
           - "1"
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -95,6 +93,7 @@ jobs:
           - core
           - downstream
           - wrappers
+          - misc
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolveBase.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolveBase)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/NonlinearSolveBase/**"
       - ".github/workflows/CI_NonlinearSolveBase.yml"
@@ -30,7 +28,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolveFirstOrder.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolveFirstOrder)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/NonlinearSolveFirstOrder/**"
       - ".github/workflows/CI_NonlinearSolveFirstOrder.yml"
@@ -31,7 +29,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolveHomotopyContinuation.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolveHomotopyContinuation)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/NonlinearSolveHomotopyContinuation/**"
       - ".github/workflows/CI_NonlinearSolveHomotopyContinuation.yml"
@@ -30,7 +28,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolveQuasiNewton.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolveQuasiNewton)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/NonlinearSolveQuasiNewton/**"
       - ".github/workflows/CI_NonlinearSolveQuasiNewton.yml"
@@ -31,7 +29,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_NonlinearSolveSpectralMethods.yml

@@ -2,8 +2,6 @@ name: CI (NonlinearSolveSpectralMethods)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/NonlinearSolveSpectralMethods/**"
       - ".github/workflows/CI_NonlinearSolveSpectralMethods.yml"
@@ -31,7 +29,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_SCCNonlinearSolve.yml

@@ -2,8 +2,6 @@ name: CI (SCCNonlinearSolve)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/SCCNonlinearSolve/**"
       - ".github/workflows/CI_SCCNonlinearSolve.yml"
@@ -31,7 +29,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_SciMLJacobianOperators.yml

@@ -2,8 +2,6 @@ name: CI (SciMLJacobianOperators)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/SciMLJacobianOperators/**"
       - ".github/workflows/CI_SciMLJacobianOperators.yml"
@@ -29,7 +27,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

.github/workflows/CI_SimpleNonlinearSolve.yml

@@ -2,8 +2,6 @@ name: CI (SimpleNonlinearSolve)
 
 on:
   pull_request:
-    branches:
-      - master
     paths:
       - "lib/SimpleNonlinearSolve/**"
       - ".github/workflows/CI_SimpleNonlinearSolve.yml"
@@ -32,7 +30,6 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          - windows-latest
         group:
           - core
           - adjoint

.github/workflows/CompatHelper.yml

@@ -15,11 +15,14 @@ jobs:
         julia-arch: [x86]
         os: [ubuntu-latest]
     steps:
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
           version: ${{ matrix.julia-version }}
+
       - name: Pkg.add("CompatHelper")
         run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+
       - name: CompatHelper.main()
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Project.toml

@@ -1,7 +1,7 @@
 name = "NonlinearSolve"
 uuid = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
 authors = ["SciML"]
-version = "4.4.0"
+version = "4.6.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -32,6 +32,14 @@ SparseMatrixColorings = "0a514795-09f3-496d-8182-132a7b665d35"
 StaticArraysCore = "1e83bf80-4336-4d27-bf5d-d5a4f845583c"
 SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
 
+[sources]
+BracketingNonlinearSolve = {path = "lib/BracketingNonlinearSolve"}
+NonlinearSolveBase = {path = "lib/NonlinearSolveBase"}
+NonlinearSolveFirstOrder = {path = "lib/NonlinearSolveFirstOrder"}
+NonlinearSolveQuasiNewton = {path = "lib/NonlinearSolveQuasiNewton"}
+NonlinearSolveSpectralMethods = {path = "lib/NonlinearSolveSpectralMethods"}
+SimpleNonlinearSolve = {path = "lib/SimpleNonlinearSolve"}
+
 [weakdeps]
 FastLevenbergMarquardt = "7a0df574-e128-4d35-8cbd-3d84502bf7ce"
 FixedPointAcceleration = "817d07cb-a79a-5c30-9a31-890123675176"
@@ -75,8 +83,8 @@ ExplicitImports = "1.5"
 FastClosures = "0.3.2"
 FastLevenbergMarquardt = "0.1"
 FiniteDiff = "2.24"
-FixedPointAcceleration = "0.3"
-ForwardDiff = "0.10.36"
+FixedPointAcceleration = "0.3, 1"
+ForwardDiff = "0.10.36, 1"
 Hwloc = "3"
 InteractiveUtils = "<0.0.1, 1"
 LeastSquaresOptim = "0.8.5"
@@ -97,14 +105,14 @@ NonlinearSolveSpectralMethods = "1.1"
 OrdinaryDiffEqTsit5 = "1.1.0"
 PETSc = "0.3"
 Pkg = "1.10"
-PolyesterForwardDiff = "0.1"
+PolyesterForwardDiff = "0.1.3"
 PrecompileTools = "1.2"
 Preferences = "1.4"
 Random = "1.10"
 ReTestItems = "1.24"
 Reexport = "1.2"
 SIAMFANLEquations = "1.0.1"
-SciMLBase = "2.58"
+SciMLBase = "2.69"
 SimpleNonlinearSolve = "2.1"
 SparseArrays = "1.10"
 SparseConnectivityTracer = "0.6.5"
@@ -114,9 +122,9 @@ StableRNGs = "1"
 StaticArrays = "1.9"
 StaticArraysCore = "1.4"
 Sundials = "4.23.1"
-SymbolicIndexingInterface = "0.3.31"
+SymbolicIndexingInterface = "0.3.36"
 Test = "1.10"
-Zygote = "0.6.69"
+Zygote = "0.6.69, 0.7"
 julia = "1.10"
 
 [extras]

docs/Project.toml

@@ -32,7 +32,7 @@ Sundials = "c3572dad-4567-51f8-b174-8c6c989267f4"
 
 [compat]
 ADTypes = "1.9.0"
-AlgebraicMultigrid = "0.5, 0.6"
+AlgebraicMultigrid = "0.5, 0.6, 1"
 ArrayInterface = "6, 7"
 BenchmarkTools = "1"
 BracketingNonlinearSolve = "1"
@@ -43,17 +43,18 @@ DocumenterCitations = "1"
 DocumenterInterLinks = "1.0.0"
 IncompleteLU = "0.2"
 InteractiveUtils = "<0.0.1, 1"
-LinearSolve = "2"
+LinearSolve = "2, 3"
 NonlinearSolve = "4"
 NonlinearSolveBase = "1"
 NonlinearSolveFirstOrder = "1"
+NonlinearSolveHomotopyContinuation = "0.1"
 NonlinearSolveQuasiNewton = "1"
 NonlinearSolveSpectralMethods = "1"
 OrdinaryDiffEqTsit5 = "1.1.0"
 PETSc = "0.3"
 Plots = "1"
 Random = "1.10"
-SciMLBase = "2.58"
+SciMLBase = "2.69"
 SciMLJacobianOperators = "0.1"
 SimpleNonlinearSolve = "2"
 SparseConnectivityTracer = "0.6.5"

docs/make.jl

@@ -25,8 +25,8 @@ include("pages.jl")
 bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
 
 interlinks = InterLinks(
-    "ADTypes" => "https://sciml.github.io/ADTypes.jl/stable/",
-    "LineSearch" => "https://sciml.github.io/LineSearch.jl/dev/"
+    "ADTypes" => "https://docs.sciml.ai/ADTypes/dev/",
+    "LineSearch" => "https://docs.sciml.ai/LineSearch/dev/"
 )
 
 makedocs(;
@@ -46,7 +46,8 @@ makedocs(;
     linkcheck = true,
     linkcheck_ignore = [
         "https://twitter.com/ChrisRackauckas/status/1544743542094020615",
-        "https://link.springer.com/article/10.1007/s40096-020-00339-4"
+        "https://link.springer.com/article/10.1007/s40096-020-00339-4",
+        "https://dl.acm.org/doi/10.1145/210089.210111"
     ],
     checkdocs = :exports,
     warnonly = [:missing_docs],

docs/src/basics/diagnostics_api.md

@@ -20,7 +20,7 @@ solve process. This is controlled by 3 keyword arguments to `solve`:
 
 All the native NonlinearSolve.jl algorithms come with in-built
 [TimerOutputs.jl](https://github.com/KristofferC/TimerOutputs.jl) support. However, this
-is disabled by default and can be enabled via [`NonlinearSolve.enable_timer_outputs`](@ref).
+is disabled by default and can be enabled via [`NonlinearSolveBase.enable_timer_outputs`](@ref).
 
 Note that you will have to restart Julia to disable the timer outputs once enabled.
 

docs/src/basics/faq.md

@@ -72,28 +72,28 @@ differentiate the function based on the input types. However, this function has
 be a Dual number. This causes the error. To fix it:
 
  1. Specify the `autodiff` to be `AutoFiniteDiff`
-
-```@example dual_error_faq
-sol = solve(prob_oop, LevenbergMarquardt(; autodiff = AutoFiniteDiff());
-    maxiters = 10000, abstol = 1e-8)
-```
-
-This worked but, Finite Differencing is not the recommended approach in any scenario.
+    
+    ```@example dual_error_faq
+    sol = solve(prob_oop, LevenbergMarquardt(; autodiff = AutoFiniteDiff());
+        maxiters = 10000, abstol = 1e-8)
+    ```
+    
+    This worked but, Finite Differencing is not the recommended approach in any scenario.
 
  2. Rewrite the function to use
     [PreallocationTools.jl](https://github.com/SciML/PreallocationTools.jl) or write it as
-
-```@example dual_error_faq
-function fff_correct(var, p)
-    v_true = [1.0, 0.1, 2.0, 0.5]
-    xx = eltype(var)[1.0, 2.0, 3.0, 4.0]
-    xx[1] = var[1] - v_true[1]
-    return xx - v_true
-end
-
-prob_oop = NonlinearLeastSquaresProblem{false}(fff_correct, v_init)
-sol = solve(prob_oop, LevenbergMarquardt(); maxiters = 10000, abstol = 1e-8)
-```
+    
+    ```@example dual_error_faq
+    function fff_correct(var, p)
+        v_true = [1.0, 0.1, 2.0, 0.5]
+        xx = eltype(var)[1.0, 2.0, 3.0, 4.0]
+        xx[1] = var[1] - v_true[1]
+        return xx - v_true
+    end
+    
+    prob_oop = NonlinearLeastSquaresProblem{false}(fff_correct, v_init)
+    sol = solve(prob_oop, LevenbergMarquardt(); maxiters = 10000, abstol = 1e-8)
+    ```
 
 ## I thought NonlinearSolve.jl was type-stable and fast. But it isn't, why?
 

docs/src/native/bracketingnonlinearsolve.md

@@ -18,4 +18,5 @@ Bisection
 Falsi
 Ridder
 Brent
+Muller
 ```

docs/src/solvers/bracketing_solvers.md

@@ -26,13 +26,14 @@ This gives a robust and fast method, which therefore enjoys considerable popular
 
 ## Full List of Methods
 
-### SimpleNonlinearSolve.jl
+### BracketingNonlinearSolve.jl
 
 These methods are automatically included as part of NonlinearSolve.jl. Though, one can use
-SimpleNonlinearSolve.jl directly to decrease the dependencies and improve load time.
+BracketingNonlinearSolve.jl directly to decrease the dependencies and improve load time.
 
   - [`ITP`](@ref): A non-allocating ITP (Interpolate, Truncate & Project) method
   - [`Falsi`](@ref): A non-allocating regula falsi method
   - [`Bisection`](@ref): A common bisection method
   - [`Ridder`](@ref): A non-allocating Ridder method
   - [`Brent`](@ref): A non-allocating Brent method
+  - [`Muller`](@ref): A non-allocating Muller's method