-
Notifications
You must be signed in to change notification settings - Fork 1
/
linear_solver_stops.jl
59 lines (51 loc) · 1.74 KB
/
linear_solver_stops.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
############################################################################################
## This file is part of RLinearAlgebra.jl
##
## Overview: abstractions and methods for stopping a randomized linear system solver
##
## Contents
## - Abstract Types
## - `check_stop_criterion` Docstring
## - Stopping Criteria
## - Export Statements
##
############################################################################################
# Dependencies:
#############################################
# Abstract Types
#############################################
"""
LinSysStopCriterion
Abstract supertype for specifying stopping criteria for randomized linear solver.
"""
abstract type LinSysStopCriterion end
#############################################
# `check_stop_criterion` Docstring
#############################################
"""
check_stop_criterion(
log::LinSysSolverLog,
stop::LinSysStopCriterion
)
A common interface for specifying different strategies for stopping `log` with supertype
`LinSysSolverLog`. A `stop` of supertype `LinSysStopCriterion` can be used to provide
specific multiple implementations of stopping conditions for the same log type.
"""
function check_stop_criterion(
log::LinSysSolverLog,
stop::LinSysStopCriterion
)
return nothing
end
#############################################
# Stopping Criteria
#############################################
include("linear_solver_stops/stop_max_iter.jl")
include("linear_solver_stops/stop_ma_thres.jl")
include("linear_solver_stops/stop_thres.jl")
#############################################
# Export Statements
#############################################
# See RLinearAlgebra.jl
#export LinSysStopCriterion
#export LSStopMaxIterations