Skip to content

[RTR] scoot docstrings #529

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

Merged
pariterre merged 1 commit into from
Sep 8, 2022
Merged

[RTR] scoot docstrings #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions bioptim/dynamics/integrator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ class Integrator:
The parameters variables scaling factor
fun: Callable
The dynamic function which provides the derivative of the states
implicit_fun: Callable
The implicit dynamic function which provides the defects of the dynamics
control_type: ControlType
The type of the controls
step_time: float
Expand Down
8 changes: 8 additions & 0 deletions bioptim/dynamics/ode_solver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@ class COLLOCATION(OdeSolverBase):
----------
polynomial_degree: int
The degree of the implicit RK
method : str
The method of interpolation ("legendre" or "radau")
defects_type: DefectType
The type of defect to use (DefectType.EXPLICIT or DefectType.IMPLICIT)

Methods
-------
Expand Down Expand Up @@ -309,6 +313,10 @@ class IRK(COLLOCATION):
----------
polynomial_degree: int
The degree of the implicit RK
method: str
The method of interpolation ("legendre" or "radau")
defects_type: DefectType
The type of defect to use (DefectType.EXPLICIT or DefectType.IMPLICIT)

Methods
-------
Expand Down