From c301be6166cdf0c85bc0f5590036cf49bc7d33af Mon Sep 17 00:00:00 2001 From: Olivier Cots <66357348+ocots@users.noreply.github.com> Date: Thu, 27 Jul 2023 17:44:15 -0400 Subject: [PATCH] v0.4.5 --- Project.toml | 2 +- docs/src/api.md | 2 +- src/CTDirect.jl | 2 +- src/solve.jl | 6 +++--- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Project.toml b/Project.toml index 628b6aa0..b9318b2c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "CTDirect" uuid = "790bbbee-bee9-49ee-8912-a9de031322d5" authors = ["Olivier Cots "] -version = "0.4.4" +version = "0.4.5" [deps] ADNLPModels = "54578032-b7ea-4c30-94aa-7cbd1cce6c9a" diff --git a/docs/src/api.md b/docs/src/api.md index 8e378c13..fc55b2b9 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -13,7 +13,7 @@ Private = false ```@example using CTDirect -Methods() +available_methods() ``` ## Documentation diff --git a/src/CTDirect.jl b/src/CTDirect.jl index 8b78c4e1..261aedfa 100644 --- a/src/CTDirect.jl +++ b/src/CTDirect.jl @@ -24,6 +24,6 @@ include("solve.jl") export solve export is_solvable export OptimalControlInit -export Methods +export available_methods end \ No newline at end of file diff --git a/src/solve.jl b/src/solve.jl index 343c0708..8313bdf7 100644 --- a/src/solve.jl +++ b/src/solve.jl @@ -7,7 +7,7 @@ $(TYPEDSIGNATURES) Return the list of available methods to solve the optimal control problem. """ -function Methods()::Tuple{Tuple{Vararg{Symbol}}} +function available_methods()::Tuple{Tuple{Vararg{Symbol}}} return algorithmes end @@ -43,7 +43,7 @@ Keyword arguments: !!! tip - - To see the list of available methods, simply call `Methods()`. + - To see the list of available methods, simply call `available_methods()`. - You can pass any other option by a pair `keyword=value` according to the chosen method. See for instance, [`Ipopt` options](https://coin-or.github.io/Ipopt/OPTIONS.html). - The default values for the keyword arguments are given [here](https://control-toolbox.org/CTDocs.jl/ctbase/stable/api-default.html). @@ -66,7 +66,7 @@ function solve(ocp::OptimalControlModel, # get full description from partial # throw error if description is not valid # thus, no else is needed below - method = getFullDescription(description, Methods()) + method = getFullDescription(description, available_methods()) # Model: from ocp to nlp if :adnlp in method