Repository navigation
Expand file tree
/
Copy pathanalysis.py
More file actions
1733 lines (1604 loc) · 80.7 KB
/
Copy pathanalysis.py
File metadata and controls
1733 lines (1604 loc) · 80.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# analysis.py
#
# Copyright 2010 Enrico Avventi <avventi@Lonewolf>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
from . import _wrapper
from .exceptions import raise_if_slycot_error, SlycotParameterError
def ab01nd(n,m,A,B,jobz='N',tol=0,ldwork=None):
""" Ac,Bc,ncont,indcon,nblk,Z,tau = ab01nd_i(n,m,A,B,[jobz,tol,ldwork])
To find a controllable realization for the linear time-invariant
multi-input system
dX/dt = A * X + B * U,
where A and B are N-by-N and N-by-M matrices, respectively,
which are reduced by this routine to orthogonal canonical form
using (and optionally accumulating) orthogonal similarity
transformations. Specifically, the pair (A, B) is reduced to
the pair (Ac, Bc), Ac = Z' * A * Z, Bc = Z' * B, given by
[ Acont * ] [ Bcont ]
Ac = [ ], Bc = [ ],
[ 0 Auncont ] [ 0 ]
and
[ A11 A12 . . . A1,p-1 A1p ] [ B1 ]
[ A21 A22 . . . A2,p-1 A2p ] [ 0 ]
[ 0 A32 . . . A3,p-1 A3p ] [ 0 ]
Acont = [ . . . . . . . ], Bc = [ . ],
[ . . . . . . ] [ . ]
[ . . . . . ] [ . ]
[ 0 0 . . . Ap,p-1 App ] [ 0 ]
where the blocks B1, A21, ..., Ap,p-1 have full row ranks and
p is the controllability index of the pair. The size of the
block Auncont is equal to the dimension of the uncontrollable
subspace of the pair (A, B).
Required arguments:
n : input int
The order of the original state-space representation, i.e.
the order of the matrix A. N > 0.
m : input int
The number of system inputs, or of columns of B. M > 0.
A : rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the original
state dynamics matrix A.
B : rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input
matrix B.
Optional arguments:
jobz := 'N' input string(len=1)
Indicates whether the user wishes to accumulate in a matrix Z
the orthogonal similarity transformations for reducing the system,
as follows:
= 'N': Do not form Z and do not store the orthogonal transformations;
= 'F': Do not form Z, but store the orthogonal transformations in
the factored form;
= 'I': Z is initialized to the unit matrix and the orthogonal
transformation matrix Z is returned.
tol := 0 input float
The tolerance to be used in rank determination when transforming
(A, B). If tol <= 0 a default value is used.
ldwork := max(n,3*m) input int
The length of the cache array. ldwork >= max(n, 3*m).
For optimum performance it should be larger.
Return objects:
Ac : rank-2 array('d') with bounds (n,n)
The leading ncont-by-ncont part contains the upper block
Hessenberg state dynamics matrix Acont in Ac, given by Z'*A*Z,
of a controllable realization for the original system. The
elements below the first block-subdiagonal are set to zero.
Bc : rank-2 array('d') with bounds (n,m)
The leading ncont-by-m part of this array contains the transformed
input matrix Bcont in Bc, given by Z'*B, with all elements but the
first block set to zero.
ncont : int
The order of the controllable state-space representation.
indcon : int
The controllability index of the controllable part of the system
representation.
nblk : rank-1 array('i') with bounds (n)
The leading indcon elements of this array contain the the orders of
the diagonal blocks of Acont.
Z : rank-2 array('d') with bounds (n,n)
If jobz = 'I', then the leading N-by-N part of this array contains
the matrix of accumulated orthogonal similarity transformations
which reduces the given system to orthogonal canonical form.
If jobz = 'F', the elements below the diagonal, with the array tau,
represent the orthogonal transformation matrix as a product of
elementary reflectors. The transformation matrix can then be
obtained by calling the LAPACK Library routine DORGQR.
If jobz = 'N', the array Z is None.
tau : rank-1 array('d') with bounds (n)
The elements of tau contain the scalar factors of the
elementary reflectors used in the reduction of B and A."""
hidden = ' (hidden by the wrapper)'
arg_list = ['jobz', 'n', 'm', 'A', 'LDA'+hidden, 'B', 'LDB'+hidden,
'ncont', 'indcon', 'nblk', 'Z', 'LDZ'+hidden, 'tau', 'tol',
'IWORK'+hidden, 'DWORK'+hidden, 'ldwork', 'info'+hidden]
wrappermap = {"N": _wrapper.ab01nd_n,
"I": _wrapper.ab01nd_i,
"F": _wrapper.ab01nd_f}
if ldwork is None:
ldwork = max(n, 3*m)
out = wrappermap[jobz](n, m, A, B, tol=tol, ldwork=ldwork)
raise_if_slycot_error(out[-1], arg_list)
# sets Z to None
if jobz == "N":
out[5] = None
return out[:-1]
def ab05md(n1,m1,p1,n2,p2,A1,B1,C1,D1,A2,B2,C2,D2,uplo='U'):
""" n,a,b,c,d = ab05md(n1,m1,p1,n2,p2,a1,b1,c1,d1,a2,b2,c2,d2,[uplo])
To obtain the state-space model (A,B,C,D) for the cascaded
inter-connection of two systems, each given in state-space form.
Required arguments:
n1 : input int
The number of state variables in the first system, i.e. the order
of the matrix A1. n1 > 0.
m1 : input int
The number of input variables for the first system. m1 > 0.
p1 : input int
The number of output variables from the first system and the number
of input variables for the second system. p1 > 0.
n2 : input int
The number of state variables in the second system, i.e. the order
of the matrix A2. n2 > 0.
p2 : input int
The number of output variables from the second system. p2 > 0.
A1 : input rank-2 array('d') with bounds (n1,n1)
The leading n1-by-n1 part of this array must contain the state
transition matrix A1 for the first system.
B1 : input rank-2 array('d') with bounds (n1,m1)
The leading n1-by-m1 part of this array must contain the input/state
matrix B1 for the first system.
C1 : input rank-2 array('d') with bounds (p1,n1)
The leading p1-by-n1 part of this array must contain the state/output
matrix C1 for the first system.
D1 : input rank-2 array('d') with bounds (p1,m1)
The leading p1-by-m1 part of this array must contain the input/output
matrix D1 for the first system.
A2 : input rank-2 array('d') with bounds (n2,n2)
The leading n2-by-n2 part of this array must contain the state
transition matrix A2 for the second system.
B2 : input rank-2 array('d') with bounds (n2,p1)
The leading n2-by-p1 part of this array must contain the input/state
matrix B2 for the second system.
C2 : input rank-2 array('d') with bounds (p2,n2)
The leading p2-by-n2 part of this array must contain the state/output
matrix C2 for the second system.
D2 : input rank-2 array('d') with bounds (p2,p1)
The leading p2-by-p1 part of this array must contain the input/output
matrix D2 for the second system.
Optional arguments:
uplo := 'U' input string(len=1)
Indicates whether the user wishes to obtain the matrix A in
the upper or lower block diagonal form, as follows:
= 'U': Obtain A in the upper block diagonal form;
= 'L': Obtain A in the lower block diagonal form.
Return objects:
n : int
The number of state variables (n1 + n2) in the resulting system,
i.e. the order of the matrix A, the number of rows of B and
the number of columns of C.
A : rank-2 array('d') with bounds (n1+n2,n1+n2)
The leading N-by-N part of this array contains the state transition
matrix A for the cascaded system.
B : rank-2 array('d') with bounds (n1+n2,m1)
The leading n-by-m1 part of this array contains the input/state
matrix B for the cascaded system.
C : rank-2 array('d') with bounds (p2,n1+n2)
The leading p2-by-n part of this array contains the state/output
matrix C for the cascaded system.
D : rank-2 array('d') with bounds (p2,m1)
The leading p2-by-m1 part of this array contains the input/output
matrix D for the cascaded system.
Notes:
The implemented methods rely on accuracy enhancing square-root or
balancing-free square-root techniques.
The algorithms require less than 30N^3 floating point operations.
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['uplo', 'OVER'+hidden, 'n1', 'm1', 'p1', 'n2', 'p2', 'A1',
'LDA1'+hidden, 'B1', 'LDB1'+hidden, 'C1', 'LDC1'+hidden, 'D1',
'LDD1'+hidden, 'A2', 'LDA2'+hidden, 'B2', 'LDB2'+hidden, 'C2',
'LDC2'+hidden, 'D2', 'LDD2'+hidden, 'n', 'A', 'LDA'+hidden, 'B',
'LDB'+hidden, 'C', 'LDC'+hidden, 'D', 'LDD'+hidden, 'DWORK'+hidden,
'ldwork', 'info'+hidden ]
out = _wrapper.ab05md(n1,m1,p1,n2,p2,A1,B1,C1,D1,A2,B2,C2,D2,uplo=uplo)
raise_if_slycot_error(out[-1], arg_list)
return out[:-1]
def ab05nd(n1,m1,p1,n2,A1,B1,C1,D1,A2,B2,C2,D2,alpha=1.0,ldwork=None):
""" n,A,B,C,D = ab05nd(n1,m1,p1,n2,A1,B1,C1,D1,A2,B2,C2,D2,[alpha,ldwork])
To obtain the state-space model (A,B,C,D) for the feedback inter-connection
of two systems, each given in state-space form.
Required arguments:
n1 : input int
The number of state variables in the first system, i.e. the order
of the matrix A1. n1 > 0.
m1 : input int
The number of input variables for the first system and the number
of output variables from the second system. m1 > 0.
p1 : input int
The number of output variables from the first system and the number
of input variables for the second system. p1 > 0.
n2 : input int
The number of state variables in the second system, i.e. the order
of the matrix A2. n2 > 0.
A1 : input rank-2 array('d') with bounds (n1,n1)
The leading n1-by-n1 part of this array must contain the state
transition matrix A1 for the first system.
B1 : input rank-2 array('d') with bounds (n1,m1)
The leading n1-by-m1 part of this array must contain the input/state
matrix B1 for the first system.
C1 : input rank-2 array('d') with bounds (p1,n1)
The leading p1-by-n1 part of this array must contain the state/output
matrix C1 for the first system.
D1 : input rank-2 array('d') with bounds (p1,m1)
The leading p1-by-m1 part of this array must contain the input/output
matrix D1 for the first system.
A2 : input rank-2 array('d') with bounds (n2,n2)
The leading n2-by-n2 part of this array must contain the state
transition matrix A2 for the second system.
B2 : input rank-2 array('d') with bounds (n2,p1)
The leading n2-by-p1 part of this array must contain the input/state
matrix B2 for the second system.
C2 : input rank-2 array('d') with bounds (m1,n2)
The leading m1-by-n2 part of this array must contain the state/output
matrix C2 for the second system.
D2 : input rank-2 array('d') with bounds (m1,p1)
The leading m1-by-p1 part of this array must contain the input/output
matrix D2 for the second system.
Optional arguments:
alpha := 1.0 input float
A coefficient multiplying the transfer-function matrix (or the
output equation) of the second system. i.e alpha = +1 corresponds
to positive feedback, and alpha = -1 corresponds to negative
feedback.
ldwork := max(p1*p1,m1*m1,n1*p1) input int
The length of the cache array. ldwork >= max(p1*p1,m1*m1,n1*p1).
Return objects:
n : int
The number of state variables (n1 + n2) in the connected system, i.e.
the order of the matrix A, the number of rows of B and the number of
columns of C.
A : rank-2 array('d') with bounds (n1+n2,n1+n2)
The leading n-by-n part of this array contains the state transition
matrix A for the connected system.
B : rank-2 array('d') with bounds (n1+n2,m1)
The leading n-by-m1 part of this array contains the input/state
matrix B for the connected system.
C : rank-3 array('d') with bounds (p1,n1,n2)
The leading p1-by-n part of this array contains the state/output
matrix C for the connected system.
D : rank-2 array('d') with bounds (p1,m1)
The leading p1-by-m1 part of this array contains the input/output
matrix D for the connected system.
Raises
------
SlycotArithmeticError
:1 <= info <= p1:
the system is not completely controllable. That is, the matrix
``(I + ALPHA*D1*D2)`` is exactly singular (the element
``U(i,i)```` of the upper triangular factor of ``LU```
factorization is exactly zero), possibly due to
rounding errors.
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['over'+hidden, 'n1', 'm1', 'p1', 'n2', 'alpha', 'A1', 'LDA1'+hidden,
'B1', 'LDB1'+hidden, 'C1', 'LDC1'+hidden, 'D1', 'LDD1'+hidden, 'A2',
'LDA2'+hidden, 'B2', 'LDB2'+hidden, 'C2', 'LDC2'+hidden, 'D2',
'LDD2'+hidden, 'n', 'A', 'LDA'+hidden, 'B', 'LDB'+hidden, 'C',
'LDC'+hidden, 'D', 'LDD'+hidden, 'IWORK'+hidden, 'DWORK'+hidden,
'ldwork', 'info'+hidden]
if ldwork is None:
ldwork = max(p1*p1,m1*m1,n1*p1)
out = _wrapper.ab05nd(n1,m1,p1,n2,alpha,A1,B1,C1,D1,A2,B2,C2,D2,ldwork=ldwork)
raise_if_slycot_error(out[-1], arg_list, ab05nd, locals())
return out[:-1]
def ab07nd(n,m,A,B,C,D,ldwork=None):
""" A_i,B_i,C_i,D_i,rcond = ab07nd(n,m,A,B,C,D,[ldwork])
To compute the inverse (A_i,B_i,C_i,D_i) of a given system (A,B,C,D).
Required arguments:
n : input int
The order of the state matrix A. n >= 0.
m : input int
The number of system inputs and outputs. m >= 0.
A : input rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the state matrix
A of the original system.
B : input rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input matrix
B of the original system.
C : input rank-2 array('d') with bounds (m,n)
The leading m-by-n part of this array must contain the output matrix
C of the original system.
D : input rank-2 array('d') with bounds (m,m)
The leading m-by-m part of this array must contain the feedthrough
matrix D of the original system.
Optional arguments:
ldwork := None input int
The length of the cache array. The default value is max(1,4*m),
for better performance should be larger.
Return objects:
A_i : rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array contains the state matrix A_i
of the inverse system.
B_i : rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array contains the input matrix B_i
of the inverse system.
C_i : rank-2 array('d') with bounds (m,n)
The leading m-by-n part of this array contains the output matrix C_i
of the inverse system.
D_i : rank-2 array('d') with bounds (m,m)
The leading m-by-m part of this array contains the feedthrough
matrix D_i of the inverse system.
rcond : float
The estimated reciprocal condition number of the feedthrough matrix
D of the original system.
Warns
-----
SlycotResultWarning
:1 <= info <= m:
the matrix `D` is exactly singular; the ({info},{info})
diagonal element is zero, `RCOND` was set to zero;
:info == m+1:
the matrix `D` is numerically singular, i.e., `RCOND`
is less than the relative machine precision, `EPS`
(see LAPACK Library routine DLAMCH). The
calculations have been completed, but the results
could be very inaccurate.
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['n', 'm', 'A', 'LDA' + hidden, 'B', 'LDB' + hidden,
'C', 'LDC' + hidden, 'D', 'LDD' + hidden, 'rcond',
'IWORK' + hidden, 'DWORK' + hidden, 'ldwork', 'INFO' + hidden]
if ldwork is None:
ldwork = max(1, 4*m)
out = _wrapper.ab07nd(n, m, A, B, C, D, ldwork=ldwork)
raise_if_slycot_error(out[-1], arg_list, ab07nd.__doc__, locals())
return out[:-1]
def ab08nd(n,m,p,A,B,C,D,equil='N',tol=0,ldwork=None):
""" nu,rank,dinfz,nkror,nkrol,infz,kronr,kronl,Af,Bf = ab08nd(n,m,p,A,B,C,D,[equil,tol,ldwork])
To construct for a linear multivariable system described by a state-space
model (A,B,C,D) a regular pencil (Af - lambda*Bf ) which has the invariant
zeros of the system as generalized eigenvalues.
The routine also computes the orders of the infinite zeros and the
right and left Kronecker indices of the system (A,B,C,D).
Required arguments:
n : input int
The number of state variables. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the state
dynamics matrix A of the system.
B : input rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input/state
matrix B of the system.
C : input rank-2 array('d') with bounds (p,n)
The leading p-by-n part of this array must contain the state/output
matrix C of the system.
D : input rank-2 array('d') with bounds (p,m)
The leading p-by-m part of this array must contain the direct
transmission matrix D of the system.
Optional arguments:
equil := 'N' input string(len=1)
Specifies whether the user wishes to balance the compound matrix
as follows:
= 'S': Perform balancing (scaling);
= 'N': Do not perform balancing.
tol := 0.0 input float
A tolerance used in rank decisions to determine the effective rank,
which is defined as the order of the largest leading (or trailing)
triangular submatrix in the QR (or RQ) factorization with column
(or row) pivoting whose estimated condition number is less than 1/tol.
ldwork := None input int
The length of the cache array. The default value is n + 3*max(m,p),
for better performance should be larger.
Return objects:
nu : int
The number of (finite) invariant zeros.
rank : int
The normal rank of the transfer function matrix.
dinfz : int
The maximum degree of infinite elementary divisors.
nkror : int
The number of right Kronecker indices.
nkrol : int
The number of left Kronecker indices.
infz : rank-1 array('i') with bounds (n)
The leading dinfz elements of infz contain information on the
infinite elementary divisors as follows: the system has infz(i)
infinite elementary divisors of degree i, where i = 1,2,...,dinfz.
kronr : rank-1 array('i') with bounds (max(n,m)+1)
the leading nkror elements of this array contain the right kronecker
(column) indices.
kronl : rank-1 array('i') with bounds (max(n,p)+1)
the leading nkrol elements of this array contain the left kronecker
(row) indices.
Af : rank-2 array('d') with bounds (max(1,n+m),n+min(p,m))
the leading nu-by-nu part of this array contains the coefficient
matrix Af of the reduced pencil. the remainder of the leading
(n+m)-by-(n+min(p,m)) part is used as internal workspace.
Bf : rank-2 array('d') with bounds (max(1,n+p),n+m)
The leading nu-by-nu part of this array contains the coefficient
matrix Bf of the reduced pencil. the remainder of the leading
(n+p)-by-(n+m) part is used as internal workspace.
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['equil', 'n', 'm', 'p', 'A', 'LDA'+hidden, 'B', 'LDB'+hidden,
'C', 'LDC'+hidden, 'D', 'LDD'+hidden, 'nu', 'rank', 'dinfz', 'nkror',
'nkrol', 'infz', 'kronr', 'kronl', 'Af', 'LDAF'+hidden, 'Bf',
'LDBF'+hidden, 'tol', 'IWORK'+hidden, 'DWORK'+hidden, 'ldwork',
'INFO'+hidden]
if ldwork is None:
ldwork = n+3*max(m,p) #only an upper bound
out = _wrapper.ab08nd(n,m,p,A,B,C,D,equil=equil,tol=tol,ldwork=ldwork)
raise_if_slycot_error(out[-1], arg_list)
return out[:-1]
def ab08nz(n, m, p, A, B, C, D, equil='N', tol=0., lzwork=None):
""" nu,rank,dinfz,nkror,nkrol,infz,kronr,kronl,Af,Bf = ab08nz(n,m,p,A,B,C,D,[equil,tol,lzwork])
To construct for a linear multivariable system described by a state-space
model (A,B,C,D) a regular pencil (Af - lambda*Bf ) which has the invariant
zeros of the system as generalized eigenvalues.
The routine also computes the orders of the infinite zeros and the
right and left Kronecker indices of the system (A,B,C,D).
Required arguments:
n : input int
The number of state variables. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the state
dynamics matrix A of the system.
B : input rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input/state
matrix B of the system.
C : input rank-2 array('d') with bounds (p,n)
The leading p-by-n part of this array must contain the state/output
matrix C of the system.
D : input rank-2 array('d') with bounds (p,m)
The leading p-by-m part of this array must contain the direct
transmission matrix D of the system.
Optional arguments:
equil := 'N' input string(len=1)
Specifies whether the user wishes to balance the compound matrix
as follows:
= 'S': Perform balancing (scaling);
= 'N': Do not perform balancing.
tol := 0.0 input float
A tolerance used in rank decisions to determine the effective rank,
which is defined as the order of the largest leading (or trailing)
triangular submatrix in the QR (or RQ) factorization with column
(or row) pivoting whose estimated condition number is less than 1/tol.
If tol is set to less than SQRT((N+P)*(N+M))*EPS
then the tolerance is taken as SQRT((N+P)*(N+M))*EPS,
where EPS is the machine precision (see LAPACK Library
Routine DLAMCH).
lzwork := None input int
The length of the internal cache array ZWORK. The default value is
calculated to
MAX( 1,
MIN(P,M) + MAX(3*M-1,N),
MIN(P,N) + MAX(3*P-1,N+P,N+M),
MIN(M,N) + MAX(3*M-1,N+M) )
For optimum performance lzwork should be larger.
If lzwork = -1, then a workspace query is assumed;
the routine only calculates the optimal size of the
ZWORK array, and returns this value in lzwork_opt
Return objects:
nu : int
The number of (finite) invariant zeros.
rank : int
The normal rank of the transfer function matrix.
dinfz : int
The maximum degree of infinite elementary divisors.
nkror : int
The number of right Kronecker indices.
nkrol : int
The number of left Kronecker indices.
infz : rank-1 array('i') with bounds (n)
The leading dinfz elements of infz contain information on the
infinite elementary divisors as follows: the system has infz(i)
infinite elementary divisors of degree i, where i = 1,2,...,dinfz.
kronr : rank-1 array('i') with bounds (max(n,m)+1)
the leading nkror elements of this array contain the right kronecker
(column) indices.
kronl : rank-1 array('i') with bounds (max(n,p)+1)
the leading nkrol elements of this array contain the left kronecker
(row) indices.
Af : rank-2 array('d') with bounds (max(1,n+m),n+min(p,m))
the leading nu-by-nu part of this array contains the coefficient
matrix Af of the reduced pencil. the remainder of the leading
(n+m)-by-(n+min(p,m)) part is used as internal workspace.
Bf : rank-2 array('d') with bounds (max(1,n+p),n+m)
The leading nu-by-nu part of this array contains the coefficient
matrix Bf of the reduced pencil. the remainder of the leading
(n+p)-by-(n+m) part is used as internal workspace.
lzwork_opt : int
The optimal value of lzwork.
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['equil', 'n', 'm', 'p',
'a', 'lda' + hidden, 'b', 'ldb' + hidden,
'c', 'ldc' + hidden, 'd', 'ldd' + hidden,
'nu', 'rank', 'dinfz', 'nkror', 'nkrol', 'infz', 'kronr',
'kronl', 'af', 'ldaf' + hidden, 'bf', 'ldbf' + hidden,
'tol', 'iwork' + hidden, 'dwork' + hidden, 'zwork',
'lzwork', 'info']
if lzwork is None:
lzwork = max(min(p, m) + max(3*m-1, n),
min(p, n) + max(3*p-1, n+p, n+m),
min(m, n) + max(3*m-1, n+m))
nu, rank, dinfz, nkror, nkrol, infz, kronr, kronl, Af, Bf, zwork, info \
= _wrapper.ab08nz(n, m, p, A, B, C, D,
equil=equil, tol=tol, lzwork=lzwork)
raise_if_slycot_error(info, arg_list)
return (nu, rank, dinfz, nkror, nkrol, infz, kronr, kronl, Af, Bf,
int(zwork[0].real))
def ab09ad(dico,job,equil,n,m,p,A,B,C,nr=None,tol=0,ldwork=None):
""" nr,Ar,Br,Cr,hsv = ab09ad(dico,job,equil,n,m,p,A,B,C,[nr,tol,ldwork])
Compute reduced order State-Space-Model (Ar, Br, Cr) for a stable system
(A, B, C) by using either the square-root or the balancing-free square-
root Balance & truncate (B & T) model reduction method.
Required arguments:
dico : {'D', 'C'} input string(len=1)
Indicate whether the system is discrete `D` or continuous `C`
job : {'B', 'N'} input string(len=1)
Balance `B` or not `N`
equil : {'S', 'N'} input string(len=1)
Scale `S` or not `N`
n : input int
The number of state variables. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the state
dynamics matrix A of the system.
B : input rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input/state
matrix B of the system.
C : input rank-2 array('d') with bounds (p,n)
The leading p-by-n part of this array must contain the
state/output matrix C of the system.
Optional arguments:
nr := None input int
`nr` is the desired order of the resulting reduced order
system. ``0 <= nr <= n``. Automatically determined by `tol` if
``nr is None`` and returned. See return object `nr`.
tol := 0 input double precision
If ``nr is None``, `tol`contains the tolerance for determining the
order of the reduced system. For model reduction, th recommended
value is ``tol = c * HNORM(A, B, C)``, where `c` is a constan in the
interval ``[0.00001, 0.001]`` and ``HNORM(A, B, C)`` is the
Hankel-Norm of the given sysstem (computed in ``HSV(1)``). For
computing a minimal realization, the recommended value is
``tol = n * eps * HNORM(A, B, C)``, where `eps` is the machine
precision (see LAPACK Library Routine `DLAMCH`). This value is
used by default if ``tol <= 0`` on entry. If `nr` is specified,
the value of `tol` is ignored.
ldwork := None input int
The length of the cache array. The default value is
``n*(2*n+max(n,m,p)+5) + n*(n+1)/2 ~= 3.5*n**2 + 5*n``,
a larger value should lead to better performance.
Return objects :
nr : output int
`nr` is the order of the resulting reduced order model.
`nr` is set as follows:
If on input ``nr is not None``, `nr` is equal to ``MIN(nr,NMIN)``,
where `nr` is the desired order on entry and `NMIN` is the order
of a minimal realization of the given system; `NMIN` is
determined as the number of Hankel singular values greater
than ``n*eps*HNORM(A,B,C)``, where `eps` is the machine
precision (see LAPACK Library Routine DLAMCH) and
``HNORM(A,B,C)`` is the Hankel norm of the system (computed
in ``HSV(1)``);
If on input ``nr is None``, `nr` is equal to the number of Hankel
singular values greater than ``MAX(tol,n*eps*HNORM(A,B,C))``.
Ar : rank-2 array('d') with bounds ``(nr,nr)``
This array contains the state dynamics matrix `Ar` of the reduced
order system.
Br : rank-2 array('d') with bounds ``(nr,m)``
Tthis array contains the input/state matrix `Br` of the reduced
order system.
Cr : rank-2 array('d') with bounds ``(p,nr)``
This array contains the state/output matrix `Cr` of the reduced
order system.
hsv : output double precision array, dimension ``(n)``
If ``INFO = 0``, it contains the Hankel singular values of
the original system ordered decreasingly. ``HSV(1)`` is the
Hankel norm of the system.
Raises
------
SlycotArithmeticError
:info == 1:
The reduction of A to the real Schur form failed
:info == 2 and dico == 'C':
The state matrix A is not stable
:info == 2 and dico == 'D':
The state matrix A is not convergent
:info == 3:
The computation of Hankel singular values failed
Warns
-----
SlycotResultWarning
:iwarn == 1:
The selected order {nr} is greater
than the order of a minimal realization of the
given system. `nr` was set automatically to {Nr}
corresponding to the order of a minimal realization
of the system
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['dico', 'job', 'equil', 'ordsel', 'n', 'm', 'p', 'nr',
'A', 'lda' + hidden, 'B', 'ldb' + hidden, 'C', 'ldc' + hidden,
'hsv', 'tol', 'iwork' + hidden, 'dwork ' + hidden, 'ldwork',
'iwarn', 'info']
if ldwork is None:
ldwork = max(1, n*(2*n+max(n, max(m, p))+5)+n*(n+1)/2)
if nr is None:
ordsel = 'A'
nr = 0 # order will be computed by the routine
else:
ordsel = 'F'
out = _wrapper.ab09ad(dico, job, equil, ordsel,
n, m, p, nr, A, B, C, tol, ldwork)
Nr, A, B, C, hsv = out[:-2]
raise_if_slycot_error(out[-2:], arg_list, ab09ad.__doc__, locals())
return Nr, A[:Nr, :Nr], B[:Nr, :], C[:, :Nr], hsv
def ab09ax(dico,job,n,m,p,A,B,C,nr=None,tol=0.0,ldwork=None):
"""``nr,Ar,Br,Cr,hsv,T,Ti = ab09ad(dico,job,equil,n,m,p,nr,A,B,C,[nr,tol,ldwork])``
To compute a reduced order model ``(Ar,Br,Cr)`` for a stable original
state-space representation ``(A,B,C)`` by using either the square-root
or the balancing-free square-root Balance & Truncate model
reduction method. The state dynamics matrix `A` of the original
system is an upper quasi-triangular matrix in *real Schur canonical
form.* The matrices of the reduced order system are computed using
the truncation formulas:
``Ar = TI * A * T , Br = TI * B , Cr = C * T`` .
Required arguments :
dico : {'D', 'C'} input string(len=1)
Indicate whether the system is discrete `D` or continuous `C`
job : {'B', 'N'} input string(len=1)
Balance `B` or not `N`
n : input int
The number of state variables. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d') with bounds (n,n)
The leading n-by-n part of this array must contain the state
dynamics matrix A of the system *in real Schur form.*
B : input rank-2 array('d') with bounds (n,m)
The leading n-by-m part of this array must contain the input/state
matrix B of the system.
C : input rank-2 array('d') with bounds (p,n)
The leading p-by-n part of this array must contain the
state/output matrix C of the system.
Optional arguments:
nr := None input int
`nr` is the desired order of the resulting reduced order
system. ``0 <= nr <= n``. Automatically determined by `tol` if
``nr is None`` and returned. See return object `nr`.
tol := 0 input double precision
If ``nr is None``, `tol`contains the tolerance for determining the
order of the reduced system. For model reduction, the recommended
value is ``tol = c * HNORM(A, B, C)``, where `c` is a constant in
the interval ``[0.00001, 0.001]`` and ``HNORM(A, B, C)`` is
the Hankel-Norm of the given sysstem (computed in ``HSV(1)``). For
computing a minimal realization, the recommended value is
``tol = n * eps * HNORM(A, B, C)``, where `eps` is the machine
precision (see LAPACK Library Routine `DLAMCH`). This value is
used by default if ``tol <= 0`` on entry. If `nr` is specified,
the value of `tol` is ignored.
ldwork := None input int
The length of the cache array. The default value is
``n*(2*n+max(n,m,p)+5) + n*(n+1)/2 ~= 3.5*n**2 + 5*n``,
a larger value should lead to better performance.
Return objects :
nr : output int
`nr` is the order of the resulting reduced order model.
`nr` is set as follows:
If on input ``nr is not None``, `nr` is equal to ``MIN(nr,NMIN)``,
where `nr` is the desired order on entry and `NMIN` is the order
of a minimal realization of the given system; `NMIN` is
determined as the number of Hankel singular values greater
than ``n*eps*HNORM(A,B,C)``, where `eps` is the machine
precision (see LAPACK Library Routine DLAMCH) and
``HNORM(A,B,C)`` is the Hankel norm of the system (computed
in ``HSV(1)``);
If on input ``nr is None``, `nr` is equal to the number of Hankel
singular values greater than ``MAX(tol,n*eps*HNORM(A,B,C))``.
Ar : rank-2 array('d') with bounds ``(nr,nr)``
This array contains the state dynamics matrix `Ar` of the reduced
order system.
Br : rank-2 array('d') with bounds ``(nr,m)``
Tthis array contains the input/state matrix `Br` of the reduced
order system.
Cr : rank-2 array('d') with bounds ``(p,nr)``
This array contains the state/output matrix `Cr` of the reduced
order system.
hsv : output double precision array, dimension ``(n)``
If ``INFO = 0``, it contains the Hankel singular values of
the original system ordered decreasingly. ``HSV(1)`` is the
Hankel norm of the system.
T : rank-2 array('d') with bounds ``(n,nr)``
This array contains the right truncation matrix `T` of the reduced
order system.
Ti : rank-2 array('d') with bounds ``(nr,n)``
This array contains the left truncation matrix `Ti` of the reduced
order system.
Raises
------
SlycotArithmeticError
:info == 1 and dico == 'C':
The state matrix A is not stable
:info == 1 and dico == 'D':
The state matrix A is not convergent
:info == 2:
The computation of Hankel singular values failed
Warns
-----
SlycotResultWarning
:iwarn == 1:
The selected order {nr} is greater
than the order of a minimal realization of the
given system. `nr` was set automatically to {Nr}
corresponding to the order of a minimal realization
of the system
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['dico', 'job', 'ordsel', 'n', 'm', 'p', 'nr',
'A', 'lda' + hidden, 'B', 'ldb' + hidden, 'C', 'ldc' + hidden,
'hsv', 'T', 'ldt' + hidden, 'Ti', 'ldti' + hidden, 'tol',
'iwork' + hidden, 'dwork' + hidden, 'ldwork', 'iwarn', 'info']
if ldwork is None:
ldwork = max(1, n*(2*n + max(n, max(m, p))+5)+n*(n+1)/2)
if nr is None:
ordsel = 'A'
nr = 0 # order will be computed by the routine
else:
ordsel = 'F'
out = _wrapper.ab09ax(dico, job, ordsel, n, m, p, nr, A, B, C, tol, ldwork)
Nr, A, B, C, hsv, T, Ti = out[:-2]
raise_if_slycot_error(out[-2:], arg_list, ab09ax.__doc__, locals())
return Nr, A[:Nr, :Nr], B[:Nr, :], C[:, :Nr], hsv, T[:, :Nr], Ti[:Nr, :]
def ab09bd(dico,job,equil,n,m,p,A,B,C,D,nr=None,tol1=0,tol2=0,ldwork=None):
""" nr,Ar,Br,Cr,Dr,hsv = ab09bd(dico,job,equil,n,m,p,A,B,C,D,[nr,tol1,tol2,ldwork])
To compute a reduced order model (Ar,Br,Cr,Dr) for a stable
original state-space representation (A,B,C,D) by using either the
square-root or the balancing-free square-root Singular
Perturbation Approximation (SPA) model reduction method.
Must supply either nr or tolerance values.
Arguments
Mode Parameters
dico
Specifies the type of the original system as follows:
= 'C': continuous-time system;
= 'D': discrete-time system.
job
Specifies the model reduction approach to be used
as follows:
= 'B': use the square-root SPA method;
= 'N': use the balancing-free square-root SPA method.
equil
Specifies whether the user wishes to preliminarily
equilibrate the triplet (A,B,C) as follows:
= 'S': perform equilibration (scaling);
= 'N': do not perform equilibration.
Required arguments
n : input int
The order of the original state-space representation, i.e.
the order of the matrix A. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d') with bounds (n,n)
On entry, the leading n-by-n part of this array must
contain the state dynamics matrix A.
B : input rank-2 array('d') with bounds (n,m)
On entry, the leading n-by-m part of this array must
contain the original input/state matrix B.
C : input rank-2 array('d') with bounds (p,n)
On entry, the leading p-by-n part of this array must
contain the original state/output matrix C.
D : input rank-2 array('d') with bounds (p,m)
On entry, the leading p-by-m part of this array must
contain the original input/output matrix D.
Optional arguments :
nr :=None input int
nr is the desired order of
the resulting reduced order system. 0 <= nr <= n.
tol1 :=0 input double precision
If ordsel = 'A', tol1 contains the tolerance for
determining the order of reduced system.
For model reduction, the recommended value is
tol1 = c*hnorm(A,B,C), where c is a constant in the
interval [0.00001,0.001], and hnorm(A,B,C) is the
Hankel-norm of the given system (computed in hsv(1)).
For computing a minimal realization, the recommended
value is tol1 = n*eps*hnorm(A,B,C), where eps is the
machine precision (see LAPACK Library Routine DLAMCH).
This value is used by default if tol1 <= 0 on entry.
If ordsel = 'F', the value of tol1 is ignored.
tol2 :=0 input double precision
The tolerance for determining the order of a minimal
realization of the given system. The recommended value is
tol2 = n*eps*hnorm(A,B,C). This value is used by default
if tol2 <= 0 on entry.
If tol2 > 0, then tol2 <= tol1.
ldwork := None input int
The length of the cache array. The default value is n + 3*max(m,p),
for better performance should be larger.
Return objects
nr : output int
nr is the order of the resulting reduced order model.
nr is set as follows:
if ordsel = 'F', nr is equal to min(nr,nmin), where nr
is the desired order on entry and nmin is the order of a
minimal realization of the given system; nmin is
determined as the number of Hankel singular values greater
than n*eps*hnorm(A,B,C), where eps is the machine
precision (see LAPACK Library Routine DLAMCH) and
hnorm(A,B,C) is the Hankel norm of the system (computed
in hsv(1));
if ordsel = 'A', nr is equal to the number of Hankel
singular values greater than max(tol1,n*eps*hnorm(A,B,C)).
Ar : rank-2 array('d') with bounds (nr,nr)
the leading nr-by-nr part of this array contains the
state dynamics matrix Ar of the reduced order system.
Br : rank-2 array('d') with bounds (nr,m)
the leading nr-by-m part of this array contains the
input/state matrix Br of the reduced order system.
Cr : rank-2 array('d') with bounds (p,nr)
the leading p-by-nr part of this array contains the
state/output matrix Cr of the reduced order system.
Dr : rank-2 array('d') with bounds (p,m)
the leading p-by-m part of this array contains the
input/output matrix Dr of the reduced order system.
hsv : output double precision array, dimension (n)
If info = 0, it contains the Hankel singular values of
the original system ordered decreasingly. hsv(1) is the
Hankel norm of the system.
Raises
------
SlycotArithmeticError
:info == 1:
The reduction of A to the real Schur form failed
:info == 2 and dico == 'C':
The state matrix A is not stable
:info == 2 and dico == 'D':
The state matrix A is not convergent
:info == 3:
The computation of Hankel singular values failed
Warns
-----
SlycotResultWarning
:iwarn == 1:
The selected order {nr} is greater
than the order of a minimal realization of the
given system. `nr` was set automatically to {Nr}
corresponding to the order of a minimal realization
of the system
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['dico', 'job', 'equil', 'ordsel', 'n', 'm', 'p', 'nr',
'A', 'lda' + hidden, 'B', 'ldb' + hidden, 'C', 'ldc' + hidden,
'D', 'ldd' + hidden, 'hsv', 'tol1', 'tol2',
'iwork' + hidden, 'dwork' + hidden, 'ldwork', 'iwarn', 'info']
if ldwork is None:
ldwork = max(1, n*(2*n+max(n, max(m, p))+5)+n*(n+1)/2)
if nr is None:
ordsel = 'A'
nr = 0 # order will be computed by the routine
else:
ordsel = 'F'
out = _wrapper.ab09bd(dico, job, equil, ordsel,
n, m, p, nr, A, B, C, D, tol1, tol2, ldwork)
Nr, A, B, C, D, hsv = out[:-2]
raise_if_slycot_error(out[-2:], arg_list, ab09bd.__doc__, locals())
return Nr, A[:Nr, :Nr], B[:Nr, :], C[ :,:Nr], D[:, :], hsv
def ab09md(dico,job,equil,n,m,p,A,B,C,alpha=None,nr=None,tol=0,ldwork=None):
""" nr,Ar,Br,Cr,ns,hsv = ab09md(dico,job,equil,n,m,p,A,B,C,[alpha,nr,tol,ldwork])
To compute a reduced order model (Ar,Br,Cr) for an original
state-space representation (A,B,C) by using either the square-root
or the balancing-free square-root Balance & Truncate (B & T)
model reduction method for the ALPHA-stable part of the system.
Arguments
Mode Parameters
dico
Specifies the type of the original system as follows:
= 'C': continuous-time system;
= 'D': discrete-time system.
job
Specifies the model reduction approach to be used
as follows:
= 'B': use the square-root Balance & Truncate method;
= 'N': use the balancing-free square-root
Balance & Truncate method.
equil
Specifies whether the user wishes to preliminarily
equilibrate the triplet (A,B,C) as follows:
= 'S': perform equilibration (scaling);
= 'N': do not perform equilibration.
Required arguments
n : input int
The order of the original state-space representation, i.e.
the order of the matrix A. n >= 0.
m : input int
The number of system inputs. m >= 0.
p : input int
The number of system outputs. p >= 0.
A : input rank-2 array('d'), dimension (n,n)
On entry, the leading N-by-N part of this array must
contain the state dynamics matrix A.
B : input rank-2 array('d'), dimension (n,m)
On entry, the leading N-by-M part of this array must