Skip to content

Commit 07b6ab2

Browse files
authored
Merge pull request #636 from JuliaHomotopyContinuation/singular_min_accuracy_doc
add documentation for singular_min_accuracy
2 parents 0cac932 + bfd961a commit 07b6ab2

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/endgame_tracker.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,12 @@ These parameters control the behaviour during the endgame.
3535
endgame strategy is considered to be applied.
3636
* `min_coord_growth = 100`: The minimal relative growth of a coordinate necessary to
3737
to be considered going to infininity (resp. zero).
38+
* `singular_min_accuracy = 1e-6`: A solution can be treated with a singular endgame method only if its [`accuracy`](@ref) is below this threshold. Otherwise, the solution will either be refined or labeled as unsuccessfully terminated.
3839
* `val_at_infinity_tol = 1e-3`: Tolerance on the valuation which has to be
3940
satisfied before a path is considered to diverge / go to infinity.
4041
* `val_finite_tol = 1e-3`: Tolerance on the valuation which has to be satisfied before the endgame is started.
4142
* `sing_cond = 1e14`: value for the condition number above which a solution is considered singular.
42-
* `sing_accuracy = 1e-12`: value for the accuracy number above which a solution is considered singular.
43+
* `sing_accuracy = 1e-12`: value for the [`accuracy`](@ref) above which a solution is considered singular.
4344
* `scaling_threshold = -30.0`: Row scaling of matrices is only applied to rows with `e < scaling_threshold`, where is the norm of the row is estimated to be `2^e`. See [`skeel_row_scaling`](@skeel_row_scaling) for details.
4445
* `refine_steps = 3`: number of steps for refining solutions at the end.
4546
"""

0 commit comments

Comments
 (0)