Merge pull request #36 from rafaelbailo/main

Remove optimise alias
PdIPS · Jun 7, 2024 · c45084b · c45084b
2 parents a5bc13a + 9ce77f9
commit c45084b
Show file tree

Hide file tree

Showing 5 changed files with 1 addition and 12 deletions.
diff --git a/docs/src/function_minimisation.md b/docs/src/function_minimisation.md
@@ -29,11 +29,6 @@ This is a version of the full-code example above, using `config` instead:
 {{basic_usage/minimise_with_config.jl}}
 
 
-## Aliases
-
-ConsensusBasedX.jl also defines `optimise` as an alias of `minimise`.
-
-
 ## Receiving extended output
 
 It is possible to receive extended output from `minimise` by passing the option `extended_output = true`:

diff --git a/src/CBS/CBS.jl b/src/CBS/CBS.jl
@@ -29,8 +29,7 @@ end
 
   if Symbol(CBS_mode) == :sampling
     λ = 1 / (1 + α)
-  elseif Symbol(CBS_mode) in
-         [:minimise, :minimisation, :optimise, :optimisation]
+  elseif Symbol(CBS_mode) in [:minimise, :minimisation]
     λ = 1
   else
     explanation = "`CBS_mode` should be either `:sampling` or `:minimise`."

diff --git a/src/ConsensusBasedX.jl b/src/ConsensusBasedX.jl
@@ -21,7 +21,6 @@ include("./interface/config.jl")
 include("./interface/initialise_particles.jl")
 include("./interface/maximise.jl")
 include("./interface/minimise.jl")
-include("./interface/optimise.jl")
 include("./interface/parse_config.jl")
 include("./interface/sample.jl")
 

diff --git a/src/interface/minimise.jl b/src/interface/minimise.jl
@@ -11,8 +11,6 @@ Minimise the function `f` using Consensus-Based Optimisation (see [Function mini
 
 You must specify the dimension `D` of the problem. Other parameters (e.g. the number of particles `N` or the number of ensembles `M`) can also be specified; see [Summary of options](@ref).
 
-`optimise` is an alias for `minimise`.
-
 # Examples
 
 ```julia

diff --git a/src/interface/optimise.jl b/src/interface/optimise.jl