rename engine related functions

Author: Maximilian-Stefan-Ernst

ext/SEMNLOptExt/NLopt.jl

@@ -109,7 +109,7 @@ end
 
 SEM.SemOptimizer(::Val{:NLopt}, args...; kwargs...) = SemOptimizerNLopt(args...; kwargs...)
 
-SEM.engine_info(engine::Val{:NLopt}) = doc(SemOptimizerNLopt)
+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.engine_info(engine::Val{:Proximal}) = doc(SemOptimizerProximal)
+SEM.optimizer_engine_doc(engine::Val{:Proximal}) = doc(SemOptimizerProximal)
 
 """
 Connects to `ProximalAlgorithms.jl` as the optimization backend. For more information on 

src/StructuralEquationModels.jl

@@ -124,7 +124,7 @@ export AbstractSem,
     SemWLS,
     loss,
     SemOptimizer,
-    engine_info,
+    optimizer_engine_doc,
     optimizer_engines,
     optimizer,
     n_iterations,

src/frontend/fit/SemFit.jl

@@ -41,7 +41,7 @@ function Base.show(io::IO, semfit::SemFit)
     print(io, "------------- Optimization result ------------- \n")
     print(io, "\n")
     print(io, "engine: ")
-    print(io, engine(semfit))
+    print(io, optimizer_engine(semfit))
     print(io, "\n")
     print(io, "\n")
     print(io, semfit.optimization_result)
@@ -63,7 +63,7 @@ model(sem_fit::SemFit) = sem_fit.model
 optimization_result(sem_fit::SemFit) = sem_fit.optimization_result
 
 # optimizer properties
-engine(sem_fit::SemFit) = engine(sem_fit.optimizer)
+optimizer_engine(sem_fit::SemFit) = optimizer_engine(sem_fit.optimizer)
 optimizer(sem_fit::SemFit) = optimizer(optimization_result(sem_fit))
 n_iterations(sem_fit::SemFit) = n_iterations(optimization_result(sem_fit))
 convergence(sem_fit::SemFit) = convergence(optimization_result(sem_fit))

src/optimizer/Empty.jl

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

src/optimizer/abstract.jl

@@ -1,5 +1,5 @@
-engine(::Type{<:SemOptimizer{E}}) where {E} = E
-engine(::SemOptimizer{E}) where {E} = E
+optimizer_engine(::Type{<:SemOptimizer{E}}) where {E} = E
+optimizer_engine(::SemOptimizer{E}) where {E} = E
 
 """
     SemOptimizer(args...; engine::Symbol = :Optim, kwargs...)
@@ -9,7 +9,7 @@ of the numerical optimization involved in fitting a SEM.
 
 The keyword `engine` controlls which Julia package is used, with `:Optim` being the default.
 - `optimizer_engines()` prints a list of currently available engines.
-- `engine_info(EngineName)` prints information on the usage of a specific engine.
+- `optimizer_engine_doc(EngineName)` prints information on the usage of a specific engine.
 
 More engines become available if specific packages are loaded, for example 
 [*NLopt.jl*](https://github.com/JuliaOpt/NLopt.jl) (also see [Constrained optimization](@ref) 
@@ -19,7 +19,7 @@ in the online documentation) or
 
 The additional arguments `args...` and `kwargs...` are engine-specific and control further
 aspects of the optimization process, such as the algorithm, convergence criteria or constraints.
-Information on those can be accessed with `engine_info`.
+Information on those can be accessed with `optimizer_engine_doc`.
 
 To connect the SEM package to a completely new optimization backend, you can implement a new 
 subtype of SemOptimizer.
@@ -51,17 +51,17 @@ the [`SemOptimizer`](@ref) constructor.
 The list of engines depends on the Julia packages loaded (with the `using` directive)
 into the current session.
 """
-optimizer_engines() = Symbol[engine(opt_type) for opt_type in subtypes(SemOptimizer)]
+optimizer_engines() = Symbol[optimizer_engine(opt_type) for opt_type in subtypes(SemOptimizer)]
 
 """
-    engine_info(engine::Symbol)
+    optimizer_engine_doc(engine::Symbol)
 
 Shows information on the optimizer engine.
 For a list of available engines, call `optimizer_engines`.
 """
-engine_info(engine) = engine_info(Val(engine))
+optimizer_engine_doc(engine) = optimizer_engine_doc(Val(engine))
 
-engine_info(engine::Val) = 
+optimizer_engine_doc(engine::Val) = 
     throw(ArgumentError("Unknown engine. Did you forget to load the necessary packages?"))
 
 """

src/optimizer/optim.jl

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