Skip to content

add documentation for use_numpy_matrix #323

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 1 commit into from
Jul 2, 2019
Merged

add documentation for use_numpy_matrix #323

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
18 changes: 17 additions & 1 deletion control/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
_use_numpy_matrix = True # Decide whether to use numpy.marix

def reset_defaults():
"""Reset configuration values to their default values."""
"""Reset package configuration values to their default values."""
global bode_dB; bode_dB = False
global bode_deg; bode_deg = True
global bode_Hz; bode_Hz = False
Expand Down Expand Up @@ -61,6 +61,22 @@ def use_fbs_defaults():

# Decide whether to use numpy.matrix for state space operations
def use_numpy_matrix(flag=True, warn=True):
"""Turn on/off use of Numpy `matrix` class for state space operations.

Parameters
----------
flag : bool
If flag is `True` (default), use the Numpy (soon to be deprecated)
`matrix` class to represent matrices in the `~control.StateSpace`
class and functions. If flat is `False`, then matrices are represnted

@bnavigator bnavigator Jul 2, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo in represented

@murrayrm murrayrm Jul 2, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Will fix that in a subsequent PR.

by a 2D `ndarray` object.

warn : bool
If flag is `True` (default), issue a warning when turning on the use
of the Numpy `matrix` class. Set `warn` to false to omit display of
the warning message.

"""
if flag and warn:
warnings.warn("Return type numpy.matrix is soon to be deprecated.",
stacklevel=2)
Expand Down
2 changes: 2 additions & 0 deletions doc/control.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ Utility functions and conversions
observable_form
pade
reachable_form
reset_defaults
sample_system
ss2tf
ssdata
Expand All @@ -166,3 +167,4 @@ Utility functions and conversions
unwrap
use_fbs_defaults
use_matlab_defaults
use_numpy_matrix
4 changes: 3 additions & 1 deletion doc/conventions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,8 @@ Functions that can be used to set standard configurations:

.. autosummary::
:toctree: generated/


reset_defaults
use_fbs_defaults
use_matlab_defaults
use_numpy_matrix