Skip to content

Commit d44489f

Browse files
author
Jed
committed
Renamed cleanPart to _cleanPart since it is an internal function, as suggested by @murrayrm 
1 parent 509ff8e commit d44489f

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

‎control/tests/xferfcn_input_test.py

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from numpy import float, float16, float32, float64, float128
1111
from numpy import all, ndarray, array
1212

13-
from control.xferfcn import cleanPart
13+
from control.xferfcn import _cleanPart
1414

1515
class TestXferFcnInput(unittest.TestCase):
1616
"""These are tests for functionality of cleaning and validating
@@ -20,16 +20,16 @@ class TestXferFcnInput(unittest.TestCase):
2020
def testBadInputType(self):
2121
"""Give the part cleaner invalid input type."""
2222

23-
self.assertRaises(TypeError, cleanPart, [[0., 1.], [2., 3.]])
23+
self.assertRaises(TypeError, _cleanPart, [[0., 1.], [2., 3.]])
2424

2525
def testBadInputType2(self):
2626
"""Give the part cleaner another invalid input type."""
27-
self.assertRaises(TypeError, cleanPart, [1,"a"])
27+
self.assertRaises(TypeError, _cleanPart, [1,"a"])
2828

2929
def testScalar(self):
3030
"""Test single scalar value."""
3131
num = 1
32-
num_ = cleanPart(num)
32+
num_ = _cleanPart(num)
3333

3434
assert isinstance(num_, list)
3535
assert np.all([isinstance(part, list) for part in num_])
@@ -38,7 +38,7 @@ def testScalar(self):
3838
def testListScalar(self):
3939
"""Test single scalar value in list."""
4040
num = [1]
41-
num_ = cleanPart(num)
41+
num_ = _cleanPart(num)
4242

4343
assert isinstance(num_, list)
4444
assert np.all([isinstance(part, list) for part in num_])
@@ -47,7 +47,7 @@ def testListScalar(self):
4747
def testTupleScalar(self):
4848
"""Test single scalar value in tuple."""
4949
num = (1)
50-
num_ = cleanPart(num)
50+
num_ = _cleanPart(num)
5151

5252
assert isinstance(num_, list)
5353
assert np.all([isinstance(part, list) for part in num_])
@@ -56,7 +56,7 @@ def testTupleScalar(self):
5656
def testList(self):
5757
"""Test multiple values in a list."""
5858
num = [1, 2]
59-
num_ = cleanPart(num)
59+
num_ = _cleanPart(num)
6060

6161
assert isinstance(num_, list)
6262
assert np.all([isinstance(part, list) for part in num_])
@@ -65,7 +65,7 @@ def testList(self):
6565
def testTuple(self):
6666
"""Test multiple values in tuple."""
6767
num = (1, 2)
68-
num_ = cleanPart(num)
68+
num_ = _cleanPart(num)
6969

7070
assert isinstance(num_, list)
7171
assert np.all([isinstance(part, list) for part in num_])
@@ -75,7 +75,7 @@ def testAllScalarTypes(self):
7575
"""Test single scalar value for all valid data types."""
7676
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
7777
num = dtype(1)
78-
num_ = cleanPart(num)
78+
num_ = _cleanPart(num)
7979

8080
assert isinstance(num_, list)
8181
assert np.all([isinstance(part, list) for part in num_])
@@ -84,7 +84,7 @@ def testAllScalarTypes(self):
8484
def testNpArray(self):
8585
"""Test multiple values in numpy array."""
8686
num = np.array([1, 2])
87-
num_ = cleanPart(num)
87+
num_ = _cleanPart(num)
8888

8989
assert isinstance(num_, list)
9090
assert np.all([isinstance(part, list) for part in num_])
@@ -94,7 +94,7 @@ def testAllNumpyArrayTypes(self):
9494
"""Test scalar value in numpy array of ndim=0 for all data types."""
9595
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
9696
num = np.array(1, dtype=dtype)
97-
num_ = cleanPart(num)
97+
num_ = _cleanPart(num)
9898

9999
assert isinstance(num_, list)
100100
assert np.all([isinstance(part, list) for part in num_])
@@ -104,7 +104,7 @@ def testAllNumpyArrayTypes2(self):
104104
"""Test numpy array for all types."""
105105
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
106106
num = np.array([1, 2], dtype=dtype)
107-
num_ = cleanPart(num)
107+
num_ = _cleanPart(num)
108108

109109
assert isinstance(num_, list)
110110
assert np.all([isinstance(part, list) for part in num_])
@@ -114,7 +114,7 @@ def testListAllTypes(self):
114114
"""Test list of a single value for all data types."""
115115
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
116116
num = [dtype(1)]
117-
num_ = cleanPart(num)
117+
num_ = _cleanPart(num)
118118
assert isinstance(num_, list)
119119
assert np.all([isinstance(part, list) for part in num_])
120120
np.testing.assert_array_equal(num_[0][0], array([1.0], dtype=float))
@@ -123,7 +123,7 @@ def testListAllTypes2(self):
123123
"""List of list of numbers of all data types."""
124124
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
125125
num = [dtype(1), dtype(2)]
126-
num_ = cleanPart(num)
126+
num_ = _cleanPart(num)
127127
assert isinstance(num_, list)
128128
assert np.all([isinstance(part, list) for part in num_])
129129
np.testing.assert_array_equal(num_[0][0], array([1.0, 2.0], dtype=float))
@@ -132,7 +132,7 @@ def testTupleAllTypes(self):
132132
"""Test tuple of a single value for all data types."""
133133
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
134134
num = (dtype(1),)
135-
num_ = cleanPart(num)
135+
num_ = _cleanPart(num)
136136
assert isinstance(num_, list)
137137
assert np.all([isinstance(part, list) for part in num_])
138138
np.testing.assert_array_equal(num_[0][0], array([1.0], dtype=float))
@@ -141,31 +141,31 @@ def testTupleAllTypes2(self):
141141
"""Test tuple of a single value for all data types."""
142142
for dtype in [int, int8, int16, int32, int64, float, float16, float32, float64, float128]:
143143
num = (dtype(1), dtype(2))
144-
num_ = cleanPart(num)
144+
num_ = _cleanPart(num)
145145
assert isinstance(num_, list)
146146
assert np.all([isinstance(part, list) for part in num_])
147147
np.testing.assert_array_equal(num_[0][0], array([1, 2], dtype=float))
148148

149149
def testListListListInt(self):
150150
""" Test an int in a list of a list of a list."""
151151
num = [[[1]]]
152-
num_ = cleanPart(num)
152+
num_ = _cleanPart(num)
153153
assert isinstance(num_, list)
154154
assert np.all([isinstance(part, list) for part in num_])
155155
np.testing.assert_array_equal(num_[0][0], array([1.0], dtype=float))
156156

157157
def testListListListFloat(self):
158158
""" Test a float in a list of a list of a list."""
159159
num = [[[1.0]]]
160-
num_ = cleanPart(num)
160+
num_ = _cleanPart(num)
161161
assert isinstance(num_, list)
162162
assert np.all([isinstance(part, list) for part in num_])
163163
np.testing.assert_array_equal(num_[0][0], array([1.0], dtype=float))
164164

165165
def testListListListInts(self):
166166
"""Test 2 lists of ints in a list in a list."""
167167
num = [[[1,1],[2,2]]]
168-
num_ = cleanPart(num)
168+
num_ = _cleanPart(num)
169169

170170
assert isinstance(num_, list)
171171
assert np.all([isinstance(part, list) for part in num_])
@@ -175,7 +175,7 @@ def testListListListInts(self):
175175
def testListListListFloats(self):
176176
"""Test 2 lists of ints in a list in a list."""
177177
num = [[[1.0,1.0],[2.0,2.0]]]
178-
num_ = cleanPart(num)
178+
num_ = _cleanPart(num)
179179

180180
assert isinstance(num_, list)
181181
assert np.all([isinstance(part, list) for part in num_])
@@ -186,7 +186,7 @@ def testListListArray(self):
186186
"""List of list of numpy arrays for all valid types."""
187187
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
188188
num = [[array([1,1], dtype=dtype),array([2,2], dtype=dtype)]]
189-
num_ = cleanPart(num)
189+
num_ = _cleanPart(num)
190190

191191
assert isinstance(num_, list)
192192
assert np.all([isinstance(part, list) for part in num_])
@@ -197,7 +197,7 @@ def testTupleListArray(self):
197197
"""Tuple of list of numpy arrays for all valid types."""
198198
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
199199
num = ([array([1,1], dtype=dtype),array([2,2], dtype=dtype)],)
200-
num_ = cleanPart(num)
200+
num_ = _cleanPart(num)
201201

202202
assert isinstance(num_, list)
203203
assert np.all([isinstance(part, list) for part in num_])
@@ -208,7 +208,7 @@ def testListTupleArray(self):
208208
"""List of tuple of numpy array for all valid types."""
209209
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
210210
num = [(array([1,1], dtype=dtype),array([2,2], dtype=dtype))]
211-
num_ = cleanPart(num)
211+
num_ = _cleanPart(num)
212212

213213
assert isinstance(num_, list)
214214
assert np.all([isinstance(part, list) for part in num_])
@@ -220,7 +220,7 @@ def testTupleTuplesArrays(self):
220220
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
221221
num = ((array([1,1], dtype=dtype),array([2,2], dtype=dtype)),
222222
(array([3,4], dtype=dtype),array([4,4], dtype=dtype)))
223-
num_ = cleanPart(num)
223+
num_ = _cleanPart(num)
224224

225225
assert isinstance(num_, list)
226226
assert np.all([isinstance(part, list) for part in num_])
@@ -232,7 +232,7 @@ def testListTuplesArrays(self):
232232
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
233233
num = [(array([1,1], dtype=dtype),array([2,2], dtype=dtype)),
234234
(array([3,4], dtype=dtype),array([4,4], dtype=dtype))]
235-
num_ = cleanPart(num)
235+
num_ = _cleanPart(num)
236236

237237
assert isinstance(num_, list)
238238
assert np.all([isinstance(part, list) for part in num_])
@@ -244,7 +244,7 @@ def testListListArrays(self):
244244
for dtype in int, int8, int16, int32, int64, float, float16, float32, float64, float128:
245245
num = [[array([1,1], dtype=dtype),array([2,2], dtype=dtype)],
246246
[array([3,3], dtype=dtype),array([4,4], dtype=dtype)]]
247-
num_ = cleanPart(num)
247+
num_ = _cleanPart(num)
248248

249249
assert len(num_) == 2
250250
assert np.all([isinstance(part, list) for part in num_])
@@ -258,4 +258,4 @@ def suite():
258258
return unittest.TestLoader().loadTestsFromTestCase(TestXferFcnInput)
259259

260260
if __name__ == "__main__":
261-
unittest.main()
261+
unittest.main()

‎control/xferfcn.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ def __init__(self, *args):
128128
raise ValueError("Needs 1, 2 or 3 arguments; received %i."
129129
% len(args))
130130

131-
num = cleanPart(num)
132-
den = cleanPart(den)
131+
num = _cleanPart(num)
132+
den = _cleanPart(den)
133133

134134
inputs = len(num[0])
135135
outputs = len(num)
@@ -1318,7 +1318,7 @@ def tfdata(sys):
13181318

13191319
return (tf.num, tf.den)
13201320

1321-
def cleanPart(data):
1321+
def _cleanPart(data):
13221322
'''
13231323
Return a valid, cleaned up numerator or denominator
13241324
for the TransferFunction class.
@@ -1355,4 +1355,4 @@ def cleanPart(data):
13551355
# the meaning is.
13561356
raise TypeError("The numerator and denominator inputs must be \
13571357
scalars or vectors (for\nSISO), or lists of lists of vectors (for SISO or \
1358-
MIMO).")
1358+
MIMO).")

0 commit comments

Comments
 (0)