SemOptimizer_impltype(engine)

return the type that implements SemOptimizer{engine}

Author: Alexey Stukalov

ext/SEMNLOptExt/NLopt.jl

@@ -13,6 +13,8 @@ struct SemOptimizerNLopt <: SemOptimizer{:NLopt}
     inequality_constraints::Vector{NLoptConstraint}
 end
 
+SEM.SemOptimizer_impltype(::Val{:NLopt}) = SemOptimizerNLopt
+
 ############################################################################################
 ### Constructor
 ############################################################################################
@@ -109,8 +111,6 @@ end
 
 SEM.SemOptimizer(::Val{:NLopt}, args...; kwargs...) = SemOptimizerNLopt(args...; kwargs...)
 
-SEM.optimizer_engine_doc(engine::Val{:NLopt}) = doc(SemOptimizerNLopt)
-
 ############################################################################################
 ### Recommended methods
 ############################################################################################

ext/SEMProximalOptExt/ProximalAlgorithms.jl

@@ -9,7 +9,7 @@ end
 
 SEM.SemOptimizer{:Proximal}(args...; kwargs...) = SemOptimizerProximal(args...; kwargs...)
 
-SEM.optimizer_engine_doc(engine::Val{:Proximal}) = doc(SemOptimizerProximal)
+SEM.SemOptimizer_impltype(::Val{:Proximal}) = SemOptimizerProximal
 
 """
 Connects to `ProximalAlgorithms.jl` as the optimization backend. For more information on 

src/optimizer/Empty.jl

@@ -14,7 +14,7 @@ struct SemOptimizerEmpty <: SemOptimizer{:Empty} end
 
 SemOptimizer(::Val{:Empty}) = SemOptimizerEmpty()
 
-optimizer_engine_doc(engine::Val{:Empty}) = doc(SemOptimizerEmpty)
+SemOptimizer_impltype(::Val{:Empty}) = SemOptimizerEmpty
 
 ############################################################################################
 ### Recommended methods

src/optimizer/abstract.jl

@@ -64,15 +64,20 @@ into the current session.
 """
 optimizer_engines() = Symbol[optimizer_engine(opt_type) for opt_type in subtypes(SemOptimizer)]
 
+# return the type implementing SemOptimizer{engine}
+# should be overridden in the extension
+SemOptimizer_impltype(engine::Symbol) = SemOptimizer_impltype(Val(engine))
+
+SemOptimizer_impltype(::Val{E}) where {E} = throw_engine_error(E)
+
 """
     optimizer_engine_doc(engine::Symbol)
 
-Shows information on the optimizer engine.
-For a list of available engines, call `optimizer_engines`.
-"""
-optimizer_engine_doc(engine) = optimizer_engine_doc(Val(engine))
+Shows documentation for the optimizer engine.
 
-optimizer_engine_doc(::Val{E}) where {E} = throw_engine_error(E)
+For a list of available engines, call [`optimizer_engines`](@ref).
+"""
+optimizer_engine_doc(engine) = doc(SemOptimizer_impltype(engine))
 
 """
     fit([optim::SemOptimizer], model::AbstractSem;

src/optimizer/optim.jl

@@ -61,7 +61,7 @@ SemOptimizerOptim(;
 
 SemOptimizer(::Val{:Optim}, args...; kwargs...) = SemOptimizerOptim(args...; kwargs...)
 
-SEM.optimizer_engine_doc(engine::Val{:Optim}) = doc(SemOptimizerOptim)
+SemOptimizer_impltype(::Val{:Optim}) = SemOptimizerOptim
 
 ############################################################################################
 ### Recommended methods