Detailed development docs

Author: avik-pal

Manifest.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.10.0"
 manifest_format = "2.0"
-project_hash = "2ecb05140fa52842af7b288b7753b90c53bb9e3c"
+project_hash = "f8ec89b048e63a09aa2dd683e874045fd757cebb"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "41c37aa88889c171f1300ceac1313c06e891d245"

Project.toml

@@ -81,6 +81,7 @@ NonlinearProblemLibrary = "0.1.2"
 OrdinaryDiffEq = "6.63"
 Pkg = "1"
 PrecompileTools = "1.2"
+Preferences = "1"
 Printf = "1"
 Random = "1.91"
 RecursiveArrayTools = "3.2"

docs/pages.jl

@@ -35,7 +35,11 @@ pages = ["index.md",
         "api/siamfanlequations.md",
         "api/speedmapping.md",
         "api/sundials.md"],
-    "Development Documentation" => [],
+    "Development Documentation" => ["devdocs/internal_interfaces.md",
+        "devdocs/linear_solve.md",
+        "devdocs/jacobian.md",
+        "devdocs/operators.md",
+        "devdocs/algorithm_helpers.md"],
     "Release Notes" => "release_notes.md",
     "References" => "references.md",
 ]

docs/src/basics/nonlinear_solution.md

@@ -4,6 +4,13 @@
 SciMLBase.NonlinearSolution
 ```
 
+## Statistics
+
+```@docs
+SciMLBase.NLStats
+NonlinearSolve.ImmutableNLStats
+```
+
 ## Return Code
 
 ```@docs

docs/src/devdocs/algorithm_helpers.md

@@ -0,0 +1,68 @@
+# Internal Algorithm Helpers
+
+## Pseudo Transient Method
+
+```@docs
+NonlinearSolve.SwitchedEvolutionRelaxation
+NonlinearSolve.SwitchedEvolutionRelaxationCache
+```
+
+## Approximate Jacobian Methods
+
+### Initialization
+
+```@docs
+NonlinearSolve.IdentityInitialization
+NonlinearSolve.TrueJacobianInitialization
+NonlinearSolve.BroydenLowRankInitialization
+```
+
+### Jacobian Structure
+
+```@docs
+NonlinearSolve.FullStructure
+NonlinearSolve.DiagonalStructure
+```
+
+### Jacobian Caches
+
+```@docs
+NonlinearSolve.InitializedApproximateJacobianCache
+```
+
+### Reset Methods
+
+```@docs
+NonlinearSolve.NoChangeInStateReset
+NonlinearSolve.IllConditionedJacobianReset
+```
+
+### Update Rules
+
+```@docs
+NonlinearSolve.GoodBroydenUpdateRule
+NonlinearSolve.BadBroydenUpdateRule
+NonlinearSolve.KlementUpdateRule
+```
+
+## Levenberg Marquardt Method
+
+```@docs
+NonlinearSolve.LevenbergMarquardtTrustRegion
+```
+
+## Trust Region Method
+
+```@docs
+NonlinearSolve.GenericTrustRegionScheme
+```
+
+## Miscelleneous
+
+```@docs
+SimpleNonlinearSolve.__nextfloat_tdir
+SimpleNonlinearSolve.__prevfloat_tdir
+SimpleNonlinearSolve.__max_tdir
+NonlinearSolve.callback_into_cache!
+NonlinearSolve.concrete_jac
+```

docs/src/devdocs/internal_interfaces.md

@@ -0,0 +1,53 @@
+# Internal Abstract Types
+
+## Solvers
+
+```@docs
+NonlinearSolve.AbstractNonlinearSolveAlgorithm
+NonlinearSolve.AbstractNonlinearSolveExtensionAlgorithm
+NonlinearSolve.AbstractNonlinearSolveCache
+```
+
+## Descent Algorithms
+
+```@docs
+NonlinearSolve.AbstractDescentAlgorithm
+NonlinearSolve.AbstractDescentCache
+```
+
+## Approximate Jacobian
+
+```@docs
+NonlinearSolve.AbstractApproximateJacobianStructure
+NonlinearSolve.AbstractJacobianInitialization
+NonlinearSolve.AbstractApproximateJacobianUpdateRule
+NonlinearSolve.AbstractApproximateJacobianUpdateRuleCache
+NonlinearSolve.AbstractResetCondition
+```
+
+## Damping Algorithms
+
+```@docs
+NonlinearSolve.AbstractDampingFunction
+NonlinearSolve.AbstractDampingFunctionCache
+```
+
+## Line Search
+
+```@docs
+NonlinearSolve.AbstractNonlinearSolveLineSearchAlgorithm
+NonlinearSolve.AbstractNonlinearSolveLineSearchCache
+```
+
+## Trust Region
+
+```@docs
+NonlinearSolve.AbstractTrustRegionMethod
+NonlinearSolve.AbstractTrustRegionMethodCache
+```
+
+## Tracing
+
+```@docs
+NonlinearSolve.AbstractNonlinearSolveTraceLevel
+```

docs/src/devdocs/jacobian.md

@@ -0,0 +1,13 @@
+# Jacobian Wrappers
+
+```@docs
+NonlinearSolve.AbstractNonlinearSolveJacobianCache
+NonlinearSolve.JacobianCache
+```
+
+## SimpleNonlinearSolve functions
+
+```@docs
+SimpleNonlinearSolve.jacobian_cache
+SimpleNonlinearSolve.value_and_jacobian
+```

docs/src/devdocs/linear_solve.md

@@ -0,0 +1,6 @@
+# Linear Solve
+
+```@docs
+NonlinearSolve.AbstractLinearSolverCache
+NonlinearSolve.LinearSolverCache
+```

docs/src/devdocs/operators.md

@@ -0,0 +1,28 @@
+# Custom SciML Operators
+
+## Abstract Operators
+
+```@docs
+NonlinearSolve.AbstractNonlinearSolveOperator
+```
+
+## Jacobian Operators
+
+```@docs
+NonlinearSolve.JacobianOperator
+NonlinearSolve.VecJacOperator
+NonlinearSolve.JacVecOperator
+```
+
+### Stateful Jacobian Operators
+
+```@docs
+NonlinearSolve.StatefulJacobianOperator
+NonlinearSolve.StatefulJacobianNormalFormOperator
+```
+
+## Low-Rank Jacobian Operators
+
+```@docs
+NonlinearSolve.BroydenLowRankJacobian
+```

docs/src/refs.bib

@@ -91,6 +91,13 @@ @article{la2006spectral
   year    = {2006}
 }
 
+@article{lepage2021alternating,
+  title   = {Alternating cyclic extrapolation methods for optimization algorithms},
+  author  = {Lepage-Saucier, Nicolas},
+  journal = {arXiv preprint arXiv:2104.04974},
+  year    = {2021}
+}
+
 @article{li2000derivative,
   title     = {A derivative-free line search and global convergence of Broyden-like method for nonlinear equations},
   author    = {Li, Dong-Hui and Fukushima, Masao},