Skip to content

Feature enable doctest #868

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
murrayrm merged 10 commits into from
Mar 27, 2023
Merged

Feature enable doctest #868

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
562701c
Enable doctest
henklaak Feb 21, 2023
c913c8f
Docs update
henklaak Feb 21, 2023
c4c275f
remove imports and use ct.fcn instead
murrayrm Mar 25, 2023
98fdb35
clean up/simplify docstring examples
murrayrm Mar 25, 2023
07cedd8
revert to use classes.pdf in doc/ (instead of classes.png)
murrayrm Mar 25, 2023
1d1c289
fix up rounding errors and matrix/array
murrayrm Mar 25, 2023
927f478
Merge branch 'main' into feature_enable_doctest
murrayrm Mar 25, 2023
c39bc87
fix up errors from merge with zpk feature
murrayrm Mar 25, 2023
983cbc0
revert use of round() in canonical examples (fix doctest failures next)
murrayrm Mar 27, 2023
df38286
skip doctests with rounding errors in GitHub Actions
murrayrm Mar 27, 2023
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
Prev Previous commit
Next Next commit
revert use of round() in canonical examples (fix doctest failures next)
  • Loading branch information
@murrayrm
murrayrm committed Mar 27, 2023
commit 983cbc072af7f864fd7917c5ed51bd6c02792e7b
16 changes: 8 additions & 8 deletions control/canonical.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ def canonical_form(xsys, form='reachable'):
--------
>>> Gs = ct.tf2ss([1], [1, 3, 2])
>>> Gc, T = ct.canonical_form(Gs) # default reachable
>>> Gc.B.round()
>>> Gc.B
array([[1.],
[0.]])

>>> Gc, T = ct.canonical_form(Gs, 'observable')
>>> Gc.C.round()
>>> Gc.C
array([[1., 0.]])

>>> Gc, T = ct.canonical_form(Gs, 'modal')
>>> Gc.A.round() # doctest: +SKIP
>>> Gc.A
array([[-2., 0.],
[ 0., -1.]])

Expand Down Expand Up @@ -89,7 +89,7 @@ def reachable_form(xsys):
--------
>>> Gs = ct.tf2ss([1], [1, 3, 2])
>>> Gc, T = ct.reachable_form(Gs) # default reachable
>>> Gc.B.round()
>>> Gc.B
array([[1.],
[0.]])

Expand Down Expand Up @@ -152,7 +152,7 @@ def observable_form(xsys):
--------
>>> Gs = ct.tf2ss([1], [1, 3, 2])
>>> Gc, T = ct.observable_form(Gs)
>>> Gc.C.round()
>>> Gc.C
array([[1., 0.]])

"""
Expand Down Expand Up @@ -217,13 +217,13 @@ def similarity_transform(xsys, T, timescale=1, inverse=False):
Examples
--------
>>> Gs = ct.tf2ss([1], [1, 3, 2])
>>> Gs.A.round()
>>> Gs.A
array([[-3., -2.],
[ 1., 0.]])

>>> T = np.array([[0, 1], [1, 0]])
>>> Gt = ct.similarity_transform(Gs, T)
>>> Gt.A.round()
>>> Gt.A
array([[ 0., 1.],
[-2., -3.]])

Expand Down Expand Up @@ -508,7 +508,7 @@ def modal_form(xsys, condmax=None, sort=False):
--------
>>> Gs = ct.tf2ss([1], [1, 3, 2])
>>> Gc, T = ct.modal_form(Gs) # default reachable
>>> Gc.A.round() # doctest: +SKIP
>>> Gc.A
array([[-2., 0.],
[ 0., -1.]])

Expand Down