Skip to content

Commit 2f5f464

Browse files
author
Alexey Stukalov
committed
rename sem_optimizer_subtype
1 parent 6c81fad commit 2f5f464

File tree

6 files changed

+10
-9
lines changed

6 files changed

+10
-9
lines changed

docs/src/developer/optimizer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ end
1616

1717
SemOptimizer(Val{:Myopt}, args...; kwargs...) = SemOptimizerMyopt(args...; kwargs...)
1818

19-
SemOptimizer_impltype(::Val{:Myopt}) = SemOptimizerMyopt
19+
sem_optimizer_subtype(::Val{:Myopt}) = SemOptimizerMyopt
2020

2121
SemOptimizerMyopt(;
2222
algorithm = LBFGS(),

ext/SEMNLOptExt/NLopt.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ struct SemOptimizerNLopt <: SemOptimizer{:NLopt}
1313
inequality_constraints::Vector{NLoptConstraint}
1414
end
1515

16-
SEM.SemOptimizer_impltype(::Val{:NLopt}) = SemOptimizerNLopt
16+
SEM.sem_optimizer_subtype(::Val{:NLopt}) = SemOptimizerNLopt
1717

1818
############################################################################################
1919
### Constructor

ext/SEMProximalOptExt/ProximalAlgorithms.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ end
99

1010
SEM.SemOptimizer{:Proximal}(args...; kwargs...) = SemOptimizerProximal(args...; kwargs...)
1111

12-
SEM.SemOptimizer_impltype(::Val{:Proximal}) = SemOptimizerProximal
12+
SEM.sem_optimizer_subtype(::Val{:Proximal}) = SemOptimizerProximal
1313

1414
"""
1515
SemOptimizerProximal(;

src/optimizer/Empty.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ struct SemOptimizerEmpty <: SemOptimizer{:Empty} end
1919

2020
SemOptimizer(::Val{:Empty}) = SemOptimizerEmpty()
2121

22-
SemOptimizer_impltype(::Val{:Empty}) = SemOptimizerEmpty
22+
sem_optimizer_subtype(::Val{:Empty}) = SemOptimizerEmpty
2323

2424
############################################################################################
2525
### Recommended methods

src/optimizer/abstract.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ optimizer_engines() =
6666
Symbol[optimizer_engine(opt_type) for opt_type in subtypes(SemOptimizer)]
6767

6868
# return the type implementing SemOptimizer{engine}
69-
# should be overridden in the extension
70-
SemOptimizer_impltype(engine::Symbol) = SemOptimizer_impltype(Val(engine))
69+
# the method should be overridden in the extension
70+
sem_optimizer_subtype(engine::Symbol) = sem_optimizer_subtype(Val(engine))
7171

72-
SemOptimizer_impltype(::Val{E}) where {E} = throw_engine_error(E)
72+
# fallback method for unsupported engines
73+
sem_optimizer_subtype(::Val{E}) where {E} = throw_engine_error(E)
7374

7475
"""
7576
optimizer_engine_doc(engine::Symbol)
@@ -78,7 +79,7 @@ Shows documentation for the optimizer engine.
7879
7980
For a list of available engines, call [`optimizer_engines`](@ref).
8081
"""
81-
optimizer_engine_doc(engine) = doc(SemOptimizer_impltype(engine))
82+
optimizer_engine_doc(engine) = doc(sem_optimizer_subtype(engine))
8283

8384
optimizer(result::SemOptimizerResult) = result.optimizer
8485

src/optimizer/optim.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ SemOptimizerOptim(;
6161

6262
SemOptimizer(::Val{:Optim}, args...; kwargs...) = SemOptimizerOptim(args...; kwargs...)
6363

64-
SemOptimizer_impltype(::Val{:Optim}) = SemOptimizerOptim
64+
sem_optimizer_subtype(::Val{:Optim}) = SemOptimizerOptim
6565

6666
############################################################################################
6767
### Recommended methods

0 commit comments

Comments
 (0)