Vd/documentation #315
Merged
Vd/documentation #315
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## master #315 +/- ##
=======================================
Coverage 82.83% 82.83%
=======================================
Files 60 60
Lines 4410 4410
=======================================
Hits 3653 3653
Misses 757 757
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Where can I see the documentation that has been generated ? |
adrienbanse
reviewed
Oct 22, 2023
docs/src/reference/Optim.md
Outdated
| @@ -1,14 +1,14 @@ | |||
| # Optim | |||
|
|
|||
| This folder contains all the different solvers that can be used. | |||
| This folder contains all the different (abstraction-based or not) solvers that can be used. Note that all the solvers are defined using the MathOptInterface framework: for each solver, we define the structure [`AbstractOptimizer`](https://jump.dev/MathOptInterface.jl/stable/reference/models/#MathOptInterface.AbstractOptimizer) and implement the [`Optimize!`](https://jump.dev/MathOptInterface.jl/stable/reference/models/#MathOptInterface.optimize!) function. | |||
There was a problem hiding this comment.
It's a subclass of AbstractOptimizer but not an object of this type
docs/src/reference/System.md
Outdated
| @@ -3,23 +3,36 @@ | |||
| This folder contains different ways to define systems, for instance to encode a controller. | |||
|
|
|||
| ## Control system | |||
|
|
|||
| Each control system should be implemented as a ControlSystem . | |||
docs/src/reference/System.md
Outdated
| Dionysos.System.ControlSystem | ||
| ``` | ||
|
|
||
| So far, we have implemented a few examples of control systems : |
src/domain/domain_list.jl
Outdated
| @@ -7,7 +7,7 @@ end | |||
| """ | |||
| DomainList{N,T,S<:Grid{N,T}} | |||
|
|
|||
| Struct for a basic domain based on a `Grid` | |||
| Struct for a basic domain based on a `Grid` . | |||
src/domain/grid.jl
Outdated
| @@ -113,7 +113,7 @@ end | |||
| GridEllipsoidalRectangular{N,T} <: Grid{N,T} | |||
|
|
|||
| Uniform grid on rectangular space `rect`, centered at `orig` and with steps set by the vector `h`. | |||
| Cells are (possibly overlapping) ellipsoids defined at each grid point `c` as `(x-c)'P(x-c) ≤ 1` | |||
| Cells are (possibly overlapping) ellipsoids defined at each grid point `c` as `(x-c)'P(x-c) ≤ 1` . | |||
src/optim/branch_and_bound.jl
Outdated
| @@ -16,7 +16,7 @@ using HybridSystems | |||
| """ | |||
| Optimizer{T} <: MOI.AbstractOptimizer | |||
|
|
|||
| Branch and bound solver | |||
| Branch and bound solver : Optimal control of hybrid systems via a predictive control scheme combining a branch and bound algorithm that can refine Q-functions using Lagrangian duality. | |||
src/system/controlsystem.jl
Outdated
|
|
||
| is the abstract type which defines a control system. |
There was a problem hiding this comment.
"that" instead of "which"?
src/system/controlsystem.jl
Outdated
| @@ -164,7 +170,7 @@ end | |||
| """ | |||
| SimpleSystem{N, T, F <: Function, F2} <: ControlSystem{N, T} | |||
|
|
|||
| TO ADD | |||
| is one implementation of the `ControlSystem` type | |||
src/system/trajectory.jl
Outdated
| @@ -10,7 +10,7 @@ using Polyhedra | |||
| DiscreteTrajectory{Q, TT} | |||
|
|
|||
| `q_0` is the starting mode and `transitions` is a sequence of discrete | |||
| transitions in the system | |||
| transitions in the system. | |||
src/system/trajectory.jl
Outdated
| @@ -37,7 +37,7 @@ end | |||
| ContinuousTrajectory{T, XVT<:AbstractVector{T}, UVT<:AbstractVector{T}} | |||
|
|
|||
| `x` is a sequence of points in the state space and `u` is a sequence of points | |||
| in the input space | |||
| in the input space. | |||
adrienbanse
approved these changes
Oct 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation + description folder utils + name project.toml