Skip to content

Commit

Permalink
doc string
Browse files Browse the repository at this point in the history
  • Loading branch information
s-m-e committed Apr 29, 2024
1 parent eff4f8a commit 97b4c93
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions src/hapsira/core/math/ivp/_rkdenseinterp.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,25 @@ def dop853_dense_interp_hf(t, t_old, h, rr_old, vv_old, F):
Parameters
----------
t : float or array_like with shape (n_points,)
Points to evaluate the solution at.
t : float
Current time.
t_old : float
Previous time.
h : float
Step to use.
rr_rold : tuple[float,float,float]
Last values 0:3.
vv_vold : tuple[float,float,float]
Last values 3:6.
F : tuple[tuple[float,...]...]
Dense output coefficients.
Returns
-------
y : ndarray, shape (n,) or (n, n_points)
Computed values. Shape depends on whether `t` was a scalar or a
1-D array.
rr : tuple[float,float,float]
Computed values 0:3.
vv : tuple[float,float,float]
Computed values 3:6.
"""

F00, F01, F02, F03, F04, F05, F06 = F
Expand Down

0 comments on commit 97b4c93

Please sign in to comment.