Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Commit 409d36c

Browse files
committed
Remove docstrings to ensure users don't directly construct the batched solvers
1 parent 815fb11 commit 409d36c

File tree

2 files changed

+0
-30
lines changed

2 files changed

+0
-30
lines changed

src/batched/broyden.jl

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
"""
2-
BatchedBroyden(;
3-
termination_condition = NLSolveTerminationCondition(NLSolveTerminationMode.NLSolveDefault;
4-
abstol = nothing,
5-
reltol = nothing))
6-
7-
A low-overhead batched implementation of Broyden capable of solving multiple nonlinear
8-
problems simultaneously.
9-
10-
!!! note
11-
12-
To use this version, remember to load `NNlib`, i.e., `using NNlib` or
13-
`import NNlib` must be present in your code.
14-
"""
151
struct BatchedBroyden{TC <: NLSolveTerminationCondition} <:
162
AbstractBatchedNonlinearSolveAlgorithm
173
termination_condition::TC

src/batched/raphson.jl

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,3 @@
1-
"""
2-
SimpleBatchedNewtonRaphson(; chunk_size = Val{0}(),
3-
autodiff = Val{true}(),
4-
diff_type = Val{:forward},
5-
termination_condition = NLSolveTerminationCondition(NLSolveTerminationMode.NLSolveDefault;
6-
abstol = nothing,
7-
reltol = nothing))
8-
9-
A low-overhead batched implementation of Newton-Raphson capable of solving multiple
10-
nonlinear problems simultaneously.
11-
12-
!!! note
13-
14-
To use the `batched` version, remember to load `AbstractDifferentiation` and
15-
`LinearSolve`.
16-
"""
171
struct SimpleBatchedNewtonRaphson{AD, LS, TC <: NLSolveTerminationCondition} <:
182
AbstractBatchedNonlinearSolveAlgorithm
193
autodiff::AD

0 commit comments

Comments
 (0)