Skip to content

Commit f48161b

Browse files
committed
Update documentaion for Matlab module
Matlab module documentation is now in the same format as the main module, with one routine per html page.
1 parent c51d665 commit f48161b

3 files changed

Lines changed: 146 additions & 4 deletions

File tree

control/matlab/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
from .timeresp import *
9393
from .wrappers import *
9494

95-
__doc__ += r"""
95+
r"""
9696
The following tables give an overview of the module ``control.matlab``.
9797
They also show the implementation progress and the planned features of the
9898
module.

doc/control.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ System creation
1717

1818
ss
1919
tf
20+
rss
21+
drss
2022

2123
Frequency domain plotting
2224
=========================
@@ -181,7 +183,6 @@ Utility functions and conversions
181183
unwrap
182184
db2mag
183185
mag2db
184-
drss
185186
isctime
186187
isdtime
187188
issys

doc/matlab.rst

Lines changed: 143 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,147 @@
11
.. _matlab-module:
22

3-
MATLAB compatibility module
4-
===========================
3+
=============================
4+
MATLAB compatibility module
5+
=============================
56

67
.. automodule:: control.matlab
8+
:no-members:
9+
:no-inherited-members:
10+
11+
.. currentmodule:: control.matlab
12+
13+
Creating linear models
14+
======================
15+
.. autosummary::
16+
:toctree: generated/
17+
18+
tf
19+
ss
20+
frd
21+
rss
22+
drss
23+
24+
Utility functions and conversions
25+
=================================
26+
.. autosummary::
27+
:toctree: generated/
28+
29+
mag2db
30+
db2mag
31+
c2d
32+
ss2tf
33+
tf2ss
34+
tfdata
35+
36+
System interconnections
37+
=======================
38+
.. autosummary::
39+
:toctree: generated/
40+
41+
series
42+
parallel
43+
feedback
44+
negate
45+
connect
46+
append
47+
48+
System gain and dynamics
49+
========================
50+
.. autosummary::
51+
:toctree: generated/
52+
53+
dcgain
54+
pole
55+
zero
56+
damp
57+
pzmap
58+
59+
Time-domain analysis
60+
====================
61+
.. autosummary::
62+
:toctree: generated/
63+
64+
step
65+
impulse
66+
initial
67+
lsim
68+
69+
Frequency-domain analysis
70+
=========================
71+
.. autosummary::
72+
:toctree: generated/
73+
74+
bode
75+
nyquist
76+
nichols
77+
margin
78+
freqresp
79+
evalfr
80+
81+
Compensator design
82+
==================
83+
.. autosummary::
84+
:toctree: generated/
85+
86+
rlocus
87+
place
88+
lqr
89+
90+
State-space (SS) models
91+
=======================
92+
.. autosummary::
93+
:toctree: generated/
94+
95+
rss
96+
drss
97+
ctrb
98+
obsv
99+
gram
100+
101+
Model simplification
102+
====================
103+
.. autosummary::
104+
:toctree: generated/
105+
106+
minreal
107+
hsvd
108+
balred
109+
modred
110+
era
111+
markov
112+
113+
Time delays
114+
===========
115+
.. autosummary::
116+
:toctree: generated/
117+
118+
pade
119+
120+
Matrix equation solvers and linear algebra
121+
==========================================
122+
.. autosummary::
123+
:toctree: generated/
124+
125+
lyap
126+
dlyap
127+
care
128+
dare
129+
130+
Additional functions
131+
====================
132+
.. autosummary::
133+
:toctree: generated/
134+
135+
gangof4
136+
unwrap
137+
138+
Functions imported from other modules
139+
=====================================
140+
.. autosummary::
141+
142+
~numpy.linspace
143+
~numpy.logspace
144+
~scipy.signal.ss2zpk
145+
~scipy.signal.tf2zpk
146+
~scipy.signal.zpk2ss
147+
~scipy.signal.zpk2tf

0 commit comments

Comments
 (0)