Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove optimise alias #36

Merged
merged 2 commits into from
Jun 7, 2024
Merged

Remove optimise alias #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf6d3b6
Remove alias
rafaelbailo Jun 7, 2024
9ce77f9
Merge branch 'main' into main
rafaelbailo Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/src/function_minimisation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
3 changes: 1 addition & 2 deletions src/CBS/CBS.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`."
Expand Down
1 change: 0 additions & 1 deletion src/ConsensusBasedX.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
2 changes: 0 additions & 2 deletions src/interface/minimise.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions src/interface/optimise.jl
View file
Open in desktop

This file was deleted.

Loading