From d44bc84487d5f9c366e78cbb20e3cd907d38450d Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Fri, 16 Aug 2024 17:45:11 -0700 Subject: [PATCH 1/3] DOC: box_grid -> boxgrid + fix module path refs --- doc/plotting.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/doc/plotting.rst b/doc/plotting.rst index a4611f1bd..ebc0f7d33 100644 --- a/doc/plotting.rst +++ b/doc/plotting.rst @@ -1,5 +1,7 @@ .. _plotting-module: +.. currentmodule:: control + ************* Plotting data ************* @@ -408,10 +410,10 @@ are part of the :mod:`~control.phaseplot` (pp) module:: The following helper functions are available: .. autosummary:: - ~control.phaseplot.equilpoints - ~control.phaseplot.separatrices - ~control.phaseplot.streamlines - ~control.phaseplot.vectorfield + phaseplot.equilpoints + phaseplot.separatrices + phaseplot.streamlines + phaseplot.vectorfield The :func:`~control.phase_plane_plot` function calls these helper functions based on the options it is passed. @@ -653,10 +655,10 @@ Plotting functions ~control.nichols_plot ~control.nyquist_plot ~control.phase_plane_plot - ~control.phaseplot.equilpoints - ~control.phaseplot.separatrices - ~control.phaseplot.streamlines - ~control.phaseplot.vectorfield + phaseplot.equilpoints + phaseplot.separatrices + phaseplot.streamlines + phaseplot.vectorfield ~control.pole_zero_plot ~control.root_locus_plot ~control.singular_values_plot @@ -665,7 +667,6 @@ Plotting functions Utility functions ----------------- - These additional functions can be used to manipulate response data or carry out other operations in creating control plots. @@ -673,7 +674,7 @@ carry out other operations in creating control plots. .. autosummary:: :toctree: generated/ - ~control.box_grid + phaseplot.boxgrid ~control.combine_time_responses ~control.pole_zero_subplots ~control.reset_rcParams From 7b9664c64f8d3cc923dcb447268035f43fd5ca1d Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Fri, 16 Aug 2024 17:55:38 -0700 Subject: [PATCH 2/3] fix up a few referencs in optimal documentation --- doc/optimal.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/optimal.rst b/doc/optimal.rst index 4df8d4861..bc37607e1 100644 --- a/doc/optimal.rst +++ b/doc/optimal.rst @@ -221,7 +221,7 @@ state and/or input, either along the trajectory and at the terminal time. The optimal control module operates by converting the optimal control problem into a standard optimization problem that can be solved by :func:`scipy.optimize.minimize`. The optimal control problem can be solved -by using the :func:`~control.obc.solve_ocp` function:: +by using the :func:`~control.optimal.solve_ocp` function:: res = obc.solve_ocp(sys, timepts, X0, cost, constraints) @@ -467,6 +467,10 @@ formulations. Module classes and functions ============================ + +The following classes and functions are defined in the +``optimal`` module: + .. autosummary:: :toctree: generated/ :template: custom-class-template.rst From d176201230e31fe3bc17460d5614acf9e40c3086 Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Sat, 17 Aug 2024 05:34:04 -0700 Subject: [PATCH 3/3] fix additional broken links (from @slivingston review) --- doc/iosys.rst | 14 +++++++------- doc/plotting.rst | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/iosys.rst b/doc/iosys.rst index eb4311e05..9008a0e56 100644 --- a/doc/iosys.rst +++ b/doc/iosys.rst @@ -25,11 +25,11 @@ a :class:`~control.StateSpace` linear system. Use the ss_sys = ct.linearize(io_sys, xeq, ueq) Input/output systems are automatically created for state space LTI systems -when using the :func:`ss` function. Nonlinear input/output systems can be -created using the :func:`~control.nlsys` function, which requires -the definition of an update function (for the right hand side of the -differential or different equation) and an output function (computes the -outputs from the state):: +when using the :func:`~control.ss` function. Nonlinear input/output +systems can be created using the :func:`~control.nlsys` function, which +requires the definition of an update function (for the right hand side of +the differential or different equation) and an output function (computes +the outputs from the state):: io_sys = ct.nlsys(updfcn, outfcn, inputs=M, outputs=P, states=N) @@ -434,8 +434,8 @@ of an individual system are used in a given specification:: inplist=['sum.r', 'P.v'], outlist=['P', 'C.u'] ) -And finally, since we have named the signals throughout the system in -a consistent way, we could let :func:`ct.interconnect` do all of the +And finally, since we have named the signals throughout the system in a +consistent way, we could let :func:`~control.interconnect` do all of the work:: clsys5 = ct.interconnect( diff --git a/doc/plotting.rst b/doc/plotting.rst index ebc0f7d33..367e2c349 100644 --- a/doc/plotting.rst +++ b/doc/plotting.rst @@ -215,8 +215,8 @@ plot, use `plot_type='nichols'`:: .. image:: freqplot-siso_nichols-default.png -Another response function that can be used to generate Bode plots is -the :func:`~control.gangof4` function, which computes the four primary +Another response function that can be used to generate Bode plots is the +:func:`~control.gangof4_response` function, which computes the four primary sensitivity functions for a feedback control system in standard form:: proc = ct.tf([1], [1, 1, 1], name="process") pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy