Scilab

Reference
Manual
On-line Documentation

Scilab Group
SCILAB
REFERENCE
MANUAL

Scilab Group
INRIA Meta2 Project/ENPC Cergrene

INRIA - Unité de recherche de Rocquencourt - Projet Meta2

Domaine de Voluceau - Rocquencourt - BP 105 - 78153 Le Chesnay Cedex (France)
Email: Scilab@inria.fr
Contents

1 Basic functions 25
1.1 Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.1.1 abort interrupt evaluation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.1.2 ans answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.1.3 apropos searches keywords in Scilab help . . . . . . . . . . . . . . . . . . . . . 26
1.1.4 backslash - left matrix division. . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.1.5 bool2s convert boolean matrix to a zero one matrix. . . . . . . . . . . . . . . . . 27
1.1.6 boolean Scilab Objects, boolean variables and operators & j ˜ . . . . . . . . . . . 27
1.1.7 brackets - left and right brackets . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.1.8 break keyword to interrupt loops . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.1.9 call Fortran or C user routines call . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.1.10 case keyword used in select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.1.11 clear kills variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.1.12 clearglobal kills global variables . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.1.13 colon - colon operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.1.14 comma - column, instruction, argument separator . . . . . . . . . . . . . . . . . 32
1.1.15 comments comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.1.16 debug debugging level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.1.17 dot - symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.1.18 else keyword in if-then-else . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.1.19 elseif keyword in if-then-else . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.1.20 empty - empty matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.1.21 end end keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.1.22 equal - affectation, comparison equal sign . . . . . . . . . . . . . . . . . . . . . 34
1.1.23 errcatch error trapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.1.24 errclear error clearing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.1.25 error error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.1.26 evstr evaluation of expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.1.27 exec script file execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.1.28 execstr execute Scilab code in strings . . . . . . . . . . . . . . . . . . . . . . . . 37
1.1.29 exists checks variable existence . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
1.1.30 exit Ends the current Scilab session . . . . . . . . . . . . . . . . . . . . . . . . . 38
1.1.31 external Scilab Object, external function or routine . . . . . . . . . . . . . . . . 38
1.1.32 extraction matrix and list entry extraction . . . . . . . . . . . . . . . . . . . . . 39
1.1.33 feval multiple evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
1.1.34 find find indices of boolean vector or matrix true elements . . . . . . . . . . . . . 41
1.1.35 for language keyword for loops . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.1.36 format number printing and display format . . . . . . . . . . . . . . . . . . . . . 42
1.1.37 fort Fortran or C user routines call . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.1.38 funptr coding of primitives ( wizard stuff ) . . . . . . . . . . . . . . . . . . . . . 45
1.1.39 getenv get the value of an environment variable . . . . . . . . . . . . . . . . . . 45
1.1.40 getfield list field extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.1.41 getpid get Scilab process identificator . . . . . . . . . . . . . . . . . . . . . . . 46

5
1.1.42 getversion get Scilab version name . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.1.43 global Define global variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.1.44 gstacksize set/get scilab global stack size . . . . . . . . . . . . . . . . . . . . . 47
1.1.45 hat - exponentiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.1.46 host shell (sh) command execution . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.1.47 hypermat initialize an N dimensional matrices . . . . . . . . . . . . . . . . . . . 48
1.1.48 hypermatrices Scilab object, N dimensional matrices in Scilab . . . . . . . . . . 49
1.1.49 iconvert conversion to 1 or 4 byte integer representation . . . . . . . . . . . . . . 49
1.1.50 ieee set floating point exception mode . . . . . . . . . . . . . . . . . . . . . . . 50
1.1.51 if else - conditional execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
1.1.52 insertion matrix and list insertion or modification . . . . . . . . . . . . . . . . . 51
1.1.53 intppty set interface argument passing properties . . . . . . . . . . . . . . . . . 53
1.1.54 inttype type integers used in integer data types . . . . . . . . . . . . . . . . . . . 54
1.1.55 inv coeff build a polynomial matrix from its coefficients . . . . . . . . . . . . . . 54
1.1.56 iserror error test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.1.57 isglobal check if a variable is global . . . . . . . . . . . . . . . . . . . . . . . . 55
1.1.58 lasterror get last recorded error message . . . . . . . . . . . . . . . . . . . . . . 55
1.1.59 left - left bracket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.1.60 less - lower than comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.1.61 list Scilab object and list function definition . . . . . . . . . . . . . . . . . . . . 57
1.1.62 lsslist Scilab linear state space function definition . . . . . . . . . . . . . . . . . 57
1.1.63 lstcat list concatenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.1.64 matrices Scilab object, matrices in Scilab . . . . . . . . . . . . . . . . . . . . . . 58
1.1.65 matrix reshape a vector or a matrix to a different size matrix . . . . . . . . . . . 58
1.1.66 mlist Scilab object, matrix oriented typed list definition. . . . . . . . . . . . . . . 59
1.1.67 mode select a mode in exec file . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
1.1.68 mtlb mode switch Matlab like operations . . . . . . . . . . . . . . . . . . . . . 60
1.1.69 names scilab names syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.1.70 null delete an element in a list . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.1.71 overloading display, functions and operators overloading capabilities . . . . . . . 61
1.1.72 parents ) - left and right parenthesis . . . . . . . . . . . . . . . . . . . . . . . . . 63
1.1.73 pause pause mode, invoke keyboard . . . . . . . . . . . . . . . . . . . . . . . . 64
1.1.74 percent - special character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
1.1.75 plus - addition operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
1.1.76 poly polynomial definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1.1.77 power power operation (ˆ,.ˆ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.1.78 predef variable protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.1.79 pwd print Scilab current directory . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.1.80 quit decrease the pause level or exit . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.1.81 quote - transpose operator, string delimiter . . . . . . . . . . . . . . . . . . . . . 67
1.1.82 rational Scilab objects, rational in Scilab . . . . . . . . . . . . . . . . . . . . . . 68
1.1.83 resume return or resume execution and copy some local variables . . . . . . . . 68
1.1.84 return return or resume execution and copy some local variables . . . . . . . . . 68
1.1.85 rlist Scilab rational fraction function definition . . . . . . . . . . . . . . . . . . . 69
1.1.86 sciargs scilab command line arguments . . . . . . . . . . . . . . . . . . . . . . . 69
1.1.87 select select keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
1.1.88 semi - instruction and row separator . . . . . . . . . . . . . . . . . . . . . . . . 70
1.1.89 semicolumn - ending expression and row separator . . . . . . . . . . . . . . . . 70
1.1.90 setfield list field insertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
1.1.91 slash - right division and feed back . . . . . . . . . . . . . . . . . . . . . . . . . 71
1.1.92 stacksize set scilab stack size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
1.1.93 star - multiplication operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.1.94 symbols scilab operator names . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.1.95 testmatrix generate some particular matrices . . . . . . . . . . . . . . . . . . . . 73
1.1.96 then keyword in if-then-else . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
 1.1.97 tilda - logical not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
1.1.98 tlist Scilab object and typed list definition. . . . . . . . . . . . . . . . . . . . . . 73
1.1.99 type variable type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
1.1.100 typename associates a name to variable type . . . . . . . . . . . . . . . . . . . . 75
1.1.101 user interfacing a fortran routine . . . . . . . . . . . . . . . . . . . . . . . . . . 75
1.1.102 varn symbolic variable of a polynomial . . . . . . . . . . . . . . . . . . . . . . . 75
1.1.103 what list the Scilab primitives . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
1.1.104 where get current instruction calling tree . . . . . . . . . . . . . . . . . . . . . . 76
1.1.105 whereami display current instruction calling tree . . . . . . . . . . . . . . . . . . 76
1.1.106 whereis name of library containing a function . . . . . . . . . . . . . . . . . . . 77
1.1.107 while while keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
1.1.108 who listing of variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
1.1.109 whos listing of variables in long form . . . . . . . . . . . . . . . . . . . . . . . 78
1.2 Graphic Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
1.2.1 Graphics graphics library overview . . . . . . . . . . . . . . . . . . . . . . . . . 80
1.2.2 Matplot 2D plot of a matrix using colors . . . . . . . . . . . . . . . . . . . . . . 82
1.2.3 Matplot1 2D plot of a matrix using colors . . . . . . . . . . . . . . . . . . . . . 83
1.2.4 Sfgrayplot smooth 2D plot of a surface defined by a function using colors . . . . 84
1.2.5 Sgrayplot smooth 2D plot of a surface using colors . . . . . . . . . . . . . . . . 84
1.2.6 addcolor add new colors to the current colormap . . . . . . . . . . . . . . . . . . 85
1.2.7 alufunctions description and number of pixel drawing modes. . . . . . . . . . . . 85
1.2.8 black Black’s diagram (Nichols chart) . . . . . . . . . . . . . . . . . . . . . . . 85
1.2.9 bode Bode plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
1.2.10 champ 2D vector field plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
1.2.11 champ1 2D vector field plot with colored arrows . . . . . . . . . . . . . . . . . . 88
1.2.12 chart Nichols chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
1.2.13 colormap using colormaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
1.2.14 contour level curves on a 3D surface . . . . . . . . . . . . . . . . . . . . . . . . 90
1.2.15 contour2d level curves of a surface on a 2D plot . . . . . . . . . . . . . . . . . . 91
1.2.16 contour2di compute level curves of a surface on a 2D plot . . . . . . . . . . . . . 92
1.2.17 contourf filled level curves of a surface on a 2D plot . . . . . . . . . . . . . . . . 93
1.2.18 dragrect Drag rectangle(s) with mouse . . . . . . . . . . . . . . . . . . . . . . . 94
1.2.19 drawaxis draw an axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
1.2.20 driver select a graphics driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
1.2.21 edit curv interactive graphic curve editor . . . . . . . . . . . . . . . . . . . . . . 96
1.2.22 errbar add vertical error bars on a 2D plot . . . . . . . . . . . . . . . . . . . . . 96
1.2.23 eval3d values of a function on a grid . . . . . . . . . . . . . . . . . . . . . . . . 97
1.2.24 eval3dp compute facets of a 3D surface . . . . . . . . . . . . . . . . . . . . . . 98
1.2.25 evans Evans root locus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
1.2.26 fac3d 3D plot of a surface (obsolete) . . . . . . . . . . . . . . . . . . . . . . . . 99
1.2.27 fchamp direction field of a 2D first order ODE . . . . . . . . . . . . . . . . . . . 99
1.2.28 fcontour level curves on a 3D surface defined by a function . . . . . . . . . . . . 100
1.2.29 fcontour2d level curves of a surface defined by a function on a 2D plot . . . . . . 100
1.2.30 fec contour level of a function defined on a triangular mesh . . . . . . . . . . . . 101
1.2.31 fgrayplot 2D plot of a surface defined by a function using colors . . . . . . . . . 102
1.2.32 fplot2d 2D plot of a curve defined by a function . . . . . . . . . . . . . . . . . . 102
1.2.33 fplot3d 3D plot of a surface defined by a function . . . . . . . . . . . . . . . . . 103
1.2.34 fplot3d1 3D gray or color level plot of a surface defined by a function . . . . . . 103
1.2.35 gainplot magnitude plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
1.2.36 genfac3d compute facets of a 3D surface . . . . . . . . . . . . . . . . . . . . . . 105
1.2.37 geom3d projection from 3D on 2D after a 3D plot . . . . . . . . . . . . . . . . . 105
1.2.38 getcolor dialog to select colors in the current colormap . . . . . . . . . . . . . . 106
1.2.39 getfont dialog to select font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
1.2.40 getlinestyle dialog to select linestyle . . . . . . . . . . . . . . . . . . . . . . . . 106
1.2.41 getmark dialog to select mark (symbol) . . . . . . . . . . . . . . . . . . . . . . . 107
1.2.42 getsymbol dialog to select a symbol and its size . . . . . . . . . . . . . . . . . . 107
1.2.43 gr menu simple interactive graphic editor . . . . . . . . . . . . . . . . . . . . . 107
1.2.44 graduate pretty axis graduations . . . . . . . . . . . . . . . . . . . . . . . . . . 108
1.2.45 graycolormap linear gray colormap . . . . . . . . . . . . . . . . . . . . . . . . . 108
1.2.46 grayplot 2D plot of a surface using colors . . . . . . . . . . . . . . . . . . . . . 109
1.2.47 graypolarplot Polar 2D plot of a surface using colors . . . . . . . . . . . . . . . 109
1.2.48 hist3d 3D representation of a histogram . . . . . . . . . . . . . . . . . . . . . . 110
1.2.49 histplot plot a histogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
1.2.50 hotcolormap red to yellow colormap . . . . . . . . . . . . . . . . . . . . . . . . 111
1.2.51 isoview set scales for isometric plot (do not change the size of the window) . . . 111
1.2.52 legends draw graph legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
1.2.53 locate mouse selection of a set of points . . . . . . . . . . . . . . . . . . . . . . 112
1.2.54 m circle M-circle plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
1.2.55 milk drop milk drop 3D function . . . . . . . . . . . . . . . . . . . . . . . . . . 114
1.2.56 nf3d rectangular facets to plot3d parameters . . . . . . . . . . . . . . . . . . . . 114
1.2.57 nyquist nyquist plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
1.2.58 param3d 3D plot of a curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
1.2.59 param3d1 3D plot of curves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
1.2.60 paramfplot2d animated 2D plot, curve defined by a function . . . . . . . . . . . 117
1.2.61 plot simple plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.2.62 plot2d 2D plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
1.2.63 plot2d1 2D plot (logarithmic axes) (obsolete) . . . . . . . . . . . . . . . . . . . 121
1.2.64 plot2d2 2D plot (step function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
1.2.65 plot2d3 2D plot (vertical bars) . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
1.2.66 plot2d4 2D plot (arrows style) . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
1.2.67 plot3d 3D plot of a surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
1.2.68 plot3d1 3D gray or color level plot of a surface . . . . . . . . . . . . . . . . . . 125
1.2.69 plot3d2 plot surface defined by rectangular facets . . . . . . . . . . . . . . . . . 126
1.2.70 plot3d3 mesh plot surface defined by rectangular facets . . . . . . . . . . . . . . 127
1.2.71 plotframe plot a frame with scaling and grids . . . . . . . . . . . . . . . . . . . 127
1.2.72 plzr pole-zero plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
1.2.73 polarplot Plot polar coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
1.2.74 printing printing scilab graphics . . . . . . . . . . . . . . . . . . . . . . . . . . 129
1.2.75 replot redraw the current graphics window with new boundaries . . . . . . . . . 130
1.2.76 rotate rotation of a set of points . . . . . . . . . . . . . . . . . . . . . . . . . . 131
1.2.77 scaling affine transformation of a set of points . . . . . . . . . . . . . . . . . . . 131
1.2.78 sd2sci gr menu structure to scilab instruction convertor . . . . . . . . . . . . . . 131
1.2.79 secto3d 3D surfaces conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
1.2.80 sgrid s-plane grid lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
1.2.81 square set scales for isometric plot (change the size of the window) . . . . . . . . 133
1.2.82 subplot divide a graphics window into a matrix of sub-windows . . . . . . . . . . 133
1.2.83 titlepage add a title in the middle of a graphics window . . . . . . . . . . . . . . 134
1.2.84 winsid return the list of graphics windows . . . . . . . . . . . . . . . . . . . . . 134
1.2.85 xarc draw a part of an ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
1.2.86 xarcs draw parts of a set of ellipses . . . . . . . . . . . . . . . . . . . . . . . . . 135
1.2.87 xarrows draw a set of arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
1.2.88 xaxis draw an axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
1.2.89 xbasc clear a graphics window and erase the associated recorded graphics . . . . 137
1.2.90 xbasimp send graphics to a Postscript printer or in a file . . . . . . . . . . . . . . 137
1.2.91 xbasr redraw a graphics window . . . . . . . . . . . . . . . . . . . . . . . . . . 138
1.2.92 xchange transform real to pixel coordinates . . . . . . . . . . . . . . . . . . . . 138
1.2.93 xclea erase a rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
1.2.94 xclear clear a graphics window . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
1.2.95 xclick wait for a mouse click . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
1.2.96 xclip set a clipping zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
 1.2.97 xdel delete a graphics window . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
1.2.98 xend close a graphics session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
1.2.99 xfarc fill a part of an ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
1.2.100 xfarcs fill parts of a set of ellipses . . . . . . . . . . . . . . . . . . . . . . . . . . 142
1.2.101 xfpoly fill a polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
1.2.102 xfpolys fill a set of polygons . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
1.2.103 xfrect fill a rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
1.2.104 xget get current values of the graphics context . . . . . . . . . . . . . . . . . . . 144
1.2.105 xgetech get the current graphics scale . . . . . . . . . . . . . . . . . . . . . . . 145
1.2.106 xgetmouse get the current position of the mouse . . . . . . . . . . . . . . . . . . 145
1.2.107 xgraduate axis graduation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
1.2.108 xgrid add a grid on a 2D plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
1.2.109 xinfo draw an info string in the message subwindow . . . . . . . . . . . . . . . . 147
1.2.110 xinit initialisation of a graphics driver . . . . . . . . . . . . . . . . . . . . . . . 147
1.2.111 xlfont load a font in the graphics context or query loaded font . . . . . . . . . . . 148
1.2.112 xload load a saved graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
1.2.113 xname change the name of the current graphics window . . . . . . . . . . . . . . 149
1.2.114 xnumb draw numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
1.2.115 xpause suspend Scilab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
1.2.116 xpoly draw a polyline or a polygon . . . . . . . . . . . . . . . . . . . . . . . . . 150
1.2.117 xpolys draw a set of polylines or polygons . . . . . . . . . . . . . . . . . . . . . 150
1.2.118 xrect draw a rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
1.2.119 xrects draw or fill a set of rectangles . . . . . . . . . . . . . . . . . . . . . . . . 151
1.2.120 xrpoly draw a regular polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
1.2.121 xs2fig send graphics to a file in Xfig syntax . . . . . . . . . . . . . . . . . . . . 152
1.2.122 xsave save graphics into a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
1.2.123 xsegs draw unconnected segments . . . . . . . . . . . . . . . . . . . . . . . . . 153
1.2.124 xselect raise the current graphics window . . . . . . . . . . . . . . . . . . . . . 153
1.2.125 xset set values of the graphics context . . . . . . . . . . . . . . . . . . . . . . . 154
1.2.126 xsetech set the sub-window of a graphics window for plotting . . . . . . . . . . . 155
1.2.127 xsetm dialog to set values of the graphics context . . . . . . . . . . . . . . . . . 157
1.2.128 xstring draw strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
1.2.129 xstringb draw strings into a box . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
1.2.130 xstringl compute a box which surrounds strings . . . . . . . . . . . . . . . . . . 158
1.2.131 xtape set up the record process of graphics . . . . . . . . . . . . . . . . . . . . . 159
1.2.132 xtitle add titles on a graphics window . . . . . . . . . . . . . . . . . . . . . . . . 159
1.2.133 zgrid zgrid plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
1.3 Utilities and Elementary Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
1.3.1 abs absolute value, magnitude . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
1.3.2 acos element wise cosine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . 162
1.3.3 acosh hyperbolic cosine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
1.3.4 acoshm matrix hyperbolic inverse cosine . . . . . . . . . . . . . . . . . . . . . . 163
1.3.5 acosm matrix wise cosine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . 163
1.3.6 addf symbolic addition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
1.3.7 adj2sp converts adjacency form into sparse matrix. . . . . . . . . . . . . . . . . 164
1.3.8 amell Jacobi’s am function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
1.3.9 and - logical and . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
1.3.10 asin sine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
1.3.11 asinh hyperbolic sine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
1.3.12 asinhm matrix hyperbolic inverse sine . . . . . . . . . . . . . . . . . . . . . . . 167
1.3.13 asinm matrix wise sine inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
1.3.14 atan 2-quadrant and 4-quadrant inverse tangent . . . . . . . . . . . . . . . . . . 167
1.3.15 atanh hyperbolic tangent inverse . . . . . . . . . . . . . . . . . . . . . . . . . . 168
1.3.16 atanhm matrix hyperbolic tangent inverse . . . . . . . . . . . . . . . . . . . . . 169
1.3.17 atanm square matrix tangent inverse . . . . . . . . . . . . . . . . . . . . . . . . 169
1.3.18 besseli Modified I sub ALPHA Bessel functions of the first kind. . . . . . . . . . 169
1.3.19 besselj Modified J sub ALPHA Bessel functions of the first kind. . . . . . . . . . 170
1.3.20 besselk Modified K sub ALPHA Bessel functions of the second kind. . . . . . . . 170
1.3.21 bessely Modified Y sub ALPHA Bessel functions of the second kind. . . . . . . . 171
1.3.22 binomial binomial distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
1.3.23 bloc2exp block-diagram to symbolic expression . . . . . . . . . . . . . . . . . . 172
1.3.24 bloc2ss block-diagram to state-space conversion . . . . . . . . . . . . . . . . . . 173
1.3.25 calerf computes error functions. . . . . . . . . . . . . . . . . . . . . . . . . . . 175
1.3.26 ceil rounding up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
1.3.27 cmb lin symbolic linear combination . . . . . . . . . . . . . . . . . . . . . . . . 176
1.3.28 conj conjugate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
1.3.29 cos cosine function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
1.3.30 cosh hyperbolic cosine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
1.3.31 coshm matrix hyperbolic cosine . . . . . . . . . . . . . . . . . . . . . . . . . . 178
1.3.32 cosm matrix cosine function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
1.3.33 cotg cotangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
1.3.34 coth hyperbolic cotangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
1.3.35 cothm matrix hyperbolic cotangent . . . . . . . . . . . . . . . . . . . . . . . . . 179
1.3.36 cumprod cumulative product . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
1.3.37 cumsum cumulative sum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
1.3.38 delip elliptic integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
1.3.39 diag diagonal including or extracting . . . . . . . . . . . . . . . . . . . . . . . 181
1.3.40 dlgamma derivative of gammaln function. . . . . . . . . . . . . . . . . . . . . . 182
1.3.41 double conversion from integer to double precision representation . . . . . . . . 182
1.3.42 erf The error function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
1.3.43 erfc The complementary error function. . . . . . . . . . . . . . . . . . . . . . . 183
1.3.44 erfcx scaled complementary error function. . . . . . . . . . . . . . . . . . . . . 183
1.3.45 eval evaluation of a matrix of strings . . . . . . . . . . . . . . . . . . . . . . . . 184
1.3.46 eye identity matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
1.3.47 fix rounding towards zero . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
1.3.48 floor rounding down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
1.3.49 frexp dissect floating-point numbers into base 2 exponent and mantissa . . . . . . 185
1.3.50 full sparse to full matrix conversion . . . . . . . . . . . . . . . . . . . . . . . . . 186
1.3.51 gamma The gamma function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
1.3.52 gammaln The logarithm of gamma function. . . . . . . . . . . . . . . . . . . . . 186
1.3.53 gsort decreasing order sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
1.3.54 imag imaginary part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
1.3.55 int integer part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
1.3.56 int8 conversion to one byte integer representation . . . . . . . . . . . . . . . . . 188
1.3.57 integrate integration by quadrature . . . . . . . . . . . . . . . . . . . . . . . . . 189
1.3.58 interp interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
1.3.59 interpln linear interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
1.3.60 intersect returns the vector of common values of two vectors . . . . . . . . . . . 190
1.3.61 intsplin integration of experimental data by spline interpolation . . . . . . . . . . 191
1.3.62 inttrap integration of experimental data by trapezoidal interpolation . . . . . . . . 192
1.3.63 isdef check variable existence . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
1.3.64 isinf check for infinite entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
1.3.65 isnan check for ”Not a Number” entries . . . . . . . . . . . . . . . . . . . . . . 193
1.3.66 isreal check if a variable as real or complex entries . . . . . . . . . . . . . . . . 193
1.3.67 kron Kronecker product (.*.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
1.3.68 ldivf left symbolic division . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
1.3.69 lex sort lexicographic matrix rows sorting . . . . . . . . . . . . . . . . . . . . . 194
1.3.70 linspace linearly spaced vector . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
1.3.71 log natural logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
1.3.72 log10 logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
1.3.73 log2 base 2 logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
1.3.74 logm square matrix logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
1.3.75 logspace logarithmically spaced vector . . . . . . . . . . . . . . . . . . . . . . . 197
1.3.76 max maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
1.3.77 maxi maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
1.3.78 mean mean (row mean, column mean) of vector/matrix entries . . . . . . . . . . 198
1.3.79 median median (row median, column median) of vector/matrix entries . . . . . . 199
1.3.80 min minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
1.3.81 mini minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
1.3.82 minus - substraction operator, sign changes . . . . . . . . . . . . . . . . . . . . 201
1.3.83 modulo symetric arithmetic remainder modulo m . . . . . . . . . . . . . . . . . 201
1.3.84 mps2linpro convert lp problem given in MPS format to linpro format . . . . . . . 202
1.3.85 mtlb sparse convert sparse matrix . . . . . . . . . . . . . . . . . . . . . . . . . 202
1.3.86 mulf symbolic multiplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
1.3.87 nnz number of non zero entries in a matrix . . . . . . . . . . . . . . . . . . . . . 203
1.3.88 norm matrix norms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
1.3.89 not - logical not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
1.3.90 ones matrix made of ones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
1.3.91 or - logical or . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
1.3.92 pen2ea pencil to E,A conversion . . . . . . . . . . . . . . . . . . . . . . . . . . 205
1.3.93 pertrans pertranspose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
1.3.94 prod product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
1.3.95 rand random number generator . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
1.3.96 rat Floating point rational approximation . . . . . . . . . . . . . . . . . . . . . 207
1.3.97 rdivf right symbolic division . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
1.3.98 real real part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
1.3.99 round rounding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
1.3.100 sign sign function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
1.3.101 signm matrix sign function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
1.3.102 sin sine function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
1.3.103 sinh hyperbolic sine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
1.3.104 sinhm matrix hyperbolic sine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
1.3.105 sinm matrix sine function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
1.3.106 size size of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
1.3.107 smooth smoothing by spline functions . . . . . . . . . . . . . . . . . . . . . . . 212
1.3.108 solve symbolic linear system solver . . . . . . . . . . . . . . . . . . . . . . . . . 212
1.3.109 sort decreasing order sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
1.3.110 sp2adj converts sparse matrix into adjacency form . . . . . . . . . . . . . . . . . 213
1.3.111 sparse sparse matrix definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
1.3.112 spcompack converts a compressed adjacency representation . . . . . . . . . . . . 215
1.3.113 speye sparse identity matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
1.3.114 spget retrieves entries of sparse matrix . . . . . . . . . . . . . . . . . . . . . . . 216
1.3.115 splin spline function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
1.3.116 spones sparse matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
1.3.117 sprand sparse random matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
1.3.118 spzeros sparse zero matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
1.3.119 sqrt square root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
1.3.120 sqrtm matrix square root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
1.3.121 squarewave generates a square wave with period 2*%pi . . . . . . . . . . . . . . 220
1.3.122 ssprint pretty print for linear system . . . . . . . . . . . . . . . . . . . . . . . . 220
1.3.123 ssrand random system generator . . . . . . . . . . . . . . . . . . . . . . . . . . 220
1.3.124 st deviation standard deviation (row or column-wise) of vector/matrix entries . . 221
1.3.125 subf symbolic subtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
1.3.126 sum sum (row sum, column sum) of vector/matrix entries . . . . . . . . . . . . . 222
1.3.127 sysconv system conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
 1.3.128 sysdiag block diagonal system connection . . . . . . . . . . . . . . . . . . . . . 224
1.3.129 syslin linear system definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
1.3.130 tan tangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
1.3.131 tanh hyperbolic tangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
1.3.132 tanhm matrix hyperbolic tangent . . . . . . . . . . . . . . . . . . . . . . . . . . 226
1.3.133 tanm matrix tangent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
1.3.134 toeplitz toeplitz matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
1.3.135 trfmod poles and zeros display . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
1.3.136 trianfml symbolic triangularization . . . . . . . . . . . . . . . . . . . . . . . . . 228
1.3.137 tril lower triangular part of matrix . . . . . . . . . . . . . . . . . . . . . . . . . 228
1.3.138 trisolve symbolic linear system solver . . . . . . . . . . . . . . . . . . . . . . . 229
1.3.139 triu upper triangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
1.3.140 typeof object type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
1.3.141 union extract union components of a vector . . . . . . . . . . . . . . . . . . . . 230
1.3.142 unique extract unique components of a vector . . . . . . . . . . . . . . . . . . . 230
1.3.143 zeros matrix made of zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
1.4 Input/Output functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
1.4.1 diary diary of session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
1.4.2 disp displays variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
1.4.3 dispfile display opened files properties . . . . . . . . . . . . . . . . . . . . . . . 233
1.4.4 file file management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
1.4.5 fileinfo Provides information about a file . . . . . . . . . . . . . . . . . . . . . . 235
1.4.6 fprintf Emulator of C language fprintf function . . . . . . . . . . . . . . . . . . 235
1.4.7 fprintfMat print a matrix in a file. . . . . . . . . . . . . . . . . . . . . . . . . . . 236
1.4.8 fscanf Converts formatted input read on a file . . . . . . . . . . . . . . . . . . . 237
1.4.9 fscanfMat Reads a Matrix from a text file. . . . . . . . . . . . . . . . . . . . . . 237
1.4.10 getio get Scilab input/output logical units . . . . . . . . . . . . . . . . . . . . . 238
1.4.11 input prompt for user input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
1.4.12 lines rows and columns used for display . . . . . . . . . . . . . . . . . . . . . . 238
1.4.13 load load saved variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
1.4.14 manedit editing a manual item . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
1.4.15 mclearerr reset binary file access errors . . . . . . . . . . . . . . . . . . . . . . 240
1.4.16 mclose close an opened file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
1.4.17 meof check if end of file has been reached . . . . . . . . . . . . . . . . . . . . . 241
1.4.18 mscanf interface to the C scanf function . . . . . . . . . . . . . . . . . . . . . . 241
1.4.19 mget reads byte or word in a given binary format and convert to double . . . . . . 242
1.4.20 mgetl read lines from an ascii file . . . . . . . . . . . . . . . . . . . . . . . . . . 243
1.4.21 mgetstr read a character string . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
1.4.22 mopen open a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
1.4.23 mfprintf converts, formats, and writes data to a file . . . . . . . . . . . . . . . . 245
1.4.24 mput writes byte or word in a given binary format . . . . . . . . . . . . . . . . . 246
1.4.25 mputl writes strings in an ascii file . . . . . . . . . . . . . . . . . . . . . . . . . 247
1.4.26 mputstr write a character string in a file . . . . . . . . . . . . . . . . . . . . . . . 247
1.4.27 mfscanf scan data from file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
1.4.28 mseek set current position in binary file. . . . . . . . . . . . . . . . . . . . . . . 248
1.4.29 mtell binary file management . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
1.4.30 newest returns newest file of a set of files . . . . . . . . . . . . . . . . . . . . . . 250
1.4.31 oldload load saved variable in 2.4.1 and previous formats . . . . . . . . . . . . . 250
1.4.32 oldsave saving variables in 2.4.1 and previous format . . . . . . . . . . . . . . . 251
1.4.33 print prints variables in a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
1.4.34 printf Emulator of C language printf function . . . . . . . . . . . . . . . . . . . 252
1.4.35 printf conversion printf, sprintf, fprintf conversion specifications . . . . . . . . . 252
1.4.36 read matrices read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
1.4.37 read4b fortran file binary read . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
1.4.38 readb fortran file binary read . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
 1.4.39 readc read a character string . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
1.4.40 readmps reads a file in MPS format . . . . . . . . . . . . . . . . . . . . . . . . 256
1.4.41 save saving variables in binary files . . . . . . . . . . . . . . . . . . . . . . . . . 258
1.4.42 scanf Converts formatted input on standard input . . . . . . . . . . . . . . . . . 259
1.4.43 scanf conversion scanf, sscanf, fscanf conversion specifications . . . . . . . . . . 259
1.4.44 sprintf Emulator of C language sprintf function . . . . . . . . . . . . . . . . . . 260
1.4.45 sscanf Converts formatted input given by a string . . . . . . . . . . . . . . . . . 260
1.4.46 startup startup file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
1.4.47 warning warning messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
1.4.48 writb fortran file binary write . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
1.4.49 write write in a formatted file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
1.4.50 write4b fortran file binary write . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
1.4.51 xgetfile dialog to get a file path . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
1.5 Handling of functions and libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
1.5.1 addinter new functions interface incremental linking at run time . . . . . . . . . 265
1.5.2 argn number of arguments in a function call . . . . . . . . . . . . . . . . . . . . 265
1.5.3 clearfun remove primitive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
1.5.4 comp scilab function compilation . . . . . . . . . . . . . . . . . . . . . . . . . . 266
1.5.5 deff on-line definition of function . . . . . . . . . . . . . . . . . . . . . . . . . . 266
1.5.6 delbpt delete breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
1.5.7 dispbpt display breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
1.5.8 edit function editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
1.5.9 funcprot switch scilab functions protection mode . . . . . . . . . . . . . . . . . 268
1.5.10 function opens a function definition . . . . . . . . . . . . . . . . . . . . . . . . 268
1.5.11 functions Scilab procedures and Scilab objects . . . . . . . . . . . . . . . . . . . 269
1.5.12 genlib build library from all functions in given directory . . . . . . . . . . . . . . 270
1.5.13 get function path get source file path of a library function . . . . . . . . . . . . . 271
1.5.14 getd getting all functions defined in a directory . . . . . . . . . . . . . . . . . . . 271
1.5.15 getf defining a function from a file . . . . . . . . . . . . . . . . . . . . . . . . . 272
1.5.16 lib library definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
1.5.17 macr2lst function to list conversion . . . . . . . . . . . . . . . . . . . . . . . . . 273
1.5.18 macro Scilab procedure and Scilab object . . . . . . . . . . . . . . . . . . . . . 273
1.5.19 macrovar variables of function . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
1.5.20 newfun add a name in the table of functions . . . . . . . . . . . . . . . . . . . . 274
1.5.21 plotprofile extracts and displays execution profiles of a Scilab function . . . . . . 274
1.5.22 profile extract execution profiles of a Scilab function . . . . . . . . . . . . . . . 275
1.5.23 setbpt setting breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
1.5.24 showprofile extracts and displays execution profiles of a Scilab function . . . . . 276
1.5.25 varargin variable numbers of arguments in an input argument list . . . . . . . . . 277
1.5.26 varargout variable numbers of arguments in an output argument list . . . . . . . . 277
1.6 Strings manipulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
1.6.1 code2str returns character string associated with Scilab integer codes. . . . . . . 280
1.6.2 convstr case conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
1.6.3 emptystr zero length string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
1.6.4 grep find matches of a string in a vector of strings . . . . . . . . . . . . . . . . . 281
1.6.5 length length of object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
1.6.6 part extraction of strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
1.6.7 str2code return scilab integer codes associated with a character string . . . . . . . 282
1.6.8 strcat catenate character strings . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
1.6.9 strindex search position of a character string in an other string. . . . . . . . . . . 283
1.6.10 string conversion to string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
1.6.11 strings Scilab Object, character strings . . . . . . . . . . . . . . . . . . . . . . . 284
1.6.12 stripblanks strips leading and trailing blanks of strings . . . . . . . . . . . . . . . 284
1.6.13 strsubst substitute a character string by another in a character string. . . . . . . . 285
1.7 Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
 1.7.1 addmenu interactive button or menu definition . . . . . . . . . . . . . . . . . . . 287
1.7.2 delmenu interactive button or menu deletion . . . . . . . . . . . . . . . . . . . . 288
1.7.3 getvalue xwindow dialog for data acquisition . . . . . . . . . . . . . . . . . . . 288
1.7.4 halt stop execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
1.7.5 havewindow return scilab window mode . . . . . . . . . . . . . . . . . . . . . . 289
1.7.6 keyboard keyboard commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
1.7.7 setmenu interactive button or menu activation . . . . . . . . . . . . . . . . . . . 290
1.7.8 unsetmenu interactive button or menu or submenu de-activation . . . . . . . . . . 290
1.7.9 x choices interactive Xwindow choices through toggle buttons . . . . . . . . . . 291
1.7.10 x choose interactive Xwindow choice . . . . . . . . . . . . . . . . . . . . . . . 291
1.7.11 x dialog Xwindow dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
1.7.12 x matrix Xwindow editing of matrix . . . . . . . . . . . . . . . . . . . . . . . . 292
1.7.13 x mdialog Xwindow dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
1.7.14 x message X window message . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
1.7.15 x message modeless X window modeless message . . . . . . . . . . . . . . . . 294
1.8 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
1.8.1 %helps Variable defining the path of help directories . . . . . . . . . . . . . . . 296
1.8.2 G make call make or nmake . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
1.8.3 c link check dynamic link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
1.8.4 chdir changes Scilab current directory . . . . . . . . . . . . . . . . . . . . . . . 297
1.8.5 dec2hex hexadecimal representation of integers . . . . . . . . . . . . . . . . . . 298
1.8.6 demos guide for scilab demos . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
1.8.7 help on-line help command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
1.8.8 hex2dec converts hexadecimal representation of integers to numbers . . . . . . . 299
1.8.9 ilib build utility for shared library management . . . . . . . . . . . . . . . . . . 299
1.8.10 ilib compile ilib build utility: executes the makefile produced by ilib gen Make . 300
1.8.11 ilib for link utility for shared library management with link . . . . . . . . . . . . 301
1.8.12 ilib gen Make utility for ilib build: produces a makefile for building shared libraries 302
1.8.13 ilib gen gateway utility for ilib build, generates a gateway file. . . . . . . . . . . 302
1.8.14 ilib gen loader utility for ilib build: generates a loader file . . . . . . . . . . . . 302
1.8.15 intersci scilab tool to interface C of Fortran functions with scilab . . . . . . . . . 303
1.8.16 link dynamic link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
1.8.17 man on line help source file description format . . . . . . . . . . . . . . . . . . . 305
1.8.18 sci2exp converts variable to expression . . . . . . . . . . . . . . . . . . . . . . . 307
1.8.19 sci2map Scilab to Maple variable conversion . . . . . . . . . . . . . . . . . . . . 308
1.8.20 scilab Major unix script to execute Scilab and miscellaneous tools . . . . . . . . 308
1.8.21 scilink Unix script to relink Scilab . . . . . . . . . . . . . . . . . . . . . . . . . 309
1.8.22 ulink unlink a dynamically linked shared object . . . . . . . . . . . . . . . . . . 309
1.8.23 unix shell (sh) command execution . . . . . . . . . . . . . . . . . . . . . . . . . 310
1.8.24 unix g shell (sh) command execution, output redirected to a variable . . . . . . . 310
1.8.25 unix s shell (sh) command execution, no output . . . . . . . . . . . . . . . . . . 311
1.8.26 unix w shell (sh) command execution, output redirected to scilab window . . . . 311
1.8.27 unix x shell (sh) command execution, output redirected to a window . . . . . . . 312
1.9 Time and date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
1.9.1 date Current date as date string . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
1.9.2 getdate get date and time information . . . . . . . . . . . . . . . . . . . . . . . . 314
1.9.3 timer cpu time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

2 Specialized Toolboxes 317

2.1 General System and Control macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
2.1.1 abcd state-space matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
2.1.2 abinv AB invariant subspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
2.1.3 arhnk Hankel norm approximant . . . . . . . . . . . . . . . . . . . . . . . . . . 321
2.1.4 arl2 SISO model realization by L2 transfer approximation . . . . . . . . . . . . . 321
2.1.5 balreal balanced realization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
2.1.6 bilin general bilinear transform . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
2.1.7 cainv Dual of abinv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
2.1.8 calfrq frequency response discretization . . . . . . . . . . . . . . . . . . . . . . 324
2.1.9 canon canonical controllable form . . . . . . . . . . . . . . . . . . . . . . . . . 325
2.1.10 cls2dls bilinear transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
2.1.11 colregul removing poles and zeros at infinity . . . . . . . . . . . . . . . . . . . . 326
2.1.12 cont frm transfer to controllable state-space . . . . . . . . . . . . . . . . . . . . 327
2.1.13 cont mat controllability matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
2.1.14 contr controllability, controllable subspace . . . . . . . . . . . . . . . . . . . . . 328
2.1.15 contrss controllable part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
2.1.16 csim simulation (time response) of linear system . . . . . . . . . . . . . . . . . . 329
2.1.17 ctr gram controllability gramian . . . . . . . . . . . . . . . . . . . . . . . . . . 330
2.1.18 dbphi frequency response to phase and magnitude representation . . . . . . . . . 330
2.1.19 ddp disturbance decoupling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
2.1.20 des2tf descriptor to transfer function conversion . . . . . . . . . . . . . . . . . . 332
2.1.21 dscr discretization of linear system . . . . . . . . . . . . . . . . . . . . . . . . . 333
2.1.22 dsimul state space discrete time simulation . . . . . . . . . . . . . . . . . . . . 333
2.1.23 dt ility detectability test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
2.1.24 equil balancing of pair of symmetric matrices . . . . . . . . . . . . . . . . . . . 334
2.1.25 equil1 balancing (nonnegative) pair of matrices . . . . . . . . . . . . . . . . . . 335
2.1.26 feedback feedback operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
2.1.27 flts time response (discrete time, sampled system) . . . . . . . . . . . . . . . . . 336
2.1.28 frep2tf transfer function realization from frequency response . . . . . . . . . . . 338
2.1.29 freq frequency response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
2.1.30 freson peak frequencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
2.1.31 g margin gain margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
2.1.32 gfrancis Francis equations for tracking . . . . . . . . . . . . . . . . . . . . . . . 340
2.1.33 imrep2ss state-space realization of an impulse response . . . . . . . . . . . . . . 341
2.1.34 invsyslin system inversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
2.1.35 kpure continuous SISO system limit feedback gain . . . . . . . . . . . . . . . . 342
2.1.36 krac2 continuous SISO system limit feedback gain . . . . . . . . . . . . . . . . 343
2.1.37 lin linearization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
2.1.38 lqe linear quadratic estimator (Kalman Filter) . . . . . . . . . . . . . . . . . . . 344
2.1.39 lqg LQG compensator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
2.1.40 lqg2stan LQG to standard problem . . . . . . . . . . . . . . . . . . . . . . . . . 345
2.1.41 lqr LQ compensator (full state) . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
2.1.42 ltitr discrete time response (state space) . . . . . . . . . . . . . . . . . . . . . . 347
2.1.43 markp2ss Markov parameters to state-space . . . . . . . . . . . . . . . . . . . . 347
2.1.44 minreal minimal balanced realization . . . . . . . . . . . . . . . . . . . . . . . . 348
2.1.45 minss minimal realization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
2.1.46 obs gram observability gramian . . . . . . . . . . . . . . . . . . . . . . . . . . 349
2.1.47 obscont observer based controller . . . . . . . . . . . . . . . . . . . . . . . . . . 349
2.1.48 observer observer design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
2.1.49 obsv mat observability matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
2.1.50 obsvss observable part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
2.1.51 p margin phase margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
2.1.52 pfss partial fraction decomposition . . . . . . . . . . . . . . . . . . . . . . . . . 353
2.1.53 phasemag phase and magnitude computation . . . . . . . . . . . . . . . . . . . . 353
2.1.54 ppol pole placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
2.1.55 projsl linear system projection . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
2.1.56 repfreq frequency response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
2.1.57 ricc Riccati equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
2.1.58 rowregul removing poles and zeros at infinity . . . . . . . . . . . . . . . . . . . 357
2.1.59 rtitr discrete time response (transfer matrix) . . . . . . . . . . . . . . . . . . . . 358
2.1.60 sm2des system matrix to descriptor . . . . . . . . . . . . . . . . . . . . . . . . . 360
 2.1.61 sm2ss system matrix to state-space . . . . . . . . . . . . . . . . . . . . . . . . . 360
2.1.62 specfact spectral factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
2.1.63 ss2des (polynomial) state-space to descriptor form . . . . . . . . . . . . . . . . . 361
2.1.64 ss2ss state-space to state-space conversion, feedback, injection . . . . . . . . . . 362
2.1.65 ss2tf conversion from state-space to transfer function . . . . . . . . . . . . . . . 363
2.1.66 st ility stabilizability test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
2.1.67 stabil stabilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
2.1.68 svplot singular-value sigma-plot . . . . . . . . . . . . . . . . . . . . . . . . . . 365
2.1.69 sysfact- factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
2.1.70 syssize size of state-space system . . . . . . . . . . . . . . . . . . . . . . . . . . 367
2.1.71 tf2ss transfer to state-space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
2.1.72 time id SISO least square identification . . . . . . . . . . . . . . . . . . . . . . 367
2.1.73 trzeros transmission zeros and normal rank . . . . . . . . . . . . . . . . . . . . . 368
2.1.74 ui observer unknown input observer . . . . . . . . . . . . . . . . . . . . . . . . 369
2.1.75 unobs unobservable subspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
2.1.76 zeropen zero pencil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
2.2 Robust control toolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
2.2.1 augment augmented plant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
2.2.2 bstap hankel approximant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
2.2.3 ccontrg central H-infinity controller . . . . . . . . . . . . . . . . . . . . . . . . 374
2.2.4 colinout inner-outer factorization . . . . . . . . . . . . . . . . . . . . . . . . . . 375
2.2.5 copfac right coprime factorization . . . . . . . . . . . . . . . . . . . . . . . . . 375
2.2.6 dcf double coprime factorization . . . . . . . . . . . . . . . . . . . . . . . . . . 375
2.2.7 des2ss descriptor to state-space . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
2.2.8 dhnorm discrete H-infinity norm . . . . . . . . . . . . . . . . . . . . . . . . . . 376
2.2.9 dtsi stable anti-stable decomposition . . . . . . . . . . . . . . . . . . . . . . . . 377
2.2.10 fourplan augmented plant to four plants . . . . . . . . . . . . . . . . . . . . . . 377
2.2.11 fspecg stable factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
2.2.12 fstabst Youla’s parametrization . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
2.2.13 gamitg H-infinity gamma iterations . . . . . . . . . . . . . . . . . . . . . . . . . 378
2.2.14 gcare control Riccati equation . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
2.2.15 gfare filter Riccati equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
2.2.16 gtild tilde operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
2.2.17 h2norm H2 norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
2.2.18 h cl closed loop matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
2.2.19 h inf H-infinity (central) controller . . . . . . . . . . . . . . . . . . . . . . . . . 381
2.2.20 h inf st static H infinity problem . . . . . . . . . . . . . . . . . . . . . . . . . . 382
2.2.21 h norm H-infinity norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
2.2.22 hankelsv Hankel singular values . . . . . . . . . . . . . . . . . . . . . . . . . . 383
2.2.23 lcf normalized coprime factorization . . . . . . . . . . . . . . . . . . . . . . . . 383
2.2.24 leqr H-infinity LQ gain (full state) . . . . . . . . . . . . . . . . . . . . . . . . . 383
2.2.25 lft linear fractional transformation . . . . . . . . . . . . . . . . . . . . . . . . . 384
2.2.26 linf infinity norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
2.2.27 linfn infinity norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
2.2.28 lqg ltr LQG with loop transform recovery . . . . . . . . . . . . . . . . . . . . . 386
2.2.29 macglov Mac Farlane Glover problem . . . . . . . . . . . . . . . . . . . . . . . 387
2.2.30 nehari Nehari approximant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
2.2.31 parrot Parrot’s problem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
2.2.32 ric desc Riccati equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
2.2.33 riccati Riccati equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
2.2.34 rowinout inner-outer factorization . . . . . . . . . . . . . . . . . . . . . . . . . 389
2.2.35 sensi sensitivity functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
2.2.36 tf2des transfer function to descriptor . . . . . . . . . . . . . . . . . . . . . . . . 390
2.3 Tools for dynamical systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
2.3.1 arma Scilab arma library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
 2.3.2 arma2p extract polynomial matrices from ar representation . . . . . . . . . . . . 393
2.3.3 armac Scilab description of an armax process . . . . . . . . . . . . . . . . . . . 394
2.3.4 armax armax identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
2.3.5 armax1 armax identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
2.3.6 arsimul armax simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
2.3.7 narsimul armax simulation ( using rtitr) . . . . . . . . . . . . . . . . . . . . . . 397
2.3.8 noisegen noise generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
2.3.9 odedi test of ode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
2.3.10 prbs a pseudo random binary sequences generation . . . . . . . . . . . . . . . . 398
2.3.11 reglin Linear regression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
2.4 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
2.4.1 artest arnold dynamical system . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
2.4.2 bifish shows a bifurcation diagram in a fish population discrete time model . . . 400
2.4.3 boucle phase portrait of a dynamical system with observer . . . . . . . . . . . . 401
2.4.4 chaintest a three-species food chain model . . . . . . . . . . . . . . . . . . . . . 401
2.4.5 gpeche a fishing program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
2.4.6 fusee a set of Scilab macro for a landing rocket problem . . . . . . . . . . . . . 402
2.4.7 lotest demo of the Lorenz attractor . . . . . . . . . . . . . . . . . . . . . . . . . 403
2.4.8 mine a mining problem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
2.4.9 obscont1 a controlled-observed system . . . . . . . . . . . . . . . . . . . . . . . 405
2.4.10 portr3d 3 dimensional phase portrait. . . . . . . . . . . . . . . . . . . . . . . . . 405
2.4.11 portrait 2 dimensional phase portrait. . . . . . . . . . . . . . . . . . . . . . . . . 406
2.4.12 recur a bilinear recurrent equation . . . . . . . . . . . . . . . . . . . . . . . . . 406
2.4.13 systems a collection of dynamical system . . . . . . . . . . . . . . . . . . . . . 407
2.4.14 tangent linearization of a dynamical system at an equilibrium point . . . . . . . 408
2.4.15 tdinit interactive initialisation of the tdcs dynamical systems . . . . . . . . . . . 409
2.5 Non-linear tools (optimization and simulation) . . . . . . . . . . . . . . . . . . . . . . . 410
2.5.1 bvode boundary value problems for ODE . . . . . . . . . . . . . . . . . . . . . 411
2.5.2 colnew boundary value problems for ODE . . . . . . . . . . . . . . . . . . . . . 414
2.5.3 dasrt DAE solver with zero crossing . . . . . . . . . . . . . . . . . . . . . . . . 414
2.5.4 dassl differential algebraic equation . . . . . . . . . . . . . . . . . . . . . . . . 416
2.5.5 datafit Parameter identification based on measured data . . . . . . . . . . . . . . 417
2.5.6 derivative- derivative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
2.5.7 fit dat Parameter identification based on measured data . . . . . . . . . . . . . . 419
2.5.8 fsolve find a zero of a system of n nonlinear functions . . . . . . . . . . . . . . . 420
2.5.9 impl differential algebraic equation . . . . . . . . . . . . . . . . . . . . . . . . . 421
2.5.10 int2d definite 2D integral by quadrature and cubature method . . . . . . . . . . . 422
2.5.11 int3d definite 3D integral by quadrature and cubature method . . . . . . . . . . . 423
2.5.12 intc Cauchy integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
2.5.13 intg definite integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
2.5.14 intl Cauchy integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
2.5.15 karmarkar karmarkar algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
2.5.16 leastsq Solves non-linear least squares problems . . . . . . . . . . . . . . . . . . 427
2.5.17 linpro linear programming solver . . . . . . . . . . . . . . . . . . . . . . . . . . 429
2.5.18 lmisolver linear matrix inequation solver . . . . . . . . . . . . . . . . . . . . . . 430
2.5.19 lmitool tool for solving linear matrix inequations . . . . . . . . . . . . . . . . . 431
2.5.20 ode ordinary differential equation solver . . . . . . . . . . . . . . . . . . . . . . 431
2.5.21 ode discrete ordinary differential equation solver, discrete time simulation . . . . 434
2.5.22 ode root ordinary differential equation solver with root finding . . . . . . . . . . 435
2.5.23 odedc discrete/continuous ode solver . . . . . . . . . . . . . . . . . . . . . . . . 436
2.5.24 odeoptions set options for ode solvers . . . . . . . . . . . . . . . . . . . . . . . 437
2.5.25 optim non-linear optimization routine . . . . . . . . . . . . . . . . . . . . . . . 438
2.5.26 quapro linear quadratic programming solver . . . . . . . . . . . . . . . . . . . . 440
2.5.27 semidef semidefinite programming . . . . . . . . . . . . . . . . . . . . . . . . . 441
2.6 Signal Processing toolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
2.6.1 %asn elliptic integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
2.6.2 %k Jacobi’s complete elliptic integral . . . . . . . . . . . . . . . . . . . . . . . 445
2.6.3 %sn Jacobi ’s elliptic function . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
2.6.4 analpf create analog low-pass filter . . . . . . . . . . . . . . . . . . . . . . . . . 446
2.6.5 buttmag response of Butterworth filter . . . . . . . . . . . . . . . . . . . . . . . 447
2.6.6 casc cascade realization of filter from coefficients . . . . . . . . . . . . . . . . . 447
2.6.7 cepstrum cepstrum calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
2.6.8 cheb1mag response of Chebyshev type 1 filter . . . . . . . . . . . . . . . . . . . 448
2.6.9 cheb2mag response of type 2 Chebyshev filter . . . . . . . . . . . . . . . . . . . 449
2.6.10 chepol Chebychev polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
2.6.11 convol convolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
2.6.12 corr correlation, covariance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
2.6.13 cspect spectral estimation (correlation method) . . . . . . . . . . . . . . . . . . 452
2.6.14 czt chirp z-transform algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
2.6.15 dft discrete Fourier transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
2.6.16 ell1mag magnitude of elliptic filter . . . . . . . . . . . . . . . . . . . . . . . . . 455
2.6.17 eqfir minimax approximation of FIR filter . . . . . . . . . . . . . . . . . . . . . 455
2.6.18 eqiir Design of iir filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
2.6.19 faurre filter computation by simple Faurre algorithm . . . . . . . . . . . . . . . . 456
2.6.20 ffilt coefficients of FIR low-pass . . . . . . . . . . . . . . . . . . . . . . . . . . 457
2.6.21 fft fast Fourier transform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
2.6.22 filter modelling filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
2.6.23 find freq parameter compatibility for elliptic filter design . . . . . . . . . . . . . 458
2.6.24 findm for elliptic filter design . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
2.6.25 frfit frequency response fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
2.6.26 frmag magnitude of FIR and IIR filters . . . . . . . . . . . . . . . . . . . . . . . 460
2.6.27 fsfirlin design of FIR, linear phase filters, frequency sampling technique . . . . . 460
2.6.28 group group delay for digital filter . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.6.29 hank covariance to hankel matrix . . . . . . . . . . . . . . . . . . . . . . . . . . 461
2.6.30 hilb Hilbert transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
2.6.31 iir iir digital filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
2.6.32 iirgroup group delay Lp IIR filter optimization . . . . . . . . . . . . . . . . . . . 463
2.6.33 iirlp Lp IIR filter optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
2.6.34 intdec Changes sampling rate of a signal . . . . . . . . . . . . . . . . . . . . . . 464
2.6.35 jmat row or column block permutation . . . . . . . . . . . . . . . . . . . . . . . 464
2.6.36 kalm Kalman update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
2.6.37 lattn recursive solution of normal equations . . . . . . . . . . . . . . . . . . . . 465
2.6.38 lattp lattp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
2.6.39 lev Yule-Walker equations (Levinson’s algorithm) . . . . . . . . . . . . . . . . . 466
2.6.40 levin Toeplitz system solver by Levinson algorithm (multidimensional) . . . . . . 466
2.6.41 lgfft utility for fft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.6.42 lindquist Lindquist’s algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
2.6.43 mese maximum entropy spectral estimation . . . . . . . . . . . . . . . . . . . . 469
2.6.44 mfft multi-dimensional fft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
2.6.45 mrfit frequency response fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
2.6.46 phc Markovian representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
2.6.47 pspect cross-spectral estimate between 2 series . . . . . . . . . . . . . . . . . . . 472
2.6.48 remez Remez’s algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
2.6.49 remezb Minimax approximation of magnitude response . . . . . . . . . . . . . . 473
2.6.50 rpem RPEM estimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
2.6.51 sinc samples of sinc function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
2.6.52 sincd digital sinc function or Direchlet kernel . . . . . . . . . . . . . . . . . . . 476
2.6.53 srfaur square-root algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
2.6.54 srkf square root Kalman filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
2.6.55 sskf steady-state Kalman filter . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
 2.6.56 system observation update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
2.6.57 trans low-pass to other filter transform . . . . . . . . . . . . . . . . . . . . . . . 478
2.6.58 wfir linear-phase FIR filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
2.6.59 wiener Wiener estimate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
2.6.60 wigner ’time-frequency’ wigner spectrum . . . . . . . . . . . . . . . . . . . . . 480
2.6.61 window symmetric window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
2.6.62 yulewalk least-square filter design . . . . . . . . . . . . . . . . . . . . . . . . . 480
2.6.63 zpbutt Butterworth analog filter . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
2.6.64 zpch1 Chebyshev analog filter . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
2.6.65 zpch2 Chebyshev analog filter . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
2.6.66 zpell lowpass elliptic filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
2.7 Polynomial calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
2.7.1 bezout Bezout equation for polynomials . . . . . . . . . . . . . . . . . . . . . . 484
2.7.2 clean cleans matrices (round to zero small entries) . . . . . . . . . . . . . . . . 484
2.7.3 cmndred common denominator form . . . . . . . . . . . . . . . . . . . . . . . . 485
2.7.4 coeff coefficients of matrix polynomial . . . . . . . . . . . . . . . . . . . . . . . 485
2.7.5 coffg inverse of polynomial matrix . . . . . . . . . . . . . . . . . . . . . . . . . 485
2.7.6 colcompr column compression of polynomial matrix . . . . . . . . . . . . . . . 486
2.7.7 degree degree of polynomial matrix . . . . . . . . . . . . . . . . . . . . . . . . 486
2.7.8 denom denominator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
2.7.9 derivat rational matrix derivative . . . . . . . . . . . . . . . . . . . . . . . . . . 487
2.7.10 determ determinant of polynomial matrix . . . . . . . . . . . . . . . . . . . . . 487
2.7.11 detr polynomial determinant . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
2.7.12 diophant diophantine (Bezout) equation . . . . . . . . . . . . . . . . . . . . . . 488
2.7.13 factors numeric real factorization . . . . . . . . . . . . . . . . . . . . . . . . . . 488
2.7.14 gcd gcd calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.7.15 hermit Hermite form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.7.16 horner polynomial/rational evaluation . . . . . . . . . . . . . . . . . . . . . . . 490
2.7.17 hrmt gcd of polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
2.7.18 htrianr triangularization of polynomial matrix . . . . . . . . . . . . . . . . . . . 491
2.7.19 invr inversion of (rational) matrix . . . . . . . . . . . . . . . . . . . . . . . . . . 491
2.7.20 lcm least common multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
2.7.21 lcmdiag least common multiple diagonal factorization . . . . . . . . . . . . . . . 492
2.7.22 ldiv polynomial matrix long division . . . . . . . . . . . . . . . . . . . . . . . . 493
2.7.23 numer numerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
2.7.24 pdiv polynomial division . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
2.7.25 pol2des polynomial matrix to descriptor form . . . . . . . . . . . . . . . . . . . 494
2.7.26 pol2str polynomial to string conversion . . . . . . . . . . . . . . . . . . . . . . . 494
2.7.27 polfact minimal factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
2.7.28 residu residue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
2.7.29 roots roots of polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
2.7.30 routh t Routh’s table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
2.7.31 rowcompr row compression of polynomial matrix . . . . . . . . . . . . . . . . . 496
2.7.32 sfact discrete time spectral factorization . . . . . . . . . . . . . . . . . . . . . . 497
2.7.33 simp rational simplification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
2.7.34 simp mode toggle rational simplification . . . . . . . . . . . . . . . . . . . . . 498
2.7.35 sylm Sylvester matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
2.7.36 systmat system matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
2.8 Linear Algebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
2.8.1 aff2ab linear (affine) function to A,b conversion . . . . . . . . . . . . . . . . . . 501
2.8.2 balanc matrix or pencil balancing . . . . . . . . . . . . . . . . . . . . . . . . . . 502
2.8.3 bdiag block diagonalization, generalized eigenvectors . . . . . . . . . . . . . . . 502
2.8.4 chfact sparse Cholesky factorization . . . . . . . . . . . . . . . . . . . . . . . . 503
2.8.5 chol Cholesky factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
2.8.6 chsolve sparse Cholesky solver . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
2.8.7 classmarkov recurrent and transient classes of Markov matrix . . . . . . . . . . . 504
2.8.8 coff resolvent (cofactor method) . . . . . . . . . . . . . . . . . . . . . . . . . . 505
2.8.9 colcomp column compression, kernel, nullspace . . . . . . . . . . . . . . . . . . 505
2.8.10 companion companion matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
2.8.11 cond condition number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
2.8.12 det determinant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
2.8.13 eigenmarkov normalized left and right Markov eigenvectors . . . . . . . . . . . 507
2.8.14 ereduc computes matrix column echelon form by qz transformations . . . . . . . 508
2.8.15 exp element-wise exponential . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
2.8.16 expm square matrix exponential . . . . . . . . . . . . . . . . . . . . . . . . . . 509
2.8.17 fstair computes pencil column echelon form by qz transformations . . . . . . . . 509
2.8.18 fullrf full rank factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.8.19 fullrfk full rank factorization of Aˆk . . . . . . . . . . . . . . . . . . . . . . . . 510
2.8.20 genmarkov generates random markov matrix with recurrent and transient classes . 511
2.8.21 givens Givens transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
2.8.22 glever inverse of matrix pencil . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
2.8.23 gschur generalized Schur form (matrix pencils). . . . . . . . . . . . . . . . . . . 513
2.8.24 gspec eigenvalues of matrix pencil . . . . . . . . . . . . . . . . . . . . . . . . . 514
2.8.25 hess Hessenberg form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
2.8.26 householder Householder orthogonal reflexion matrix . . . . . . . . . . . . . . . 515
2.8.27 im inv inverse image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
2.8.28 inv matrix inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
2.8.29 kernel kernel, nullspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
2.8.30 kroneck Kronecker form of matrix pencil . . . . . . . . . . . . . . . . . . . . . 517
2.8.31 linsolve linear equation solver . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
2.8.32 lu LU factors of Gaussian elimination . . . . . . . . . . . . . . . . . . . . . . . 519
2.8.33 ludel utility function used with lufact . . . . . . . . . . . . . . . . . . . . . . . . 519
2.8.34 lufact sparse lu factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
2.8.35 luget sparse lu factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
2.8.36 lusolve sparse linear system solver . . . . . . . . . . . . . . . . . . . . . . . . . 521
2.8.37 lyap Lyapunov equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
2.8.38 nlev Leverrier’s algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
2.8.39 orth orthogonal basis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
2.8.40 pbig eigen-projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
2.8.41 pencan canonical form of matrix pencil . . . . . . . . . . . . . . . . . . . . . . . 524
2.8.42 penlaur Laurent coefficients of matrix pencil . . . . . . . . . . . . . . . . . . . . 524
2.8.43 pinv pseudoinverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.8.44 polar polar form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.8.45 proj projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
2.8.46 projspec spectral operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
2.8.47 psmall spectral projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
2.8.48 qr QR decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
2.8.49 quaskro quasi-Kronecker form . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
2.8.50 randpencil random pencil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
2.8.51 range range (span) of Aˆk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
2.8.52 rank rank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
2.8.53 rcond inverse condition number . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
2.8.54 rowcomp row compression, range . . . . . . . . . . . . . . . . . . . . . . . . . 531
2.8.55 rowshuff shuffle algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
2.8.56 rref computes matrix row echelon form by lu transformations . . . . . . . . . . . 532
2.8.57 schur [ordered] Schur decomposition . . . . . . . . . . . . . . . . . . . . . . . . 533
2.8.58 spaninter subspace intersection . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
2.8.59 spanplus sum of subspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
2.8.60 spantwo sum and intersection of subspaces . . . . . . . . . . . . . . . . . . . . . 535
2.8.61 spchol sparse cholesky factorization . . . . . . . . . . . . . . . . . . . . . . . . 536
 2.8.62 spec eigenvalues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
2.8.63 sqroot W*W’ hermitian factorization . . . . . . . . . . . . . . . . . . . . . . . . 537
2.8.64 sva singular value approximation . . . . . . . . . . . . . . . . . . . . . . . . . . 538
2.8.65 svd singular value decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . 538
2.8.66 sylv Sylvester equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
2.8.67 trace trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
2.9 Metanet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
2.9.1 add edge adds an edge or an arc between two nodes . . . . . . . . . . . . . . . . 541
2.9.2 add node adds a disconnected node to a graph . . . . . . . . . . . . . . . . . . . 541
2.9.3 adj lists computes adjacency lists . . . . . . . . . . . . . . . . . . . . . . . . . . 542
2.9.4 arc graph graph with nodes corresponding to arcs . . . . . . . . . . . . . . . . . 543
2.9.5 arc number number of arcs of a graph . . . . . . . . . . . . . . . . . . . . . . . 543
2.9.6 articul finds one or more articulation points . . . . . . . . . . . . . . . . . . . . 544
2.9.7 bandwr bandwidth reduction for a sparse matrix . . . . . . . . . . . . . . . . . . 544
2.9.8 best match best matching of a graph . . . . . . . . . . . . . . . . . . . . . . . . 545
2.9.9 chain struct chained structure from adjacency lists of a graph . . . . . . . . . . . 546
2.9.10 check graph checks a Scilab graph list . . . . . . . . . . . . . . . . . . . . . . . 547
2.9.11 circuit finds a circuit or the rank function in a directed graph . . . . . . . . . . . 548
2.9.12 con nodes set of nodes of a connected component . . . . . . . . . . . . . . . . . 548
2.9.13 connex connected components . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
2.9.14 contract edge contracts edges between two nodes . . . . . . . . . . . . . . . . . 549
2.9.15 convex hull convex hull of a set of points in the plane . . . . . . . . . . . . . . . 550
2.9.16 cycle basis basis of cycle of a simple undirected graph . . . . . . . . . . . . . . 551
2.9.17 delete arcs deletes all the arcs or edges between a set of nodes . . . . . . . . . . 551
2.9.18 delete nodes deletes nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
2.9.19 edge number number of edges of a graph . . . . . . . . . . . . . . . . . . . . . 553
2.9.20 find path finds a path between two nodes . . . . . . . . . . . . . . . . . . . . . . 553
2.9.21 gen net generation of a network . . . . . . . . . . . . . . . . . . . . . . . . . . 554
2.9.22 girth girth of a directed graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
2.9.23 glist graph list creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
2.9.24 graph-list description of graph list . . . . . . . . . . . . . . . . . . . . . . . . . 555
2.9.25 graph 2 mat node-arc or node-node incidence matrix of a graph . . . . . . . . . 558
2.9.26 graph center center of a graph . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
2.9.27 graph complement complement of a graph . . . . . . . . . . . . . . . . . . . . 559
2.9.28 graph diameter diameter of a graph . . . . . . . . . . . . . . . . . . . . . . . . . 560
2.9.29 graph power kth power of a directed 1-graph . . . . . . . . . . . . . . . . . . . . 560
2.9.30 graph simp converts a graph to a simple undirected graph . . . . . . . . . . . . . 561
2.9.31 graph sum sum of two graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
2.9.32 graph union union of two graphs . . . . . . . . . . . . . . . . . . . . . . . . . . 562
2.9.33 hamilton hamiltonian circuit of a graph . . . . . . . . . . . . . . . . . . . . . . . 563
2.9.34 is connex connectivity test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
2.9.35 knapsack solves a 0-1 multiple knapsack problem . . . . . . . . . . . . . . . . . 564
2.9.36 line graph graph with nodes corresponding to edges . . . . . . . . . . . . . . . . 564
2.9.37 load graph loads a graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
2.9.38 make graph makes a graph list . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
2.9.39 mat 2 graph graph from node-arc or node-node incidence matrix . . . . . . . . . 566
2.9.40 max cap path maximum capacity path . . . . . . . . . . . . . . . . . . . . . . . 567
2.9.41 max clique maximum clique of a graph . . . . . . . . . . . . . . . . . . . . . . 568
2.9.42 max flow maximum flow between two nodes . . . . . . . . . . . . . . . . . . . 568
2.9.43 mesh2d triangulation of n points in the plane . . . . . . . . . . . . . . . . . . . . 569
2.9.44 metanet opens a Metanet window . . . . . . . . . . . . . . . . . . . . . . . . . . 571
2.9.45 metanet sync asynchronous or synchronous mode in Metanet . . . . . . . . . . . 572
2.9.46 min lcost cflow minimum linear cost constrained flow . . . . . . . . . . . . . . 572
2.9.47 min lcost flow1 minimum linear cost flow . . . . . . . . . . . . . . . . . . . . . 573
2.9.48 min lcost flow2 minimum linear cost flow . . . . . . . . . . . . . . . . . . . . . 574
 2.9.49 min qcost flow minimum quadratic cost flow . . . . . . . . . . . . . . . . . . . 576
2.9.50 min weight tree minimum weight spanning tree . . . . . . . . . . . . . . . . . . 577
2.9.51 neighbors nodes connected to a node . . . . . . . . . . . . . . . . . . . . . . . . 577
2.9.52 netclose closes a Metanet window . . . . . . . . . . . . . . . . . . . . . . . . . 578
2.9.53 netwindow chooses a Metanet window . . . . . . . . . . . . . . . . . . . . . . . 578
2.9.54 netwindows gets the numbers of Metanet windows . . . . . . . . . . . . . . . . 579
2.9.55 node number number of nodes of a graph . . . . . . . . . . . . . . . . . . . . . 579
2.9.56 nodes 2 path path from a set of nodes . . . . . . . . . . . . . . . . . . . . . . . 579
2.9.57 nodes degrees degrees of the nodes of a graph . . . . . . . . . . . . . . . . . . . 580
2.9.58 path 2 nodes set of nodes from a path . . . . . . . . . . . . . . . . . . . . . . . 580
2.9.59 perfect match min-cost perfect matching . . . . . . . . . . . . . . . . . . . . . . 581
2.9.60 pipe network solves the pipe network problem . . . . . . . . . . . . . . . . . . . 582
2.9.61 plot graph general plot of a graph . . . . . . . . . . . . . . . . . . . . . . . . . 582
2.9.62 predecessors tail nodes of incoming arcs of a node . . . . . . . . . . . . . . . . . 584
2.9.63 qassign solves a quadratic assignment problem . . . . . . . . . . . . . . . . . . . 584
2.9.64 salesman solves the travelling salesman problem . . . . . . . . . . . . . . . . . . 585
2.9.65 save graph saves a graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
2.9.66 shortest path shortest path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
2.9.67 show arcs highlights a set of arcs . . . . . . . . . . . . . . . . . . . . . . . . . . 587
2.9.68 show graph displays a graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
2.9.69 show nodes highlights a set of nodes . . . . . . . . . . . . . . . . . . . . . . . . 588
2.9.70 split edge splits an edge by inserting a node . . . . . . . . . . . . . . . . . . . . 589
2.9.71 strong con nodes set of nodes of a strong connected component . . . . . . . . . 589
2.9.72 strong connex strong connected components . . . . . . . . . . . . . . . . . . . . 590
2.9.73 subgraph subgraph of a graph . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
2.9.74 successors head nodes of outgoing arcs of a node . . . . . . . . . . . . . . . . . 591
2.9.75 supernode replaces a group of nodes with a single node . . . . . . . . . . . . . . 592
2.9.76 trans closure transitive closure . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
2.10 Scicos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
2.10.1 Scicos editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
2.10.2 Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
2.10.3 Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
2.10.4 Useful Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
2.11 Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
2.11.1 analyze frequency plot of a sound signal . . . . . . . . . . . . . . . . . . . . . . 631
2.11.2 auread load .au sound file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
2.11.3 auwrite writes .au sound file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
2.11.4 lin2mu linear signal to mu-law encoding . . . . . . . . . . . . . . . . . . . . . . 632
2.11.5 loadwave load a sound <<wav>> file into scilab . . . . . . . . . . . . . . . . 632
2.11.6 mapsound Plots a sound map . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
2.11.7 mu2lin mu-law encoding to linear signal . . . . . . . . . . . . . . . . . . . . . . 633
2.11.8 playsnd sound player facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
2.11.9 savewave save data into a sound <<wav>> file. . . . . . . . . . . . . . . . . . 634
2.11.10 sound sound player facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
2.11.11 wavread load .wav sound file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
2.11.12 wavwrite writes .wav sound file . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
2.12 Cumulative Distribution Functions, Inverses, Random variables . . . . . . . . . . . . . . . 637
2.12.1 cdfbet cumulative distribution function Beta distribution . . . . . . . . . . . . . 638
2.12.2 cdfbin cumulative distribution function Binomial distribution . . . . . . . . . . . 638
2.12.3 cdfchi cumulative distribution function chi-square distribution . . . . . . . . . . 639
2.12.4 cdfchn cumulative distribution function non-central chi-square distribution . . . 639
2.12.5 cdff cumulative distribution function F distribution . . . . . . . . . . . . . . . . 640
2.12.6 cdffnc cumulative distribution function non-central f-distribution . . . . . . . . . 640
2.12.7 cdfgam cumulative distribution function gamma distribution . . . . . . . . . . . 641
2.12.8 cdfnbn cumulative distribution function negative binomial distribution . . . . . . 642
 2.12.9 cdfnor cumulative distribution function normal distribution . . . . . . . . . . . . 642
2.12.10 cdfpoi cumulative distribution function poisson distribution . . . . . . . . . . . 643
2.12.11 cdft cumulative distribution function Student’s T distribution . . . . . . . . . . . 643
2.12.12 grand Random number generator . . . . . . . . . . . . . . . . . . . . . . . . . . 644
2.13 TCL/Tk interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
2.13.1 ScilabEval tcl instruction : Evaluate a string with scilab interpreter . . . . . . . . 649
2.13.2 TK EvalFile Reads and evaluate a tcl/tk file . . . . . . . . . . . . . . . . . . . . 649
2.13.3 TK EvalStr Evaluate a string whithin the tcl/tk interpreter . . . . . . . . . . . . . 650
2.13.4 TK GetVar Get a tcl/tk variable value . . . . . . . . . . . . . . . . . . . . . . . 651
2.13.5 TK SetVar Set a tcl/tk variable value . . . . . . . . . . . . . . . . . . . . . . . . 651
2.13.6 close close a figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
2.13.7 figure create a figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
2.13.8 findobj find an object with specified property . . . . . . . . . . . . . . . . . . . . 653
2.13.9 gcf gets the current active tksci figure . . . . . . . . . . . . . . . . . . . . . . . 654
2.13.10 get Retrieve a property value from an User Interface object. . . . . . . . . . . . . 654
2.13.11 set set a property value of a User Interface object. . . . . . . . . . . . . . . . . . 655
2.13.12 uicontrol create a Graphic User Interface object . . . . . . . . . . . . . . . . . . 655
2.13.13 uimenu Create a menu or a submenu in a figure . . . . . . . . . . . . . . . . . . 657
2.14 Language and data translation tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
2.14.1 ascii string ascii conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
2.14.2 excel2sci reads ascii Excel files . . . . . . . . . . . . . . . . . . . . . . . . . . 660
2.14.3 formatman formats all help files in a directory in ascii, text or html . . . . . . . . 660
2.14.4 fun2string generates ascii definition of a scilab function . . . . . . . . . . . . . . 661
2.14.5 mfile2sci Matlab M file to scilab translation function . . . . . . . . . . . . . . . 661
2.14.6 mtlb load load variables from file with matlab4 format. . . . . . . . . . . . . . . 663
2.14.7 mtlb save save variables on file with matlab4 format. . . . . . . . . . . . . . . . 663
2.14.8 pol2tex convert polynomial to TeX format . . . . . . . . . . . . . . . . . . . . . 664
2.14.9 sci2for scilab function to Fortran routine conversion . . . . . . . . . . . . . . . . 664
2.14.10 texprint TeX output of Scilab object . . . . . . . . . . . . . . . . . . . . . . . . 665
2.14.11 translatepaths translate a set of Matlab M file directories to scilab . . . . . . . . 665
2.15 Interprocess communication toolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
2.15.1 AdCommunications advanced communication toolbox for parallel programming . 668
2.15.2 Example just to test the environment . . . . . . . . . . . . . . . . . . . . . . . . 668
2.15.3 pvm communications with other applications using Parallel Virutal Machine . . . 668
2.15.4 pvm addhosts add hosts to the virtual machine. . . . . . . . . . . . . . . . . . . 669
2.15.5 pvm bcast broacasts a message to all members of a group . . . . . . . . . . . . . 669
2.15.6 pvm bufinfo Returns information about a message buffer. . . . . . . . . . . . . . 670
2.15.7 pvm config sends a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
2.15.8 pvm delhosts deletes hosts from the virtual machine. . . . . . . . . . . . . . . . 671
2.15.9 pvm error Prints message describing an error returned by a PVM call. . . . . . . 671
2.15.10 pvm exit tells the local pvmd that this process is leaving PVM. . . . . . . . . . . 672
2.15.11 pvm sci2f77 Convert a F77 complex into a complex scalar . . . . . . . . . . . . 672
2.15.12 pvm get timer Gets the system’s notion of the current time. . . . . . . . . . . . . 673
2.15.13 pvm getinst returns the instance number in a group of a PVM process. . . . . . . 673
2.15.14 pvm gsize returns the number of members presently in the named group. . . . . . 674
2.15.15 pvm halt stops the PVM daemon . . . . . . . . . . . . . . . . . . . . . . . . . . 674
2.15.16 pvm joingroup enrolls the calling process in a named group. . . . . . . . . . . . 675
2.15.17 pvm kill Terminates a specified PVM process. . . . . . . . . . . . . . . . . . . . 675
2.15.18 pvm lvgroup Unenrolls the calling process from a named group. . . . . . . . . . 676
2.15.19 pvm mytid returns the tid of the calling process. . . . . . . . . . . . . . . . . . . 676
2.15.20 pvm probe Check if message has arrived. . . . . . . . . . . . . . . . . . . . . . 677
2.15.21 pvm recv receive a message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
2.15.22 pvm reduce Performs a reduce operation over members of the specified group. . . 678
2.15.23 pvm sci2f77 Convert complex scalar into F77 . . . . . . . . . . . . . . . . . . . 679
2.15.24 pvm send immediately sends (or multicast) data. . . . . . . . . . . . . . . . . . 679
2.15.25 pvm set timer Sets the system’s notion of the current time. . . . . . . . . . . . . 680
2.15.26 pvm spawn Starts new Scilab processes. . . . . . . . . . . . . . . . . . . . . . . 681
2.15.27 pvm spawn independent Starts new PVM processes. . . . . . . . . . . . . . . . 681
2.15.28 pvm start Start the PVM daemon . . . . . . . . . . . . . . . . . . . . . . . . . . 682
2.15.29 pvm tidtohost returns the host of the specified PVM process. . . . . . . . . . . . 683
2.15.30 pvmd3 PVM daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
2.15.31 Communications communications with other applications using GeCi . . . . . . 686
2.15.32 CreateLink creates a link between two applications . . . . . . . . . . . . . . . . 686
2.15.33 DestroyLink destroys the link between two applications . . . . . . . . . . . . . . 687
2.15.34 ExecAppli executes an application . . . . . . . . . . . . . . . . . . . . . . . . . 687
2.15.35 ExecScilab executes another local Scilab . . . . . . . . . . . . . . . . . . . . . . 687
2.15.36 ExeclScilab executes another linked local Scilab . . . . . . . . . . . . . . . . . . 688
2.15.37 GetMsg gets a pending message . . . . . . . . . . . . . . . . . . . . . . . . . . 688
2.15.38 SendMsg sends a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
2.15.39 WaitMsg waits for a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Chapter 1

Basic functions

1.1 Programming

25
bool2s Scilab Function

1.1.1 abort interrupt evaluation.

DESCRIPTION :
abort interrupts current evaluation and gives the prompt. Within a pause level abort return to level
0 prompt.
S EE A LSO : quit 67, pause 64, break 28, abort 26, quit 67

1.1.2 ans answer

DESCRIPTION :
ans means ”answer”. Variable ans is created automatically when expressions are not assigned. ans
contains the last unassigned evaluated expression.

1.1.3 apropos searches keywords in Scilab help

CALLING SEQUENCE :

apropos word
apropos ’string’

DESCRIPTION :
Looks for keywords in man/*/whatis files.
EXAMPLE :

apropos ’+’
apropos ode
apropos ’list of’

S EE A LSO : help 298

1.1.4 backslash - left matrix division.

CALLING SEQUENCE :

x=A\\b

DESCRIPTION :
Backslash denotes left matrix division. x=Anb is a solution to A*x=b.
If A is nonsingular x=Anb (uniquely defined) is equivalent to x=inv(A)*b.
If A is singular, x is a least square solution. i.e. norm(A*x-b) is minimal. If A is full column rank, the
least square solution, x=Anb, is uniquely defined (there is a unique x which minimizes norm(A*x-b)).
If A is not full column rank, then the least square solution is not unique, and x=Anb, in general, is not the
solution with minimum norm (the minimum norm solution is x=pinv(A)*b).
A.nB is the matrix with (i,j) entry A(i,j)nB(i,j). If A (or B) is a scalar A.nB is equivalent to
A*ones(B).nB (or A.n(B*ones(A))
An.B is an operator with no predefined meaning. It may be used to define a new operator (see overloading)
with the same precedence as * or /.
EXAMPLE :

Scilab Group September 1997 26

brackets Scilab Function

A=rand(3,2);b=[1;1;1]; x=A\\b; y=pinv(A)*b; x-y

A=rand(2,3);b=[1;1]; x=A\\b; y=pinv(A)*b; x-y, A*x-b, A*y-b
A=rand(3,1)*rand(1,2); b=[1;1;1]; x=A\\b; y=pinv(A)*b; A*x-b, A*y-b
A=rand(2,1)*rand(1,3); b=[1;1]; x=A\\b; y=pinv(A)*b; A*x-b, A*y-b

S EE A LSO : slash 71, inv 516, pinv 525, percent 64, ieee 50

1.1.5 bool2s convert boolean matrix to a zero one matrix.

CALLING SEQUENCE :

bool2s(x)

PARAMETERS :

x : a boolean vector or a boolean matrix or a constant matrix

DESCRIPTION :
If x is a boolean matrix, bool2s(x) returns the matrix where ”true” values are replaced by 1 and
”false” value by 0.
If x is a ”standard” matrix, bool2s(x) returns the matrix where non-zero values are replaced by 1.
EXAMPLE :

bool2s([%t %t %f %t])
bool2s([2.3 0 10 -1])

S EE A LSO : boolean 27, find 41

1.1.6 boolean Scilab Objects, boolean variables and operators & j ˜

DESCRIPTION :
A boolean variable is %T (for ”true”) or %F (for ”false”). These variables can be used to define matrices
of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for ele-
ments extraction/insertion and concatenation. Note that other usual operations (+, *, -, ˆ, etc) are
undefined for booleans matrices, three special operators are defined for boolean matrices:

˜b : is the element wise negation of boolean b (matrix).

b1&b2 : is the element wise logical and of b1 and b2 (matrices).
b1jb2 : is the element wise logical or of b1 and b2 (matrices).
Boolean variables can be used for indexing matrices or vectors. For instance
a([%T,%F,%T],:) returns the submatrix made of rows 1 and 3 of a. Boolean sparse matrices
are supported.

EXAMPLE :

[1,2]==[1,3]
[1,2]==1
a=1:5; a(a>2)

S EE A LSO : matrices 58, or 205, and 165, not 204

Scilab Group April 1993 27

call Scilab Function

1.1.7 brackets - left and right brackets

CALLING SEQUENCE :

[a11,a12,...;a21,a22,...;...]
[s1,s2,...]=func(...)

PARAMETERS :

a11,a12,... : any matrix (real, polynomial, rational,syslin list ...) with appropriate dimensions
s1,s2,... : any possible variable name

DESCRIPTION :
Left and right brackets are used to note vector and matrix concatenation. These symbols are also used to
denote a multiple left-hand-side for a function call
Inside concatenation brackets, blank or comma characters mean ”column concatenation”, semicolumn and
carriage-return mean ”row concatenation”.
Note : to avoid confusions it is safer to use commas instead of blank to separate columns.
Within multiple lhs brackets variable names must be separated by comma.
EXAMPLES :

[6.9,9.64; sqrt(-1) 0]
[1 +%i 2 -%i 3]
[]
[’this is’;’a string’;’vector’]
s=poly(0,’s’);[1/s,2/s]
[tf2ss(1/s),tf2ss(2/s)]

[u,s]=schur(rand(3,3))

S EE A LSO : comma 32, semicolumn 70

1.1.8 break keyword to interrupt loops

DESCRIPTION :
Inside a for or while loop, the command break forces the end of the loop.
EXAMPLE :

k=0; while 1==1, k=k+1; if k > 100 then break,end; end

S EE A LSO : while 77, if 50, for 42, abort 26, return 68

1.1.9 call Fortran or C user routines call

CALLING SEQUENCE :

// long form ’out’ is present

[y1,...,yk]=call("ident",x1,px1,"tx1",...,xn,pxn,"txn",
"out",[ny1,my1],py1,"ty1",...,[nyl,myl],pyl,"tyl")
// short form : no ’out’ parameter
[y1,....,yk]=call("ident",x1,...,xn)

Scilab Group April 1993 28

call Scilab Function

PARAMETERS :

"ident" : string.
xi : real matrix or string
pxi, pyi : integers
txi, tyi : character string "d", "r", "i" or "c".

DESCRIPTION :
Interactive call of Fortran (or C) user program from Scilab. The routine must be previously linked with
Scilab. This link may be done:

- with Scilab ”link” command (incremental ”soft” linking) during the Scilab session.(see link)
- by ”hard” re-linking. Writing the routine call within Scilab routine default/Ex-fort.f, adding
the entry point in the file default/Flist and then re linking Scilab with the command make
bin/scilex in main Scilab directory.
There are two forms of calling syntax, a short one and a long one. The short one will give faster code
and an easier calling syntax but one has to write a small (C or Fortran) interface in order to make
the short form possible. The long one make it possible to call a Fortran routine (or a C one) whitout
modification of the code but the syntax is more complex and the interpreted code slower.

The meaning of each parameter is described now:

"ident" is the name of the called subroutine.

x1,...,xn are input variables (real matrices or strings) sent to the routine,
px1,...,pxn are the respective positions of these variables in the calling sequence of the routine "ident"
and
tx1,...,txn are their types ("r", "i", "d" and "c" for real (float) , integer, double precision and
strings)
"out" is a keyword used to separate input variables from output variables. when this key word is present
it is assumes that the long form will be used and when it is not prsent, the short form is used.
[ny1, my1] are the size (# of rows and columns. For ’c’ arguments,m1*n1 is the number of charaters
) of output variables and
py1, ... are the positions of output variables (possibly equal to pxi ) in the calling sequence of the
routine. The pyi’s integers must be in increasing order.
"ty1", ... are the Fortran types of output variables. The k first output variables are put in y1,...,
yk.

If an output variable coincides with an input variable (i.e. pyi=pxj ) one can pass only its position pyi
. The size and type of yi are then the same as those of xi. If an output variable coincides with an input
variable and one specify the dimensions of the output variable [myl,nyl] must follow the compatibility
condition mxk*nxk >= myl*nyl.
In the case of short syntax , [y1,....,yk]=call("ident",x1,...,xn), the input parameters
xi’s and the name "ident" are sent to the interface routine Ex-fort. This interface routine is then
very similar to an interface (see the source code in the directory SCIDIR/default/Ex-fort.f).
For example the following program:

subroutine foof(c,a,b,n,m)
integer n,m
double precision a(*),b,c(*)
do 10 i=1,m*n
c(i) = sin(a(i))+b
10 continue
end

link("foof.o","foof")
a=[1,2,3;4,5,6];b= %pi;

Scilab Group April 1993 29

clear Scilab Function

[m,n]=size(a);
// Inputs:
// a is in position 2 and double
// b 3 double
// n 4 integer
// m 5 integer
// Outputs:
// c is in position 1 and double with size [m,n]
c=call("foof",a,2,"d",b,3,"d",n,4,"i",m,5,"i","out",[m,n],1,"d");
returns the matrix c=2*a+b.
If your machine is a DEC Alpha, SUN Solaris or SGI you may have to change the previous command
line link("foo.o","foo") by one of the followings:
link(’foof.o -lfor -lm -lc’,’foof’).
link(’foof.o -lftn -lm -lc’,’foof’).
link(’foof.o -L/opt/SUNWspro/SC3.0/lib/lib77 -lm -lc’,’foof’).
The same example coded in C:
void fooc(c,a,b,m,n)
double a[],*b,c[];
int *m,*n;
{ double sin();
int i;
for ( i =0 ; i < (*m)*(*n) ; i++)
c[i] = sin(a[i]) + *b;
}

link("fooc.o","fooc","C") // note the third argument

a=[1,2,3;4,5,6];b= %pi;
[m,n]=size(a);
c=call("fooc",a,2,"d",b,3,"d",m,4,"i",n,5,"i","out",[m,n],1,"d");

S EE A LSO : link 303, c_link 297, intersci 303, addinter 265

1.1.10 case keyword used in select

DESCRIPTION :
Keyword used in select ... case Use it in the following way:
select expr0,
case expr1 then instructions1,
case expr2 then instructions2,
...
case exprn then instructionsn,
[else instructions],
end

S EE A LSO : select 69, while 77, end 34, for 42

1.1.11 clear kills variables

CALLING SEQUENCE :

Scilab Group April 1993 30

comma Scilab Function

clear a

DESCRIPTION :
This command kills variables which are not protected. It removes the named variables from the environ-
ment. By itself clear kills all the variables except the variables protected by predef. Thus the two
commands predef(0) and clear remove all the variables.
Normally, protected variables are standard libraries and variables with the percent prefix.
Note the particular syntax clear a and not clear(a). Note also that a=[] does not kill a but sets
a to an empty matrix.
S EE A LSO : predef 66, who 77

1.1.12 clearglobal kills global variables

CALLING SEQUENCE :

clearglobal()
clearglobal nam1 .. namn
clearglobal(’nam1’, ..,’namn’)

PARAMETERS :

nam1,..., namn : valid variable names

DESCRIPTION :
clearglobal() kills all the global variables.
clearglobal nam1 .. namn kills the global variables given by their names
Note that clearglobal() only clears the global variables, the local variables pointing on these global
variables are not destroyed.
S EE A LSO : global 46, who 77
EXAMPLE :

global a b c
a=1;b=2;c=3;
who(’global’)
clearglobal b
who(’global’)

1.1.13 colon - colon operator

DESCRIPTION :

: : Colon. Used in subscripts and loops.

j:k is the vector [j, j+1, ..., k] (empty if J>K).

j:d:k is the vector [j, j+d, ..., j+m*d]
The colon notation can also be used to pick out selected rows, columns and elements of vectors and matrices.
A(:) is the vector of all the elements of A regarded as a single column.
A(:,j) is the j-th column of A
A(j:k) is [A(j),A(j+1),...,A(k)]
A(:,j:k) is [A(:,j),A(:,j+1),...,A(:,k)]
A(:)=w fills the matrix A with entries of w (taken column by column if w is a matrix).

S EE A LSO : matrix 58

Scilab Group April 1993 31

dot Scilab Symbol

1.1.14 comma - column, instruction, argument separator

DESCRIPTION :
Commas are used to separate parameters in functions or to separate entries of row vectors.
Blanks can also be used to separate entries in a row vector but use preferably commas.
Also used to separate Scilab instructions. (Use ; to have the result not displayed on the screen).
EXAMPLES :

a=[1,2,3;4,5,6];
a=1,b=1;c=2

S EE A LSO : semi 70, brackets 28

1.1.15 comments comments

DESCRIPTION :
Command lines which begin by // are not interpreted by Scilab.
Comments must not begin with //end !

1.1.16 debug debugging level

CALLING SEQUENCE :

debug(level-int)
level-int=debug()

PARAMETERS :

level-int : integer (0 to 4)

DESCRIPTION :
For the values 0,1,2,3,4 of level-int , debug defines various levels of debugging. (For Scilab experts
only).

1.1.17 dot - symbol

CALLING SEQUENCE :

123.33
a.*b
[123,..
456]
.SH DESCRIPTION
.TP 6
.
Dot is used to mark decimal point for numbers : 3.25 and 0.001
.TP
.<op>
used in cunjunction with other operator symbols (* / \\ ˆ ’) to form
other operators. Element-by-element multiplicative operations are

Scilab Group April 1993 32

end Scilab Function

obtained using .* , .ˆ , ./ , .\\ or .’. For example, C = A ./ B is

the matrix with elements c(i,j) = a(i,j)/b(i,j). Kronecker product is
noted .*. .

Note that when dot follows a number it is alway prt of the number so 2.*x
is evaluated as 2.0*x and 2 .*x is evaluated as (2).*x
.TP
..
Continuation. Two or more decimal points at the end of
a line causes the following line to be a continuation.
.SH EXAMPLE
.nf
1.345
x=[1 2 3];x.ˆ2 .*x // a space is required between 2 and dot
[123,..
456]

S EE A LSO : star 72, hat 47, slash 71, backslash 26

1.1.18 else keyword in if-then-else

DESCRIPTION :
Used with if.
S EE A LSO : if 50

1.1.19 elseif keyword in if-then-else

DESCRIPTION :
See if,then,else .

1.1.20 empty - empty matrix

DESCRIPTION :
[] denotes the empty matrix. It is uniquely defined and has 0 row and 0 column, i.e. size([])
=[0,0] . The following convenient conventions are made:
[] * A = A * [] = []
[] + A = A + [] = A
[ [], A] = [A, []] = A inv([]) =[]
det([])=cond([])=rcond([])=1, rank([])=0
Matrix functions return [] or an error message when there is no obvious answer. Empty linear systems (
syslin lists) may have several rows or columns.
EXAMPLE :
s=poly(0,’s’); A = [s, s+1];
A+[], A*[]
A=rand(2,2); AA=A([],1), size(AA)
svd([])
w=ssrand(2,2,2); wr=[]*w; size(wr), w1=ss2tf(wr), size(w1)

S EE A LSO : matrices 58, poly 65, string 284, boolean 27, rational 68, syslin
224

Scilab Group April 1993 33

errclear Scilab Function

1.1.21 end end keyword

DESCRIPTION :
Used at end of loops or conditionals. for, while, if, select must be terminated by end .

S EE A LSO : for 42, while 77, if 50, select 69

1.1.22 equal - affectation, comparison equal sign

DESCRIPTION :
Equal sign is used to denote a value affectation to a variable.
== denote equality comparison between two expressions and returns a boolean matrix.
EXAMPLES :
a=sin(3.2)
[u,s]=schur(rand(3,3))
[1:10]==4
1˜=2
S EE A LSO : less 56, boolean 27

1.1.23 errcatch error trapping

CALLING SEQUENCE :
errcatch(n [,’action’] [,’option’])
PARAMETERS :
n : integer
action, option : strings
DESCRIPTION :
errcatch gives an ”action” (error-handler) to be performed when an error of type n occurs. n has the
following meaning:
if n>0, n is the error number to trap
if n<0 all errors are to be trapped
action is one of the following character strings:
"pause" : a pause is executed when trapping the error. This option is useful for debugging purposes. Use
whereami() to get informations on the current context.
"continue" : next instruction in the function or exec files is executed, current instruction is ignored.
It is possible to check if an error has occured using the iserror function. Do not forget to clear
the error using the errclear function as soon as possible This option is useful for error recov-
ery. In many cases, usage of errcatch(n,"continue",..) can be replaced by the use of
execstr function.
"kill" : default mode, all intermediate functions are killed, scilab goes back to the level 0 prompt.
"stop" : interrupts the current Scilab session (useful when Scilab is called from an external program).
option is the character string ’nomessage’ for killing error message.
To set back default mode, enter errcatch(-1,"kill") or similarly errcatch(-1).
Then called in a scilab function the errcatch is automatically reset to the default mode when the func-
tion returns.
S EE A LSO : errclear 35, iserror 55, whereami 76, execstr 37

Scilab Group April 1993 34

exec Scilab Function

1.1.24 errclear error clearing

CALLING SEQUENCE :
errclear([n])
DESCRIPTION :
clears the action (error-handler) connected to error of type n.
If n is positive, it is the number of the cleared error ; otherwise all errors are cleared (default case)
S EE A LSO : errcatch 34, iserror 55, lasterror 55

1.1.25 error error messages

CALLING SEQUENCE :
error(’string’ [,n])
error(m)
DESCRIPTION :
prints the character string ’string’ in an error message and stops the current instruction.
If n is given, it is associated to the number of the error. n should be larger than 10000 (default value).
error(m) prints the message associated with the error number m.
S EE A LSO : warning 261

1.1.26 evstr evaluation of expressions

CALLING SEQUENCE :
H=evstr(Z)
[H,ierr]=evstr(Z)
PARAMETERS :
Z : matrix of character strings M or list(M,Subexp)
M : matrix of character strings
Subexp : vector of character strings
H : matrix
ierr : integer, error indicator
DESCRIPTION :
Returns the result of the evaluation of the matrix of character strings M. Each element of the matrix must
define a valid Scilab expression.
If the evaluation of M expression leads to an error, the single return value version, H=evstr(M), raises
the error as usual. The two return values version, [H,ierr]=evstr(M), on the other hand, produces no
error, but returns the error number in ierr.
If Z is a list, Subexp is a vector of character strings, that defines sub expressions which are evalu-
ated before evaluating M. These sub expressions must be referred to as %(k) in M, where k is the sub-
expression’s index in Subexp.
evstr(’a=1’) is not valid (use execstr instead).
EXAMPLES :
a=1; b=2; Z=[’a’,’b’] ; evstr(Z)

a=1; b=2; Z=list([’%(1)’,’%(1)-%(2)’],[’a+1’,’b+1’]);

evstr(Z)
S EE A LSO : execstr 37

Scilab Group April 1993 35

exec Scilab Function

1.1.27 exec script file execution

CALLING SEQUENCE :

exec(path [,mode])
exec(fun [,mode])
ierr=exec(path,’errcatch’ [,mode])
ierr=exec(fun,’errcatch’ [,mode])

PARAMETERS :

path : a string, the path of the script file

mode : an integer scalar, the execution mode (see below)
fun : a scilab function
ierr : integer, 0 or error number

DESCRIPTION :
exec(path [,mode]) executes sequentialy the scilab instructions contained in the file given by path
with an optional execution mode mode .
The different cases for mode are :

0 : the default value

-1 : nothing is printed
1 : echo of each command line
2 : prompt --> is printed
3 : echoes + prompts
4 : stops before each prompt
7 : stops + prompts + echoes : useful mode for demos.

exec(fun [,mode]) executes function fun as a script: no input nor output argument nor specific
variable environment. This form is more efficient, because script code may be pre-compiled (see getf,
comp). This method for script evaluation allows to store scripts as function in libraries.
If an error is encountered while executing , if ’errcatch’ flag is present exec issues an error message,
aborts execution of the instructions and resume with ierr equal to the error number,if ’errcatch’ flag is
not present, standard error handling works.
REMARK :
exec files may now be used to define functions using the inline function definition syntax (see function).
EXAMPLES :

// create a script file

write(TMPDIR+’/myscript’,’a=1;b=2’)
// execute it
exec(TMPDIR+’/myscript’)
who

//create a function
deff(’y=foo(x)’,’a=x+1;y=aˆ2’)
clear a b
//execute the function
foo(1)
// a is a variable created in the environment of the function foo
// it is destroyed when foo returns
who

x=1 //create x to make it known by the script foo

Scilab Group April 1993 36

exists Scilab Function

exec(foo)
// a and y are created in the current environment
who

S EE A LSO : getf 272, execstr 37, evstr 35, comp 266, mode 59, chdir 297,
getcwd 67

1.1.28 execstr execute Scilab code in strings

CALLING SEQUENCE :

execstr(instr)
ierr=execstr(instr,’errcatch’ [,msg])

PARAMETERS :

instr : vector of character strings, Scilab instruction to be executed.

ierr : integer, 0 or error number.
msg : character string with values ’m’ or ’n’. Default value is ’n’.

DESCRIPTION :
Executes the Scilab instructions given in argument instr.
If the ’errcatch’ flag is not present, error handling works as usual.
If the ’errcatch’ flag is set, and an error is encountered while executing the instructions defined in instr,
execstr issues no error message, but aborts execution of the instr instructions (at the point where
the error occurred), and resumes with ierr equal to the error number. In this case the display of the error
message is controlled by the msg option:
"m" : error message is displayed and recorded.
"n" : no error message is displayed, but the error message is recorded (see lasterror). This is the
default.

EXAMPLE :

execstr(’a=1’) // sets a=1.

execstr(’1+1’) // does nothing (while evstr(’1+1’) returns 2)

execstr([’if %t then’;
’ a=1’;
’ b=a+1’;
’else’
’ b=0’
’end’])

execstr(’a=zzzzzzz’,’errcatch’)
execstr(’a=zzzzzzz’,’errcatch’,’m’)

S EE A LSO : evstr 35, lasterror 55, error 35

1.1.29 exists checks variable existence

CALLING SEQUENCE :

exists(name [,where])

Scilab Group April 1993 37

extraction Scilab Function

PARAMETERS :
name : a character string
where : an optional character string with default value ’all’
DESCRIPTION :
exists(name) returns 1 if the variable named name exists and 0 otherwise.
Caveats: a function which uses exists may return a result which depends on the environment!
exists(name,’local’) returns 1 if the variable named name exists in the local environment
of the current function and 0 otherwise.
EXAMPLE :
deff(’foo(x)’,..
[’disp([exists(’’a12’’),exists(’’a12’’,’’local’’)])’
’disp([exists(’’x’’),exists(’’x’’,’’local’’)])’])
foo(1)
a12=[];foo(1)
S EE A LSO : isdef 192, whereis 77, type 74, typeof 229, macrovar 274

1.1.30 exit Ends the current Scilab session

DESCRIPTION :
Ends the current Scilab session.
S EE A LSO : quit 67, abort 26, break 28, return 68, resume 68

1.1.31 external Scilab Object, external function or routine

DESCRIPTION :
External function or routine for use with specific commands.
An ”external” is a function or routine which is used as an argument of some high-level primitives (such as
ode, optim, schur...).
The calling sequence of the external (function or routine) is imposed by the high-level primitive which sets
the arguments of the external.
For example the external function costfunc is an argument of the optim primitive. Its calling se-
quence must be: [f,g,ind]=costfunc(x,ind) and optim (the high-level optimization primitive)
is invoked as follows:
optim(costfunc,...)
Here costfunc (the cost function to be minimized by the primitive optim) evaluates f=f(x) and
g= gradient of f at x (ind is an integer which is not useful here).
If other values are needed by the external function these variables can be defined in the environment. Also,
they can be put in a list. For example,the external function
[f,g,ind]=costfunc(x,ind,a,b,c)
is valid for optim if the external is list(costfunc,a,b,c) and the call to optim is then:
optim(list(costfunc,a1,b1,c1),....
An external can also be a Fortran routine : this is convenient to speed up the computations.
The name of the routine is given to the high-level primitive as a character string. The calling sequence of
the routine is also imposed. Examples are given in the routines/default directory (see the README
file).
External Fortran routines can also be dynamically linked (see link)
S EE A LSO : ode 431, optim 438, impl 421, dassl 416, intg 425, schur 533, gschur
513

Scilab Group September 1996 38

extraction Scilab Function

1.1.32 extraction matrix and list entry extraction

CALLING SEQUENCE :

x(i,j)
x(i)
[...]=l(i)
[...]=l(k1)...(kn)(i) or [...]=l(list(k1,...,kn,i))
l(k1)...(kn)(i,j) or l(list(k1,...,kn,list(i,j))

PARAMETERS :

x : matrix of any possible types

l : list variable
i,j : indices
k1,...kn : indices

DESCRIPTION :

MATRIX CASE i and j, can be:

- real scalars or vectors or matrices with positive elements.
* r=x(i,j) designs the matrix r such as r(l,k)=x(int(i(l)),int(j(k))) for l from 1
to size(i,’*’) and k from 1 to size(j,’*’).
i (j) Maximum value must be less or equal to size(x,1) (size(x,2)).
* r=x(i) with x a 1x1 matrix designs the matrix r such as r(l,k)=x(int(i(l)),int(i(k)))
for l from 1 to size(i,1) and k from 1 to size(i,2).
Note that in this case index i is valid only if all its entries are equal to one.
* r=x(i) with x a row vector designs the row vector r such as r(l)=x(int(i(l))) for l from
1 to size(i,’*’) i Maximum value must be less or equal to size(x,’*’).
* r=x(i) with x a matrix with one or more columns designs the column vector r such as r(l)
(l from 1 to size(i,’*’)) designs the int(i(l)) entry of the column vector formed by the
concatenation of the x’s columns.
i Maximum value must be less or equal to size(x,’*’).
- the : symbol which stands for ”all elements”.
* r=x(i,:) designs the matrix r such as r(l,k)=x(int(i(l)),k)) for l from 1 to size(i,’*’)
and k from 1 to size(x,2)
* r=x(:,j) designs the matrix r such as r(l,k)=x(l,int(j(k))) for l from 1 to size(r,1)
and k from 1 to size(j,’*’).
* r=x(:) designs the column vector r formed by the column concatenations of x columns. It is
equivalent to matrix(x,size(x,’*’),1).
- vector of boolean. If an index (i or j )is a vector of booleans it is interpreted as find(i) or respec-
tively find(j)
- a polynomial. If an index (i or j )is a vector of polynomials or implicit polynomial vector it is in-
terpreted as horner(i,m) or respectively horner(j,n) where m and n are associated x di-
mensions.
Even if this feature works for all polynomials, it is recommended to use polynomials in $ for read-
ability.
LIST OR TLIST CASE If they are present the ki give the path to a sub-list entry of l data structure.
They allow a recursive extraction without intermediate copies.
The [...]=l(k1)...(kn)(i) and [...]=l(list(k1,...,kn,i)) instructions are in-
terpreted as:
lk1 = l(k1) .. = .. lkn = lkn-1(kn) [...] = lkn(i) And the l(k1)...(kn)(i,j)
and l(list(k1,...,kn,list(i,j)) instructions are interpreted as:

Scilab Group September 1996 39

 extraction Scilab Function

lk1 = l(k1) .. = .. lkn = lkn-1(kn) lkn(i,j) i and j, can be:

When path points on more than one list component the instruction must have as many left hand side
arguments as selected components. But if the extraction syntax is used within a function input calling
sequence each returned list component is added to the function calling sequence.
Note that, l(list() is the same as l.

- real scalar or vector or matrix with positive elements.

[r1,...rn]=l(i) extracts the i(k) elements from the list l and store them in rk variable for
k from 1 to size(i,’*’)
- the : symbol which stands for ”all elements”.
- a vector of booleans. If i is a vector of booleans it is interpreted as find(i).
- a polynomial. If i is a vector of polynomials or implicit polynomial vector it is interpreted as horner(i,m)
where m=size(l).
Even if this feature works for all polynomials, it is recommended to use polynomials in $ for read-
ability.

k1,..kn may-bereal : positive scalar.

- a polynomial,interpreted as horner(ki,m) where m is the corresponding sub-list size.

REMARKS :
For soft coded matrix types such as rational functions and state space linear systems, x(i) syntax may not
be used for vector element extraction due to confusion with list element extraction. x(1,j) or x(i,1)
syntax must be used.
EXAMPLE :

- a character string associated with a sub-list entry name. // MATRIX CASE

a=[1 2 3;4 5 6]
a(1,2)
a([1 1],2)
a(:,1)
a(:,3:-1:1)
a(1)
a(6)
a(:)
a([%t %f %f %t])
a([%t %f],[2 3])
a(1:2,$-1)
a($:-1:1,2)
a($)
//
x=’test’
x([1 1;1 1;1 1])
//
b=[1/%s,(%s+1)/(%s-1)]
b(1,1)
b(1,$)
b(2) // the numerator
// LIST OR TLIST CASE
l=list(1,’qwerw’,%s)
l(1)
[a,b]=l([3 2])
l($)
x=tlist(l(2:3)) //form a tlist with the last 2 components of l

Scilab Group September 1996 40

find Scilab Function

//
dts=list(1,tlist([’x’;’a’;’b’],10,[2 3]));
dts(2)(’a’)
dts(2)(’b’)(1,2)
[a,b]=dts(2)([’a’,’b’])

S EE A LSO : find 41, horner 490, parents 63

1.1.33 feval multiple evaluation

CALLING SEQUENCE :

[z]=feval(x,y,f)
[z]=feval(x,f)

PARAMETERS :

x,y : two vectors

f : function or character string (for Fortran call)

DESCRIPTION :
Multiple evaluation of a function for one or two arguments of vector type :
z=feval(x,f) returns the vector z defined by z(i)=f(x(i))
z=feval(x,y,f) returns the matrix z, z(i,j)=f(x(i),y(j))
f is an external (function or routine) depending on one or two arguments which are supposed to be real.
The result returned by f can be real or complex. In case of a Fortran call, the function ’f’ must be
defined in the subroutine ffeval.f (in directory SCIDIR/routines/default)
EXAMPLE :

deff(’[z]=f(x,y)’,’z=xˆ2+yˆ2’);
feval(1:10,1:5,f)
deff(’[z]=f(x,y)’,’z=x+%i*y’);
feval(1:10,1:5,f)
feval(1:10,1:5,’parab’) //See ffeval.f file
feval(1:10,’parab’)
// For dynamic link (see example ftest in ffeval.f)
// you can use the link command (the parameters depend on the machine):
// unix(’make ftest.o’);link(’ftest.o’,’ftest); feval(1:10,1:5,’ftest’)

S EE A LSO : evstr 35, horner 490, execstr 37, external 38, link 303

1.1.34 find find indices of boolean vector or matrix true elements

CALLING SEQUENCE :

[ii]=find(x)
[ir,ic]=find(x)

PARAMETERS :

x : a boolean vector or a boolean matrix or a ”standard” matrix

ii, ir, ic : integer vectors of indices or empty matrices

Scilab Group April 1993 41

format Scilab Function

DESCRIPTION :
If x is a boolean matrix,
ii=find(x) returns the vector of indices i for which x(i) is ”true”. If no true element found find
returns an empty matrix.
[ir,ic]=find(x) returns two vectors of indices ir (for rows) and ic (for columns) such that x(ir(n),ic(n))
is ”true”. If no true element found find returns empty matrices in ir and ic.
if x is standard matrix find(x) is interpreted as find(x<>0)
find([]) returns []
EXAMPLE :

A=rand(1,20);
w=find(A<0.5);
A(w)
w=find(A>100);

S EE A LSO : boolean 27, extraction 39, insertion 51

1.1.35 for language keyword for loops

DESCRIPTION :
Used to define loops. Its syntax is:
for variable=expression ,instruction, ,instruction,end
for variable=expression do instruction, ,instruction,end
If expression is a matrix or a row vector, variable takes as values the values of each column of the
matrix.
Useful example : for variable=n1:step:n2, ...,end
If expression is a list variable takes as values the successive entries of the list.
Warning: the number of characters used to define the body of any conditionnal instruction (if while for or
select/case) must be limited to 16k.
EXAMPLE :

n=5;
for i = 1:n, for j = 1:n, a(i,j) = 1/(i+j-1);end;end
for j = 2:n-1, a(j,j) = j; end; a
for e=eye(3,3),e,end
for v=a, write(6,v),end
for j=1:n,v=a(:,j), write(6,v),end
for l=list(1,2,’example’); l,end

1.1.36 format number printing and display format

CALLING SEQUENCE :

format([type],[long])
format()

PARAMETERS :

type : character string

long : integer ( max number of digits (default 10))

DESCRIPTION :
Sets the current printing format with the parameter type ; it is one of the following :

Scilab Group April 1993 42

fort Scilab Function

"v" : for a variable format (default)

"e" : for the e-format.
long defines the max number of digits (default 10). format() returns a vector for the current format:
first component is the type of format (0 if v ; 1 if e ); second component is the number of digits.
In ”variable format” mode, vectors entries which are less than %eps times the maximum absolute value of
the entries were displayed as ”0” in the previous Scilab versions. It is no more the case, the clean function
can be used to set neglitible entries to zeros.
EXAMPLE :

x=rand(1,5);
format(’v’,10);x
format(20);x
format(’e’,10);x
format(20);x

x=[100 %eps];
format(’e’,10);x
format(’v’,10);x

format()

S EE A LSO : write 262, disp 233, print 251

1.1.37 fort Fortran or C user routines call

CALLING SEQUENCE :

// long form ’out’ is present

[y1,...,yk]=fort("ident",x1,px1,"tx1",...,xn,pxn,"txn",
"out",[ny1,my1],py1,"ty1",...,[nyl,myl],pyl,"tyl")
// short form : no ’out’ parameter
[y1,....,yk]=fort("ident",x1,...,xn)

PARAMETERS :

"ident" : string.
xi : real matrix or string
pxi, pyi : integers
txi, tyi : character string "d", "r", "i" or "c".

DESCRIPTION :
Interactive call of Fortran (or C) user program from Scilab. The routine must be previously linked with
Scilab. This link may be done:

- with Scilab ”link” command (incremental ”soft” linking) during the Scilab session.(see link)
- by ”hard” re-linking. Writing the routine call within Scilab routine default/Ex-fort.f, adding
the entry point in the file default/Flist and then re linking Scilab with the command make
bin/scilex in main Scilab directory.
There are two forms of calling syntax, a short one and a long one. The short one will give faster code
and an easier calling syntax but one has to write a small (C or Fortran) interface in order to make
the short form possible. The long one make it possible to call a Fortran routine (or a C one) whitout
modification of the code but the syntax is more complex and the interpreted code slower.

The meaning of each parameter is described now:

Scilab Group April 1993 43

fort Scilab Function

"ident" is the name of the called subroutine.

x1,...,xn are input variables (real matrices or strings) sent to the routine,
px1,...,pxn are the respective positions of these variables in the calling sequence of the routine "ident"
and
tx1,...,txn are their types ("r", "i", "d" and "c" for real (float) , integer, double precision and
strings)
"out" is a keyword used to separate input variables from output variables. when this key word is present
it is assumes that the long form will be used and when it is not prsent, the short form is used.
[ny1, my1] are the size (# of rows and columns. For ’c’ arguments,m1*n1 is the number of charaters
) of output variables and
py1, ... are the positions of output variables (possibly equal to pxi ) in the calling sequence of the
routine. The pyi’s integers must be in increasing order.
"ty1", ... are the Fortran types of output variables. The k first output variables are put in y1,...,
yk.

If an output variable coincides with an input variable (i.e. pyi=pxj ) one can pass only its position pyi
. The size and type of yi are then the same as those of xi. If an output variable coincides with an input
variable and one specify the dimensions of the output variable [myl,nyl] must follow the compatibility
condition mxk*nxk >= myl*nyl.
In the case of short syntax , [y1,....,yk]=fort("ident",x1,...,xn), the input parameters
xi’s and the name "ident" are sent to the interface routine Ex-fort. This interface routine is then
very similar to an interface (see the source code in the directory SCIDIR/default/Ex-fort.f).
For example the following program:
subroutine foof(c,a,b,n,m)
integer n,m
double precision a(*),b,c(*)
do 10 i=1,m*n
c(i) = sin(a(i))+b
10 continue
end

link("foof.o","foof")
a=[1,2,3;4,5,6];b= %pi;
[m,n]=size(a);
// Inputs:
// a is in position 2 and double
// b 3 double
// n 4 integer
// m 5 integer
// Outputs:
// c is in position 1 and double with size [m,n]
c=fort("foof",a,2,"d",b,3,"d",n,4,"i",m,5,"i","out",[m,n],1,"d");
returns the matrix c=2*a+b.
If your machine is a DEC Alpha, SUN Solaris or SGI you may have to change the previous command
line link("foo.o","foo") by one of the followings:
link(’foof.o -lfor -lm -lc’,’foof’).
link(’foof.o -lftn -lm -lc’,’foof’).
link(’foof.o -L/opt/SUNWspro/SC3.0/lib/lib77 -lm -lc’,’foof’).
The same example coded in C:
void fooc(c,a,b,m,n)
double a[],*b,c[];
int *m,*n;

Scilab Group April 1993 44

getfield Scilab Function

{ double sin();
int i;
for ( i =0 ; i < (*m)*(*n) ; i++)
c[i] = sin(a[i]) + *b;
}

link("fooc.o","fooc","C") // note the third argument

a=[1,2,3;4,5,6];b= %pi;
[m,n]=size(a);
c=fort("fooc",a,2,"d",b,3,"d",m,4,"i",n,5,"i","out",[m,n],1,"d");

S EE A LSO : link 303, c_link 297, intersci 303, addinter 265

1.1.38 funptr coding of primitives ( wizard stuff )

DESCRIPTION :
Utility function (for experts only) funptr(’name’) returns 100*fun + fin where (fun,fin)
is the internal coding of the primitive ’name’ . fun is the interface number and fin the routine number

S EE A LSO : clearfun 265, newfun 274

1.1.39 getenv get the value of an environment variable

CALLING SEQUENCE :

env=getenv(str [, rep] )

PARAMETERS :

str : character string specifying environment variable name rep : an optional character string. When this
optional value is used, the function getenv returns the value rep when the environment variable
str is not found.
env : character string which contain the environment variable value

DESCRIPTION :
Return the value of an environment variable if it exists.
EXAMPLE :

getenv(’SCI’)
getenv(’FOO’,’foo’)

1.1.40 getfield list field extraction

CALLING SEQUENCE :

[x,...]=getfield(i,l)

PARAMETERS :

x : matrix of any possible types

l : list, tlist or mlist variable
i : field index, see extraction for more details.

Scilab Group September 1999 45

global Scilab Function

DESCRIPTION :
This function is an equivalent of [x,...]=l(i) syntax for field extraction with the only difference that
it also applies to mlist objects.
EXAMPLE :

l=list(1,’qwerw’,%s)
[a,b]=getfield([3 2],l)

a=hypermat([2,2,2],rand(1:2ˆ3));// hypermatrices are coded using mlists

a(1) // the a(1,1,1) entry
getfield(1,a) // the mlist first field

S EE A LSO : extraction 39

1.1.41 getpid get Scilab process identificator

CALLING SEQUENCE :

id=getpid()

DESCRIPTION :
Return an the scilab process identificator integer
EXAMPLE :

d=’SD_’+string(getpid())+’_’

1.1.42 getversion get Scilab version name

CALLING SEQUENCE :

version=getversion()

PARAMETERS :

version : a string

DESCRIPTION :
return in version the Scilab version name
EXAMPLE :

getversion()

1.1.43 global Define global variable

CALLING SEQUENCE :

global(’nam1’,...,’namn’)
global nam1 ... namn

PARAMETERS :

nam1,..., namn : valid variable names

Scilab Group Mai 1999 46

hat Scilab Function

DESCRIPTION :
Ordinarily, each Scilab function, has its own local variables and can ”read” all variables created in the base
workspace or by the calling functions. The global allow to make variables read/write across functions.
Any assignment to that variable, in any function, is available to all the other functions declaring it global.
If the global variable doesn’t exist the first time you issue the global statement, it will be initialized
to the empty matrix.
EXAMPLE :

//first: calling environnment and a function share a variable

global a
a=1
deff(’y=f1(x)’,’global a,a=xˆ2,y=aˆ2’)
f1(2)
a
//second: three functions share variables
deff(’initdata()’,’global A C ;A=10,C=30’)
deff(’letsgo()’,’global A C ;disp(A) ;C=70’)
deff(’letsgo1()’,’global C ;disp(C)’)
initdata()
letsgo()
letsgo1()

S EE A LSO : who 77, isglobal 55, clearglobal 31, gstacksize 47, resume 68

1.1.44 gstacksize set/get scilab global stack size

CALLING SEQUENCE :

gstacksize(n)
sz=gstacksize()

PARAMETERS :

n : integer, the required global stack size given in number of double precision words
sz : 2-vector [total used]

DESCRIPTION :
Scilab stores gobal variables in a stack
gstacksize(n) allows the user to increase or decrease the size of this stack. The maximum allowed
size depends on the amount of free memory and swap space available at the time. Note that Scilab can
increase automatically the global stacksize when needed
sz=gstacksize() returns a 2-vector which contains the current total and used global stack size.
S EE A LSO : who 77, stacksize 71

1.1.45 hat - exponentiation

CALLING SEQUENCE :

Aˆb

Scilab Group April 1993 47

hypermat Scilab Function

DESCRIPTION :
Exponentiation of matrices or vectors by a constant vector.
If A is a vector or a rectangular matrix the exponentiation is done element-wise, with the usual meaning.
For square A matrices the exponentiation is done in the matrix sense.
For boolean, polynomial and rational matrices, the exponent must be an integer
Remark that 123.ˆb is interpreted as (123).ˆb. In such cases dot is part of the operator, not of the
number.
EXAMPLES :

2ˆ4
[1 2;2 4]ˆ(1+%i)
s=poly(0,"s");
[1 2 s]ˆ4
[s 1;1 s]ˆ(-1)

S EE A LSO : exp 508, inv 516

1.1.46 host shell (sh) command execution

CALLING SEQUENCE :

stat=host(command-name)

PARAMETERS :

command-name : A character string containing Unix sh instruction

stat : An integer flag

DESCRIPTION :
Sends a string command-name to Unix for execution by the sh shell. Standard output and standard errors
of the shell command are written in the calling shell. stat gives -1 if host can’t be called (Not enough
system memory available) or the sh return code.
EXAMPLE :

host("ls $SCI/demos");
host("emacs $SCI/demos/wheel2/Makefile");
deff(’wd=getdir()’,’if MSDOS then host(’’cd>’’+TMPDIR+’’\\path’’);..
else host(’’pwd>’’+TMPDIR+’’/path’’);end..
wd=read(TMPDIR+’’/path’’,1,1,’’(a)’’)’)
wd=getdir()

S EE A LSO : edit 267, manedit 239, unix_g 310, unix_s 311, unix_w 311, unix_x
312

1.1.47 hypermat initialize an N dimensional matrices

CALLING SEQUENCE :

M=hypermat(dims [,v])

PARAMETERS :

dims : vector of hypermatrix dimensions

v : vector of hypermatrix entries (default value zeros(prod(dims),1))

Scilab Group April 1993 48

ieee Scilab Function

DESCRIPTION :
Initialize an hypermatrix whose dimensions are given in the vector dims and entries are given in optional ar-
gument v M data structure contains the vector of matrix dimensions M(’dims’) and the vector of entries
M(’entries’) such as the leftmost subcripts vary first [M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n

EXAMPLES :

M=hypermat([2 3 2 2],1:24)

1.1.48 hypermatrices Scilab object, N dimensional matrices in Scilab

DESCRIPTION :
Hypermatrix type allows to manipulate multidimensional arrays
They can be defined by extension of 2D matrices as follows a=[1 2;3 4];a(:,:,2)=rand(2,2)
or directly using hypermat function
Entries can be real or complex numbers, polynomials, rationals, strings, booleans.
Hypermatrices are mlists: mlist([’hm’,’dims’,’entries’],sz,v) where sz is the
row vector of dimensions and v the column vector of entries (first dimension are stored first)
EXAMPLES :

a(1,1,1,1:2)=[1 2]
a=[1 2;3 4];a(:,:,2)=rand(2,2)
a(1,1,:)
[a a]

S EE A LSO : hypermat 48

1.1.49 iconvert conversion to 1 or 4 byte integer representation

CALLING SEQUENCE :

y=iconvert(X,itype)
PARAMETERS :

X : matrix of floats or integers

y : matrix of integers coded on one, two or four bytes.
DESCRIPTION :
converts and stores data two one, two or four bytes integers.
itype=0 : return floating point numbers
itype=1 : return int8 numbers in the range [-128,127]
itype=11 : return uint8 numbers in the range [0,255]
itype=2 : return int16 numbers in the range [-32768,32767]
itype=12 : return uint16 numbers in the range [0, 65535]
itype=4 : return int32 numbers in the range [-2147483648,2147483647]
itype=14 : return uint32 numbers in the range [0, 4294967295]
EXAMPLE :

b=int32([1 -120 127 312])

y=iconvert(b,8)

S EE A LSO : double 182, inttype 54

Scilab Group April 1998 49

if Scilab Function

1.1.50 ieee set floating point exception mode

CALLING SEQUENCE :

mod=ieee()
ieee(mod)

PARAMETERS :

mod : integer scalar whose possible values are 0,1,or 2

DESCRIPTION :
ieee() returns the current floating point exception mode.

0 : floating point exception produce an error

1 : floating point exception produce a warning
2 : floating point exception procudes Inf or Nan
ieee(mod) sets the current floating point exception mode.

The initial mode value is 0.

REMARKS :
Floating point exeception arizing inside some library algorithms are not yet handled by ieee modes.
EXAMPLE :

ieee(1);1/0
ieee(2);1/0,log(0)

S EE A LSO : errcatch 34

1.1.51 if else - conditional execution

SYNTAX :

if expr1 then statements

elseif expri then statements
....
else statements
end

DESCRIPTION :
The if statement evaluates a logical expression and executes a group of statements when the expression is
true.
The expri are expressions with numeric or boolean values. If expri are matrix valued the condition
is true only if all matrix entries are true.
The optional elseif and else provide for the execution of alternate groups of statements. An end
keyword, which matches the if, terminates the last group of statements. The line structure given above
is not significant, the only constraint is that each then keyword must be on the same line line as its
corresponding if or elseif keyword.
The keyword then can be replaced by a carriage return or a comma.
Warning: the number of characters used to define the body of any conditionnal instruction (if while for or
select/case) must be limited to 16k.
EXAMPLE :

Scilab Group April 1993 50

insertion Scilab Function

i=2
for j = 1:3,
if i == j then
a(i,j) = 2;
elseif abs(i-j) == 1 then
a(i,j) = -1;
else a(i,j) = 0;
end,
end

S EE A LSO : while 77, select 69, boolean 27, end 34, then 73, else 33

1.1.52 insertion matrix and list insertion or modification

CALLING SEQUENCE :

x(i,j)=a
x(i)=a
l(i)=a
l(k1)...(kn)(i)=a or l(list(k1,...,kn,i))=a
l(k1)...(kn)(i,j)=a or l(list(k1,...,kn,list(i,j))=a

PARAMETERS :

x : matrix of any kind (constant, sparse, polynomial,...)

l : list
i,j : indices
k1,...kn : indices with integer value
a : new entry value

DESCRIPTION :

MATRIX CASE i and j, may be:

- real scalars or vectors or matrices with positive elements.
* if a is a matrix with dimensions (size(i,’*’),size(j,’*’)) x(i,j)=a returns a new x
matrix such as x(int(i(l)),int(j(k)))=a(l,k) for l from 1 to size(i,’*’) and k
from 1 to size(j,’*’), other initial entries of x are unchanged.

if a is a scalar x(i,j)=a returns a new x matrix such as x(int(i(l)),int(j(k)))=a for l

from 1 to size(i,’*’) and k from 1 to size(j,’*’), other initial entries of x are unchanged.
If i or j maximum value exceed corresponding x matrix dimension x is previously extended to the
required dimensions with zeros entries for standard matrices, 0 length character string for string matrices
and false values for boolean matrices.

* x(i,j)=[] kills rows specified by i if j matches all columns of x or kills columns specified by j
if i matches all rows of x. In other cases x(i,j)=[] produce an error.
* x(i)=a with a a vector returns a new x matrix such as x(int(i(l)))=a(l) for l from 1 to
size(i,’*’) , other initial entries of x are unchanged.

x(i)=a with a a scalar returns a new x matrix such as x(int(i(l)))=a for l from 1 to size(i,’*’)
, other initial entries of x are unchanged.
If i maximum value exceed size(x,1), x is previously extended to the required dimension with zeros
entries for standard matrices, 0 length character string for string matrices and false values for boolean
matrices.

Scilab Group September 1996 51

 insertion Scilab Function

if x is a 1x1 matrix a may be a row (respectively a column) vector with dimension size(i,’*’).
Resulting x matrix is a row (respectively a column) vector
if x is a row vector a must be a row vector with dimension size(i,’*’)
if x is a column vector a must be a column vector with dimension size(i,’*’)
if x is a general matrix a must be a row or column vector with dimension size(i,’*’) and i
maximum value cannot exceed size(x,’*’),
* x(i)=[] kills entries specified by i.
- the : symbol which stands for ”all elements”.
* x(i,:)=a is interpreted as x(i,1:size(x,2))=a
* x(:,j)=a is interpreted as x(1:size(x,1),j)=a
* x(:)=a returns in x the a matrix reshaped according to x dimensions. size(x,’*’) must be
equal to size(a,’*’)
- vector of boolean. If an index (i or j )is a vector of booleans it is interpreted as find(i) or respec-
tively find(j)
- a polynomial. If an index (i or j )is a vector of polynomials or implicit polynomial vector it is in-
terpreted as horner(i,m) or respectively horner(j,n) where m and n are associated x di-
mensions.
Even if this feature works for all polynomials, it is recommended to use polynomials in $ for read-
ability.
LIST OR TLIST CASE If they are present the ki give the path to a sub-list entry of l data structure.
They allow a recursive extraction without intermediate copies.
The l(k1)...(kn)(i)=a and l(list(k1,...,kn,i)=a) instructions are interpreted as:
lk1 = l(k1) .. = .. lkn = lkn-1(kn) lkn(i) = a lkn-1(kn) = lkn ..
= .. l(k1) = lk1 And the l(k1)...(kn)(i,j)=a and l(list(k1,...,kn,list(i,j))=a
instructions are interpreted as:
lk1 = l(k1) .. = .. lkn = lkn-1(kn) lkn(i,j) = a lkn-1(kn) = lkn ..
= .. l(k1) = lk1

i may-bea :real non negative scalar. l(0)=a adds an entry on the ”left” of the list
l(i)=a sets the i entry of the list l to a. if i>size(l), l is previously extended with zero
length entries (undefined).
l(i)=null() suppress the ith list entry.
- a polynomial. If i is a polynomial it is interpreted as horner(i,m) where m=size(l).
Even if this feature works for all polynomials, it is recommended to use polynomials in $ for read-
ability.
k1,..kn may be :
- real positive scalar.
- a polynomial,interpreted as horner(ki,m) where m is the corresponding sub-list size.

REMARKS :
For soft coded matrix types such as rational functions and state space linear systems, x(i) syntax may
not be used for vector entry insertion due to confusion with list entry insertion. x(1,j) or x(i,1)
syntax must be used.
EXAMPLE :

- a character string associated with a sub-list entry name. // MATRIX CASE

a=[1 2 3;4 5 6]
a(1,2)=10
a([1 1],2)=[-1;-2]
a(:,1)=[8;5]
a(1,3:-1:1)=[77 44 99]

Scilab Group September 1996 52

intppty Scilab Function

a(1)=%s
a(6)=%s+1
a(:)=1:6
a([%t %f],1)=33
a(1:2,$-1)=[2;4]
a($:-1:1,1)=[8;7]
a($)=123
//
x=’test’
x([4 5])=[’4’,’5’]
//
b=[1/%s,(%s+1)/(%s-1)]
b(1,1)=0
b(1,$)=b(1,$)+1
b(2)=[1 2] // the numerator
// LIST OR TLIST CASE
l=list(1,’qwerw’,%s)
l(1)=’Changed’
l(0)=’Added’
l(6)=[’one more’;’added’]
//
//
dts=list(1,tlist([’x’;’a’;’b’],10,[2 3]));
dts(2)(’a’)=33
dts(2)(’b’)(1,2)=-100

S EE A LSO : find 41, horner 490, parents 63, extraction 39

1.1.53 intppty set interface argument passing properties

CALLING SEQUENCE :

funs=intppty()
intppty(fun)

PARAMETERS :

fun : integer an interface number (see funptr)

funs : integer vector, vector of interface number (see funptr)

DESCRIPTION :
The interface programs may be written in 2 different ways for the mode of function argument passing.
In the first and default way, the arguments are passed by value. With the following syntax:

foo(A,1+2)

the argument associated with A will be passed by value (a copy of A is made before foo is called,
and the argument associated with 1+2 will be passed by value.
In the second way arguments may be passed be reference if there are ”named arguments” (no copy of
the variable value is done). intppty(fun) with fun>0 tells Scilab that the interface with number
fun can handle arguments passed by reference. With the following syntax:

foo(A,1+2)

Scilab Group Nov 1999 53

inv coeff Scilab Function

the argument associated with A will be passed by reference, and the argument associated with 1+2
will be passed by value.
Warning, declaring that the interface with number fun can handle arguments passed by reference if it is
not the case should produce unpredictable results.
intppty(fun) with fun<0 suppress this property for the interface -fun.
intppty() returns the vector of interfaces which handle arguments passed by reference.
This function may be useful for dynamically loaded interface (see addinter).
S EE A LSO : funptr 45, addinter 265

1.1.54 inttype type integers used in integer data types

CALLING SEQUENCE :

[i]=inttype(x)

PARAMETERS :

x : an matrix of integers (see int8,..)

i : integer

DESCRIPTION :
inttype(x) returns an integer which is the type of the entries of x as following :

1 : one byte integer representation

2 : two bytes integer representation
4 : four bytes integer representation
11 : one byte unsigned integer representation
12 : two bytes unsigned integer representation
14 : four bytes unsigned integer representation

EXAMPLE :

x=uint16(1:10);
inttype(x)

S EE A LSO : int8 188

1.1.55 inv coeff build a polynomial matrix from its coefficients

CALLING SEQUENCE :

[P]=inv_coeff(C,[,d,[name])

PARAMETERS :

C : big matrix of the coefficients

d : Polynomial matrix degree. optional parameter with default value d=-1+size(C,’c’)/size(C,’r’)
name : string giving the polynomial variable name (default value ’x’).

DESCRIPTION :
P=inv coeff(Mp,k). When k is compatible with Mp size it returns a polynomial matrix of degree k.
C=[C0,C1,...,Ck] and P= C0 + C1*x +... +Ck*xˆk.
EXAMPLE :

Scilab Group April 1993 54

lasterror Scilab Function

A=int(10*rand(2,6))
// Building a degree 1 polynomial matrix
P=inv_coeff(A,1)
norm(coeff(P)-A)
// Using default value for degree
P1=inv_coeff(A)
norm(coeff(P1)-A)

S EE A LSO : poly 65, degree 486, coeff 485

1.1.56 iserror error test

CALLING SEQUENCE :

iserror([n])

DESCRIPTION :
tests if error number n has occurred (after a call to errcatch). iserror returns 1 if the error oc-
curred a nd 0 otherwise
n>0 is the error number ; all errors are tested with n<0.
S EE A LSO : error 35, errcatch 34

1.1.57 isglobal check if a variable is global

CALLING SEQUENCE :

t=isglobal(x)

PARAMETERS :

x : any variable
t : a boolean

DESCRIPTION :
isglobal(x) returns true if x has been declared to be a global variable and false otherwise.
EXAMPLE :

isglobal(1)
global a
isglobal(a)

S EE A LSO : global 46, clearglobal 31, who 77

1.1.58 lasterror get last recorded error message

CALLING SEQUENCE :

str=lasterror( [opt] )
[str,n]=lasterror([opt])

PARAMETERS :

Scilab Group April 2000 55

list Scilab Function

str : vector of character strings or an empty matrix. The last recorded error message.
n : integer, 0 or the last recorded error number.
opt : boolean, if %t recorded message is cleared. Default is %t.
DESCRIPTION :
Each time an error occur, the Scilab error handler records it in internal tables (only the last one is retained).
The lasterror function allows to get the message and the error number out of these tables.
This function is useful while using errcatch or execstr.
The recorded error message may be retained for a further call to lasterror using lasterror(%f).
EXAMPLE :
ierr=execstr(’a=zzzzzzz’,’errcatch’)
if ierr>0 then disp(lasterror()),end

S EE A LSO : errcatch 34, execstr 37, error 35, errclear 35

1.1.59 left - left bracket

CALLING SEQUENCE :
[a11,a12,...;a21,a22,...;...]
[s1,s2,...]=func(...)
PARAMETERS :
a11,a12,... : matrix of any compatibles types with compatibles dimensions s1,s2,... : any possible
variable name
DESCRIPTION :
Left and right brackets are used for vector and matrix concatenation. These symbols are also used to denote
a multiple left-hand-side for a function call
Inside concatenation brackets blank or comma characters mean ”column concatenation”, semicolumn and
carriage-return mean ”row concatenation”.
Note : to avoid confusions it is safer to use comma instead of blank to separate columns.
Within multiple lhs brackets variable names must be separated by comma.
EXAMPLES :
[6.9,9.64; sqrt(-1) 0]
[1 +%i 2 -%i 3]
[]
[’this is’;’a string’;’vector’]

[u,s]=schur(rand(3,3))

1.1.60 less - lower than comparison

DESCRIPTION :
logical comparison symbol
<> means ”different” (same as ˜=)
< means ”lower than”
> means ”larger than”
<= means lower than or equal to.
>= means larger than or equal to
S EE A LSO : if 50

Scilab Group April 1993 56

matrices Scilab Function

1.1.61 list Scilab object and list function definition

CALLING SEQUENCE :
list(a1,....an)
DESCRIPTION :
Creates a list with elements ai’s which are arbitrary Scilab objects (matrix, list,...). Type of
list objects is 15.
list() is the empty list (0 element).
Operations on lists:
extraction : [x,y,z...]=l(v) where v is a vector of indices; [x,y,z]=l(:) extracts all the
elements.
insertion : l(i)=a
deletion : l(i)=null() removes the i-th element of the list l.
EXAMPLE :
x=list(1,2,3);
x(4)=10;
x(10)=’a’
S EE A LSO : null 61, tlist 73, insertion 51, extraction 39, size 211, length
281

1.1.62 lsslist Scilab linear state space function definition

CALLING SEQUENCE :
lsslist()
lsslist(a1,....an)
DESCRIPTION :
lsslist(a1,....an) is a shortcut to to tlist([’lss’,’A’;’B’;’C’;’X0’,’dt’], a1,....an)
Creates a tlist with [’lss’,’A’;’B’;’C’;’X0’,’dt’] as first entry and ai’s as next entries
if any. No type nor size checking is done on ai’s.
S EE A LSO : tlist 73, syslin 224

1.1.63 lstcat list concatenation

CALLING SEQUENCE :
lc=lstcat(l1,..ln)
PARAMETERS :
li : list or any other type of variable
lc : a list
DESCRIPTION :
lc=lstcat(l1,..ln) catenates components of li lists in a single list. If li are other type of
variables they are simply added to the resulting list.
EXAMPLE :
lstcat(list(1,2,3),33,list(’foo’,%s))
lstcat(1,2,3)
S EE A LSO : list 57

Scilab Group April 1993 57

mlist Scilab Function

1.1.64 matrices Scilab object, matrices in Scilab

DESCRIPTION :
Matrices are basic objects defined in Scilab. They can be defined as follows:
E=[e11,e12,...,e1n;
e21,e22,...,e2n;
....
em1,em2,...,emn];
Entries eij can be real or complex numbers, polynomials, rationals, strings, booleans.
Vectors are seen as matrices with one row or one column.
syslin lists in state-space form or transfer matrices can also be defined as above.
EXAMPLES :

E=[1,2;3,4]
E=[%T,%F;1==1,1˜=1]
s=poly(0,’s’);E=[s,sˆ2;1,1+s]
E=[1/s,0;s,1/(s+1)]
E=[’A11’,’A12’;’A21’,’A22’]

S EE A LSO : poly 65, string 284, boolean 27, rational 68, syslin 224, empty
33, hypermatrices 49

1.1.65 matrix reshape a vector or a matrix to a different size matrix

CALLING SEQUENCE :

y=matrix(v,n,m)
y=matrix(v,[sizes])

PARAMETERS :

v : a vector, a matrix or an hypermatrix

n,m : integers
sizes : vector of integers
y : a vector matrix or hypermatrix

DESCRIPTION :
For a vector or a matrix with n x m entries y=matrix(v,n,m) or similarily y=matrix(v,[n,m]).
transforms the v vector (or matrix) into an nxm matrix by stacking columnwise the entries of v.
if one of the dimension m or n is equal to -1 it is automatically assigned to the quotient of size(v,’*’) by the
other dimension,
For an hypermatrix such as prod(size(v))==prod(sizes),y=matrix(v,sizes) (or equiv-
alently y=matrix(v,n1,n2,...nm)) transforms v into an matrix or hypermatrix by stacking colum-
nwise the entries of v. y=matrix(v,sizes) results in a regular matrix if sizes is a scalar or a 2-vector.
S EE A LSO : matrices 58, hypermatrices 49, ones 204, zeros 231, rand 207,
poly 65, empty 33
EXAMPLES :

a=[1 2 3;4 5 6]
matrix(a,1,6)
matrix(a,1,-1)
matrix(a,3,2)

Scilab Group September 1995 58

mode Scilab Function

1.1.66 mlist Scilab object, matrix oriented typed list definition.

CALLING SEQUENCE :

mlist(typ,a1,....an )

PARAMETERS :

typ : vector of character strings

ai : any Scilab object (matrix, list,string...).

DESCRIPTION :
mlist object are very similar to tlist objects. But if M is an mlist, for any index i which is not a field name,
M(i) is not the ith field of the list but is interpreted as the i th entry of M seen as a vector. This is the
only difference between mlist and tlist.
mlist fields must then be designed by their names. They can also be handled using the getfield and
setfield functions.
EXAMPLE :

M=mlist([’V’,’name’,’value’],[’a’,’b’,’c’],[1 2 3]);
//define display
deff(’%V_p(M)’,’disp(M.name+’’:’’+string(M.value))’)
//define extraction operation
deff(’r=%V_e(i,M)’,..
’r=mlist([’’V’’,’’name’’,’’value’’],M.name(i),M.value(i))’)
M(2) // the second entry of the vector M
M(2).value

//define M as a tlist
M=tlist([’V’,’name’,’value’],[’a’,’b’,’c’],[1 2 3]);
M(2)

M(’name’)

//with two indices

M=mlist([’V’,’name’,’value’],[’a’,’b’;’c’ ’d’],[1 2;3 4]);
deff(’r=%V_e(varargin)’,[
’M=varargin($)’;
’H=[’’V’’,’’name’’,’’value’’]’
’r=mlist(H,M.name(varargin(1:$-1)),M.value(varargin(1:$-1)))’])

M(:,2)
// multidimensionnal array
str=[’a’,’b’,’c’,’d’,’e’,’f’,’g’,’h’];
n=hypermat([2,2,2],str);
v=hypermat([2,2,2],1:8);
M=mlist([’V’,’name’,’value’],n,v);
M(1,1:2,2)

S EE A LSO : tlist 73, list 57, overloading 61, getfield 45, setfield 70

1.1.67 mode select a mode in exec file

Scilab Group April 1993 59

names Scilab Syntax

CALLING SEQUENCE :

mode(k)
k=mode()

DESCRIPTION :
Used inside an exec-file or a scilab function mode(k) allows to change the information displayed during
the execution, depending on the value of k:

k=0 : The new variable values are displayed if required (see help on semi or comma).
k=-1 : the exec file or scilab function executes silently. (this is the default value for scilab functions)
k=1 or k=3 : each line of instructions is echoed preceded of the prompt. The new variable values are
displayed if required. This is the default for exec files.
k=7 : The new variable values are displayed if required, each line of instructions is echoed (if possible)
and a prompt (>>) is issued after each line waiting for a carriage return.

line display is disable for compiled scilab function (see getf or comp)
S EE A LSO : exec 36, getf 272, semi 70, comma 32

1.1.68 mtlb mode switch Matlab like operations

CALLING SEQUENCE :

mmode=mtlb_mode()
mtlb_mode(mmode)

PARAMETERS :

mmode : boolean

DESCRIPTION :
Scilab and Matlab additions and substractions work differently when used with empty matrices:

Scilab :

a+[] -->a
a-[] -->a
[]+a -->a
[]-a -->-a

Matlab a+[] -->[]

a-[] -->[]
[]+a -->[]
[]-a -->[]
mtlb mode(%t) switches to Matlab evaluation mode for additions and substractions. mtlb mode(%f)
switches back to Scilab mode.
mtlb mode() return the current mmode’ value

S EE A LSO : empty 33

Scilab Group April 1993 60

overloading Scilab keyword

1.1.69 names scilab names syntax

DESCRIPTION :
Names of variables and functions must begin with a letter or one of the following special characters ’%’,
’ ’, ’#’, ’!’, ’$’, ’?’.
Next characters may be letters or digits or any special character in ’ ’, ’#’, ’!’, ’$’, ’?’
Names may be as long as you want but only the first 24 characters are taken into account. Upper and
lower case letters are different.
EXAMPLES :

//Valid names
%eps
A1=123
#Color=8
My_Special_Color_Table=rand(10,3)
//Non valid names
//1A , b%, .C

1.1.70 null delete an element in a list

CALLING SEQUENCE :

l(i)=null()

DESCRIPTION :
Deletion of objects inside a list
EXAMPLE :

l=list(1,2,3);
l(2)=null() // get list(1,3)

S EE A LSO : list 57, clear 30

1.1.71 overloading display, functions and operators overloading capabilities

DESCRIPTION :
In scilab, variable display, functions and operators may be defined for new objects using functions (scilab
coded or primitives).
Display : The display of new objects defined by tlist structure may be overloaded (the default
display is similar to list’s one). The overloading function must have no output argument a single
input argument. It’s name is formed as follow %<tlist type> p where %<tlist type>
stands for the first entry of the tlist type component.
Operators : Each operator which is not defined for given operands type may be defined. The overload-
ing function must have a single output argument and one or two inputs according to the number of
operands. The function name is formed as follow:
for binary operators: %<first operand type> <op code> <second operand type>
for unary operators: %<operand type> <op code>
extraction and insertion operators which are n-nary operators are described below.
<operand type>, <first operand type>, <second operand type> are sequence of char-
acters associated with each data type as described in the following table:

Scilab Group April 1993 61

overloading Scilab keyword

string c
polynomial p
function m
constant s
list l
tlist ¡tlist type¿
boolean b
sparse sp
boolean sparse spb

<op code> is a single character associated with each operator as described in the following table:
’ t
+ a
- s
* m
/ r
n l
ˆ p
.* x
./ d
.n q
.*. k
./. y
. z
: b
*. u
/. v
n. w
[a,b] c
[a;b] f
() extraction e
() insertion i
== o
<> n
j g
& h
.ˆ j
˜ 5
.’ 0
< 1
> 2
<= 3
>= 4

The overloading function for extraction syntax b=a(i1,...,in) has the following calling sequence:
b=%<type of a> e (i1,...,in,a) and the syntax [x1,..,xm]=a(i1,...,in) has the fol-
lowing calling sequence: [x1,..,xm]=%<type of a> e (i1,...,in,a)
The overloading function associated to the insertion syntax a(i1,...,in)=b has the following calling
sequence: a=%<type of a> i <type of b>(i1,...,in,b,a).
Functions : Some basic primitive function may also be overloaded for new data type. W
such a function is undefined for a particular data types the function %<type of an argument> <function name>
is called. User may add in this called function the definition associated
with the input data types.

S EE A LSO : tlist 73, disp 233, symbols 72

Scilab Group April 1993 62

parents Scilab Function

EXAMPLES :

//DISPLAY
deff(’[]=%tab_p(l)’,’disp([[’’ ’’;l(3)] [l(2);string(l(4))]])’)
tlist(’tab’,[’a’,’b’],[’x’;’y’],rand(2,2))

//OPERATOR
deff(’x=%c_a_s(a,b)’,’x=a+string(b)’)
’s’+1

//FUNCTION
deff(’x=%c_sin(a)’,’x=’’sin(’’+a+’’)’’’)
sin(’2*x’)

1.1.72 parents ) - left and right parenthesis

CALLING SEQUENCE :

(expression)
[...]=func(e1,e2,...)
[x1,x2,...]=(e1,e2,...)
x(i,j)
v(i)
[...]=l(i)

PARAMETERS :

x : matrix of any possible type

v : row or column vector of any possible type
l : list variable
func : any function name
e1,e2,... : any possible type expression

DESCRIPTION :
Left and right parenthesis are used to

* Specify evaluation order within expressions,

* Form right-hand-side functions argument list. Within multiple rhs arguments must be separated by
comma.
* Select elements within vectors, matrices and lists. see help on extraction and insertion for more precisions
* [x1,x2,...]=(e1,e2,...) is equivalent to first performing %t 1 = e1, %t 2 = e2, ..., and then x1 = %t 1, x2 =
%t 2, ..., where the variables %t i, i = 1, 2, ... are invisible to the user.

EXAMPLE :

3ˆ(-1)
x=poly(0,"x");
//
(x+10)/2
i3=eye(3,3)
//
a=[1 2 3;4 5 6;7 8 9],a(1,3),a([1 3],:),a(:,3)
a(:,3)=[]
a(1,$)=33
a(2,[$ $-1])

Scilab Group April 1993 63

plus Scilab Operator

a(:,$+1)=[10;11;12]
//
w=ssrand(2,2,2);ssprint(w)
ssprint(w(:,1))
ss2tf(w(:,1))
//
l=list(1,2,3,4)
[a,b,c,d]=l(:)
l($+1)=’new’
//
v=%t([1 1 1 1 1])
//
[x,y,z]=(1,2,3)

S EE A LSO : colon 31, comma 32, brackets 28, list 57, extraction 39, insertion
51

1.1.73 pause pause mode, invoke keyboard

DESCRIPTION :
Switch to the pause mode; inserted in the code of a function, pause interrupts the execution of the
function: one receives a prompt symbol which indicates the level of the pause (e.g. -1->). The user is
then in a new session in which all the lower-level variables (and in particular all the variable of the function)
are available. To return to lower session enter "return"
In this mode, [...]=return(...) returns the variables of the argument (...) to lower session
with names in the output [...]. Otherwise, the lower-level variables are protected and cannot be modified.
The pause is extremely useful for debugging purposes.
This mode is killed by the command "abort".
S EE A LSO : halt 289, return 68, abort 26, quit 67, whereami 76, where 76

1.1.74 percent - special character

DESCRIPTION :
Some predefined variables begin with %, such as %i (for sqrt(-1)), %inf (for Infinity), %pi
(for 3.14...), %T (for the boolean variable "true"),...
In addition, functions whose names begin with % are special : they are used for coding (extensions of
usual) operations .
For example the function %rmr performs the multiplication (m) operation x*y for x and y rational ma-
trices (r). The coding conventions are given by the readme file in directory SCIDIR/macros/percent.

EXAMPLE :

x1=tlist(’x’,1,2);
x2=tlist(’x’,2,3);
deff(’x=%xmx(x1,x2)’,’x=list(’’x’’,x1(2)*x2(2),x2(3)*x2(3))’);
x1*x2

1.1.75 plus - addition operator

CALLING SEQUENCE :

Scilab Group April 1993 64

power Scilab Function

X+Y
str1+str2

PARAMETERS :

X : scalar or vector or matrix of numbers, polynomials or rationals. It may also be a syslin list
Y : scalar or vector or matrix of numbers, polynomials or rationals. It may also be a syslin list
str1 : a character string, a vector or a matrix of character strings
str2 : a character string, a vector or a matrix of character strings

DESCRIPTION :
Addition.
For numeric operands addition as its usual meaning. If one of the operands is a matrix and the other one a
scalar the scalar is added to each matrix entries. if one of the operands is an empty matrix the other operand
is returned.
For character strings + means concatenation.
Addition may also be defined for other data types through ”soft-coded” operations.
EXAMPLE :

[1,2]+1
[]+2
s=poly(0,"s");
s+2
1/s+2
"cat"+"enate"

S EE A LSO : addf 164, mtlb_mode 60

1.1.76 poly polynomial definition

CALLING SEQUENCE :

[p]=poly(a,"x", ["flag"])

PARAMETERS :

a : matrix or real number

x : symbolic variable
"flag" : string (”roots”, ”coeff”), default value is ”roots”.

DESCRIPTION :
If a is a matrix, p is the characteristic polynomial i.e. determinant(x*eye()-a), x being the
symbolic variable.
If v is a vector, poly(v,"x",["roots"]) is the polynomial with roots the entries of v and "x"
as formal variable. (In this case, roots and poly are inverse functions).
poly(v,"x","coeff") creates the polynomial with symbol "x" and with coefficients the entries of
v. (Here poly and coeff are inverse functions).
s=poly(0,"s") is the seed for defining polynomials with symbol "s".
EXAMPLE :

s=poly(0,"s");p=1+s+2*sˆ2;
A=rand(2,2);poly(A,"x")

S EE A LSO : coeff 485, matrices 58, rational 68

Scilab Group April 1993 65

predef Scilab Function

1.1.77 power power operation (ˆ,.ˆ)

CALLING SEQUENCE :

t=Aˆb
t=A**b
t=A.ˆb

PARAMETERS :

A,t : scalar, polynomial or rational matrix.

b :a scalar, a vector or a scalar matrix.

DESCRIPTION :

(A:square)ˆ(b:scalar) : If A is a square matrix and b is a scalar then Aˆb is the matrix A to

the power b.
(A:matrix).ˆ(b:scalar) : If b is a scalar and A a matrix then A.ˆb is the matrix formed
by the element of A to the power b (elementwise power). If A is a vector and b is a scalar then
Aˆb and A.ˆb performs the same operation (i.e elementwise power).
(A:scalar).ˆ(b:matrix) If A is a scalar and b is a scalar matrix (or vector) Aˆb and A.ˆb are
the matrices (or vectors) formed by aˆ(b(i,j)).
(A:matrix).ˆ(b:matrix) If A and b are vectors (matrices) with compatible dimensions A.ˆb is
the A(i)ˆb(i) vector (A(i,j)ˆb(i,j) matrix).

Notes:

- For square matrices Aˆp is computed through successive matrices multiplications if p is a positive
integer, and by diagonalization if not.
- ** and ˆ operators are synonyms.

EXAMPLE :

A=[1 2;3 4];

Aˆ2.5,
A.ˆ2.5
(1:10)ˆ2
(1:10).ˆ2

s=poly(0,’s’)
sˆ(1:10)

S EE A LSO : exp 508

1.1.78 predef variable protection

CALLING SEQUENCE :

n=predef()
oldnew=predef(n)
oldnew=predef(’all’)
oldnew=predef(’clear’)

Scilab Group April 1993 66

rational Scilab Objects

DESCRIPTION :
Utility function used for defining ”oldest” variables as ”protected”. Protected variables cannot be killed.
They are not saved by the ’save’ command. The ”oldest” are those appearing last in the fVwho(’get’).
predef() gets the number of protected variables
predef(’a[ll]’) sets all the variables protected, it also return the old and new value of protected
variables number.
predef(’c[lear]’) unprotect all but the last 7 variables, it also return the old and new value of
protected variables number.
predef(n) sets the max(n,7) last defined variables as protected, it also return the old and new value
of protected variables number.

REMARK :
A number of protected variables are set in the start-up file scilab.star.
User may in particular set its own predefined variables in user’s startup file home/.scilab
S EE A LSO : clear 30, save 258

1.1.79 pwd print Scilab current directory

getcwd - get Scilab current directory
CALLING SEQUENCE :
pwd
x=pwd()
x=getwcd()
DESCRIPTION :
pwd returns in ans the Scilab current directory. x=pwd() or fVx=getcwd() returns in x the Scilab
current directory.
EXAMPLE :
pwd
x=pwd()
S EE A LSO : chdir 297, unix 310

1.1.80 quit decrease the pause level or exit

DESCRIPTION :
quit terminates Scilab or decreases the pause level.
S EE A LSO : pause 64, break 28, abort 26, exit 38

1.1.81 quote - transpose operator, string delimiter

DESCRIPTION :
quote (’)is used for (Conjugate) Transpose of matrix.
quote (.’)is used for (non Conjugate) Transpose of matrix.
Simple (’) or double (”) quotes are also used to define character strings. (Character strings are defined
between two quotes). A Quote within a character string is denoted by two quotes.
EXAMPLES :
[1+%i, 2]’
[1+%i, 2].’
x=’This is a character string’
’He said:’’Good’’’

Scilab Group April 1993 67

return Scilab Function

1.1.82 rational Scilab objects, rational in Scilab

DESCRIPTION :
A rational r is a quotient of two polynomials r=num/den. The internal representation of a rational is
a list. r=tlist(’[’r’,’num’,’den’,’dt’],num,den,[]) is the same as r=num/den. A ra-
tional matrix can be defined with the usual syntax e.g. [r11,r12;r21,r22] is a 2x2 matrix where rij
are 1x1 rationals. A rational matrix can also be defined as above as a list tlist([’r’,’num’,’den’,’dt’],num,den,[])
with num and den polynomial matrices.
EXAMPLES :

s=poly(0,’s’);
W=[1/s,1/(s+1)]
W’*W
Num=[s,s+2;1,s];Den=[s*s,s;s,s*s];
tlist([’r’,’num’,’den’,’dt’],Num,Den,[])
H=Num./Den
syslin(’c’,Num,Den)
syslin(’c’,H)
[Num1,Den1]=simp(Num,Den)

S EE A LSO : poly 65, syslin 224, simp 497

1.1.83 resume return or resume execution and copy some local variables

CALLING SEQUENCE :

resume
[x1,..,xn]=resume(a1,..,an)

PARAMETERS :

DESCRIPTION :
In a function resume stops the execution of the function, [..]=resume(..) stops the execution of
the function and put the local variables ai in calling environnement under names xi.
In pause mode, it allows to return to lower level [..]=resume(..) returns to lower level and put
the local variables ai in calling environnement under names xi.
In an execstr called by a function [..]=resume(..) stops the execution of the function and put
the local variables ai in calling environnement under names xi.
resume is equivalent to return.
S EE A LSO : abort 26, break 28

1.1.84 return return or resume execution and copy some local variables

CALLING SEQUENCE :

return
[x1,..,xn]=return(a1,..,an)

PARAMETERS :

Scilab Group April 1993 68

select Scilab Function

DESCRIPTION :
In a function return stops the execution of the function, [..]=return(..) stops the execution of
the function and put the local variables ai in calling environnement under names xi.
In pause mode, it allows to return to lower level [..]=return(..) returns to lower level and put
the local variables ai in calling environnement under names xi.
In an execstr called by a function [..]=return(..) stops the execution of the function and put
the local variables ai in calling environnement under names xi.
resume is equivalent to return.
S EE A LSO : abort 26, break 28

1.1.85 rlist Scilab rational fraction function definition

CALLING SEQUENCE :

rlist()
rlist(a1,....an)

DESCRIPTION :
rlist(a1,....an) is a shortcut to tlist([’r’,’num’;’den’,’dt’], a1,....an)
Creates a tlist with [’r’,’num’;’den’,’dt’] as first entry and ai’s as next entries if any. No
type nor size checking is done on ai’s.
S EE A LSO : tlist 73, syslin 224

1.1.86 sciargs scilab command line arguments

CALLING SEQUENCE :

args=sciargs()

DESCRIPTION :
This function returns a vector of character strings containing the arguments of the Scilab command line.
First args entry contains the path of the lanched executable file.
This function correspond to the getarg function in C langage
S EE A LSO : getenv 45

1.1.87 select select keyword

DESCRIPTION :

select expr,
case expr1 then instructions1,
case expr2 then instructions2,
...
case exprn then instructionsn,
[else instructions],
end

Notes:

Scilab Group April 1993 69

setfield Scilab Function

- The only constraint is that each ”then” keyword must be on the same line line as corresponding ”case”
keyword.
- The ”keyword ”then” can be replaced by a carriage return or a comma.
instructions1 are executed if expr1=expr, etc.
Warning: the number of characters used to define the body of any conditionnal instruction (if while for or
select/case) must be limited to 16k.
EXAMPLE :

while %t do
n=round(10*rand(1,1))
select n
case 0 then
disp(0)
case 1 then
disp(1)
else
break
end
end

S EE A LSO : if 50, while 77, for 42

1.1.88 semi - instruction and row separator

DESCRIPTION :
semicolumns are used to separate rows in a matrix definition.
semicolumns may also be used at the end of an instruction. In this case it means that the result(s) are not
displayed. Conversely use comma (,) to get the display
EXAMPLES :

a=[1,2,3;4,5,6];
a=1;b=1,c=2

S EE A LSO : comma 32, brackets 28

1.1.89 semicolumn - ending expression and row separator

DESCRIPTION :
In a file, the line separator “;” suppresses the display of the line.
Within brackets ; denotes row separator in matrix definition.
EXAMPLES :
sin(%pi) sin(%pi); a=[1,2;3 4]

1.1.90 setfield list field insertion

CALLING SEQUENCE :

setfield(i,x,l)

Scilab Group September 1999 70

stacksize Scilab Function

PARAMETERS :

x : matrix of any possible types

l : list, tlist or mlist variable
i : field index, see insertion for more details.

DESCRIPTION :
This function is an equivalent of l(i)=x syntax for field extraction with the only difference that it also
applies to mlist objects.
EXAMPLE :

l=list(1,’qwerw’,%s)
l(1)=’Changed’
l(0)=’Added’
l(6)=[’one more’;’added’]
//

a=hypermat([2,2,2],rand(1:2ˆ3));// hypermatrices are coded using mlists

setfield(3,1:8,a);a // set the field value to 1:8

S EE A LSO : insertion 51

1.1.91 slash - right division and feed back

DESCRIPTION :
Right division. x=A / b is the solution of x*b=A .
b/a = (a’ nb’)’ .
a ./ b is the matrix with entries a(i,j)/ b(i,j). If b is scalar (1x1 matrix) this operation is the
same as a./b*ones(a). (Same convention if a is a scalar).
Remark that 123./b is interpreted as (123.)/b. In this cases dot is part of the number not of the
operator.
Backslash stands for left division.
System feed back. S=G/.K evaluates S=G*(eye()+K*G)ˆ(-1) this operator avoid simplification
problem.
Remark that G/.5 is interpreted as G/(.5). In such cases dot is part of the number, not of the operator.
Comment // comments a line i.e lines which begin by // are ignored by the interpreter.
S EE A LSO : inv 516, percent 64, backslash 26, ieee 50

1.1.92 stacksize set scilab stack size

CALLING SEQUENCE :

stacksize(n)
sz=stacksize()

PARAMETERS :

n : integer, the required stack size given in number of double precision words
sz : 2-vector [total used]

Scilab Group October 1995 71

testmatrix Scilab Function

DESCRIPTION :
Scilab stores all variables in a unique stack stk.
stacksize(n) allows the user to increase or decrease the size of this stack. The maximum allowed
size depends on the amount of free memory and swap space available at the time.
This function with the n argument may only be called at the main prompt; it cannot be called within a
scilab function.
sz=stacksize() returns a 2-vector which contains the current total and used stack size. It can be
used everywhere.
S EE A LSO : who 77

1.1.93 star - multiplication operator

DESCRIPTION :
Multiplication. Usual meaning. Valid for constant, boolean, polynomial and rational matrices.
Element-wise multiplication is denoted x.*y. If x or y is scalar (1x1 matrix) .* is the same as *.
Kronecker product is x.*.y
S EE A LSO : mulf 203

1.1.94 symbols scilab operator names

DESCRIPTION :
Use the following names to get help on a specific symbol.
operator name in Scilab help
’,",.’ quote
+ plus
- minus
*,.* star
/,./ slash
n,.n backslash
. dot
=,== equal
<,>, <=, >=,<> less
˜ tilda
[ left
] right
() parents
% percent
: column
, comma
; semi
ˆ hat
.ˆ power
j or
& and
.*.,./., .n. kron

S EE A LSO : overloading 61

Scilab Group April 1993 72

tlist Scilab Function

1.1.95 testmatrix generate some particular matrices

CALLING SEQUENCE :

[y]=testmatrix(name,n)

PARAMETERS :

name : a character string

n : integers, matrix size
y : n x m matrix

DESCRIPTION :
Create some particular matrices

testmatrix(’magi’,n) : returns a magic square of size n .

testmatrix(’frk’,n) : returns the Franck matrix :
testmatrix(’hilb’,n) : is the inverse of the nxn Hilbert matrix (Hij= 1/(i+j-1)).

1.1.96 then keyword in if-then-else

DESCRIPTION :
Used with if.
S EE A LSO : if 50

1.1.97 tilda - logical not

CALLING SEQUENCE :

˜m

PARAMETERS :

m : boolean matrix

DESCRIPTION :
˜m is the negation of m.

1.1.98 tlist Scilab object and typed list definition.

CALLING SEQUENCE :

tlist(typ,a1,....an )

PARAMETERS :

typ : Character string or vector of character strings

ai : Any Scilab object (matrix, list,string...).

Scilab Group September 1995 73

typename Scilab Function

DESCRIPTION :
Creates a typed-list with elements ai’s. The typ argument specifies the list type. Such typed-list
allow the user to define new operations working on these object through scilab functions. The only differ-
ence between typed-list and list is the value of the type (16 instead of 15).
typ(1) specifies the list type (character string used to define soft coded operations)
if specified typ(i) may give the i+1th element formal name
Standard Operations on list work similarly for typed-list:

extraction : [x,y,z...]=l(v) where v is a vector of indices; [x,y,z]=l(:) extracts all the

elements.
insertion : l(i)=a
deletion : l(i)=null() removes the i-th element of the tlist l.
display

Moreover if typ(2:n+1) are specified, user may point elements by their names
We give below examples where tlist are used.
Linear systems are represented by specific typed-list e.g. a linear system [A,B,C,D] is repre-
sented by the tlist Sys=tlist([’lss’;’A’;’B’;’C’;’D’;’X0’;’dt’],A,B,C,D,x0,’c’)
and this specific list may be created by the function syslin.
Sys(2) or Sys(’A’) is the state-matrix and Sys(’td’) is the time domain
A rational matrix H is represented by the typed-list H=tlist([’r’;’num’;’den’;’dt’],Num,Den,[])
where Num and Den are two polynomial matrices and a (e.g. continuous time) linear system with transfer
matrix H maybe created by syslin(’c’,H).
H(2) or H(’num’) is the transfer matrix numerator
S EE A LSO : null 61, percent 64, syslin 224, list 57

1.1.99 type variable type

CALLING SEQUENCE :

[i]=type(x)

PARAMETERS :

x : Scilab object
i : integer

DESCRIPTION :
type(x) returns an integer which is the type of x as following :

1 : real or complex constant matrix.

2 : polynomial matrix.
4 : boolean matrix.
5 : sparse matrix.
8 : matrix of integers stored on 1 2 or 4 bytes
10 : matrix of character strings.
11 : un-compiled function.
13 : compiled function.
14 : function library.
15 : list.
16 : typed list (tlist)
128 : pointer

S EE A LSO : typeof 229

Scilab Group April 1993 74

varn Scilab Function

1.1.100 typename associates a name to variable type

CALLING SEQUENCE :

[types [ [,names]]=typename()
typename(name,type)

PARAMETERS :

types : integer column vector: the types codes of each defined data types.
names : column vector of strings: the names associated to type codes.
type : integer: the type code of new data type.
name : string: the name associated to the type code

DESCRIPTION :
The function and operator overloading make use of a formal name associated to data types to form the
name of the overloading function (see overloading). The typename can be used to handle this formal
names for hard coded data types (the tlist or mlist coded data types formal names are defined in an
other way, see overloading).
Called without right hand side argument, typename returns informations on defined data types.
Called with right hand side argument, typename associates a name to a data type code.
typename(’’,type) suppress the data type given by its code type out of the table of known data
types.
S EE A LSO : type 74, typeof 229, overloading 61, tlist 73, mlist 59

1.1.101 user interfacing a fortran routine

CALLING SEQUENCE :

[s_1,s_2,...,s_lhs]=user(e_1,e_2,...,e_rhs)

DESCRIPTION :
With this command it is possible to use an external program as a Scilab command where (s 1,s 2,...,s lhs)
are the output variables and (e 1,e 2,...,e rhs) are the input variables. To insert this command in
Scilab one has to write a few lines in the user fortran subroutine of Scilab. See intersci or the Scilab
documentation for more information.
S EE A LSO : fort 43, link 303

1.1.102 varn symbolic variable of a polynomial

CALLING SEQUENCE :

[symb]=varn(p)
[pm]=varn(x,var)

PARAMETERS :

p : polynomial (or matrix polynomial)

symb : character string
x : polynomial or polynomial matrix
var : symbolic variable (character string)
pm : matrix or polynomial matrix

Scilab Group April 1993 75

what Scilab Function

DESCRIPTION :
symb=varn(p) returns in symb the symbolic variable of the polynomial p (i.e. varn(poly(0,’x’))
is ’x’).
varn(x,’s’) returns a polynomial matrix with same coefficients as x but with ’s’ as symbolic vari-
able (change of variable name).
EXAMPLE :

s=poly(0,’s’);p=[sˆ2+1,s];
varn(p) is the string ’s’ and varn(p,’x’) is the polynomial matrix [xˆ2+1,x]
S EE A LSO : horner 490, poly 65

1.1.103 what list the Scilab primitives

DESCRIPTION :
List of low level primitives and commands.

1.1.104 where get current instruction calling tree

CALLING SEQUENCE :

[linenum,mac]=where()

PARAMETERS :

linenum : column vector of integer

mac : column vector of strings

DESCRIPTION :
returns linenum and mac such as current instruction has been called by the linenum(1) line of function
mac(1), mac(1) has been called by the linenum(2) line of function mac(2) and so on
mac(i) is in general the name of a function but it may also be ”exec” or ”execstr” if instruction lies in
ans exec file or an execstr instruction
S EE A LSO : whereami 76, pause 64

1.1.105 whereami display current instruction calling tree

CALLING SEQUENCE :

whereami()

DESCRIPTION :
Displays calling tree to instruction which contain whereami(). May be used within pause levels.
EXAMPLE :

deff(’y=test(a)’,[’y=sin(a)+1’;
’y=t1(y)’;
’y=y+1’])
deff(’y=t1(y)’,[’y=yˆ2’;’whereami()’])
test(1)

S EE A LSO : where 76, pause 64, errcatch 34

Scilab Group April 1993 76

whos Scilab Function

1.1.106 whereis name of library containing a function

CALLING SEQUENCE :

[librname]=whereis(function-name)

DESCRIPTION :
returns as a character string the name of the library containing the function function-name. The path
of the library is returned by typing "librname".
S EE A LSO : lib 272

1.1.107 while while keyword

DESCRIPTION :
while clause. Must be terminated by "end"
while expr ,instructions,...[,else instructions], end
while expr do instructions,...[,else instructions], end
while expr then instructions,...[,else instructions], end Notes:
- The only constraint is that each ”then” or ”do” keyword must be on the same line line as ”while” keyword.
- The ”keyword ”then” or ”do” can be replaced by a carriage return or a comma.
- The optional ,else instructions construction allows to gives instructions which are executed
when expr expression becomes false.
Warning: the number of characters used to define the body of any conditionnal instruction (if while for or
select/case) must be limited to 16k.
EXAMPLE :

e=1; a=1; k=1;

while norm(a-(a+e),1) > %eps, e=e/2; k=k+1; end
e,k

S EE A LSO : for 42, select 69, break 28, return 68, pause 64

1.1.108 who listing of variables

CALLING SEQUENCE :

who
who()
names=who(’local’)
[names,mem]=who(’local’)
names=who(’global’)
[names,mem]=who(’global’)

DESCRIPTION :
who displays current variable names.
who(’local’) or who(’get’) Returns current variable names and memory used in double precision
worlds.
who(’global’) returns global variable names and memory used in double precision worlds.
S EE A LSO : whos 78

Scilab Group Jan 1997 77

whos Scilab Function

1.1.109 whos listing of variables in long form

CALLING SEQUENCE :

whos()
whos -type typ
whos -name nam

PARAMETERS :

typ : name of selected variable type (see typeof)

nam : first characters of selected names

DESCRIPTION :
whos() displays all current variable names, types and memory used
whos -type typ displays all current variables with specified type
whos -name nam displays all current variables whose names begin with nam
EXAMPLE :

whos()

whos -type boolean

whos -name %

S EE A LSO : who 77, typeof 229

Scilab Group Jan 1997 78

whos Scilab Function

1.2 Graphic Library

Scilab Group Jan 1997 79

graphics Scilab Function

1.2.1 Graphics graphics library overview

2D PLOTTING :

plot2d : plot a curve

plot2d2 : plot a curve as step function
plot2d3 : plot a curve with vertical bars
plot2d4 : plot a curve with arrows
fplot2d : plot a curve defined by a function
champ : 2D vector field
champ1 : 2D vector field with colored arrows
fchamp : direction field of a 2D first order ODE
contour2d : level curves of a surface on a 2D plot
fcontour2d : level curves of a surface defined by a function on a 2D plot
grayplot : 2D plot of a surface using colors
fgrayplot : 2D plot of a surface defined by a function using colors
Sgrayplot : smooth 2D plot of a surface using colors
Sfgrayplot : smooth 2D plot of a surface defined by a function using colors
xgrid : add a grid on a 2D plot
errbar : add vertical error bars on a 2D plot
histplot : plot a histogram
Matplot : 2D plot of a matrix using colors

3D PLOTTING :

plot3d : plot a surface

plot3d1 : plot a surface with gray or color level
fplot3d : plot a surface defined by a function
fplot3d1 : plot a surface defined by a function with gray or color level
param3d : plot one curve
param3d1 : plots curves
contour : level curves on a 3D surface
fcontour : level curves on a 3D surface defined by a function
hist3d : 3D representation of a histogram
genfac3d : compute facets of a 3D surface
eval3dp : compute facets of a 3D surface
geom3d : projection from 3D on 2D after a 3D plot

LINE AND POLYGON PLOTTING :

xpoly : draw a polyline or a polygon

xpolys : draw a set of polylines or polygons
xrpoly : draw a regular polygon
xsegs : draw unconnected segments
xfpoly : fill a polygon
xfpolys : fill a set of polygons

RECTANGLE PLOTTING :

xrect : draw a rectangle

xfrect : fill a rectangle
xrects : draw or fill a set of rectangles

ARC PLOTTING :

xarc : draw a part of an ellipse

Scilab Group April 1993 80

graphics Scilab Function

xarcs : draw parts of a set of ellipses

xfarc : fill a part of an ellipse
xfarcs : fill parts of a set of ellipses

ARROW PLOTTING :

xarrows : draw a set of arrows

STRINGS :

xstring : draw strings

xstringl : compute a box which surrounds strings
xstringb : draw strings into a box
xtitle : add titles on a graphics window
titlepage : add a title in the middle of a graphics window
xinfo : draw an info string in the message subwindow

FRAMES AND AXES :

xaxis : draw an axis

graduate : pretty axis graduations
plotframe : plot a frame with scaling and grids

COORDINATES TRANSFORMATIONS :

isoview : set scales for isometric plot (do not change the size of the window)
square : set scales for isometric plot (change the size of the window)
scaling : affine transformation of a set of points
rotate : rotation of a set of points
xsetech : set the sub-window of a graphics window for plotting
subplot : divide a graphics window into a matrix of sub-windows
xgetech : get the current graphics scale
xchange : transform real to pixel coordinates

COLORS :

colormap : using colormaps

getcolor : dialog to select colors in the current colormap
addcolor : add new colors to the current colormap
graycolormap : linear gray colormap
hotcolormap : red to yellow colormap

GRAPHICS CONTEXT :

xset : set values of the graphics context

xget : get current values of the graphics context
xlfont : load a font in the graphics context or query loaded font
getsymbol : dialog to select a symbol and its size

SAVE AND LOAD :

xsave : save graphics into a file

xload : load a saved graphics
xbasimp : send graphics to a Postscript printer or in a file
xs2fig : send graphics to a file in Xfig syntax

GRAPHICS PRIMITIVES :

xbasc : clear a graphics window and erase the associated recorded graphics
xclear : clear a graphics window

Scilab Group April 1993 81

Matplot1 Scilab Function

driver : select a graphics driver

xinit : initialisation of a graphics driver
xend : close a graphics session
xbasr : redraw a graphics window
replot : redraw the current graphics window with new boundaries
xpause : suspend Scilab
xselect : raise the current graphics window
xclea : erase a rectangle
xclip : set a clipping zone
xdel : delete a graphics window
winsid : return the list of graphics windows
xname : change the name of the current graphics window

MOUSE POSITION :

xclick : wait for a mouse click

locate : mouse selection of a set of points
xgetmouse : get the current position of the mouse

INTERACTIVE EDITOR :

edit curv : interactive graphics curve editor

gr menu : simple interactives graphic editor
sd2sci : gr menu structure to scilab instruction convertor

GRAPHICS FUNCTIONS FOR AUTOMATIC CONTROL :

bode : Bode plot

gainplot : magnitude plot
nyquist : Nyquist plot
m circle : M-circle plot
chart : Nichols chart
black : Black’s diagram
evans : Evans root locus
sgrid : s-plane grid lines
plzr : pole-zero plot
zgrid : zgrid plot

1.2.2 Matplot 2D plot of a matrix using colors

CALLING SEQUENCE :

Matplot(a,[strf,rect,nax])

PARAMETERS :

a : real matrix of size (n1,n2).

strf,rect,nax : optional arguments, see plot2d.

DESCRIPTION :
The entries of matrix int(a) are used as colormap entries in the current colormap. The color associated
to a(i,j) is used do draw a small square of length 1 with center at location (x=j,y=(n2-i+1)).
Enter the command Matplot() to see a demo.
EXAMPLE :

Scilab Group April 1993 82

Sfgrayplot Scilab Function

Matplot([1 2 3;4 5 6])

// draw the current colormap
Matplot((1:xget("lastpattern")))
S EE A LSO : colormap 89, plot2d 118, Matplot1 83
AUTHOR : J.Ph.C.

1.2.3 Matplot1 2D plot of a matrix using colors

CALLING SEQUENCE :
Matplot1(a,rect)
PARAMETERS :
a : real matrix of size (n1,n2).
rect : [xmin;ymin,xmax,ymax]
DESCRIPTION :
The entries of matrix int(a) are used as colormap entries in the current colormap. rect specify a
rectangle in the current scale and the matrix is drawn inside this rectangle. Each matrix entry will be
rendered as a small rectangle filled with its associated color.
EXAMPLE :
//--- first example
// fix current scale
xsetech(frect=[0,0,10,10])
xrect(0,10,10,10)
a=5*ones(11,11); a(2:10,2:10)=4; a(5:7,5:7)=2;
// first matrix in rectangle [1,1,3,3]
Matplot1(a,[1,1,3,3])
a=ones(10,10); a= 3*tril(a)+ 2*a;
// second matrix in rectangle [5,6,7,8]
Matplot1(a,[5,6,7,8])
xset(’default’)
xbasc()
//--- second example
xsetech(frect=[0,0,10,10])
xrect(0,10,10,10)
n=100;
xset(’pixmap’,1)
driver(’X11’);
for k=-n:n,
a=ones(n,n);
a= 3*tril(a,k)+ 2*a;
a= a + a’;
k1= 3*(k+100)/200;
Matplot1(a,[k1,2,k1+7,9])
xset(’wshow’)
xset(’wwpc’)
end
xset(’pixmap’,0)
xset(’default’)
xbasc()
S EE A LSO : colormap 89, plot2d 118, Matplot 82
AUTHOR : J.Ph.C.

Scilab Group April 1993 83

addcolor Scilab Function

1.2.4 Sfgrayplot smooth 2D plot of a surface defined by a function using colors

CALLING SEQUENCE :

Sfgrayplot(x,y,f,[strf,rect,nax])

DESCRIPTION :
Sfgrayplot is the same as fgrayplot but the plot is smoothed. The function fec is used for
smoothing. The surface is plotted assuming that it is linear on a set of triangles built from the grid:

______
| /| /|
|/_|/_|
| /| /|
|/_|/_|

Enter the command Sfgrayplot() to see a demo.

EXAMPLE :

t=-1:0.1:1;
deff("[z]=surf(x,y)","z=x**2+y**2")
Sfgrayplot(t,t,surf,"111",[-2,-2,2,2])

S EE A LSO : fec 101, fgrayplot 102, grayplot 109, Sgrayplot 84

AUTHOR : J.Ph.C.

1.2.5 Sgrayplot smooth 2D plot of a surface using colors

CALLING SEQUENCE :

Sgrayplot(x,y,z,[strf,rect,nax])

DESCRIPTION :
Sgrayplot is the same as grayplot but the plot is smoothed. The function fec is used for smooth-
ing. The surface is plotted assuming that it is linear on a set of triangles built from the grid:

______
| /| /|
|/_|/_|
| /| /|
|/_|/_|

Enter the command Sgrayplot() to see a demo.

EXAMPLE :

x=-10:10; y=-10:10;m =rand(21,21);

Sgrayplot(x,y,m,"111",[-20,-20,20,20])
t=-%pi:0.1:%pi; m=sin(t)’*cos(t);
xbasc()
Sgrayplot(t,t,m)

S EE A LSO : fec 101, fgrayplot 102, grayplot 109, Sfgrayplot 84

AUTHOR : J.Ph.C.

Scilab Group April 1993 84

 black Scilab Function

1.2.6 addcolor add new colors to the current colormap

CALLING SEQUENCE :

new=addcolor(c)

PARAMETERS :

new : ids of the colors defined in c in the new color table.

c : matrix with 3 columns, RGB color definition.

DESCRIPTION :
addcolor adds new colors given in the c argument to the current colormap. c must be a matrix with
3 columns [R G B] R is red component, G is green component, B is blue component). Each entry in
c must be a non negative number less or equal to 1.
The ids of the new colors are returned into new.
If a color defined in c is already present in the current colormap it is not added.
S EE A LSO : colormap 89

1.2.7 alufunctions description and number of pixel drawing modes.

DESCRIPTION :
src is the source ie the ”value of the pixel” which we want to draw. dst is the destination ie ”value of the
pixel” which is already drawn.
0: clear ie ”0”
1: and ie ”src AND dst”
2: and reverse ie ”src AND NOT dst”
3: copy ie ”src”
4: and inverted ie ”(NOT src) AND dst”
5: noop ie ”dst”
6: xor ie ”src XOR dst”
7: or ie ”src OR dst”
8: nor ie ”(NOT src) AND (NOT dst)”
9: equiv ie ”(NOT src) XOR dst”
10: invert ie ”NOT dst”
11: or reverse ie ”src OR (NOT dst)”
12: copy inverted ie ”NOT src”
13: or inverted ie ”(NOT src) OR dst”
14: nand ie ”(NOT src) OR (NOT dst)”
15: set ie ”1”

1.2.8 black Black’s diagram (Nichols chart)

CALLING SEQUENCE :

black( sl,[fmin,fmax] [,step] [,comments] )

black( sl,frq [,comments] )
black(frq,db,phi [,comments])
black(frq,repf [,comments])

PARAMETERS :

Scilab Group April 1993 85

bode Scilab Function

sl : list ( linear system syslin)

fmin,fmax : real scalars (frequency bounds)
frq : row vector or matrix (frequencies)
db,phi : row vectors or matrices (modulus, phase)
repf : row vectors or matrices (complex frequency response)
step : real
comments : string

DESCRIPTION :
Black’s diagram (Nichols’chart) for a linear system sl. sl can be a continuous-time or discrete-time
SIMO system (see syslin). In case of multi-output the outputs are plotted with different symbols.
The frequencies are given by the bounds fmin,fmax (in Hz) or by a row-vector (or a matrix for multi-
output) frq.
step is the ( logarithmic ) discretization step. (see calfrq for the choice of default value).
comments is a vector of character strings (captions).
db,phi are the matrices of modulus (in Db) and phases (in degrees). (One row for each response).
repf matrix of complex numbers. One row for each response.
To plot the grid of iso-gain and iso-phase of y/(1+y) use chart().
Default values for fmin and fmax are 1.d-3, 1.d+3 if sl is continuous-time or 1.d-3, 0.5 if sl
is discrete-time.
EXAMPLE :

s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
chart();
sstr=’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’;
black(h,0.01,100,sstr);
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
xbasc()
black([h1;h],0.01,100,[’h1’;’h’])

S EE A LSO : bode 86, nyquist 115, chart 88, freq 339, repfreq 355, calfrq
324, phasemag 353

1.2.9 bode Bode plot

CALLING SEQUENCE :

bode(sl,[fmin,fmax] [,step] [,comments] )

bode(sl,frq [,comments] )
bode(frq,db,phi [,comments])
bode(frq, repf [,comments])

PARAMETERS :

sl : syslin list (SISO or SIMO linear system) in continuous or discrete time.

fmin,fmax : real (frequency bounds (in Hz))
step : real (logarithmic step.)
comments : vector of character strings (captions).
frq : row vector or matrix (frequencies (in Hz) ) (one row for each SISO subsystem).
db : row vector or matrix ( magnitudes (in Db)). (one row for each SISO subsystem).
phi : row vector or matrix ( phases (in degree)) (one row for each SISO subsystem).
repf : row vector or matrix of complex numbers (complex frequency response).

Scilab Group April 1993 86

champ Scilab Function

DESCRIPTION :
Bode plot, i.e magnitude and phase of the frequency response of sl.
sl can be a continuous-time or discrete-time SIMO system (see syslin). In case of multi-output the
outputs are plotted with different symbols.
The frequencies are given by the bounds fmin,fmax (in Hz) or by a row-vector (or a matrix for multi-
output) frq.
step is the ( logarithmic ) discretization step. (see calfrq for the choice of default value).
comments is a vector of character strings (captions).
db,phi are the matrices of modulus (in Db) and phases (in degrees). (One row for each response).
repf matrix of complex numbers. One row for each response.
Default values for fmin and fmax are 1.d-3, 1.d+3 if sl is continuous-time or 1.d-3, 0.5 if sl
is discrete-time. Automatic discretization of frequencies is made by calfrq.
EXAMPLE :

s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
title=’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’;
bode(h,0.01,100,title);
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
xbasc()
bode([h1;h],0.01,100,[’h1’;’h’])

S EE A LSO : black 85, nyquist 115, gainplot 104, repfreq 355, g_margin 340,
p_margin 352, calfrq 324, phasemag 353

1.2.10 champ 2D vector field plot

CALLING SEQUENCE :

champ(x,y,fx,fy,[arfact,rect,strf])
champ(x,y,fx,fy,<opt_args>)

PARAMETERS :

x,y : two vectors which define the grid.

fx : a matrix which describes the x component of the vector field. fx(i,j) is the x component of the
vector field at point (x(i),y(j)).
fy : a matrix which describes the y component of the vector field. fy(i,j) is the y component of the
vector field at point (x(i),y(j)).
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: arfact, rect, strf (see below).
arfact : an optional argument of type real which gives a scale factor for the display of the arrow heads
on the plot (default value is 1.0).
rect : a vector rect=[xmin,ymin,xmax,ymax] which gives the boundaries of the graphics frame
to use.
strf : a string of length 3 ”xyz” which has the same meaning as the strf parameter of plot2d. The
first character x has no effect with champ.

DESCRIPTION :
champ draws a 2D vector field. The length of the arrows is proportional to the intensity of the field.
If you want colored arrows with the color of the arrows depending on the intensity of the field, use
champ1.
Enter the command champ() to see a demo.
EXAMPLE :

Scilab Group April 1993 87

chart Scilab Function

// using rect as plot boundaries

champ(-5:5,-5:5,rand(11,11),rand(11,11),1,[-10,-10,10,10],"011")
// using (x,y) to get boundaries
xbasc()
champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")

S EE A LSO : champ1 88, fchamp 99, plot2d 118

AUTHOR : J.Ph.C.

1.2.11 champ1 2D vector field plot with colored arrows

CALLING SEQUENCE :

champ1(x,y,fx,fy,[arfact,rect,strf])

PARAMETERS :

x,y : two vectors which define the grid.

fx : a matrix which describes the x component of the vector field. fx(i,j) is the x component of the
vector field at point (x(i),y(j)).
fy : a matrix which describes the y component of the vector field. fy(i,j) is the y component of the
vector field at point (x(i),y(j)).
arfact : an optional argument of type real which gives a scale factor for the display of the arrow heads
on the plot (default value is 1.0).
rect : a vector rect=[xmin,ymin,xmax,ymax] which gives the boundaries of the graphics frame
to use.
strf : a string of length 3 ”xyz” which has the same meaning as the strf parameter of plot2d. The
first character x has no effect with champ1.

DESCRIPTION :
champ1 draws a 2D vector field with colored arrows. The color of the arrows depends on the intensity of
the field.
If you want arrows proportional to the intensity of the field, use champ.
Enter the command champ1() to see a demo.
EXAMPLE :

xset("use color",1)
champ1(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")

S EE A LSO : champ 87, fchamp 99, plot2d 118

AUTHOR : J.Ph.C.

1.2.12 chart Nichols chart

CALLING SEQUENCE :

chart([flags])
chart(gain [,flags])
chart(gain,phase [,flags])

PARAMETERS :

gain : real vector ( gains (in DB))

Scilab Group April 1993 88

contour Scilab Function

phase : real vector (phases (in degree))

flags : a list of at most 4 flags list(sup [,leg [,cm [,cphi]]])
sup : 1 indicates superposition on the previous plot 0 no superposition is done
leg : 1 indicates that legends are drawn, o: no legends
cm : color number (see plot2d) for gain curves
cphi : color number (see plot2d) for phase curves

DESCRIPTION :
plot the Nichols’chart.
The default values for gain and phase are respectively :
[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]
[-(1:10) , -(20:10:160)]
EXAMPLE :

s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
black(h,0.01,100,’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’)
chart(list(1,0,2,3));

Another example :

xbasc()
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
black([h1;h],0.01,100,[’h1’;’h’])
chart([-8 -6 -4],[80 120],list(1,0));

1.2.13 colormap using colormaps

DESCRIPTION :
A colormap cmap is defined by a m x 3 matrix. m is the number of colors. Color number i is given
as a 3-uple cmap(i,1), cmap(i,2) cmap(i,3) corresponding respectively to red, green and blue
intensity between 0 and 1.
At the beginning, 32 colors are defined in the colormap. You can change the colormap by using
xset("colormap",cmap).
Each color in the colormap has an id you have to use to specify color in most plot functions. To see the
ids, use xset() or xgetcolor().
You can come back to default colormap with xset("default").
EXAMPLE :

m=228;
n= fix(3/8*m);
r=[(1:n)’/n; ones(m-n,1)];
g=[zeros(n,1); (1:n)’/n; ones(m-2*n,1)];
b=[zeros(2*n,1); (1:m-2*n)’/(m-2*n)];
h=[r g b];
xset("colormap",h)
plot3d1()
xset("default")

S EE A LSO : addcolor 85, getcolor 106, xset 154

Scilab Group April 1993 89

contour Scilab Function

1.2.14 contour level curves on a 3D surface

CALLING SEQUENCE :

contour(x,y,z,nz,[theta,alpha,leg,flag,ebox,zlev])
contour(x,y,z,nz,<opt_args>)

PARAMETERS :

x,y : two real row vectors of size n1 and n2.

z : real matrix of size (n1,n2), the values of the function.
nz : the level values or the number of levels.
- If nz is an integer, its value gives the number of level curves equally spaced from zmin to zmax as
follows:

z= zmin + (1:nz)*(zmax-zmin)/(nz+1)

Note that the zmin and zmax levels are not drawn (generically they are reduced to points) but they
can be added with

[im,jm] = find(z == zmin); // or zmax

plot2d(x(im)’,y(jm)’,-9,"000")
- If nz is a vector, nz(i) gives the value of the ith level curve. Note that it can be useful in order to see
zmin and zmax level curves to add an epsilon tolerance: nz=[ zmin+%eps,..,zmax-%eps].
<opt args> : a sequence of statements key1=value1, key2=value2, ... where keys may be
theta,alpha,leg, flag, ebox,zlev (see below). In this case, the order has no special mean-
ing.
theta, alpha : real values giving in degree the spherical coordinates of the observation point.
leg : string defining the captions for each axis with @ as a field separator, for example ”X@Y@Z”.
flag : a real vector of size three flag=[mode,type,box].
mode : string (treatment of hidden parts).
mode>0 the hidden parts of the surface are removed and the surface is painted with color mode.
mode=0 the hidden parts of the surface are drawn.
mode<0 only the shadow of the surface is painted with color or pattern id -mode. Use xset() to see
the meaning of the ids.
type : an integer (scaling).
type=0 the plot is made using the current 3D scaling (set by a previous call to param3d, plot3d,
contour or plot3d1).
type=1 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are specified by the
value of the optional argument ebox.
type=2 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are computed using
the given data.
type=3 3d isometric with box bounds given by optional ebox, similarily to type=1
type=4 3d isometric bounds derived from the data, to similarilytype=2
type=5 3d expanded isometric bounds with box bounds given by optional ebox, similarily to type=1
type=6 3d expanded isometric bounds derived from the data, similarily to type=2
box : an integer (frame around the plot).
box=0 nothing is drawn around the plot.
box=1 unimplemented (like box=0).
box=2 only the axes behind the surface are drawn.
box=3 a box surrounding the surface is drawn and captions are added.
box=4 a box surrounding the surface is drawn, captions and axes are added.
ebox : used when type in flag is 1. It specifies the boundaries of the plot as the vector [xmin,xmax,ymin,ymax,zmin,z
zlev : real number.

Scilab Group April 1993 90

contour2d Scilab Function

DESCRIPTION :
contour draws level curves of a surface z=f(x,y). The level curves are drawn on a 3D surface. The op-
tional arguments are the same as for the function plot3d (except zlev) and their meanings are the same.
They control the drawing of level curves on a 3D plot. Only flag(1)=mode has a special meaning.

mode=0 : the level curves are drawn on the surface defined by (x,y,z).
mode=1 : the level curves are drawn on a 3D plot and on the plan defined by the equation z=zlev.
mode=2 : the level curves are drawn on a 2D plot.
You can change the format of the floating point number printed on the levels by using xset("fpf",string)
where string gives the format in C format syntax (for example string="%.3f"). Use string=""
to switch back to default format.

Usually we use contour2d to draw levels curves on a 2D plot.

Enter the command contour() to see a demo.
EXAMPLE :

t=%pi*[-10:10]/10;
deff("[z]=surf(x,y)","z=sin(x)*cos(y)"); z=feval(t,t,surf);
rect=[-%pi,%pi,-%pi,%pi,-1,1];
contour(t,t,z,10,35,45," ",[0,1,0],rect)
// changing the format of the printing of the levels
xset("fpf","%.2f")
xbasc()
contour(t,t,z,10,flag=[0,1,0],ebox=rect)

S EE A LSO : contour2d 91, fcontour 100, fcontour2d 100, plot3d 123, xset 154

AUTHOR : J.Ph.C.

1.2.15 contour2d level curves of a surface on a 2D plot

CALLING SEQUENCE :

contour2d(x,y,z,nz,[style,strf,leg,rect,nax])
contour2d(x,y,z,nz,<opt_args>)

PARAMETERS :

x,y : two real row vectors of size n1 and n2: the grid.
z : real matrix of size (n1,n2), the values of the function.
nz : the level values or the number of levels.
- If nz is an integer, its value gives the number of level curves equally spaced from zmin to zmax as
follows:

z= zmin + (1:nz)*(zmax-zmin)/(nz+1)

Note that the zmin and zmax levels are not drawn (generically they are reduced to points) but they
can be added with

[im,jm] = find(z == zmin); // or zmax

plot2d(x(im)’,y(jm)’,-9,"000")
- If nz is a vector, nz(i) gives the value of the ith level curve.
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: style, leg, rect, nax, strf or axesflag and frameflag
(see plot2d)

Scilab Group April 1993 91

contour2di Scilab Function

style,strf,leg,rect,nax : see plot2d. The argument style gives the dash styles or colors
which are to be used for level curves. It must have the same size as the number of levels.
DESCRIPTION :
contour2d draws level curves of a surface z=f(x,y) on a 2D plot. The values of f(x,y) are given
by the matrix z at the grid points defined by x and y.
You can change the format of the floating point number printed on the levels by using xset("fpf",string)
where string gives the format in C format syntax (for example string="%.3f"). Use string=""
to switch back to default format.
The optional arguments style,strf,leg,rect,nax, can be passed by a sequence of statements
key1=value1, key2=value2, ... where keys may be style,strf,leg,rect,nax. In this case,
the order has no special meaning.
Use contour to draw levels curves on a 3D surface.
Enter the command contour2d() to see a demo.
EXAMPLE :
contour2d(1:10,1:10,rand(10,10),5,rect=[0,0,11,11])
// changing the format of the printing of the levels
xset("fpf","%.2f")
xbasc()
contour2d(1:10,1:10,rand(10,10),5,rect=[0,0,11,11])
S EE A LSO : contour 90, fcontour 100, fcontour2d 100, contour2di 92, plot2d
118, xset 154
AUTHOR : J.Ph.C.

1.2.16 contour2di compute level curves of a surface on a 2D plot

CALLING SEQUENCE :
[xc,yc]=contour2di(x,y,z,nz)
PARAMETERS :
x,y : two real row vectors of size n1 and n2: the grid.
z : real matrix of size (n1,n2), the values of the function.
nz : the level values or the number of levels.
- If nz is an integer, its value gives the number of level curves equally spaced from zmin to zmax as
follows:

z= zmin + (1:nz)*(zmax-zmin)/(nz+1)

Note that the zmin and zmax levels are not drawn (generically they are reduced to points) but they
can be added with

[im,jm] = find(z == zmin); // or zmax

plot2d(x(im)’,y(jm)’,-9,"000")

- If nz is a vector, nz(i) gives the value of the ith level curve.

xc,yc : vectors of identical sizes containing the contours definitions. See below for details.
DESCRIPTION :
contour2di computes level curves of a surface z=f(x,y) on a 2D plot. The values of f(x,y) are
given by the matrix z at the grid points defined by x and y.
xc(1) contains the level associated with first contour path, yc(1) contains the number N1 of points
defining this contour path and (xc(1+(1:N1)), yc(1+(1:N1)) ) contain the coordinates of the paths
points. The second path begin at xc(2+N1) and yc(2+N1) and so on.
EXAMPLE :

Scilab Group sept 2000 92

dragrect Scilab Function

[xc,yc]=contour2di(1:10,1:10,rand(10,10),5);
k=1;n=yc(k);c=1;
while k+yc(k)<size(xc,’*’)
n=yc(k);
plot2d(xc(k+(1:n)),yc(k+(1:n)),c)
c=c+1;
k=k+n+1;
end

S EE A LSO : contour 90, fcontour 100, fcontour2d 100, contour2d 91, plot2d
118, xset 154
AUTHOR : J.Ph.C.

1.2.17 contourf filled level curves of a surface on a 2D plot

CALLING SEQUENCE :

contourf(x,y,z,nz,[style,strf,leg,rect,nax])

PARAMETERS :

x,y : two real row vectors of size n1 and n2: the grid.
z : real matrix of size (n1,n2), the values of the function.
nz : the level values or the number of levels.
- If nz is an integer, its value gives the number of level curves equally spaced from zmin to zmax as
follows:

z= zmin + (1:nz)*(zmax-zmin)/(nz+1)

Note that the zmin and zmax levels are not drawn (generically they are reduced to points) but they
can be added with

[im,jm] = find(z == zmin); // or zmax

plot2d(x(im)’,y(jm)’,-9,"000")

- If nz is a vector, nz(i) gives the value of the ith level curve.

style,strf,leg,rect,nax : see plot2d. The argument style gives the dash styles or colors
which are to be used for level curves. It must have the same size as the number of levels.

DESCRIPTION :
contourf paints surface between two consecutives level curves of a surface z=f(x,y) on a 2D plot.
The values of f(x,y) are given by the matrix z at the grid points defined by x and y.
You can change the format of the floating point number printed on the levels by using xset("fpf",string)
where string gives the format in C format syntax (for example string="%.3f"). Use string=""
to switch back to default format.
Enter the command contour2d() to see a demo.
EXAMPLE :

contourf(1:10,1:10,rand(10,10),5,1:5,"011"," ",[0,0,11,11])

S EE A LSO : contour 90, fcontour 100, fcontour2d 100, contour2di 92, plot2d
118, xset 154
AUTHOR : J.Ph.C.

Scilab Group April 2000 93

drawaxis Scilab Function

1.2.18 dragrect Drag rectangle(s) with mouse

CALLING SEQUENCE :

final_rect=dragrect(initial_rect)

PARAMETERS :

initial rect : 4 4xn matrix containing the initial rectangles definition. Each column contains [x left;
y top; width; height]. If only one rectangle is present the initial rect may also be a vector.
final rect :a rectangle defined by [x left, y top, width, height]

DESCRIPTION :
dragrect tracks one or more rectangles anywhere on the screen. The 4xn matrix rect defines the rectan-
gles. Each column of initial rect must contain the initial rectangle position as [left;top;width;height]
values. When a button is clicked dragrect returns the final rectangles definition in final Rect.
EXAMPLE :

xsetech(frect=[0,0,100,100])
r=dragrect([10;10;30;10])
xrect(r)

S EE A LSO : xrect 151, xrects 151, xclick 139, xmouse ??

1.2.19 drawaxis draw an axis

CALLING SEQUENCE :

drawaxis([options])
// options: x,y,dir,sub_int,fontsize,format_n,seg,textcolor,ticscolor,tics

PARAMETERS :

dir=string : used to specify the tics direction. string can be chosen among ’u’,’r’,’d’,’l’ and ’l’ is
the default value. the values ’u’,’r’,’d’,’l’ stands respectively for up, right, down, left
tics=string : A flag which describes how the tics are given. string can be chosen among ’v’,’r’,
and ’i’, and, ’v’ is the default value
x,y : two vectors which give tics positions.
val= string matrix : A string matrix, which, when given, gives the string to be drawn along the
axis at tics positions.
fontsize=int : specifies the fontsize to use for displaying values along the axis. Default value is -1
which stands for current fontsize
format n=string : format to use for displaying numbers along the axis
seg= 1 or 0 : A flag which controls the display of the base segment of the axis (default value is 1).
sub int=integer : an integer which gives the number of sub-intervals to draw between large tics.
textcolor=integer : specify the color to use for displaying values along the axis. Default value is
-1 which stands for current color.
ticscolor=integer : specify the color to use for tics drawing. Default value is -1 which stands for
current color.

DESCRIPTION :
drawaxis is used to draw an axis in vertical or horizontal direction. the direction of the axis is given by
dir dir = ’u’ or ’d’ gives a horizontal axis with tics going up (’u’) or down (’d’). dir = ’r’
or ’l’ give a vertical axis with tics going right (’r’) or left (’l’).

Scilab Group April 2000 94

 driver Scilab Function

x and y give the axis tics positions. If the axis is horizontal then y must be a scalar or can be omitted
and x is a Scilab vector. The meaning of x is controlled by tics.
If tics=’v’ then x gives the tics positions along the x-axis.
If tics=’r’ then x must be of size 3. x=[xmin,xmax,n] and n gives the number of intervals.
If tics=’i’ then x must be of size 4, x=[k1,k2,a,n]. then xmin=k1*10ˆa, xmax=k2*10ˆa
and n gives the number of intervals
If y is omitted then the axis will be positioned at the top of the frame if dir=’u’ or at the bottom if
dir=’d’ By default, numbers are drawn along the axis. They are drawn using a default format which
can be changed with format n. It is also possible to display given strings and not numbers, this is done if
val is provided. The size of val must match the number of tics.
EXAMPLE :

plot2d(1:10,1:10,1,"020")
// horizontal axis
drawaxis(x=2:7,y=4,dir=’u’,tics=’v’)
// horizontal axis on top of the frame
drawaxis(x=2:7,dir=’u’,tics=’v’)
// horizontal axis at the bottom of the frame
drawaxis(x=2:7,dir=’d’,tics=’v’)

// horizontal axis given by a range

drawaxis(x=[2,7,3],y=4,dir=’d’,tics=’r’)

// vertical axis
drawaxis(x=4,y=2:7,dir=’r’,tics=’v’)
drawaxis(x=2,y=[2,7,3],dir=’l’,tics=’r’)
drawaxis(y=2:7,dir=’r’,tics=’v’)
drawaxis(y=2:7,dir=’l’,tics=’v’)

// horizontal axis with strings displayed at tics positions

drawaxis(x=2:7,y=8,dir=’u’,tics=’v’,val=’A’+string(1:6));
// vertical axis with strings displayed at tics positions
drawaxis(x=8,y=2:7,dir=’r’,tics=’v’,val=’B’+string(1:6));

// horizontal axis given with a ’i’ range.

drawaxis(x=[2,5,0,3],y=9,dir=’u’,tics=’i’);
drawaxis(x=9,y=[2,5,0,3],dir=’r’,tics=’i’,sub_int=5);

// horizontal axis again

drawaxis(x=2:7,y=4,dir=’u’,tics=’v’,fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=2

AUTHOR : J.Ph.C.

1.2.20 driver select a graphics driver

CALLING SEQUENCE :

driver(driver_name)
current_driver=driver()

PARAMETERS :

driver name : string, driver to be selected.

Scilab Group April 1993 95

errbar Scilab Function

DESCRIPTION :
This function is used to select a graphics driver, or with no arguments to get the current graphics driver
name. Most of the time, a user can ignore this function and change the driver by calling high level functions
such as xbasc or xbasimp. The selected driver can be one of the followings:

"X11" : output to the screen of the computer.

"Pos" : output into Postscript format.
"Rec" : output to the screen of the computer with recording of all the graphics commands. This is the
default driver.
"Fig" : output into XFig format. Clipping of objects is not provided in XFig.
"GIF" : output into Gif format (beta test driver written by Tom Leitner (http://wiis.tu-graz.ac.at/people/tom.html).
Note that line thickness is not handled yet.

S EE A LSO : xtape 159, xbasc 137, xbasimp 137

AUTHOR : J.Ph.C.

1.2.21 edit curv interactive graphic curve editor

CALLING SEQUENCE :

[x,y,ok,gc] = edit_curv(y)
[x,y,ok,gc] = edit_curv(x,y)
[x,y,ok,gc] = edit_curv(x,y,job)
[x,y,ok,gc] = edit_curv(x,y,job,tit)
[x,y,ok,gc] = edit_curv(x,y,job,tit,gc)

PARAMETERS :

x : vector of x coordinates
y : vector of y coordinates
job : a character string formed by one to three of the characters ’a’,’x’,’y’
’a’ : to add points to the edited curve
’x’ : to modify x coordinates of the edited curve points

’y’ : to modify y coordinates of the edited curve points tit : a vector of three char-
acter strings which give the curve legend
gc : a list of graphic window parameters: gc=list(rect,nax)
rect : bounds of the graphics (see plot2d for details)

nax : graduation parameters (see plot2d for details) ok : indicator if ok==%t user
as returned with ’ok’ menu else user as returned with ’abort’ menu : list (graphical objects created
under edit curv

DESCRIPTION :
edit curv is an interactive graphic curve editor. To add a new point simply click at the desired location,
the added point will be connected to the nearest end-point. to move a point click on it, drag the mouse to
the new position and click to set the new position
AUTHOR : Serge Steer

1.2.22 errbar add vertical error bars on a 2D plot

CALLING SEQUENCE :

Scilab Group April 1993 96

eval3dp Scilab Function

errbar(x,y,em,ep)

PARAMETERS :

x,y,em,ep : four matrices of the same size.

DESCRIPTION :
errbar adds vertical error bars on a 2D plot. x and y have the same meaning as in plot2d. em(i,j)
and ep(i,j) stands for the error interval on the value y(i,j): [y(i,j)-em(i,j),y(i,j)+ep(i,j)].
Enter the command errbar() to see a demo.
EXAMPLE :

t=[0:0.1:2*%pi]’;
y=[sin(t) cos(t)]; x=[t t];
plot2d(x,y)
errbar(x,y,0.05*ones(x),0.03*ones(x))

S EE A LSO : plot2d 118

AUTHOR : J.Ph.C.

1.2.23 eval3d values of a function on a grid

CALLING SEQUENCE :

[z]=eval3d(fun,x,[y])

PARAMETERS :

fun : function accepting vectors as arguments.

x,y : 2 vectors of size (1,n1) and (1,n2). (default value for y : y=x).
z : matrix of size (n1,n2).

DESCRIPTION :
This function returns a matrix z(n1,n2). z(i,j)=fun(x(i),y(j)). If the function fun doesn’t
accept arguments of type vector use the primitive feval.
EXAMPLE :

x=-5:5;y=x;
deff(’[z]=f(x,y)’,[’z= x.*y’]);
z=eval3d(f,x,y);
plot3d(x,y,z);
//
deff(’[z]=f(x,y)’,[’z= x*y’]);
z=feval(x,y,f);
plot3d(x,y,z);

S EE A LSO : feval 41
AUTHOR : Steer S.

Scilab Group September 1994 97

evans Scilab Function

1.2.24 eval3dp compute facets of a 3D surface

CALLING SEQUENCE :

[x,y,z]=eval3dp(fun,p1,p2)

PARAMETERS :

x,y,z : matrices of size (4,n-1*m-1). x(:,i) ,y(:,i) and z(:,i) are respectively the x-axis,
y-axis and z-axis coordinates of the 4 points of the ith four sided facet.
fun : a Scilab function.
p1 : a vector of size n.
p2 : a vector of size m.

DESCRIPTION :
eval3dp computes a four sided facets representation of a 3D surface defined by the function fun.
fun(p1,p2) computes the x-axis ,y-axis and z-axis coordinates of the corresponding points on the sur-
face, as [x(i),y(i),z(i)]=fun(p1(i),p2(i)). This is used for efficiency.
EXAMPLE :

p1=linspace(0,2*%pi,10);
p2=linspace(0,2*%pi,10);
deff("[x,y,z]=scp(p1,p2)",["x=p1.*sin(p1).*cos(p2)";..
"y=p1.*cos(p1).*cos(p2)";..
"z=p1.*sin(p2)"])
[x,y,z]=eval3dp(scp,p1,p2);
plot3d(x,y,z)

S EE A LSO : genfac3d 105, plot3d 123

1.2.25 evans Evans root locus

CALLING SEQUENCE :

evans(H [,kmax])

PARAMETERS :

H : list (linear system syslin )

kmax : real (maximum gain desired for the plot )

DESCRIPTION :
Gives the Evans root locus for a linear system in state-space or transfer form H(s) (syslin list). This is
the locus of the roots of 1+k*H(s)=1+k*N(s)/D(s), in the complex plane. For a selected sample of
gains k <= kmax, the imaginary part of the roots of D(s)+k*N(s) is plotted vs the real part.
To obtain the gain at a given point of the locus you can simply execute the following instruction : k=-1/real(horner(h,[1,%i
and click the desired point on the root locus. If the coordinates of the selected point are in the real 2 x 1 vec-
tor P=locate(1) this k solves the equation k*N(w) + D(w) =0 with w=P(1)+%i*P(2)=[1,%i]*P.

EXAMPLE :

Scilab Group April 1993 98

fchamp Scilab Function

H=syslin(’c’,352*poly(-5,’s’)/poly([0,0,2000,200,25,1],’s’,’c’));
evans(H,100)
P=3.0548543 - 8.8491842*%i; //P=selected point
k=-1/real(horner(H,P));
Ns=H(’num’);Ds=H(’den’);
roots(Ds+k*Ns) //contains P as particular root
// Another one
xbasc();s=poly(0,’s’);n=1+s;
d=real(poly([-1 -2 -%i %i],’s’));
evans(n,d,100);
//
xbasc();n=real(poly([0.1-%i 0.1+%i,-10],’s’));
evans(n,d,80);

S EE A LSO : kpure 342, krac2 343, locate 112

1.2.26 fac3d 3D plot of a surface (obsolete)

CALLING SEQUENCE :

fac3d(x,y,z,[theta,alpha,leg,flag,ebox])
fac3d1(x,y,z,[theta,alpha,leg,flag,ebox])

DESCRIPTION :
These functions are obsolete and have been replaced by plot3d and plot3d1.
S EE A LSO : plot3d 123, plot3d1 125

1.2.27 fchamp direction field of a 2D first order ODE

CALLING SEQUENCE :

fchamp(f,t,xr,yr,[arfact,rect,strf])
fchamp(x,y,xr,yr,<opt_args>)

PARAMETERS :

f : An external (function or character string) or a list which describes the ODE.

- It can be a function name f, where f is supposed to be a function of type y=f(t,x,[u]). f returns
a column vector of size 2, y, which gives the value of the direction field f at point x and at time t.
- It can also be an object of type list, list(f,u1) where f is a function of type y=f(t,x,u) and
u1 gives the value of the parameter u.
t : The selected time.
xr,yr : Two row vectors of size n1 and n2 which define the grid on which the direction field is computed.
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: arfact, rect, strf (see below).
arfact,rect,strf : Optional arguments, see champ.

DESCRIPTION :
fchamp is used to draw the direction field of a 2D first order ODE defined by the external function f.
Note that if the ODE is autonomous, argument t is useless, but it must be given.
Enter the command fchamp() to see a demo.
EXAMPLE :

Scilab Group April 1993 99

fcontour2d Scilab Function

deff("[xdot] = derpol(t,x)",..
["xd1 = x(2)";..
"xd2 = -x(1) + (1 - x(1)**2)*x(2)";..
"xdot = [ xd1 ; xd2 ]"])
xf= -1:0.1:1;
yf= -1:0.1:1;
fchamp(derpol,0,xf,yf)
xbasc()
fchamp(derpol,0,xf,yf,1,[-2,-2,2,2],"011")

S EE A LSO : champ 87, champ1 88

AUTHOR : J.Ph.C.

1.2.28 fcontour level curves on a 3D surface defined by a function

CALLING SEQUENCE :

fcontour(xr,yr,f,nz,[theta,alpha,leg,flag,ebox,zlev])
fcontour(xr,yr,f,nz,<opt_args>)

PARAMETERS :

xr,yr : two real row vectors of size n1 and n2.

f : is an external which defines the surface z=f(x,y). It is first computed on the grid specified by
xr,yr. Then, control is passed to the routine contour.
nz, : see contour.
theta,alpha,leg,flag,ebox,zlev : see contour.
<opt args> : see contour.

DESCRIPTION :
Draws level curves of a surface z=f(x,y). The level curves are drawn on a 3D surface. The surface is
given by the external function f. See contour.
The optional arguments theta,alpha,leg ,flag,ebox, zlev, can be passed by a sequence of
statements key1=value1, key2=value2, flag,ebox,zlev. In this case, the order has no special
meaning.
Enter the command fcontour() to see a demo.
EXAMPLE :

deff("[z]=surf(x,y)","z=sin(x)*cos(y)");
t=%pi*[-10:10]/10;

fcontour(t,t,surf,10)

xbasc();fcontour(t,t,surf,10,ebox=[-4 4 -4 4 -1 1],zlev=-1,flag=[0 1 4])

S EE A LSO : contour 90, contour2d 91, fcontour2d 100

AUTHOR : J.Ph.C.

1.2.29 fcontour2d level curves of a surface defined by a function on a 2D plot

CALLING SEQUENCE :

Scilab Group April 1993 100

fec Scilab Function

fcontour2d(xr,yr,f,nz,[style,strf,leg,rect,nax])
fcontour2d(xr,yr,f,nz,<opt_args>)

PARAMETERS :

xr,yr : two real row vectors of size n1 and n2.

f : is an external which defines the surface z=f(x,y). It is first computed on the grid specified by
xr,yr. Then, control is passed to the routine contour2d.
nz : the level values or the number of levels.
- If nz is an integer, its value gives the number of level curves equally spaced from zmin to zmax.
- If nz is a vector, nz(i) gives the value of the ith level curve.
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: style, leg, rect, nax, strf or axesflag and frameflag
(see plot2d)
[style,strf,leg,rect,nax] : see contour2d.

DESCRIPTION :
Draws level curves of a surface z=f(x,y). The level curves are drawn on a 2D plot. The surface is given
by the external function f. See contour2d.
Enter the command fcontour2d() to see a demo.
EXAMPLE :

deff(’z=surf(x,y)’,’z=xˆ4-yˆ4’)
x=-3:0.1:3;
y=x;
fcontour2d(x,y,surf,10);

S EE A LSO : contour 90, contour2d 91, fcontour 100

AUTHOR : J.Ph.C.

1.2.30 fec contour level of a function defined on a triangular mesh

CALLING SEQUENCE :

fec(x,y,triangles,func,[strf,leg,rect,nax,zminmax,colminmax])

PARAMETERS :

x,y : two vectors of size n, (x(i),y(i)) gives the coordinates of node i

func : a vector of size n : func(i) gives the value of the function for which we want the level curves.
triangles : is a [Ntr,5] matrix. Each line of triangles specifies a triangle of the mesh
triangle(j) = [number,node1,node2,node3,flag]. node1,node2,node3 are the
number of the nodes which constitutes the triangle. number is the number of the triangle and flag is
an integer not used in the fec function
strf,leg,rect,nax : see plot2d
zminmax : useful only for animation with fec, zminmax is a vector of size 2 [zmin zmax] which gives
the z values associated with the first and the last color (of the current colormap). (More exactly if the
colormap have nc colors and if we note dz = (zmax-zmin)/nc, then the part of the triangulation where
zmin + (i-1)dz <= z < zmin + i dz is filled with the color i). By default zmin = min(func) and zmax
= max(func). If you want to do an animation with func values that varie in time, take for zmin and
zmax the global minimum and maximum or something close. CAUTION : for func values greather
than zmax the last color is used and for func values less than zmin this is the first color (so you don’t
see that the zminmax levels are crossed).

Scilab Group April 1993 101

fplot2d Scilab Function

colminmax : a vector of 2 positives integers colminmax=[colmin colmax] with 1 <= colmin < colmax
<= nc (where nc is the number of colors of the current colormap). By default all the colors of the
colormap are used but with colminmax you may choose a sub-part of the (current) colormap.

DESCRIPTION :
See the demo files demos/fec.
fec.ex1 is a simple demo file in which a mesh and a function on that mesh is completely built in
Scilab syntax
fec.ex2 is an example for which the mesh and the function value where computed by an external
mesh builder (amdba type mesh) and an external program. A set of macros ( provided in file macros.sci)
can be used to read the data files in Scilab and plot the results.
S EE A LSO : Sfgrayplot 84, Sgrayplot 84

1.2.31 fgrayplot 2D plot of a surface defined by a function using colors

CALLING SEQUENCE :

fgrayplot(x,y,f,[strf,rect,nax])
fgrayplot(x,y,f,<opt_args>)

PARAMETERS :

x,y : real row vectors.

f : external of type y=f(x,y).
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: rect, nax, strf or axesflag and frameflag (see
plot2d).
strf,rect,nax : see plot2d.

DESCRIPTION :
fgrayplot makes a 2D plot of the surface given by z=f(x,y) on a grid defined by x and y. Each
rectangle on the grid is filled with a gray or color level depending on the average value of z on the corners
of the rectangle.
Enter the command fgrayplot() to see a demo.
EXAMPLE :

t=-1:0.1:1;
deff("[z]=surf(x,y)","z=x**2+y**2")
fgrayplot(t,t,surf,rect=[-2,-2,2,2])

S EE A LSO : grayplot 109, plot2d 118, Sgrayplot 84, Sfgrayplot 84

AUTHOR : J.Ph.C.

1.2.32 fplot2d 2D plot of a curve defined by a function

CALLING SEQUENCE :

fplot2d(xr,f,[style,strf,leg,rect,nax])
fplot2d(xr,f,<opt_args>)

PARAMETERS :

xr : vector.

Scilab Group April 1993 102

fplot3d1 Scilab Function

f : external of type y=f(x) i.e. a scilab function or a dynamically linked routine referred to as a string.
style,strf,leg,rect,nax : see plot2d
<opt args> : see plot2d

DESCRIPTION :
fplot2d plots a curve defined by the external function f. The curve is approximated by a piecewise lin-
ear interpolation using the points (xr(i),f(xr(i)). The values of f(x) are obtained by feval(xr,f).
Enter the command fplot2d() to see a demo.
EXAMPLE :

deff("[y]=f(x)","y=sin(x)+cos(x)")
x=[0:0.1:10]*%pi/10;
fplot2d(x,f)
xbasc();
fplot2d(1:10,’parab’)

S EE A LSO : plot2d 118, feval 41, paramfplot2d 117

AUTHOR : J.Ph.C.

1.2.33 fplot3d 3D plot of a surface defined by a function

CALLING SEQUENCE :

fplot3d(xr,yr,f,[theta,alpha,leg,flag,ebox])
fplot3d(xr,yr,f,<opt_args>)

PARAMETERS :

xr : row vector of size n1.

yr : row vector of size n2.
f : external of type z=f(x,y).
theta,alpha,leg,flag,ebox : see plot3d.
<opt args> : see plot3d.
DESCRIPTION :
fplot3d plots a surface defined by the external function f on the grid defined
by xr and yr.
Enter the command fplot3d() to see a demo.
EXAMPLE :

deff(’z=f(x,y)’,’z=xˆ4-yˆ4’)
x=-3:0.2:3 ;y=x ;
xbasc() ;fplot3d(x,y,f,alpha=5,theta=31)

S EE A LSO : plot3d 123

AUTHOR : J.Ph.C.

1.2.34 fplot3d1 3D gray or color level plot of a surface defined by a function

CALLING SEQUENCE :

fplot3d1(xr,yr,f,[theta,alpha,leg,flag,ebox])
fplot3d1(xr,yr,f,<opt_args>)

Scilab Group April 1993 103

genfac3d Scilab Function

PARAMETERS :

xr : row vector of size n1.

yr : row vector of size n2.
f : external of type z=f(x,y).
theta,alpha,leg,flag,ebox : see plot3d1.
<opt args> : see plot3d.

DESCRIPTION :
fplot3d1 plots a 3D gray or color level plot of a surface defined by the
external function f on the grid defined by xr and yr.
Enter the command fplot3d1() to see a demo.
EXAMPLE :

deff(’z=f(x,y)’,’z=xˆ4-yˆ4’)
x=-3:0.2:3 ;y=x ;
xbasc() ;fplot3d1(x,y,f,alpha=5,theta=31)

S EE A LSO : plot3d1 125

AUTHOR : J.Ph.C.

1.2.35 gainplot magnitude plot

CALLING SEQUENCE :

gainplot(sl,fmin,fmax [,step] [,comments] )

gainplot(frq,db,phi [,comments])
gainplot(frq, repf [,comments])

PARAMETERS :

sl : list (syslin SIMO linear system).

fmin,fmax : real scalars (frequency interval).
step : real (discretization step (logarithmic scale))
comments : string
frq : matrix (row by row frequencies)
db,phi : matrices (magnitudes and phases corresponding to frq)
repf : complex matrix. One row for each frequency response.

DESCRIPTION :
Same as Bode but plots only the magnitude.
EXAMPLE :

s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
gainplot(h,0.01,100,’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’)
xbasc()
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
gainplot([h1;h],0.01,100,[’h1’;’h’])

S EE A LSO : bode 86, black 85, nyquist 115, freq 339, repfreq 355, g_margin
340, p_margin 352

Scilab Group October 1995 104

getcolor Scilab Function

1.2.36 genfac3d compute facets of a 3D surface

CALLING SEQUENCE :
[xx,yy,zz]=genfac3d(x,y,z,[mask])
PARAMETERS :
xx,yy,zz : matrices of size (4,n-1xm-1). xx(:,i) ,yy(:,i) and zz(:,i) are respectively
the x-axis, y-axis and z-axis coordinates of the 4 points of the ith four sided facet.
x : x-axis coordinates vector of size m.
y : y-axis coordinates vector of size n.
z : matrix of size (m,n). z(i,j) is the value of the surface at the point (x(i),y(j)).
mask : boolean optional matrix with same size as z used to select the entries of z to be represented by
facets.
DESCRIPTION :
genfac3d computes a four sided facets representation of a 3D surface z=f(x,y) defined by x, y and
z.
EXAMPLE :
t=[0:0.3:2*%pi]’; z=sin(t)*cos(t’);
[xx,yy,zz]=genfac3d(t,t,z);
plot3d(xx,yy,zz)
S EE A LSO : eval3dp 98, plot3d 123

1.2.37 geom3d projection from 3D on 2D after a 3D plot

CALLING SEQUENCE :
[x,y]=geom3d(x1,y1,z1)
PARAMETERS :
x1,y1,z1 : real vectors of the same size (points in 3D).
x,y : real vectors of the same size as x1, y1 and z1.
DESCRIPTION :
After having used a 3D plot function such as plot3d, plot3d1 or param3d, geom3d gives the map-
ping between a point in 3D space (x1(i),y1(i),z1(i)) and the corresponding point (x(i),y(i))
in the projected 2D plan. Then all the 2D graphics primitives working on (x,y) can be used for superpo-
sition on the 3D plot.
EXAMPLE :
deff("[z]=surf(x,y)","z=sin(x)*cos(y)")
t=%pi*(-10:10)/10;
// 3D plot of the surface
fplot3d(t,t,surf,35,45,"X@Y@Z")
// now (t,t,sin(t).*cos(t)) is a curve on the surface
// which can be drawn using geom3d and xpoly
[x,y]=geom3d(t,t,sin(t).*cos(t));
xpoly(x,y,"lines")
// adding a comment
[x,y]=geom3d([0,0],[0,0],[5,0]);
xsegs(x,y)
xstring(x(1),y(1),"point (0,0,0)")
AUTHOR : J.Ph.C.

Scilab Group April 1993 105

getmark Scilab Function

1.2.38 getcolor dialog to select colors in the current colormap

CALLING SEQUENCE :

c=getcolor(title,[cini])
c=getcolor()

PARAMETERS :

title : string, dialog title.

cini : vector of initial selected color ids. Default value is xget(”pattern”).
c : vector of selected color ids, or [] if the user has clicked on the ”Cancel” button.

DESCRIPTION :
getcolor opens a dialog choice box with as many palettes as cini vector size. Palettes depend on the
current colormap.
S EE A LSO : xset 154, getmark 107, getfont 106

1.2.39 getfont dialog to select font

CALLING SEQUENCE :

[fId,fSize]=getfont()
[fId,fSize]=getfont(str)

PARAMETERS :

str : character (e.g. ”a”)

fId : integer, the number of the selected font
fSize : integer, the size of the selected font

DESCRIPTION :
getfont opens a graphic window to select a font. Example of use: [fId,fSize]=getfont().
xset("font",fId,fSize). plot2d(0,0,rect=[0 0 10 10],axesflag=0);xstring(5,5,"string").

S EE A LSO : xset 154, getmark 107

1.2.40 getlinestyle dialog to select linestyle

CALLING SEQUENCE :

k=getlinestyle()

PARAMETERS :

k : integer, selected linestyle or [] if the ”Cancel” button has been clicked.

DESCRIPTION :
getlinestyle opens a graphic window to select a line style. Example: k=getlinestyle()
plot2d(1:10,10,style=k).
S EE A LSO : xset 154

Scilab Group April 1993 106

graduate Scilab Function

1.2.41 getmark dialog to select mark (symbol)

CALLING SEQUENCE :
[mark,mrkSize]=getmark()
PARAMETERS :
mark : integer, the number of the selected mark
mrkSize : integer, the size of the selected mark
DESCRIPTION :
getmark opens a graphic window to select a mark (symbol). Usage: [mark,mrkSize]=getmark().
xset("mark size",mrkSize). plot2d(x,y,style=mark).
S EE A LSO : xset 154, getfont 106

1.2.42 getsymbol dialog to select a symbol and its size

CALLING SEQUENCE :
c=getsymbol([title])
PARAMETERS :
title : string, dialog title.
c : vector of size 2 [n,sz].
DESCRIPTION :
getsymbol opens a dialog choice box with title title if given where the user can select a symbol
and its size. getsymbol returns the id of the mark n and the id of its size sz.
S EE A LSO : xset 154

1.2.43 gr menu simple interactive graphic editor

CALLING SEQUENCE :
[sd1]=gr_menu([sd,flag,no_frame])
PARAMETERS :
sd : list (output of gr menu), or vector of length four [xmin,ymin,xmax,ymax] (boundaries of
the plot).
sd1 : list (graphical objects created under gr menu
flag,noframe : integers with 0, 1 value. Use flag=1 for non interactive mode (i.e to redraw saved
gr menu graphics) and no frame=1 to avoid a frame around gr menu graphics.
DESCRIPTION :
gr menu is a simple interactive graphic editor. When you execute gr menu(), three new menus,
Objects, Settings and Edit are added to the current graphics window. Use the item Exit of
menu Edit to exit gr menu.
The created graphics are saved as a list which can be given to gr menu as an entry value.
[sd]=gr menu([xmin,ymin,xmax,ymax]) : enters gr menu with a given frame
[sd]=gr menu(); : enters gr menu with the frame [0 0 100 100].
[sd]=gr menu(sd) : redraws the graphics stored in sd and enters interactive mode
[sd]=gr menu(sd,1) : only draws the graphics stored in sd.
[sd]=gr menu(sd,1,1) : only draws the graphics stored in sd and no frame is added.
AUTHOR : S.S. & J.Ph.C.

Scilab Group November 1993 107

grayplot Scilab Function

1.2.44 graduate pretty axis graduations

CALLING SEQUENCE :

[xi,xa,np]=graduate( xmi, xma,n1,n2)

[xi,xa,np]=graduate( xmi, xma)

PARAMETERS :

xmi,xma : real scalars

n1, n2 : integers with default values 3,10
xi, xa :real scalars
np : integer

DESCRIPTION :
graduate looks for the minimum interval [xi,xa] and a number of tics np such that:
xi <= xmi <= xma <= xa
xa - xi / np = k(10ˆn),k in [1 3 5] for an integer n
n1 < np < n2
EXAMPLE :

y=(0:0.33:145.78)’;
xbasc();plot2d1(’enn’,0,y)
[ymn,ymx,np]=graduate(mini(y),maxi(y))
rect=[1,ymn,prod(size(y)),ymx];
xbasc();plot2d1(’enn’,0,y,1,’011’,’ ’,rect,[10,3,10,np])

S EE A LSO : xsetech 155, plot2d 118

AUTHOR : S. Steer 1992

1.2.45 graycolormap linear gray colormap

CALLING SEQUENCE :

cmap=graycolormap(n)

PARAMETERS :

n : integer >= 1, the colormap size.

cmap : matrix with 3 columns [R,G,B].

DESCRIPTION :
graycolormap computes a colormap with n gray colors varying linearly from black to white.
EXAMPLE :

xset("colormap",graycolormap(32))
plot3d1()

S EE A LSO : colormap 89, hotcolormap 111, xset 154

Scilab Group April 1993 108

graypolarplot

1.2.46 grayplot 2D plot of a surface using colors

CALLING SEQUENCE :

grayplot(x,y,z,[strf,rect,nax])
grayplot(x,y,z,<opt_args>)

PARAMETERS :

x,y : real row vectors of size n1 and n2.

z : real matrix of size (n1,n2). z(i,j) is the value of the surface at the point (x(i),y(j)).
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: rect, nax, strf or axesflag and frameflag (see
plot2d).
strf,rect,nax : see plot2d.

DESCRIPTION :
grayplot makes a 2D plot of the surface given by z on a grid defined by x and y. Each rectangle
on the grid is filled with a gray or color level depending on the average value of z on the corners of the
rectangle.
Enter the command grayplot() to see a demo.
EXAMPLE :

x=-10:10; y=-10:10;m =rand(21,21);

grayplot(x,y,m,rect=[-20,-20,20,20])
t=-%pi:0.1:%pi; m=sin(t)’*cos(t);
xbasc()
grayplot(t,t,m)

S EE A LSO : fgrayplot 102, plot2d 118, Sgrayplot 84, Sfgrayplot 84

AUTHOR : J.Ph.C.

1.2.47 graypolarplot Polar 2D plot of a surface using colors

CALLING SEQUENCE :

graypolarplot(theta,rho,z,[strf,rect])

PARAMETERS :

rho : a vector with size n1, the discretization of the radius

theta : a vector with size n2, the discretization of the the angle.
z : real matrix of size (n1,n2). z(i,j) is the value of the surface at the point (rho(i),theta(j)).
strf : is a string of length 3 "xy0".
The default is "030".
x : controls the display of captions.
x=0 : no captions.
x=1 : captions are displayed. They are given by the optional argument leg.
y : controls the computation of the frame.
y=0 : the current boundaries (set by a previous call to another high level plotting function) are used. Useful
when superposing multiple plots.
y=1 : the optional argument rect is used to specify the boundaries of the plot.
y=2 : the boundaries of the plot are computed using min and max values of x and y.
y=3 : like y=1 but produces isoview scaling.

Scilab Function Scilab Group 109

histplot Scilab Function

y=4 : like y=2 but produces isoview scaling.

y=5 : like y=1 but plot2d can change the boundaries of the plot and the ticks of the axes to produce
pretty graduations. When the zoom button is activated, this mode is used.
y=6 : like y=2 but plot2d can change the boundaries of the plot and the ticks of the axes to produce
pretty graduations. When the zoom button is activated, this mode is used.
y=7 : like y=5 but the scale of the new plot is merged with the current scale.
y=8 : like y=6 but the scale of the new plot is merged with the current scale.
leg : a string. It is used when the first character x of argument strf is 1. leg has the form "leg1@leg2@...."
where leg1, leg2, etc. are respectively the captions of the first curve, of the second curve, etc.
The default is " ".
rect : This argument is used when the second character y of argument strf is 1, 3 or 5. It is a row
vector of size 4 and gives the dimension of the frame: rect=[xmin,ymin,xmax,ymax].

DESCRIPTION :
Takes a 2D plot of the surface given by z on a polar coordinate grid defined by rho and theta. Each
grid region if filled with a gray or color level depending on the average value of z on the corners of the
grid.
EXAMPLES :

rho=1:0.1:4;theta=(0:0.02:1)*2*%pi;
z=30+round(theta’*(1+rhoˆ2));
xset(’colormap’,hotcolormap(128))
xset(’background’,xget(’white’))
xbasc();graypolarplot(theta,rho,z)

1.2.48 hist3d 3D representation of a histogram

CALLING SEQUENCE :

hist3d(f,[theta,alpha,leg,flag,ebox])
hist3d(list(f,x,y),[theta,alpha,leg,flag,ebox])

PARAMETERS :

f : matrix of size (m,n) defining the histogram f(i,j)=F(x(i),y(j)), where x and y are taken
as 0:m and 0:n.
list(f,x,y) : where f is a matrix of size (m,n)defining the histogram f(i,j)=F(x(i),y(j)),
with x and y vectors of size (1,n+1) and (1,m+1).
theta,alpha,leg,flag,ebox : see plot3d.

DESCRIPTION :
hist3d represents a 2d histogram as a 3D plot. The values are associated to the intervals [x(i)
x(i+1)[ X [y(i) y(i+1)[.
Enter the command hist3d() to see a demo.
S EE A LSO : histplot 110, plot3d 123
AUTHOR : Steer S. & JPhilippe C.

1.2.49 histplot plot a histogram

CALLING SEQUENCE :

Scilab Group April 1993 110

isoview Scilab Function

histplot(npoint,data,[style,strf,leg,rect,nax])

PARAMETERS :

npoint : integer or a row vector of increasing values.

data : real vector.
style,strf,leg,rect,nax : see plot2d.

DESCRIPTION :

- If npoint is an integer, histplot plots a histogram of the values stored in data using npoint
equally spaced classes.
- If npoint is a vector histplot plots a histogram of the values stored in data using the classes
]npoint(k),npoint(k+1)].
Enter the command histplot() to see a demo.
S EE A LSO : hist3d 110, plot2d 118

1.2.50 hotcolormap red to yellow colormap

CALLING SEQUENCE :

cmap=hotcolormap(n)

PARAMETERS :

n : integer >= 3, the colormap size.

cmap : matrix with 3 columns [R,G,B].

DESCRIPTION :
hotcolormap computes a colormap with n hot colors varying from red to yellow.
EXAMPLE :

xset("colormap",hotcolormap(32))
plot3d1()

S EE A LSO : colormap 89, graycolormap 108, xset 154

1.2.51 isoview set scales for isometric plot (do not change the size of the window)

CALLING SEQUENCE :

isoview(xmin,xmax,ymin,ymax)

PARAMETERS :

xmin,xmax,ymin,ymax : four real values

DESCRIPTION :
This function is obsolete, use preferably the frameflag=4 plot2d option which enable window resizing.
isoview is used to have isometric scales on the x and y axes. It does not change the size of the graphics
window. The rectangle xmin, xmax, ymin, ymax will be contained in the computed frame of the
graphics window. isoview set the current graphics scales and can be used in conjunction with graphics
routines which request the current graphics scale (for instance strf="x0z" in plot2d).
EXAMPLE :

Scilab Group April 1993 111

locate Scilab Function

t=[0:0.1:2*%pi]’;
plot2d(sin(t),cos(t))
xbasc()
isoview(-1,1,-1,1)
plot2d(sin(t),cos(t),1,"001")
xset("default")

plot2d(sin(t),cos(t),frameflag=4)

S EE A LSO : square 133, xsetech 155

AUTHOR : Steer S.

1.2.52 legends draw graph legend

CALLING SEQUENCE :

legends(strings,style [,opt])
legends(strings,style,xy)

PARAMETERS :

strings : n vector of strings, strings(i) is the legend of the ith curve

style : integer row vector of size n (the plot styles, third parameter of plot2d) or an integer 2 x n
matrix, style(1,k) contains the plot style for the kth curve and style(2,k) contains the line style (if
style(1,k)>0) or mark color (if style(1,k)<0).

1opt= Upper right-hand corner 2 = Upper left-hand corner

3 = Lower left-hand corner
4 = Lower right-hand corner
5 = Interactive placement with the mouse (default)
xy : a vector [x,y] which gives the coordinates of the upper left corner of the legend box.

DESCRIPTION :
Puts a legend on the current plot using the specified strings as labels.
In the interactive placement (opt=5) move the legend box with the mouse and press the left button to release
it.
This function allow more flexible placement of the legends than the leg plot2d argument.
EXAMPLE :

t=0:0.1:2*%pi;
plot2d(t,[cos(t’),cos(2*t’),cos(3*t’)],[-1,2 3]);
legends([’cos(t)’;’cos(2*t)’;’cos(3*t)’],[-1,2 3],4)
xset("line style",2);plot2d(t,cos(t),style=5);
xset("line style",4);plot2d(t,sin(t),style=3);
legends(["sin(t)";"cos(t)"],[[5;2],[3;4]])

S EE A LSO : plot2d 118, xstring 157, xtitle 159

1.2.53 locate mouse selection of a set of points

CALLING SEQUENCE :

Scilab Group April 1993 112

milkdrop Scilab Function

x=locate([n,flag])

PARAMETERS :

x : matrix of size (2,n1). n1=n if the parameter n is given.

n,flag : integer values.

DESCRIPTION :
locate is used to get the coordinates of one or more points selected with the mouse in a graphics window.
The coordinates are given using the current graphics scale.
If n>0, n points are selected and their coordinates are returned in the matrix x.
If n<=0, points are selected until the user clicks with the left button of the mouse which stands for stop.
The last point (clicked with the left button) is not returned.
x=locate() is the same as x=locate(-1).
If flag=1 a cross is drawn at the points where the mouse is clicked.
S EE A LSO : xclick 139, xgetmouse 145
AUTHOR : S.S. & J.Ph.C

1.2.54 m circle M-circle plot

CALLING SEQUENCE :

m_circle()
m_circle(gain)

PARAMETERS :

gain : vector of gains (in DB). The default value is

gain =[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]

DESCRIPTION :
m circle is used with nyquist.
EXAMPLE :

//Example 1 :
s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
nyquist(h,0.01,100,’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’)
m_circle();
//Example 2:
xbasc();
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
nyquist([h1;h],0.01,100,[’h1’;’h’])
m_circle([-8 -6 -4]);

S EE A LSO : nyquist 115, chart 88, black 85

AUTHOR : S.Steer.

Scilab Group April 1993 113

nyquist Scilab Function

1.2.55 milk drop milk drop 3D function

CALLING SEQUENCE :

z=milk_drop(x,y)

PARAMETERS :

x,y : two row vectors of size n1 and n2.

z : matrix of size (n1,n2).

DESCRIPTION :
milk drop is a function representing the surface of a milk drop falling down into milk. It can be used
to test functions eval3d adn plot3d.
EXAMPLE :

x=-2:0.1:2; y=x;
z=eval3d(milk_drop,x,y);
plot3d(x,y,z)

S EE A LSO : eval3d 97, plot3d 123

AUTHOR : Steer S.

1.2.56 nf3d rectangular facets to plot3d parameters

DESCRIPTION :

[xx,yy,zz]=nf3d(x,y,z)

PARAMETERS :

x,y,x,xx,yy,zz : 6 real matrices

DESCRIPTION :
Utility function. Used for transforming rectangular facets coded in three matrices x,y,z to scilab code for
facets accepted by plot3d.
EXAMPLE :

//A sphere...
u = linspace(-%pi/2,%pi/2,40);
v = linspace(0,2*%pi,20);
x= cos(u)’*cos(v);
y= cos(u)’*sin(v);
z= sin(u)’*ones(v);
//plot3d2(x,y,z) is equivalent to...
[xx,yy,zz]=nf3d(x,y,z); plot3d(xx,yy,zz)

S EE A LSO : plot3d 123, plot3d2 126

Scilab Group April 1993 114

param3d Scilab Function

1.2.57 nyquist nyquist plot

CALLING SEQUENCE :

nyquist( sl,[fmin,fmax] [,step] [,comments] )

nyquist( sl, frq [,comments] )
nyquist(frq,db,phi [,comments])
nyquist(frq, repf [,comments])

PARAMETERS :

sl : syslin list (SIMO linear system in continuous or discrete time )

fmin,fmax : real scalars (frequency bounds (in Hz))
step : real (logarithmic discretization step)
comments : string vector (captions).
frq : vector or matrix of frequencies (in Hz) (one row for each output of sl).
db,phi : real matrices of modulus (in Db) and phases (in degree) (one row for each output of sl).
repf : matrix of complex numbers. Frequency response (one row for aech output of sl)

DESCRIPTION :
Nyquist plot i.e Imaginary part versus Real part of the frequency response of sl.
For continous time systems sl(2*%i*%pi*w) is plotted. For discrete time system or discretized sys-
tems sl(exp(2*%i*%pi*w*fd) is used ( fd=1 for discrete time systems and fd=sl(’dt’) for
discretized systems )
sl can be a continuous-time or discrete-time SIMO system (see syslin). In case of multi-output the
outputs are plotted with different symbols.
The frequencies are given by the bounds fmin,fmax (in Hz) or by a row-vector (or a matrix for multi-
output) frq.
step is the ( logarithmic ) discretization step. (see calfrq for the choice of default value).
comments is a vector of character strings (captions).
db,phi are the matrices of modulus (in Db) and phases (in degrees). (One row for each response).
repf is a matrix of complex numbers. One row for each response.
Default values for fmin and fmax are 1.d-3, 1.d+3 if sl is continuous-time or 1.d-3, 0.5 if sl
is discrete-time.
Automatic discretization of frequencies is made by calfrq.
EXAMPLE :

xbasc();
s=poly(0,’s’);
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01));
comm=’(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01)’;
nyquist(h,0.01,100,comm);
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
xbasc();
nyquist([h1;h],0.01,100,[’h1’;’h’])
xbasc();nyquist([h1;h])

S EE A LSO : bode 86, black 85, calfrq 324, freq 339, repfreq 355, phasemag
353

1.2.58 param3d 3D plot of a curve

CALLING SEQUENCE :

Scilab Group April 1993 115

param3d1 Scilab Function

param3d(x,y,z,[theta,alpha,leg,flag,ebox])

PARAMETERS :

x,y,z : three vectors of the same size (points of the parametric curve).
theta,alpha : real values giving in degree the spherical coordinates of the observation point.
leg : string defining the captions for each axis with @ as a field separator, for example ”X@Y@Z”.
flag=[type,box] : type and box have the same meaning as in plot3d:
type : an integer (scaling).
type=0 the plot is made using the current 3D scaling (set by a previous call to param3d, plot3d,
contour or plot3d1).
type=1 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are specified by the
value of the optional argument ebox.
type=2 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are computed using
the given data.
type=3 3d isometric with box bounds given by optional ebox, similarily to type=1
type=4 3d isometric bounds derived from the data, to similarilytype=2
type=5 3d expanded isometric bounds with box bounds given by optional ebox, similarily to type=1
type=6 3d expanded isometric bounds derived from the data, similarily to type=2
box : an integer (frame around the plot).
box=0 nothing is drawn around the plot.
box=1 unimplemented (like box=0).
box=2 only the axes behind the surface are drawn.
box=3 a box surrounding the surface is drawn and captions are added.
box=4 a box surrounding the surface is drawn, captions and axes are added.
ebox : used when type in flag is 1. It specifies the boundaries of the plot as the vector [xmin,xmax,ymin,ymax,zmin,z

DESCRIPTION :
param3d is used to plot a 3D curve defined by its coordinates x, y and z.
Use param3d1 to do multiple plots.
Enter the command param3d() to see a demo.
EXAMPLE :

t=0:0.1:5*%pi;
param3d(sin(t),cos(t),t/10,35,45,"X@Y@Z",[2,3])

S EE A LSO : param3d1 116, plot3d 123

AUTHOR : J.Ph.C.

1.2.59 param3d1 3D plot of curves

CALLING SEQUENCE :

param3d1(x,y,z,[theta,alpha,leg,flag,ebox])
param3d1(x,y,list(z,colors),[theta,alpha,leg,flag,ebox])

PARAMETERS :

x,y,z : matrices of the same size (nl,nc). Each column i of the matrices corresponds to the coordinates
of the ith curve.
You can give a specific color for each curve by using list(z,colors) instead of z, where
colors is a vector of size nc. If color(i) is negative the curve is plotted using the mark with
id abs(style(i))+1; if style(i) is strictly positive, a plain line with color id style(i)
or a dashed line with dash id style(i) is used. Use xset() to see the mark and color ids.
theta,alpha : real values giving in degree the spherical coordinates of the observation point.

Scilab Group April 1993 116

paramfplot2d Scilab Function

leg : string defining the captions for each axis with @ as a field separator, for example ”X@Y@Z”.
flag=[type,box] : type and box have the same meaning as in plot3d.
type : an integer (scaling).
type=0 the plot is made using the current 3D scaling (set by a previous call to param3d, plot3d,
contour or plot3d1).
type=1 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are specified by the
value of the optional argument ebox.
type=2 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are computed using
the given data.
type=3 3d isometric with box bounds given by optional ebox, similarily to type=1
type=4 3d isometric bounds derived from the data, to similarilytype=2
type=5 3d expanded isometric bounds with box bounds given by optional ebox, similarily to type=1
type=6 3d expanded isometric bounds derived from the data, similarily to type=2
box : an integer (frame around the plot).
box=0 nothing is drawn around the plot.
box=1 unimplemented (like box=0).
box=2 only the axes behind the surface are drawn.
box=3 a box surrounding the surface is drawn and captions are added.
box=4 a box surrounding the surface is drawn, captions and axes are added.
ebox : used when type in flag is 1. It specifies the boundaries of the plot as the vector [xmin,xmax,ymin,ymax,zmin,z
DESCRIPTION :
param3d1 is used to plot 3D curves defined by their coordinates x, y and z.
Enter the command param3d1() to see a demo.
EXAMPLE :
t=[0:0.1:5*%pi]’;
param3d1([sin(t),sin(2*t)],[cos(t),cos(2*t)],..
list([t/10,sin(t)],[3,2]),35,45,"X@Y@Z",[2,3])

S EE A LSO : param3d 115, plot3d 123, xset 154

AUTHOR : J.Ph.C.

1.2.60 paramfplot2d animated 2D plot, curve defined by a function

CALLING SEQUENCE :
paramfplot2d(f,x,theta)
paramfplot2d(f,x,theta,flag)
paramfplot2d(f,x,theta,flagrect)
PARAMETERS :
x : real vector.
f : function y=f(x,t) . f is a Scilab function or a dynamically linked routine (referred to as a string).
theta : real vector (set of parameters).
flag : string ’no’ or ’yes’: If ”yes” screen is cleared between two consecutive plots.
rect : ”rectangle” [xmin, xmax, ymin, ymax] (1 x 4 real vector),

DESCRIPTION :
Animated plot of the function x–>f(x,t) for t=theta(1),theta(2),etc. f can be a either Scilab function or a
dynamically linked routine since y=f(x,t) is evaluated as y=feval(x(:),t,f). See feval. f: mapping x,t -> f(x,t)
= RˆN valued function for x= vector of RˆN and t=real number. x is a N-vector of x-values and for each t in
theta, f(x,t)=N-vector of y-values.
EXAMPLE :

Scilab Group April 1993 117

plot2d Scilab Function

deff(’y=f(x,t)’,’y=t*sin(x)’)
x=linspace(0,2*%pi,50);theta=0:0.05:1;
paramfplot2d(f,x,theta);

S EE A LSO : plot2d 118, feval 41, fplot2d 102, pixmap ??

1.2.61 plot simple plot

CALLING SEQUENCE :

plot(x,y,[xcap,ycap,caption])
plot(y)

PARAMETERS :

x,y : two vectors with same sizes

xcap,ycap,caption : character strings or string matrices

DESCRIPTION :
Plot y as function of x. xcap and ycap are captions for x-axis and y-axis respectively and caption
is the caption of the plot.
Invoked with only one argument, plot(y) plots the y vector or, if y is a matrix, it plots all its row
vectors on the same plot. This plot is done with respect to the vector 1:<number of columns of y>.
plot is obsolete. Use plot2d instead.
EXAMPLE :

x=0:0.1:2*%pi;
// simple plot
plot(sin(x))
// using captions
xbasc()
plot(x,sin(x),"sin","time","plot of sinus")
// plot 2 functions
xbasc()
plot([sin(x);cos(x)])

S EE A LSO : plot2d 118

AUTHOR : J.Ph.C.

1.2.62 plot2d 2D plot

CALLING SEQUENCE :

plot2d([x],y)
plot2d([x],y,<opt_args>)
plot2d([logflag],x,y,[style,strf,leg,rect,nax])

PARAMETERS :

x,y : two matrices or vectors.

- If y is a vector, x must be a vector with the same size. If x is not given, it is supposed to be the vector
1:<size of y>.
- If y is a matrix, x can be:
+ a vector with size equal to the row dimension of y (each column of y is plotted with respect to x)

Scilab Group April 1993 118

plot2d Scilab Function

+ a matrix with the same dimensions as y (each column of y is plotted with respect to the corresponding
column of x)
+ If x is not given, it is supposed to be the vector 1:<row dimension of y>
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following:
style : sets the style for each curve, see below for value.
leg : sets the curves captions. If this key is given and strf is not given then x character of strf is
supposed to be 1. See below for value.
rect : sets the bounds of the plot. If this key is given and neither frameflag nor strf is given then
the y character of strf is supposed to be 7. See below for value.
nax : sets the grids definition. If this key is given and neither axesflag nor strf is given then the
z character of strf is supposed to be 1. See below for value.
logflag : sets the graduation type (linear or logarithmic) along the axes. See below for value.
frameflag : specifies how the frame of the plot is computed. The value is an integer ranging from 0 to
8. It corresponds to the y character of strf. See below.
axesflags : specifies what kind of axes are drawn around the plot. The value is an integer ranging from
0 to 5. It corresponds to the z character of strf. See below.
style : is a real row vector of size nc. The style to use for curve i is defined by style(i).
The default style is 1:nc (1 for the first curve, 2 for the second, etc.).
- if style(i) is negative or zero, the curve is plotted using the mark with id abs(style(i)); use
xset() to set the mark id and xget(’mark’) to get the current mark id.
- if style(i) is strictly positive, a plain line with color id style(i) or a dashed line with dash id
style(i) is used; use xset() to see the color ids.
- When only one curve is drawn, style can be the row vector of size 2 [sty,pos] where sty is
used to specify the style and pos is an integer ranging from 1 to 6 which specifies a position to use
for the caption. This can be useful when a user wants to draw multiple curves on a plot by calling the
function plot2d several times and wants to give a caption for each curve.
strf : is a string of length 3 "xyz".
The default is "081".
x : controls the display of captions.
x=0 : no caption.
x=1 : captions are displayed. They are given by the optional argument leg.
y : controls the computation of the actual coordinate ranges from the minimal requested values. Actual
ranges can be larger than minimal requirements.
requirements ranges ranges ranges
of a previous given by computed from
actual plot rect arg x and y
requested
one y=0 y=1 y=2
Computed
for isometric y=3 y=4
view
Enlarged
For pretty y=5 y=6
axes
Previous and
current y=7 y=8
plots merged
z : controls the display of information on the frame around the plot. If axes are requested, the number of
tics can be specified by the nax optional argument.
z=0 : nothing is drawn around the plot.
z=1 : axes are drawn, the y=axis is displayed on the left.
z=2 : the plot is surrounded by a box without tics.
z=3 : axes are drawn, the y=axis is displayed on the right.

Scilab Group April 1993 119

plot2d Scilab Function

z=4 : axes are drawn centred in the middle of the frame box.
z=5 : axes are drawn so as to cross at point (0,0). If point (0,0) does not lie inside the frame, axes
will not appear on the graph.
leg : a string. It is used when the first character x of argument strf is 1. leg has the form "leg1@leg2@...."
where leg1, leg2, etc. are respectively the captions of the first curve, of the second curve, etc.
The default is " ".
rect : This argument is used when the second character y of argument strf is 1, 3 or 5. It is a row
vector of size 4 and gives the dimension of the frame: rect=[xmin,ymin,xmax,ymax].
nax : This argument is used when the third character z of argument strf is 1. It is a row vector with
four entries [nx,Nx,ny,Ny] where nx (ny) is the number of subgraduations on the x (y) axis
and Nx (Ny) is the number of graduations on the x (y) axis.
logflag : a string formed by to characters h (for horizontal axis) and v (for vertical axis) each of these
characters can take the values ”n” or ”l”. ”l” stands for logarithmic graduation and ”n” for normal
graduation. For example ”ll”stands for a log-log plot. Default value is ”nn”.

DESCRIPTION :
plot2d plots a set of 2D curves. Piecewise linear plotting is used.
By default, successive plots are superposed. To clear the previous plot, use xbasc().
See the meaning of the parameters above for a complete description.
Enter the command plot2d() to see a demo.
Other high level plot2d function exist:
plot2d2 : same as plot2d but the curve is supposed to be piecewise constant.
plot2d3 : same as plot2d but the curve is plotted with vertical bars.
plot2d4 : same as plot2d but the curve is plotted with arrows.

EXAMPLE :

//simple plot
x=[0:0.1:2*%pi]’;
plot2d(sin(x))
xbasc()
plot2d(x,sin(x))
//multiple plot
xbasc()
plot2d(x,[sin(x) sin(2*x) sin(3*x)])
// multiple plot giving the dimensions of the frame
// old syntax and new syntax
xbasc()
plot2d(x,[sin(x) sin(2*x) sin(3*x)],1:3,"011"," ",[0,0,6,0.5])
xbasc()
plot2d(x,[sin(x) sin(2*x) sin(3*x)],rect=[0,0,6,0.5])
//multiple plot with captions and given tics
// old syntax and new syntax
xbasc()
plot2d(x,[sin(x) sin(2*x) sin(3*x)],..
[1,2,3],"111","L1@L2@L3",[0,-2,2*%pi,2],[2,10,2,10])
xbasc()
plot2d(x,[sin(x) sin(2*x) sin(3*x)],..
[1,2,3],leg="L1@L2@L3",nax=[2,10,2,10],rect=[0,-2,2*%pi,2])
// isoview
xbasc()
plot2d(x,sin(x),1,"041")
// scale
xbasc()

Scilab Group April 1993 120

plot2d1 Scilab Function

plot2d(x,sin(x),1,"061")
// auto scaling with previous plots
xbasc()
plot2d(x,sin(x),1)
plot2d(x,2*sin(x),2)
plot2d(2*x,cos(x),3)
// axis on the right
xbasc()
plot2d(x,sin(x),1,"183","sin(x)")
// centered axis
xbasc()
plot2d(x,sin(x),1,"184","sin(x)")
// axis centered at (0,0)
xbasc()
plot2d(x-4,sin(x),1,"185","sin(x)")

S EE A LSO : plot2d1 121, plot2d2 122, plot2d3 122, plot2d4 123, xbasc 137,
xset 154
AUTHOR : J.Ph.C.

1.2.63 plot2d1 2D plot (logarithmic axes) (obsolete)

CALLING SEQUENCE :

plot2d1(str,x,y,[style,strf,leg,rect,nax])

PARAMETERS :

str : is a string of length three "abc".

a : can have the following values: e, o or g.
e : means ”empty”. Itspecifies the fact that the value of x is not used (the x values are supposed to be
regularly spaced, ie 1:<number of rows of y>). The user must anyway give a value for x, 1 for
instance: plot2d1("enn",1,y).
o : means ”one”. If there are many curves, they all have the same x-values: x is a column vector of size nl
and y is a matrix of size (nl,nc). For example : x=[0:0.1:2*%pi]’; plot2d1("onn",x,[sin(x)
cos(x)]).
g : means ”general”. x and y must have the same size (nl,nc). Each column of y is plotted with respect
to the corresponding column of x. nc curves are plotted using nl points.
b, c : can have the values n (normal) or l (logarithmic).
b=l : a logarithmic axis is used on the x-axis
c=l : a logarithmic axis is used on the y-axis
x,y,[style,strf,leg,rect,nax] : these arguments have the same meaning as in the plot2d
function.
opt args : these arguments have the same meaning as in the plot2d function.

DESCRIPTION :
This function is obsolete. Use plot2d instead.
plot2d1 plots a set of 2D curves. It is the same as plot2d but with one more argument str which
enables logarithmic axis. Moreover, it allows to specify only one column vector for x when it is the same
for all the curves.
By default, successive plots are superposed. To clear the previous plot, use xbasc.
Enter the command plot2d1() to see a demo.
EXAMPLE :

Scilab Group April 1993 121

plot2d3 Scilab Function

// multiple plot without giving x

x=[0:0.1:2*%pi]’;
plot2d1("enn",1,[sin(x) sin(2*x) sin(3*x)])
// multiple plot using only one x
xbasc()
plot2d1("onn",x,[sin(x) sin(2*x) sin(3*x)])
// logarithmic plot
x=[0.1:0.1:3]’; xbasc()
plot2d1("oll",x,[exp(x) exp(xˆ2) exp(xˆ3)])

S EE A LSO : plot2d 118, plot2d2 122, plot2d3 122, plot2d4 123, xbasc 137
AUTHOR : J.Ph.C.

1.2.64 plot2d2 2D plot (step function)

CALLING SEQUENCE :

plot2d2([x],y)
plot2d2([x],y,<opt_args>)
plot2d2([logflag],x,y,[style,strf,leg,rect,nax])

PARAMETERS :
[ ] : see plot2d for a description of parameters.
DESCRIPTION :
plot2d2 is the same as plot2d but the functions given by (x,y) are supposed to be piecewise
constant.
By default, successive plots are superposed. To clear the previous plot, use xbasc().
Enter the command plot2d2() to see a demo.
EXAMPLE :

// plots a step function of value i on the segment [i,i+1]

// the last segment is not drawn
plot2d2([1:4],[1:4],1,"111","step function",[0,0,5,5])
// compare the following with plot2d
x=[0:0.1:2*%pi]’;
xbasc()
plot2d2(x,[sin(x) sin(2*x) sin(3*x)])

S EE A LSO : plot2d 118, plot2d3 122, plot2d4 123, subplot 133, xbasc 137,
xset 154
AUTHOR : J.Ph.C.

1.2.65 plot2d3 2D plot (vertical bars)

CALLING SEQUENCE :

plot2d3([logflags,] x,y,[style,strf,leg,rect,nax])
plot232(y)
plot2d3(x,y <,opt_args>)

Scilab Group April 1993 122

plot3d Scilab Function

PARAMETERS :
[ ] : see plot2d for a description of parameters.
DESCRIPTION :
plot2d3 is the same as plot2d but curves are plotted using vertical bars.
By default, successive plots are superposed. To clear the previous plot, use xbasc().
Enter the command plot2d3() to see a demo.
EXAMPLE :

// compare the following with plot2d1

x=[0:0.1:2*%pi]’;
plot2d3(x,[sin(x) sin(2*x) sin(3*x)])

S EE A LSO : plot2d 118, plot2d2 122, plot2d4 123, xbasc 137, xset 154
AUTHOR : J.Ph.C.

1.2.66 plot2d4 2D plot (arrows style)

CALLING SEQUENCE :

plot2d4([logflag,] x,y,[style,strf,leg,rect,nax])
plot2d4(y)
plot2d4(x,y <,opt_args>)

PARAMETERS :
[ ] : see plot2d for a description of parameters.
DESCRIPTION :
plot2d4 is the same as plot2d but curves are plotted using arrows style. This can be useful when
plotting solutions of an ODE in a phase space.
By default, successive plots are superposed. To clear the previous plot, use xbasc().
Enter the command plot2d4() to see a demo.
EXAMPLE :

// compare the following with plot2d1

x=[0:0.1:2*%pi]’;
plot2d4(x,[sin(x) sin(2*x) sin(3*x)])

S EE A LSO : fchamp 99, plot2d 118, plot2d2 122, plot2d3 122, subplot 133,
xbasc 137, xset 154
AUTHOR : J.Ph.C.

1.2.67 plot3d 3D plot of a surface

CALLING SEQUENCE :

plot3d(x,y,z,[theta,alpha,leg,flag,ebox])
plot3d(x,y,z,<opt_args>)

plot3d(xf,yf,zf,[theta,alpha,leg,flag,ebox])
plot3d(xf,yf,zf,<opt_args>)

plot3d(xf,yf,list(zf,colors),[theta,alpha,leg,flag,ebox])
plot3d(xf,yf,list(zf,colors),<opt_args>)

Scilab Group April 1993 123

plot3d Scilab Function

PARAMETERS :
x,y : row vectors of sizes n1 and n2 (x-axis and y-axis coordinates). These coordinates must be monotone.
z : matrix of size (n1,n2). z(i,j) is the value of the surface at the point (x(i),y(j)).
xf,yf,zf : matrices of size (nf,n). They define the facets used to draw the surface. There are n facets.
Each facet i is defined by a polygon with nf points. The x-axis, y-axis and z-axis coordinates of
the points of the ith facet are given respectively by xf(:,i), yf(:,i) and zf(:,i).
colors : a vector of size n giving the color of each facets or a matrix of size (nf,n) giving color near each
facet boundary (facet color is interpolated )
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: theta, alpha ,leg,flag,ebox (see definition below)
theta, alpha : real values giving in degree the spherical coordinates of the observation point.
leg : string defining the captions for each axis with @ as a field separator, for example ”X@Y@Z”.
flag : a real vector of size three flag=[mode,type,box].
mode : string (treatment of hidden parts).
mode>0 the hidden parts of the surface are removed and the surface is painted with color mode.
mode=0 the hidden parts of the surface are drawn.
mode<0 only the shadow of the surface is painted with color or pattern id -mode. Use xset() to see
the meaning of the ids.
type : an integer (scaling).
type=0 the plot is made using the current 3D scaling (set by a previous call to param3d, plot3d,
contour or plot3d1).
type=1 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are specified by the
value of the optional argument ebox.
type=2 rescales automatically 3d boxes with extreme aspect ratios, the boundaries are computed using
the given data.
type=3 3d isometric with box bounds given by optional ebox, similarily to type=1
type=4 3d isometric bounds derived from the data, to similarilytype=2
type=5 3d expanded isometric bounds with box bounds given by optional ebox, similarily to type=1
type=6 3d expanded isometric bounds derived from the data, similarily to type=2
box : an integer (frame around the plot).
box=0 nothing is drawn around the plot.
box=1 unimplemented (like box=0).
box=2 only the axes behind the surface are drawn.
box=3 a box surrounding the surface is drawn and captions are added.
box=4 a box surrounding the surface is drawn, captions and axes are added.
ebox : used when type in flag is 1. It specifies the boundaries of the plot as the vector [xmin,xmax,ymin,ymax,zmin,z
DESCRIPTION :
plot3d(x,y,z,[theta,alpha,leg,flag,ebox]) draws the surface z=f(x,y).
plot3d(xf,yf,zf,[theta,alpha,leg ,flag,ebox]) draws a surface defined by a set of
facets. You can draw multiple plots by replacing xf, yf and zf by multiple matrices assembled by
rows as [xf1 xf2 ...], [yf1 yf2 ...] and [zf1 zf2 ...].
You can give a specific color for each facet by using list(zf,colors) instead of zf, where colors
is a vector of size n. If colors(i) is positive it gives the color of facet i and the boundary of the facet
is drawn with current line style and color. If colors(i) is negative, color id -colors(i) is used and
the boundary of the facet is not drawn. Use xset() to see the ids of the colors.
It is also possible to get interpolated color for facets. For that the color argument must be a matrix of size
nfxn giving the color near each boundary of each facets. In this case positive values for colors mean that
the boundary are not drawn.
The optional arguments theta,alpha,leg ,flag,ebox, can be passed by a sequence of statements
key1=value1, key2=value2, ... In this case, the order has no special meaning.
You can use the function genfac3d to compute four sided facets from the surface z=f(x,y). eval3dp
can also be used.
Enter the command plot3d() to see a demo.
EXAMPLE :

Scilab Group April 1993 124

plot3d1 Scilab Function

// simple plot using z=f(x,y)

t=[0:0.3:2*%pi]’; z=sin(t)*cos(t’);
plot3d(t,t,z)
// same plot using facets computed by genfac3d
[xx,yy,zz]=genfac3d(t,t,z);
xbasc()
plot3d(xx,yy,zz)
// multiple plots
xbasc()
plot3d([xx xx],[yy yy],[zz 4+zz])
// multiple plots using colors
xbasc()
plot3d([xx xx],[yy yy],list([zz zz+4],[4*ones(1,400) 5*ones(1,400)]))
// simple plot with viewpoint and captions
xbasc()
plot3d(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[2,2,3])
// plot of a sphere using facets computed by eval3dp
deff("[x,y,z]=sph(alp,tet)",["x=r*cos(alp).*cos(tet)+orig(1)*ones(tet)";..
"y=r*cos(alp).*sin(tet)+orig(2)*ones(tet)";..
"z=r*sin(alp)+orig(3)*ones(tet)"]);
r=1; orig=[0 0 0];
[xx,yy,zz]=eval3dp(sph,linspace(-%pi/2,%pi/2,40),linspace(0,%pi*2,20));
xbasc();plot3d(xx,yy,zz)

xbasc();xset(’colormap’,hotcolormap(128));
r=0.3;orig=[1.5 0 0];
[xx1,yy1,zz1]=eval3dp(sph,linspace(-%pi/2,%pi/2,40),linspace(0,%pi*2,20));
cc=(xx+zz+2)*32;cc1=(xx1-orig(1)+zz1/r+2)*32;
xbasc();plot3d1([xx xx1],[yy yy1],list([zz,zz1],[cc cc1]),70,80)

xbasc();plot3d1([xx xx1],[yy yy1],list([zz,zz1],[cc cc1]),theta=70,alpha=80,flag=[5,6,3

S EE A LSO : eval3dp 98, genfac3d 105, geom3d 105, param3d 115, plot3d1 125,
xset 154
AUTHOR : J.Ph.C.

1.2.68 plot3d1 3D gray or color level plot of a surface

DESCRIPTION :

plot3d1(x,y,z,[theta,alpha,leg,flag,ebox])
plot3d1(xf,yf,zf,[theta,alpha,leg,flag,ebox])

PARAMETERS :
See plot3d for a full description. There is just a slight difference, only the sign of the flag(1)=mode
parameter is used: if it is negative the grid is not drawn.
DESCRIPTION :
plot3d plots a surface z=f(x,y) with colors depending on the z-level of the surface.
Enter the command plot3d1() to see a demo.
EXAMPLE :

// simple plot using z=f(x,y)

t=[0:0.3:2*%pi]’; z=sin(t)*cos(t’);

Scilab Group April 1993 125

plot3d3 Scilab Function

plot3d1(t,t,z)
// same plot using facets computed by genfac3d
[xx,yy,zz]=genfac3d(t,t,z);
xbasc()
plot3d1(xx,yy,zz)
// multiple plots
xbasc()
plot3d1([xx xx],[yy yy],[zz 4+zz])
// simple plot with viewpoint and captions
xbasc()
plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[2,2,3])
// same plot without grid
xbasc()
plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[-2,2,3])
// plot of a sphere using facets computed by eval3dp
deff("[x,y,z]=sph(alp,tet)",["x=r*cos(alp).*cos(tet)+orig(1)*ones(tet)";..
"y=r*cos(alp).*sin(tet)+orig(2)*ones(tet)";..
"z=r*sin(alp)+orig(3)*ones(tet)"]);
r=1; orig=[0 0 0];
[xx,yy,zz]=eval3dp(sph,linspace(-%pi/2,%pi/2,40),linspace(0,%pi*2,20));
xbasc()
plot3d1(xx,yy,zz)
S EE A LSO : plot3d 123
AUTHOR : J.Ph.C.

1.2.69 plot3d2 plot surface defined by rectangular facets

DESCRIPTION :
plot3d2(X,Y,Z [,vect,theta,alpha,leg,flag,ebox])
plot3d2(X,Y,Z, <opt_args>)
PARAMETERS :
X,Y,Z : 3 real matrices
vect : real vector
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: vect (see above), theta, alpha ,leg,flag,ebox (see
plot3d)
DESCRIPTION :
plot3d2 plots a surface defined by rectangular facets. (X,Y,Z) are three matrices which describe a
surface. The surface is composed of four sided polygons. The X-coordinates of a facet are given by
X(i,j),X(i+1,j),X(i,j+1),X(i+1,j+1). And similarly Y and Z are Y and Z coordinates. The vect vector is
used when multiple surfaces are coded in the same (X,Y,Z) matrices. vect(j) gives the line at which the
coding of the jth surface begins. See plot3d for a full description.
EXAMPLE :
u = linspace(-%pi/2,%pi/2,40);
v = linspace(0,2*%pi,20);
X = cos(u)’*cos(v);
Y = cos(u)’*sin(v);
Z = sin(u)’*ones(v);
plot3d2(X,Y,Z);
S EE A LSO : plot3d 123, genfac3d 105

Scilab Group April 1993 126

plotframe

1.2.70 plot3d3 mesh plot surface defined by rectangular facets

DESCRIPTION :

plot3d3(X,Y,Z [,vect,theta,alpha,leg,flag,ebox])
plot3d3(X,Y,Z, <opt_args>)

PARAMETERS :

X,Y,Z : 3 real matrices

vect : real vector
flag : flag=[type,box], type and box have the same meaning as in plot3d.
<opt args> : This represents a sequence of statements key1=value1, key2=value2,... where
key1, key2,... can be one of the following: vect,flag (see above), theta, alpha ,leg,ebox (see
plot3d)

DESCRIPTION :
plot3d3 performs a mesh plot of a surface defined by rectangular facets. (X,Y,Z) are three matrices
which describe a surface. The surface is composed of four sided polygons.
The X-coordinates of a facet are given by X(i,j),X(i+1,j),X(i,j+1),X(i+1,j+1). And similarly Y and Z are Y
and Z coordinates.
The vect vector is used when multiple surfaces are coded in the same (X,Y,Z) matrices. vect(j) gives
the line at which the coding of the jth surface begins. See plot3d2 for a full description.
EXAMPLE :

u = linspace(-%pi/2,%pi/2,40);
v = linspace(0,2*%pi,20);
X = cos(u)’*cos(v);
Y = cos(u)’*sin(v);
Z = sin(u)’*ones(v);
plot3d3(X,Y,Z);

S EE A LSO : plot3d2 126, plot3d 123, param3d 115

1.2.71 plotframe plot a frame with scaling and grids

CALLING SEQUENCE :

plotframe(rect,tics,[arg_opt1,arg_opt2,arg_opt3])

PARAMETERS :

rect : vector [xmin,ymin,xmax,ymax].

tics : vector [nx,mx,ny,my] where mx, nx (resp. my, ny) are the number of x-axis (resp. y-
axis) intervals and subintervals.
arg optX : optional arguments up to three and choosen among.
flags : vector [wantgrids,findbounds] where wantgrids is a boolean variable (%t or %f)
which indicates gridding. findbounds is a boolean variable. If findbounds is %t, the bounds
given in rect are allowed to be slightly modified (in fact always increased) in order to have simpler
graduations: then tics(2) and tics(4) are ignored.
captions : vector of 3 strings [title,x-leg,y-leg] corresponding respectively to the title of the
plot and the captions on the x-axis and the y-axis.
subwin : a vector of size 4 defining the sub window. The sub window is specified with the parame-
ter subwin=[x,y,w,h] (upper-left, width, height). The values in subwin are specified using
proportion of the width or height of the current graphics window (see xsetech).

Scilab October 1994 127

polarplot

DESCRIPTION :
plotframe is used with 2D plotting functions plot2d, plot2d1,... to set a graphics frame. It must
be used before plot2d which should be invoked with the ”000” superposition mode.
EXAMPLE :

x=[-0.3:0.8:27.3]’;
y=rand(x);
rect=[min(x),min(y),max(x),max(y)];
tics=[4,10,2,5]; //4 x-intervals and 2 y-intervals
plotframe(rect,tics,[%f,%f],["My plot","x","y"],[0,0,0.5,0.5])
plot2d(x,y,2,"000")
plotframe(rect,tics,[%t,%f],["My plot with grids","x","y"],[0.5,0,0.5,0.5])
plot2d(x,y,3,"000")
plotframe(rect,tics,[%t,%t],..
["My plot with grids and automatic bounds","x","y"],[0,0.5,0.5,0.5])
plot2d(x,y,4,"000")
plotframe(rect,tics,[%f,%t],..
["My plot without grids but with automatic bounds","x","y"],..
[0.5,0.5,0.5,0.5])
plot2d(x,y,5,"000")
xset("default")

S EE A LSO : plot2d 118, graduate 108, xsetech 155

1.2.72 plzr pole-zero plot

CALLING SEQUENCE :

plzr(sl)

PARAMETERS :

sl : list ( syslin)

DESCRIPTION :
produces a pole-zero plot of the linear system sl (syslin list)
EXAMPLE :

s=poly(0,’s’);
n=[1+s 2+3*s+4*sˆ2 5; 0 1-s s];
d=[1+3*s 5-sˆ3 s+1;1+s 1+s+sˆ2 3*s-1];
h=syslin(’c’,n./d);
plzr(h);

S EE A LSO : trzeros 368, roots 496, syslin 224

1.2.73 polarplot Plot polar coordinates

CALLING SEQUENCE :

polarplot(theta,rho,[style,strf,leg,rect])
polarplot(theta,rho,<opt_args>)

PARAMETERS :

Scilab Function Scilab Group 128

printing Scilab Function

rho : a vector, the radius values

theta : a vector with same size than rho, the angle values.
<opt args> : a sequence of statements key1=value1, key2=value2, ... where keys may be
style,leg,rect,strf or frameflag
style : is a real row vector of size nc. The style to use for curve i is defined by style(i).
The default style is 1:nc (1 for the first curve, 2 for the second, etc.).
- if style(i) is negative, the curve is plotted using the mark with id abs(style(i))+1; use
xset() to see the mark ids.
- if style(i) is strictly positive, a plain line with color id style(i) or a dashed line with dash id
style(i) is used; use xset() to see the color ids.
- When only one curve is drawn, style can be the row vector of size 2 [sty,pos] where sty is
used to specify the style and pos is an integer ranging from 1 to 6 which specifies a position to use
for the caption. This can be useful when a user wants to draw multiple curves on a plot by calling the
function plot2d several times and wants to give a caption for each curve.
strf : is a string of length 3 "xy0".
The default is "030".
x : controls the display of captions,
x=0 : no captions.
x=1 : captions are displayed. They are given by the optional argument leg.
y : controls the computation of the frame. same as frameflag
y=0 : the current boundaries (set by a previous call to another high level plotting function) are used. Useful
when superposing multiple plots.
y=1 : the optional argument rect is used to specify the boundaries of the plot.
y=2 : the boundaries of the plot are computed using min and max values of x and y.
y=3 : like y=1 but produces isoview scaling.
y=4 : like y=2 but produces isoview scaling.
y=5 : like y=1 but plot2d can change the boundaries of the plot and the ticks of the axes to produce
pretty graduations. When the zoom button is activated, this mode is used.
y=6 : like y=2 but plot2d can change the boundaries of the plot and the ticks of the axes to produce
pretty graduations. When the zoom button is activated, this mode is used.
y=7 : like y=5 but the scale of the new plot is merged with the current scale.
y=8 : like y=6 but the scale of the new plot is merged with the current scale.
leg : a string. It is used when the first character x of argument strf is 1. leg has the form "leg1@leg2@...."
where leg1, leg2, etc. are respectively the captions of the first curve, of the second curve, etc.
The default is " ".
rect : This argument is used when the second character y of argument strf is 1, 3 or 5. It is a row
vector of size 4 and gives the dimension of the frame: rect=[xmin,ymin,xmax,ymax].

DESCRIPTION :
polarplot creates a polar coordinate plot of the angle theta versus the radius rho. theta is the angle from the
x-axis to the radius vector specified in radians; rho is the length of the radius vector specified in dataspace
units.
EXAMPLES :

t= 0:.01:2*%pi;
xbasc();polarplot(sin(7*t),cos(8*t))

xbasc();polarplot([sin(7*t’) sin(6*t’)],[cos(8*t’) cos(8*t’)],[1,2])

1.2.74 printing printing scilab graphics

CALLING SEQUENCE :

Scilab Group April 1993 129

rotate Scilab Function

Blatexpr xscale yscale filename.ps

BEpsf filename.ps
Blpr "Title" filename1.ps filename2.ps ... filenamen.ps | lpr
DESCRIPTION :
The scilab graphics can be saved with the xbasimp command into unix files. The Scilab command :
xbasimp(xx,’des.ps’,0)
will save the graphics recorded in the graphic window xx in the file des.ps.xx. This file can’t be
directly send to a Postscript printer and a set of programs ( in the bin Scilab directory ) are given with
Scilab to print it :
BEpsf : The BEpsf command will create an Epsf file from your des.ps.xx under the name des.epsf,
this Epsf file can be printed on a Postscript printer or inserted into an other Postscript document.
Blatexpr : The Blatexpr command will create an Epsf file from your des.ps.xx
mv des.ps.xx des.ps
Blatexpr 1.0 1.0 des.ps
under the name des.epsf and a LaTeX file des.tex. The file des.tex can be inserted in a
LaTeX file in order to get the latex figure as follows ( the postscript file is inserted with the special
command of LaTeX )
\input des.tex
\dessin{caption}{label}
Blpr : The Blpr command is used to print a set of graphics on a same sheet of paper. For example to
print two graphics on a unique page, one can use :
Blpr "Two graphics" file1.ps.0 file2.ps.1 | lpr
Blatexprs : The Blatexprs command is used to insert in a single LaTeX figure a set of Scilab
Graphics
Blatexprs res file1.ps.0 file2.ps.1
will create two files res.ps and res.tex. The file res.tex is used as in the Blatexpr
command in order to get the figure.
S EE A LSO : xbasimp 137

1.2.75 replot redraw the current graphics window with new boundaries

CALLING SEQUENCE :
replot(rect)
PARAMETERS :
rect : row vector of size 4.
DESCRIPTION :
replot is used to redraw the content of the current graphics window with new boundaries defined by
rect=[xmin,ymin,xmax,ymax]. It works only with the driver "Rec".
EXAMPLE :
x=[0:0.1:2*%pi]’;
plot2d(x,sin(x))
replot([-1,-1,10,2])
S EE A LSO : xbasr 138
AUTHOR : J.Ph.C.

Scilab Group April 1993 130

sd2sci Scilab Function

1.2.76 rotate rotation of a set of points

CALLING SEQUENCE :

xy1=rotate(xy,[theta,orig])

PARAMETERS :

xy : matrice of size (2,.).

xy1 : matrice of size (2,.).
theta : real, angle en radian; default value is 0.
orig : center of the rotation; default value is [0;0].

DESCRIPTION :
rotate performs a rotation with angle theta:
xy1(:,i) = M(theta) *xy (:,i) + orig where M stands for the corresponding rotation
matrix.
EXAMPLE :

xsetech([0,0,1,1],[-1,-1,1,1])
xy=[(0:0.1:10);sin(0:0.1:10)]/10;
for i=2*%pi*(0:10)/10,
[xy1]=rotate(xy,i);
xpoly(xy1(1,:),xy1(2,:),"lines")
end

1.2.77 scaling affine transformation of a set of points

CALLING SEQUENCE :

xy1=scaling(xy,factor,[orig])

PARAMETERS :

xy1 : matrice of size (2,.).

xy : matrice of size (2,.).
factor : real scalar, coefficient of the linear transformation.
orig : shift vector; default value is [0;0].

DESCRIPTION :
scaling performs an affine transformation on the set of points defined by the coordinates xy:
xy1(:,i) = factor * xy(:,i) + orig.

1.2.78 sd2sci gr menu structure to scilab instruction convertor

CALLING SEQUENCE :

txt=sd2sci(sd [,sz [,orig]])

PARAMETERS :

sd : data structure build by gr menu.

sz : vector of number or strings with two components, give the x and y zoom factors

Scilab Group April 1993 131

sgrid Scilab Function

orig : vector of number or strings with two components, give the origin translation vector

DESCRIPTION :
given a sd data structure generated by gr menu sd2sci forms a vector of scilab instructions corre-
sponding to the graphic edited by gr menu.
The optional parameters sz and orig allows to zoom and shift the initial graphic.
If sz or orig are given by strings generated instructions are relative use then as formal expressions.
AUTHOR : Serge Steer INRIA 1988
S EE A LSO : gr_menu 107, execstr 37

1.2.79 secto3d 3D surfaces conversion

CALLING SEQUENCE :

[m[,x]]=secto3d(seclist,npas)
[m]=secto3d(seclist ,x)

PARAMETERS :

seclist : a list whose elements are (2,.) matrices

npas : an integer
m : a matrix
x : a vector

DESCRIPTION :
Considering a surface given through a list seclist of sections in the (x,z) plane [m [,x]]=secto3d(seclist
[,npas]) returns a matrix m which contains a regular discretization of the surface.
- The i-th row of the matrix m corresponds to the i-th section
- The j-th column of m corresponds to the x(j)
Each section seclist(i) is described by a (2,.) matrix which gives respectively the x and z coordinates
of points.
[m]=secto3d(seclist ,x) : in that case the x-vector gives the discretization of the x-axis for all
the sections
S EE A LSO : plot3d 123
AUTHOR : Steer S.

1.2.80 sgrid s-plane grid lines.

CALLING SEQUENCE :

sgrid()
sgrid(’new’)
sgrid(zeta,wn [,color])

DESCRIPTION :
Used in conjonction with evans, plots lines of constant damping ratio (zeta) and natural frequency (wn).

sgrid() : add a grid over an existing continuous s-plane root with default values for zeta and wn.
sgrid(’new’) : clears the graphic screen and then plots a default s-plane grid
sgrid(zeta,wn [,color]) : same as sgrid() but uses the provided damping ratio and natural
frequency.

Scilab Group Jun 1997 132

subplot Scilab Function

EXAMPLE :

H=syslin(’c’,352*poly(-5,’s’)/poly([0,0,2000,200,25,1],’s’,’c’));
evans(H,100)
sgrid()
sgrid(0.6,2,7)

S EE A LSO : evans 98

1.2.81 square set scales for isometric plot (change the size of the window)

CALLING SEQUENCE :

square(xmin,ymin,xmax,ymax)

PARAMETERS :

xmin,xmax,ymin,ymax : four real values

DESCRIPTION :
square is used to have isometric scales on the x and y axes. The requested values xmin, xmax,
ymin, ymax are the boundaries of the graphics frame and square changes the graphics window di-
mensions in order to have an isometric plot. square set the current graphics scales and can be used in
conjunction with graphics routines which request the current graphics scale (for instance fstrf="x0z"
in plot2d).
EXAMPLE :

t=[0:0.1:2*%pi]’;
plot2d(sin(t),cos(t))
xbasc()
square(-1,-1,1,1)
plot2d(sin(t),cos(t))
xset("default")

S EE A LSO : isoview 111, xsetech 155

AUTHOR : Steer S.

1.2.82 subplot divide a graphics window into a matrix of sub-windows

CALLING SEQUENCE :

subplot(m,n,p)
subplot(mnp)

PARAMETERS :

m,n,p : positive integers

mnp : an integer with decimal notation mnp

DESCRIPTION :
subplot(m,n,p) or subplot(mnp) breaks the graphics window into an m-by-n matrix of sub-windows and
selects the p-th sub-window for drawing the current plot. The number of a sub-window into the matrices is
counted row by row ie the sub-window corresponding to element (i,j) of the matrix has number (i-1)*m + j.

EXAMPLE :

Scilab Group April 1993 133

xarc Scilab Function

subplot(221)
plot2d()
subplot(222)
plot3d()
subplot(2,2,3)
param3d()
subplot(2,2,4)
hist3d()

S EE A LSO : plot2d 118, plot3d 123, xstring 157, xtitle 159

1.2.83 titlepage add a title in the middle of a graphics window

CALLING SEQUENCE :

titlepage(str)

PARAMETERS :

str : matrix of strings

DESCRIPTION :
titlepage displays the matrix of strings str in the middle of the current graphics window with a font
as big as possible.
S EE A LSO : xtitle 159
AUTHOR : S. S.

1.2.84 winsid return the list of graphics windows

CALLING SEQUENCE :

x=winsid()

PARAMETERS :

x : row vector.

DESCRIPTION :
winsid is used to get the list of graphics windows as a vector of windows numbers.

1.2.85 xarc draw a part of an ellipse

CALLING SEQUENCE :

xarc(x,y,w,h,a1,a2)

PARAMETERS :

x,y,w,h : four real values defining a rectangle.

a1,a2 : real values defining a sector.

Scilab Group April 1993 134

xarrows Scilab Function

DESCRIPTION :
xarc draws a part of an ellipse contained in the rectangle (x,y,w,h) (upper-left point, width, height),
and in the sector defined by the angle alpha1 and the angle alpha1+alpha2. alpha1 and alpha2
are given respectively by a1/64 degrees and a2/64 degrees. This function uses the current graphics
style and scale.
EXAMPLE :

// isoview scaling
plot2d(0,0,-1,"031"," ",[-2,-2,2,2])
xset("dashes",3)
xarc(-1,1,2,2,0,90*64)
xarc(-1.5,1.5,3,3,0,360*64)

S EE A LSO : xarcs 135, xfarc 141, xfarcs 142

AUTHOR : J.Ph.C.

1.2.86 xarcs draw parts of a set of ellipses

CALLING SEQUENCE :

xarcs(arcs,[style])

PARAMETERS :

arcs : matrix of size (6,n) describing the ellipses.

style : row vector of size n giving the style to use.

DESCRIPTION :
xarcs draws parts of a set of ellipses described by arcs: arcs=[x y w h a1 a2;x y w h a1
a2;...]’ where each ellipse is defined by the 6 parameters (x,y,w,h,a1,a2) (see xarc).
style(i) gives the dash style used to draw ellipse number i.
EXAMPLE :

plot2d(0,0,-1,"031"," ",[-1,-1,1,1])
arcs=[-1.0 0.0 0.5; // upper left x
1.0 0.0 0.5; // upper left y
0.5 1.0 0.5; // width
0.5 0.5 1.0; // height
0.0 0.0 0.0; // angle 1
180*64 360*64 90*64]; // angle 2
xarcs(arcs,[1,2,3])

S EE A LSO : xarc 134, xfarc 141, xfarcs 142

AUTHOR : J.Ph.C.

1.2.87 xarrows draw a set of arrows

CALLING SEQUENCE :

xarrows(nx,ny,[arsize,style])

PARAMETERS :

nx,ny : real vectors or matrices of same size.

Scilab Group April 1993 135

xaxis Scilab Function

arsize : real scalar, size of the arrow head. The default value can be obtained by setting arsize to -1.
style : matrix or scalar. If style is a positive scalar it gives the dash style to use for all arrows. If it
is a negative scalar then the current dash style is used. If it is a vector style(i) gives the style to
use for arrow i.

DESCRIPTION :
xarrows draws a set of arrows given by nx and ny. If nx and ny are vectors, the ith arrow is defined
by (nx(i),ny(i))-->(nx(i+1),ny(i+1)). If nx and ny are matrices:

nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]

ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]

the k th arrow is defined by (xi k,yi k)-->(xf k,yf k).

xarrows uses the current graphics scale which can be set by calling a high level drawing function such
as plot2d.
EXAMPLE :

x=2*%pi*(0:9)/8;
x1=[sin(x);9*sin(x)];
y1=[cos(x);9*cos(x)];
plot2d([-10,10],[-10,10],[-1,-1],"022")
xset("clipgrf")
xarrows(x1,y1,1,1:10)
xset("clipoff")

AUTHOR : J.Ph.C.

1.2.88 xaxis draw an axis

CALLING SEQUENCE :

xaxis(alpha,nsteps,size,init)

PARAMETERS :

alpha : real, slope in degree of the axis.

nsteps : real vector of size 2, number of big and small intervals.
size : real vector of size 3, size of the small intervals, and small and big tics.
init : real vector of size 2, origin of the axis.

DESCRIPTION :
xaxis draws an axis.
The direction of the axis is given by alpha in degree.
init=[x0 y0] is the initial point of the axis.
nsteps=[n1,n2] gives the number of big and small intervals separated by tics.
size=[s1,s2,c1] where s1 gives the size of the small intervals, s2 gives the size of the small
tics along the axis and s2*c1 gives the size of the big tics. All the sizes are given using the current x-scale
and y-scale and are given as dimensions along the drawn axis.

example : n1=3, n2=2, alpha=0

(s2*c1)
| (s2) | | |
|______|_____|_____|______|_____|_____|
s1

Scilab Group April 1993 136

xbasr Scilab Function

EXAMPLE :

x=[-%pi:0.1:%pi]’;
// plot without axis
plot2d(x,sin(x),1,"010"," ",[-4 -1 4 1])
// draw x axis
xpoly([-4 4],[0 0],"lines")
xaxis(0,[2 2],[2 0.1 3],[-4 0])
xstring(-4.1,-0.25,"-4"); xstring(-0.2,-0.1,"0"); xstring(4,-0.25,"4")
// draw y axis
xpoly([0 0],[-1 1],"lines")
xaxis(90,[2 2],[0.5 0.025 3],[0 1])
xstring(-0.5,-1.05,"-1"); xstring(-0.35,0.95,"1")

AUTHOR : J.Ph.C.

1.2.89 xbasc clear a graphics window and erase the associated recorded graphics

CALLING SEQUENCE :

xbasc([window-id])

PARAMETERS :

window-id : integer scalar or vector

DESCRIPTION :
Without any argument, this function clears the current graphics window and erases the recorded graphics.
Otherwise it clears the graphics windows whose numbers are included in the vector window-id, and
erases the corresponding recorded graphics. For example xbasc(1:3) clears windows 1, 2 and 3 and
erases the corresponding recorded graphics. If one of the windows does not exist, then it is automatically
created.
S EE A LSO : xclear 139

1.2.90 xbasimp send graphics to a Postscript printer or in a file

CALLING SEQUENCE :

xbasimp(win_num,[filen,printer])

PARAMETERS :

win num : integer scalar or vector

filen : string, Postscript file name (default value is ”file”). The window number is appended to filen.
printer : string, printer name. If printer is present or if there is only one argument in the calling
sequence, the created file is printed on printer printer.

DESCRIPTION :
xbasimp sends the recorded graphics of the window win num into the Postscript file filen and
prints the Postscript file with the command Blpr. This function works only if the selected driver is "Rec".
If win num is a vector, several files are generated, one for each selected window (with names filenxx),
and the files are printed on a unique page with the command Blpr.
The window number is appended to filen.
S EE A LSO : printing 129, xs2fig 152

Scilab Group April 1993 137

xclear Scilab Function

1.2.91 xbasr redraw a graphics window

CALLING SEQUENCE :

xbasr(win_num)

DESCRIPTION :
xbasr is used to redraw the content of the graphics window with id win num. It works only with the
driver "Rec".
S EE A LSO : driver 95, replot 130, xtape 159
AUTHOR : J.Ph.C.

1.2.92 xchange transform real to pixel coordinates

CALLING SEQUENCE :

[x1,y1,rect]=xchange(x,y,dir)

PARAMETERS :

x,y : two matrices of size (n1,n2) (coordinates of a set of points).

x1,y1 : two matrices of size (n1,n2) (coordinates of the set of points).
rect : a vector of size 4.

DESCRIPTION :
After having used a graphics function, xchange computes pixel coordinates from real coordinates and
conversely, according to the value of the parameter dir: ”f2i” (float to int) means real to pixel and ”i2f”
(int to float) means pixel to real. x1 and y1 are the new coordinates of the set of points defined by the old
coordinates x and y.
rect is the coordinates in pixel of the rectangle in which the plot was done: [upper-left point, width,
height].
EXAMPLE :

t=[0:0.1:2*%pi]’;
plot2d(t,sin(t))
[x,y,rect]=xchange(1,1,"f2i")
[x,y,rect]=xchange(0,0,"i2f")

AUTHOR : J.Ph.C.

1.2.93 xclea erase a rectangle

CALLING SEQUENCE :

xclea(x,y,w,h)

PARAMETERS :

x,y,w,h : real values defining the rectangle.

DESCRIPTION :
xclea clears the rectangle [x,y,w,h] (upper left point, width, height) in the current graphics window.

EXAMPLE :

Scilab Group April 1993 138

xclip Scilab Function

x=[0:0.1:2*%pi]’;
plot2d(x,sin(x))
xclea(1,1,1,1)
AUTHOR : J.Ph.C.

1.2.94 xclear clear a graphics window

CALLING SEQUENCE :
xclear([window-id])
PARAMETERS :
window-id : integer scalar or vector
DESCRIPTION :
Without any argument, this function clears the current window. Otherwise it clears the graphics windows
whose numbers are included in the vector window-id. For example xclear(1:3) clears windows 1,
2 and 3. If one of the windows does not exist, then it is automatically created.
Warning: in recording mode xclear clears the window, but it does not erase the recorded commands. In
this case you must use the function xbasc.
S EE A LSO : xbasc 137
AUTHOR : J.Ph.C.

1.2.95 xclick wait for a mouse click

CALLING SEQUENCE :
[c_i,c_x,c_y,c_w,c_m]=xclick([flag])
PARAMETERS :
c i : integer, mouse button number.
c x,c y : real scalars, position of the mouse.
c w : integer, window number.
c m : string, menu callback.
flag : integer. If present, the click event queue is not cleared when entering xclick.
DESCRIPTION :
xclick waits for a mouse click in the graphics window.
If it is called with 3 left hand side arguments, it waits for a mouse click in the current graphics window.
If it is called with 4 or 5 left hand side arguments, it waits for a mouse click in any graphics window.
The returned values are described below.
ci : an integer which gives the number of the mouse button that was pressed 0, 1 or 2 (for left, middle
and right) or -1 in case of problems with xclick.
c x,c y : the coordinates of the position of the mouse click in the current graphics scale.
c w : the window number where the click has occurred.
c m : string associated with a dynamic menu. If xclick returns due to a click on a menu, c i, c x, c y,
and c w take arbitrary values.
KNOWN TROUBLES :
xclick can return the message ”Can’t grab the pointer” if the graphics window is iconified when calling
it.
S EE A LSO : locate 112, xgetmouse 145
AUTHOR : J.Ph.C.

Scilab Group April 1993 139

xend Scilab Function

1.2.96 xclip set a clipping zone

CALLING SEQUENCE :

xclip([x,y,w,h])
xclip(rect)
xclip("clipgrf")

PARAMETERS :

x,y,w,h : real values.

rect : row vector of size 4.

DESCRIPTION :
xclip set a clipping zone given by the coordinates, in the current graphics scale, of the rectangle
x,y,w,h (upper-left point, width, height). If only one argument is given, it stands for a rectangle specifi-
cation rect=[x,y,w,h].
xclip("clipgrf") is used to clip the usual rectangle boundaries.
To unclip a region use the command xclip().
EXAMPLE :

x=0:0.2:2*%pi;
x1=[sin(x);100*sin(x)];
y1=[cos(x);100*cos(x)];
y1=y1+20*ones(y1);
// No clip
plot2d([-100,500],[-100,600],[-1,-1],"022")
xsegs(10*x1+200*ones(x1),10*y1+200*ones(y1))
// rectangle clipping zone
xbasc(); plot2d([-100,500],[-100,600],[-1,-1],"022")
xrect(150,460,100,150)
xclip(150,460,100,150)
xsegs(10*x1+200*ones(x1),10*y1+200*ones(y1))
// usual rectangle boundaries clipping zone
xbasc(); plot2d([-100,500],[-100,600],[-1,-1],"022")
xclip("clipgrf")
xsegs(10*x1+200*ones(x1),10*y1+200*ones(y1));
// clipping of
xclip()

AUTHOR : J.Ph.C.

1.2.97 xdel delete a graphics window

CALLING SEQUENCE :

xdel([win-nums])

DESCRIPTION :
xdel deletes the graphics windows win-nums or the current graphics window if no argument is given.

AUTHOR : J.Ph.C.

Scilab Group April 1993 140

xfarcs Scilab Function

1.2.98 xend close a graphics session

CALLING SEQUENCE :

xend()

DESCRIPTION :
xend is used to close a graphics session. Under the Postscript, Xfig or Gif drivers xend closes the file
which was opened by xinit.
EXAMPLE :

driver("Pos")
xinit("foo.ps")
plot2d()
xend()
driver("X11")

S EE A LSO : xbasimp 137, xend 141

AUTHOR : J.Ph.C.

1.2.99 xfarc fill a part of an ellipse

CALLING SEQUENCE :

xfarc(x,y,w,h,a1,a2)

PARAMETERS :

x,y,w,h : four real values defining a rectangle.

a1,a2 : real values defining a sector.

DESCRIPTION :
xfarc fills a part of an ellipse contained in the rectangle (x,y,w,h) (upper-left point, width, height),
and in the sector defined by the angle alpha1 and the angle alpha1+alpha2. alpha1 and alpha2
are given respectively by a1/64 degrees and a2/64 degrees. This function uses the current graphics
style and scale.
EXAMPLE :

// isoview scaling
plot2d(0,0,-1,"031"," ",[-2,-2,2,2])
xfarc(-0.5,0.5,1,1,0,90*64)
xset("pattern",2)
xfarc(0.5,0.5,1,1,0,360*64)

S EE A LSO : xarc 134, xarcs 135, xfarcs 142

AUTHOR : J.Ph.C.

Scilab Group April 1993 141

xfpolys Scilab Function

1.2.100 xfarcs fill parts of a set of ellipses

CALLING SEQUENCE :

xfarcs(arcs,[style])

PARAMETERS :

arcs : matrix of size (6,n) describing the ellipses.

style : row vector of size n giving the style to use.

DESCRIPTION :
xarcs fills parts of a set of ellipses described by arcs: arcs=[x y w h a1 a2;x y w h a1
a2;...]’ where each ellipse is defined by the 6 parameters (x,y,w,h,a1,a2) (see xfarc).
style(i) gives the dash style used to draw ellipse number i.
EXAMPLE :

plot2d(0,0,-1,"031"," ",[-1,-1,1,1])
arcs=[-1.0 0.0 0.5; // upper left x
1.0 0.0 0.5; // upper left y
0.5 1.0 0.5; // width
0.5 0.5 1.0; // height
0.0 0.0 0.0; // angle 1
180*64 360*64 90*64]; // angle 2
xfarcs(arcs,[1,2,3])

S EE A LSO : xarc 134, xfarc 141, xfarc 141

AUTHOR : J.Ph.C.

1.2.101 xfpoly fill a polygon

CALLING SEQUENCE :

xfpoly(xv,yv,[close])

PARAMETERS :

xv,yv : two vectors of same size (the points of the polygon).

close : integer. If close=1, the polyline is closed; default value is 0.

DESCRIPTION :
xfpoly fills a polygon with the current pattern. If close is equal to 1 a point is added to the polyline
xv,yv to define a polygon.
EXAMPLE :

x=sin(2*%pi*(0:5)/5);
y=cos(2*%pi*(0:5)/5);
plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
xset("pattern",5)
xfpoly(x,y)
xset("default")

S EE A LSO : xfpolys 143, xpoly 150, xpolys 150

AUTHOR : J.Ph.C.

Scilab Group April 1993 142

xget Scilab Function

1.2.102 xfpolys fill a set of polygons

CALLING SEQUENCE :
xfpolys(xpols,ypols,[fill])
PARAMETERS :
xpols,ypols : matrices of the same size (p,n) (points of the polygons).
fill : vector of size n.
DESCRIPTION :
xfpolys fills a set of polygons of the same size defined by the two matrices xpols and ypols. The
coordinates of each polygon are stored in a column of xpols and ypols.
The pattern for filling polygon number i is given by fill(i):
- if fill(i)<0, the polygon is filled with pattern id -fill(i).
- if fill(i)=0, the polygon is drawn with the current dash style (or current color).
- if fill(i)>0, the polygon is filled with pattern id fill(i). Then its contour is drawn with the
current dash (or color) and closed if necessary.
EXAMPLE :
plot2d(0,0,[-1],"012"," ",[0,-10,210,40])
x1=[0,10,20,30,20,10,0]’;
y1=[15,30,30,15,0,0,15]’;
xpols=[x1 x1 x1 x1]; xpols=xpols+[0,60,120,180].*.ones(x1);
ypols=[y1 y1 y1 y1];
// setting the current dash (or line color)
xset("dashes",5)
xfpolys(xpols,ypols,[-1,0,1,2])
xset("default")
S EE A LSO : xfpoly 142, xpoly 150, xpolys 150
AUTHOR : J.Ph.C.

1.2.103 xfrect fill a rectangle

CALLING SEQUENCE :
xfrect(x,y,w,h)
xfrect(rect) // rect =[x,y,w,h]
PARAMETERS :
x,y,w,h : four real values defining the rectangle.
DESCRIPTION :
xrect fills a rectangle defined by [x,y,w,h] (upper-left point, width, height) using the current scale
and style.
EXAMPLE :
plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
xset("pattern",5)
xfrect(-1,1,2,2)
xset("default")
S EE A LSO : xrect 151, xrects 151
AUTHOR : J.Ph.C.

Scilab Group April 1993 143

xgetech Scilab Function

1.2.104 xget get current values of the graphics context

CALLING SEQUENCE :
[x1]=xget(str,[flag])
xget()
PARAMETERS :
str : string.
flag : optional. Set to 1 gives a verbose mode.
DESCRIPTION :
This function is used to get values from the graphics context on the topic specified by the string str.
When called with no argument, a choice menu is created showing the current values and changes can be
performed through toggle buttons.
number=xget("alufunction") : Get the logical function number used for drawing. See xset.
str=xset("auto clear") : Get the auto clear status ("on" or "off").
color=xget("background") : Get the background color of the current graphics window.
rect=xget("clipping") : Get the clipping zone as a rectangle rect=[x,y,w,h] (Upper-Left point
Width Height).
c=xget("color") : Get the default color for filling, line or text drawing functions. c is an integer
projected in the interval [0,whiteid]. 0 stands for black filling and whiteid for white. The value of
whiteid can be obtained with xget("white").
cmap=xget("colormap") : Get the colormap used for the current graphics window as a m x 3 RGB
matrix.
dash=xget("dashes") : Get the dash style dash=[dash number] where dash number is the id of
the dash. This keyword is obsolete, please use xget("color") or xget("line style")
instead.
font=xget("font") : Get font=[fontid,fontsize], the default font and the default size for fonts. size.
fontsize=xget("font size") : Get the default size for fonts size.
color=xget("foreground") : Get the foreground color of the current graphics window.
str=xget("fpf") : Get the floating point format for number display in contour functions. Note that
str is "" when default format is used.
color=xget("hidden3d") : Get the color number for hidden faces in plot3d.
pat=xget("lastpattern") : Get the id of the last available pattern or color, with the current col-
ormap of the current window. In fact pat+1 and pat+2 are also available and stand respectively
for black and white pattern.
type=xget("line mode") : Get the line drawing mode. type=1 is absolute mode and type=0 is
relative mode. (Warning: the mode type=0 is has bugs)
xget("line style") : Get the default line style (1: solid, >1 for dashed lines).
mark=xget("mark") : Get the default mark id and the default marks size. mark=[markid,marksize].
marksize=xget("mark size") : Get the default marks size.
pat=xget("pattern") : Get the current pattern or the current color. pat is an integer in the range
[1,last]. When one uses black and white, 0 is used for black filling and last for white. The
value of last can be obtained with xget("lastpattern").
value=xget("thickness") : Get the thickness of lines in pixel (0 and 1 have the same meaning: 1
pixel thick).
flag=xget("use color") : Get the flag 0 (use black and white) or 1 (use colors). See xset.
[x,y]=xget("viewport") : Get the current postion of the visible part of graphics in the panner.
dim=xget("wdim") : Get the width and the height of the current graphics window dim=[width,height].
win=xget("window") : Get the current window number win.
pos=xget("wpos",x,y); : Get the position of the upper left point of the graphics window pos=[x,y].
S EE A LSO : xset 154, colormap 89
AUTHOR : J.Ph.C.

Scilab Group April 1993 144

xgetmouse

1.2.105 xgetech get the current graphics scale

CALLING SEQUENCE :

[wrect,frect,logflag,arect]=xgetech()

PARAMETERS :

wrect,frect : real vectors.

logflag : string of size 2 ”xy”.

DESCRIPTION :
xgetech returns the current graphics scale (of the current window). The rectangle [xmin,ymin,xmax,ymax]
given by frect is the size of the whole graphics window. The plotting will be made in the region of the
current graphics window specified by wrect.
wrect=[x,y,w,h] (upper-left point, width, height) describes a region inside the graphics window. The
values in wrect are specified using proportion of the width and height of the graphics window:
wrect=[0 0 1 1] means that the whole graphics window is used.
wrect=[0.5 0 0.5 1] means that the graphics region is the right half of the graphics window.
logflag is a string of size 2 ”xy”, where x and y can be ”n” or ”l”. ”n” stands for normal and ”l”
stands for logscale. x stands for the x-axis and y stands for the y-axis.
arect=[x left, x right,y up,y down] gives the frame size inside the subwindow. The
graphic frame is specified (like wrect) using proportion of the width or height of the current graphic
subwindow. Default value is 1/8*[1,1,1,1]. If arect is not given, current value remains unchanged.
EXAMPLE :

// first subwindow
xsetech([0,0,1.0,0.5])
plot2d()
// then xsetech is used to set the second sub window
xsetech([0,0.5,1.0,0.5])
grayplot()
// get the graphic scales of first subwindow
xsetech([0,0,1.0,0.5])
[wrect,frect,logflag,arect]=xgetech();
// get the graphic scales of second subwindow
xsetech([0,0.5,1.0,0.5])
[wrect,frect,logflag,arect]=xgetech();
xbasc();
xset(’default’)

S EE A LSO : xsetech 155

AUTHOR : J.Ph.C.

1.2.106 xgetmouse get the current position of the mouse

CALLING SEQUENCE :

rep=xgetmouse([flag])

PARAMETERS :

rep : vector of size 3, [x,y,ibutton].

flag : integer. If present, the click event queue is not cleared when entering xgetmouse.

Scilab Function Scilab Group 145

xgrid Scilab Function

DESCRIPTION :
If the mouse is located in the current graphics window, xgetmouse returns in rep the current mouse
position (x,y) and the value ibutton.
The ibutton value indicates the action of the button at this point:

- if ibutton is -1 then no button was clicked.

- if ibutton is -5 -4 or -2 then left , middle or right button was released
- if ibutton is 0, 1 or 2, then the left, middle or right button was pressed.
If the mouse is not located in the current graphics window, xgetmouse waits.

EXAMPLE :

xselect(); xbasc(); xsetech([0 0 1 1],[0 0 100 100])

xset("alufunction",6)
xtitle(" drawing a rectangle ")
[b,x0,y0]=xclick(); rep=[x0,y0,-1]; x=x0; y=y0;
xrect(x0,y0,x-x0,y-y0)
while rep(3)==-1 then
rep=xgetmouse(0)
xrect(x0,y0,x-x0,y0-y)
x=rep(1); y=rep(2);
xrect(x0,y0,x-x0,y0-y)
end
xset("alufunction",3)

S EE A LSO : locate 112, xclick 139

AUTHOR : S. Steer

1.2.107 xgraduate axis graduation

CALLING SEQUENCE :

[xi,xa,np1,np2,kMinr,kMaxr,ar]=xgraduate(xmi,xma)

PARAMETERS :

xmi,xma : real scalars

xi, xa, kMinr, kMaxr, ar :real scalars
np1,np2 : integer

DESCRIPTION :
xgraduate returns the axis graduations which are used by the plot routines (with pretty print flag en-
abled). It returns an interval [xi,xa] which contains the given interval [xmi,xma] and such that
xi= kMinr*10ˆar, xa=kMaxr*10ˆar and the interval can be divided into np2 intervals and each
interval is divided in np1 sub-intervals.
EXAMPLE :

[x1,xa,np1,np2,kMinr,kMaxr,ar]=xgraduate(-0.3,0.2)

S EE A LSO : graduate 108, plot2d 118

AUTHOR : J.P.C

Scilab Group April 1993 146

xinit Scilab Function

1.2.108 xgrid add a grid on a 2D plot

CALLING SEQUENCE :

xgrid([style])

PARAMETERS :

style : integer

DESCRIPTION :
xgrid adds a grid on a 2D plot. style is the dash id or the color id to use for the grid plotting. Use
xset() for the meaning of id.
EXAMPLE :

x=[0:0.1:2*%pi]’;
plot2d(sin(x))
xgrid(2)

S EE A LSO : xset 154, plot2d 118

AUTHOR : J.Ph.C.

1.2.109 xinfo draw an info string in the message subwindow

CALLING SEQUENCE :

xinfo(info)

PARAMETERS :

info : string

DESCRIPTION :
xinfo draws the string info in the message subwindow of the current graphics window.

1.2.110 xinit initialisation of a graphics driver

CALLING SEQUENCE :

xinit([driver-name])

PARAMETERS :

driver-name : string.

DESCRIPTION :
Initialisation of the given driver.
For X Window driver-name can be a string which gives the name of a display and a new graphics
window is created. If the argument is omitted the value of the environment variable DISPLAY is used if it
exists or the value ”unix:0.0” is used.
For the Postscript, Xfig or Gif driver, driver-name is a name of the file where all the graphics operations
are recorded.
EXAMPLE :

Scilab Group April 1993 147

xname Scilab Function

driver("Pos")
xinit("foo.ps")
plot2d()
xend()
driver("X11")

S EE A LSO : xbasimp 137, xend 141

AUTHOR : J.Ph.C.

1.2.111 xlfont load a font in the graphics context or query loaded font

CALLING SEQUENCE :

xlfont(font-name,font-id)
fonts=xlfont()

PARAMETERS :

font-name : string, name of the font family.

font-id : integer between 0 and 6.
fonts : a column vector of currently loaded font names.
DESCRIPTION :
Without any argument, xlfont() returns the list of currently loaded fonts.
With arguments, xlfont is used to load a new font at different sizes in the graphics context. The font
must be available with size 8, 10, 12, 14, 18 and 24.
Default fonts are ”Courier Roman” (0), ”Symbol” (1), ”Times Roman” (2), ”Times Italic” (3), ”Times Bold”
(4) and ”Times Bold Italic” (5).
font-name can be of 2 types:
- if it contains the character ”%”, it is supposed to be an X11 font name with %s in the size field of the
name, for example "-b&h-lucidabright-demibold-r-normal--%s-*-75-75-p-*-iso8859-1"
- if it does not contain the character ”%”, it is supposed to be an alias name and the fonts aliased by
font-name08,...,font-name24 are loaded.
font-id : give the id font-id to the loaded font font-name.

S EE A LSO : xset 154

AUTHOR : J.Ph.C.

1.2.112 xload load a saved graphics

CALLING SEQUENCE :

xload(file-name,[win-num])
PARAMETERS :

file-name : string, name of the file.

win-num : integer, the graphics window number. If not given, the current graphics window is used.
DESCRIPTION :
xload reloads the graphics contained in the file file-name in the graphics window win-num.
S EE A LSO : xsave 152
AUTHOR : J.Ph.C.

Scilab Group April 1993 148

xpoly Scilab Function

1.2.113 xname change the name of the current graphics window

CALLING SEQUENCE :

xname(name)

PARAMETERS :

name : string, new name of the graphics window.

DESCRIPTION :
xname changes the name of the current graphics window.
AUTHOR : J.Ph.C.

1.2.114 xnumb draw numbers

CALLING SEQUENCE :

xnumb(x,y,nums,[box,angle])

PARAMETERS :

x,y,nums : vectors of same size.

box : integer value.
angle : optional vector of same size as x

DESCRIPTION :
xnumb draws the value of nums(i) at position x(i),y(i) in the current scale. If box is 1, a box
is drawn around the numbers. If angle is given, it gives the direction for string drawing.
EXAMPLE :

plot2d([-100,500],[-100,600],[-1,-1],"022")
x=0:100:200;
xnumb(x,500*ones(x),[10,20,35],1)

S EE A LSO : xstring 157

AUTHOR : J.Ph.C.

1.2.115 xpause suspend Scilab

CALLING SEQUENCE :

xpause(microsecs)

DESCRIPTION :
xpause suspends the current process for the number of microseconds specified by the argument. The
actual suspension time may be longer because of other activities in the system, or because of the time spent
in processing the call.
AUTHOR : J.Ph.C.

Scilab Group April 1993 149

xrect Scilab Function

1.2.116 xpoly draw a polyline or a polygon

CALLING SEQUENCE :
xpoly(xv,yv [,dtype [,close]])
PARAMETERS :
xv,yv : matrices of the same size (points of the polyline).
dtype : string (drawing style). default value is ”lines”.
close : integer. If close=1, the polyline is closed; default value is 0.
DESCRIPTION :
xpoly draws a single polyline described by the vectors of coordinates xv and yv. If xv and yv are
matrices they are considered as vectors by concatenating their columns. dtype can be "lines" for
using the current line style or "marks" for using the current mark to draw the polyline.
EXAMPLE :
x=sin(2*%pi*(0:5)/5);
y=cos(2*%pi*(0:5)/5);
plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
xset("dashes",5)
xpoly(x,y,"lines",1)
xset("default")
S EE A LSO : xfpoly 142, xfpolys 143, xpolys 150
AUTHOR : J.Ph.C.

1.2.117 xpolys draw a set of polylines or polygons

CALLING SEQUENCE :
xpolys(xpols,ypols,[draw])
PARAMETERS :
xpols,ypols : matrices of the same size (p,n) (points of the polylines).
draw : vector of size n.
DESCRIPTION :
xpolys draws a set of polylinse using marks or dashed lines. The coordinates of each polyline are stored
in a column of xpols and ypols.
The style of polyline i is given by draw(i):
- If draw(i) is negative, the mark with id -draw(i) is used to draw polyline i (marks are drawn
using the current pattern). Use xset() to see the meaning of the ids.
- If draw(i) is strictly positive, the line style (or color) with id abs(draw(i)) is used to draw
polyline i. Use xset() to see the meaning of the ids.

EXAMPLES :
plot2d(0,0,-1,"012"," ",[0,0,1,1])
rand("uniform")
xset("pattern",3)
xpolys(rand(3,5),rand(3,5),[-1,-2,0,1,2])
xset("default")
S EE A LSO : xfpoly 142, xfpolys 143, xpoly 150
AUTHOR : J.Ph.C.

Scilab Group April 1993 150

xrpoly Scilab Function

1.2.118 xrect draw a rectangle

CALLING SEQUENCE :

xrect(x,y,w,h)
xrect(rect) // rect =[x,y,w,h]

PARAMETERS :

x,y,w,h : four real values defining the rectangle.

DESCRIPTION :
xrect draws a rectangle defined by [x,y,w,h] (upper-left point, width, height) using the current
scale and style.
EXAMPLE :

plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
xset("pattern",5)
xrect(-1,1,2,2)
xset("default")

S EE A LSO : xfrect 143, xrects 151

AUTHOR : J.Ph.C.

1.2.119 xrects draw or fill a set of rectangles

CALLING SEQUENCE :

xrects(rects,[fill])

PARAMETERS :

rects : matrix of size (4,n).

fill : vector of size n.

DESCRIPTION :
xrects draws or fills a set of rectangles. Each column of rects describes a rectangle (upper-left point,
width, height): rects=[x1 y1 w1 h1;x2 y2 w2 h2;...]’.
fill(i) gives the pattern to use for filling or drawing rectangle i:
if fill(i)<0, rectangle i is drawn using the line style (or color) -fill(i)
if fill(i)>0, rectangle i is filled using the pattern (or color) fill(n)
if fill(i)=0, rectangle i is drawn using the current line style (or color).
EXAMPLE :

plot2d([-100,500],[-50,50],[-1,-1],"022")
cols=[-34,-33,-32,-20:5:20,32,33,34];
x=400*(0:14)/14; step=20;
rects=[x;10*ones(x);step*ones(x);30*ones(x)];
xrects(rects,cols)
xnumb(x,15*ones(x),cols)

S EE A LSO : xfrect 143, xrect 151

AUTHOR : J.Ph.C.

Scilab Group April 1993 151

xsegs Scilab Function

1.2.120 xrpoly draw a regular polygon

CALLING SEQUENCE :
xrpoly(orig,n,r,[theta])
PARAMETERS :
orig : vector of size 2.
n : integer, number of sides.
r : real scalar.
theta : real, angle in radian; 0 is the default value.
DESCRIPTION :
xrpoly draws a regular polygon with n sides contained in the circle of diameter r and with the origin
of the circle set at point orig. theta specifies a rotation angle in radian. This function uses the current
graphics scales.
EXAMPLE :
plot2d(0,0,-1,"012"," ",[0,0,10,10])
xrpoly([5,5],5,5)
S EE A LSO : xrect 151

1.2.121 xs2fig send graphics to a file in Xfig syntax

CALLING SEQUENCE :
xs2fig(win_num,filen,[color])
PARAMETERS :
win num : integer scalar or vector .
filen : string, file name.
color : optional integer. 0 means black and white and 1 means color. The default value is to use a value
compatible with the screen status.
DESCRIPTION :
xs2fig sends the recorded graphics of the window win num in the file filen in Xfig syntax. This
function works only if the selected driver is "Rec".
S EE A LSO : xbasimp 137

1.2.122 xsave save graphics into a file

CALLING SEQUENCE :
xsave(file-name,[win-num])
PARAMETERS :
file-name : string, name of the file.
win-num : integer, the graphics window number. If not given, the current graphics window is used.
DESCRIPTION :
xsave saves the graphics contained in the graphics window win-num in the binary file file-name.
The graphics are stored in a machine independent way (using the xdr library) and can be reloaded with
xload.
S EE A LSO : xload 148
AUTHOR : J.Ph.C.

Scilab Group April 1993 152

xset Scilab Function

1.2.123 xsegs draw unconnected segments

CALLING SEQUENCE :

xsegs(xv,yv,[style])

PARAMETERS :

xv,yv : matrices of the same size.

style : vector or scalar. If style is a positive scalar, it gives the dash style to use for all segments. If
style is a negative scalar, then current dash style is used. If style is a vector, then style(i)
gives the style to use for segment i.

DESCRIPTION :
xsegs draws a set of unconnected segments given by xv and yv. If xv and yv are matrices they are
considered as vectors by concatenating their columns. The coordinates of the two points defining a segment
are given by two consecutive values of xv and yv:
(xv(i),yv(i))-->(xv(i+1),yv(i+1)).
For instance, using matrices of size (2,n), the segments can be defined by:

xv=[xi_1 xi_2 ...;

xf_1 xf_2 ...]

yv=[yi_1 yi_2 ...;

yf_1 yf_2 ...]

and the segments are (xi k,yi k)-->(xf k,yf k).

EXAMPLE :

x=2*%pi*(0:9)/8;
xv=[sin(x);9*sin(x)];
yv=[cos(x);9*cos(x)];
plot2d([-10,10],[-10,10],[-1,-1],"022")
xsegs(xv,yv,1:10)

AUTHOR : J.Ph.C.

1.2.124 xselect raise the current graphics window

CALLING SEQUENCE :

xselect()

DESCRIPTION :
xselect raises the current graphics window. It creates the window if none exists. If the current graphics
window is iconified nothing is done.
AUTHOR : J.Ph.C.

Scilab Group April 1993 153

xset Scilab Function

1.2.125 xset set values of the graphics context

CALLING SEQUENCE :

xset(choice-name,x1,x2,x3,x4,x5)
xset()

PARAMETERS :

choice-name : string
x1,...,x5 : depending on choice-name

DESCRIPTION :
xset is used to set default values of the current window graphic context.
When called no argument, a choice menu is created showing the current values and changes can be per-
formed through toggle buttons.
Use xset() to display or set the current color, mark and fonts used.

xset("alufunction",number) : Used to set the logical function for drawing. The logical function
used is set by x1. Usual values are: 3 for copying (default), 6 for animation and 0 for clearing. See
alufunctions for more details.
xset("auto clear","on"j"off") : Switch ”on” or ”off” the auto clear mode for graphics. When
the auto clear mode is ”on”, successive plots are not superposed, ie an xbasc() operation (the
graphics window is cleared and the associated recorded graphics is erased) is performed before each
high level graphics function. Default value is ”off”.
xset("background",color) : Set the background color of the current graphics window.
xset("clipping",x,y,w,h) : Set the clipping zone (the zone of the graphics window where plots
can be drawn) to the rectangle (x,y,w,h) (Upper-Left point Width Height). This function uses the
current coordinates of the plot.
xset("color",value) : Set the default color for filling, line or text drawing functions. value is
an integer projected in the interval [0,whiteid]. 0 is used for black filling and whiteid for white. The
value of whiteid can be obtained with xget("white").
xset("colormap",cmap) : Set the colormap as a m x 3 matrix. m is the number of colors. Color
number i is given as a 3-uple cmap(i,1), cmap(i,2), cmap(i,3) corresponding respectively to red, green
and blue intensity between 0 and 1.
xset("dashes",i) : In black and white mode (xset("use color",0)), set the dash style to
style i (0 for solid line). In color mode (xset("use color",1 )) this is used to set line,
mark and text color. This keyword is obsolete, please use xset(’color’,i) or xset(’line
style’,i) instead.
xset("default") : Reset the graphics context to default values.
xset("font",fontid,fontsize) : Set the current font and its current size.
Note that fontsize applies to all fonts not only fontid .
xset("font size",fontsize) : Set the fonts size.
xset("foreground",color) : Set the foreground color of the current graphics window.
xset("fpf",string) : Set the floating point format for number display in contour functions. string
is a string giving the format in C format syntax (for example string="%.3f"). Use string=""
to switch back to default format.
xset("hidden3d",colorid) : Set the color number for hidden faces in plot3d.
colorid=0 zero suppress the drawing of backward facing faces of 3d objects. This is technically
called ’culling’ and is useful for closed surfaces.
xset("line mode",type) : This function is used to set the line drawing mode. Absolute mode is
set with type=1 and relative mode with type=0. (Warning: the mode type=0 has bugs)
xset("line style",value) : Set the current line style (1: solid, >1 for dashed lines).
xset("mark",markid,marksize) : Set the current mark and the current mark size. Use xset()
to see the marks. Note that marksize applies to all marks not only markid .

Scilab Group April 1993 154

xsetech Scilab Function

xset("mark size",marksize) : Set the marks size.

xset("pattern",value) : Set the current pattern for filling functions. value is an integer projected
in the interval [0,whiteid]. 0 is used for black filling and whiteid for white. The value of whiteid can
be obtained with xget("white"). ”pattern” is equivalent to ”color”.
xset("pixmap",flag) If flag=0 the graphics are directly displayed on the screen.
If flag=1 the graphics are done on a pixmap and are sent to the graphics window with the command
xset("wshow"). The pixmap is cleared with the command xset("wwpc"). Note that the usual
command xbasc() also clears the pixmap.
xset("thickness",value) : Set the thickness of lines in pixel (0 and 1 have the same meaning: 1
pixel thick).
xset("use color",flag) If flag=1 then xset("pattern",.) or xset("dashes",.) will
be used so as to change the default color for drawing or for filling patterns.
If flag=0 then we switch back to the gray and dashes mode.
xset("viewport",x,y) : Set the position of the panner.
xset("wdim",width,height) : Set the width and the height of the current graphics window. This
option is not used by the postscript driver.
xset("wpdim",width,height) : Sets the width and the height of the current physical graphic win-
dow (which can be different from the actual size in mode wresize 1). This option is not used by the
postscript driver.
xset("window",window-number) : Set the current window to the window window-number
and creates the window if it does not exist.
xset("wpos",x,y) : Set the position of the upper left point of the graphics window.
xset("wresize",flag) If flag=1 then the graphic is automatically resized to fill the graphics win-
dow.

xdel();xset("wresize",1);plot2d();xset("wdim",1000,500)

If flag=0 the scale of the graphic is left unchanged when the graphics window is resized. Top left
panner or keyboard arrows may be used to scroll over the graphic.

xdel();plot2d();xset("wresize",0);xset("wdim",1000,500)

xset("wshow") : See xset("pixmap",1) above.

xset("wwpc") : See xset("pixmap",1) above.

S EE A LSO : colormap 89, xget 144, getcolor 106, getsymbol 107

AUTHOR : J.Ph.C.

1.2.126 xsetech set the sub-window of a graphics window for plotting

CALLING SEQUENCE :

xsetech(wrect,[frect,logflag])
xsetech(wrect=[...],frect=[..],logflag="..", arect=[...])
xsetech()

PARAMETERS :

wrect : vector of size 4, defining the sub-window to use.

frect : vector of size 4.
logflag : string of size 2 ”xy”, where x and y can be ”n” or ”l”. ”n” stands for normal and ”l” stands for
logscale. x stands for the x-axis and y stands for the y-axis.
arect : vector of size 4.

Scilab Group April 1993 155

xsetech Scilab Function

DESCRIPTION :

xsetech is mainly used to set the sub-window of the graphics window which will be used for plot-
ting. The sub-window is specified with the parameter wrect=[x,y,w,h] (upper-left point, width,
height). The values in wrect are specified using proportion of the width or height of the current graphic
window. For instance wrect=[0,0,1,1] means that the whole graphics window will be used, and
wrect=[0.5,0,0.5,1] means that the graphics region will be the right half of the graphics window.
xsetech also set the current graphics scales for 2D plotting and can be used in conjunction with
graphics routines which request the current graphics scale (for instance strf="x0z" orframeflag=0
in plot2d).
frect=[xmin,ymin,xmax,ymax] is used to set the graphics scale and is just like the rect
argument of plot2d. If frect is not given the current value of the graphic scale remains unchanged.
the default value of rect is [0,0,1,1] (at window creation, when switching back to default value with
xset(’default’) or when clearing graphic recorded events xbasc()).
arect=[x left, x right,y up,y down] is used to set the graphic frame inside the subwin-
dow. The graphic frame is specified (like wrect) using proportion of the width or height of the current
graphic subwindow. Default value is 1/8*[1,1,1,1]. If arect is not given, current value remains
unchanged.
EXAMPLE :

// To get a graphical explanation of xsetech parameters enter:

exec(’SCI/demos/graphics/xsetechfig.sce’);

// Here xsetech is used to split the graphics window in two parts

// first xsetech is used to set the first sub-window
// and the graphics scale
xsetech([0,0,1.0,0.5],[-5,-3,5,3])
// we call plot2d with the "001" option to use the graphics scale
// set by xsetech
plot2d([1:10]’,[1:10]’,1,"001"," ")
// then xsetech is used to set the second sub-window
xsetech([0,0.5,1.0,0.5])
// the graphics scale is set by xsetech to [0,0,1,1] by default
// and we change it with the use of the rect argument in plot2d
plot2d([1:10]’,[1:10]’,1,"011"," ",[-6,-6,6,6])
// Four plots on a single graphics window
xbasc()
xset("font",2,0)
xsetech([0,0,0.5,0.5]); plot3d()
xsetech([0.5,0,0.5,0.5]); plot2d()
xsetech([0.5,0.5,0.5,0.5]); grayplot()
xsetech([0,0.5,0.5,0.5]); histplot()
// back to default values for the sub-window
xsetech([0,0,1,1])
// One plot with changed arect
xbasc()
xset("default")
xsetech(arect=[0,0,0,0])
x=1:0.1:10;plot2d(x’,sin(x)’)
xbasc()
xsetech(arect=[1/8,1/8,1/16,1/4])
x=1:0.1:10;plot2d(x’,sin(x)’)
xbasc()
xset("default")

Scilab Group April 1993 156

xstringb Scilab Function

S EE A LSO : xgetech 145, subplot 133, isoview 111, square 133

AUTHOR : J.Ph.C.

1.2.127 xsetm dialog to set values of the graphics context

CALLING SEQUENCE :
xsetm()
DESCRIPTION :
xsetm() is the same as xset().
S EE A LSO : xset 154
AUTHOR : J.Ph.C.

1.2.128 xstring draw strings

CALLING SEQUENCE :
xstring(x,y,str,[angle,box])
PARAMETERS :
x,y : real scalars, coordinates of the lower-left point of the strings.
str : matrix of strings.
angle : real, clockwise angle in degree; default is 0.
box : integer, default is 0.
DESCRIPTION :
xstring draws the matrix of strings str at location x,y (lower-left point) in the current graphic
scale: each row of the matrix stands for a line of text and row elements stand for words separated by a white
space. If angle is given, it gives the slope in degree used for drawing the strings. If box is 1 and angle
is 0, a box is drawn around the strings.
EXAMPLE :
plot2d([0;1],[0;1],0)
xstring(0.5,0.5,["Scilab" "is"; "not" "esilaB"])
//Other example
alphabet=["a" "b" "c" "d" "e" "f" "g" ..
"h" "i" "j" "k" "l" "m" "n" ..
"o" "p" "q" "r" "s" "t" "u" ..
"v" "w" "x" "y" "z"];
xbasc()
plot2d([0;1],[0;2],0)
xstring(0.1,1.8,alphabet) // alphabet
xstring(0.1,1.6,alphabet,0,1) // alphabet in a box
xstring(0.1,1.4,alphabet,20) // angle
xset("font",1,1) // use symbol fonts
xstring(0.1,0.1,alphabet)
xset("font",1,3) // change size font
xstring(0.1,0.3,alphabet)
xset("font",1,24); xstring(0.1,0.6,"a") //big alpha
xset("default")
S EE A LSO : titlepage 134, xnumb 149, xstringb 158, xstringl 158, xtitle 159
AUTHOR : J.Ph.C.

Scilab Group April 1993 157

xtape Scilab Function

1.2.129 xstringb draw strings into a box

CALLING SEQUENCE :

xstringb(x,y,str,w,h,[option])

PARAMETERS :

x,y,w,h : vector of 4 real scalars defining the box.

str : matrix of strings.
option : string.

DESCRIPTION :
xstringb draws the matrix of strings str centered inside the rectangle rect=[x,y,w,h] (lower-
left point, width, height) in the current graphic scale. If option is given with the value "fill", the
character size is computed so as to fill as much as possible in the rectangle.
Enter the command xstringb() to see a demo.
EXAMPLE :

str=["Scilab" "is";"not" "elisaB"];

plot2d(0,0,[-1,1],"010"," ",[0,0,1,1]);
r=[0,0,1,0.5];
xstringb(r(1),r(2),str,r(3),r(4),"fill");
xrect(r(1),r(2)+r(4),r(3),r(4))
r=[r(1),r(2)+r(4)+0.01,r(3),r(4)/2];
xrect(r(1),r(2)+r(4),r(3),r(4))
xstringb(r(1),r(2),str,r(3),r(4),"fill");
r=[r(1),r(2)+r(4)+0.01,r(3),r(4)/2];
xrect(r(1),r(2)+r(4),r(3),r(4))
xstringb(r(1),r(2),str,r(3),r(4),"fill");

S EE A LSO : titlepage 134, xstring 157, xstringl 158, xtitle 159

AUTHOR : J.Ph.C.

1.2.130 xstringl compute a box which surrounds strings

CALLING SEQUENCE :

rect=xstringl(x,y,str)

PARAMETERS :

rect : vector of 4 real scalars defining the box.

x,y : real scalars, coordinates of the lower-left point of the strings.
str : matrix of strings.

DESCRIPTION :
xstringl returns in rect=[x,y,w,h] (upper-left point, width, height) the size of a rectangle in the
current graphic scale which would surround the strings str drawn at location x,y (lower-left point).
The result can be approximative when using the Postscript driver.
EXAMPLE :

Scilab Group April 1993 158

zgrid Scilab Function

plot2d([0;1],[0;1],0)
str=["Scilab" "is";"not" "elisaB"];
r=xstringl(0.5,0.5,str)
xrects([r(1) r(2)+r(4) r(3) r(4)]’)
xstring(r(1),r(2),str)

S EE A LSO : titlepage 134, xstring 157, xstringl 158, xtitle 159

AUTHOR : J.Ph.C.

1.2.131 xtape set up the record process of graphics

CALLING SEQUENCE :

xtape(str,[num,rect])

PARAMETERS :

str : string, ”on”, ”clear”, ”replay” or ”replaysc”.

num : integer.
rect : row vector of size 4.

DESCRIPTION :
xtape is used to set up the record process of graphics:
xtape(”on”) just selects the driver ”Rec” which records all the graphics operations.
xtape(”clear”,num) clears the graphics window num and clears the recorded graphics associated with
window num.
xtape(”replay”,num) redisplays all the recorded graphics in the window num.
xtape(”replaysc”,num,rect) replots the graphics window num using rect=[xmin,ymin,xmax,ymax]
as x and y bounds.
S EE A LSO : driver 95, replot 130, xbasc 137, xbasr 138
AUTHOR : J.Ph.C.

1.2.132 xtitle add titles on a graphics window

CALLING SEQUENCE :

xtitle(xtit,[xax,yax,encad])

PARAMETERS :

xtit,xax,yax : matrices of strings.

encad : integer value. If it is 1, a box is drawn around each title.

DESCRIPTION :
xtitle add titles on a 2D or 3D plot. xtit is the general title, xax is the title on the x-axis and yax
is the title on the y-axis. xtitle must be called after a call to a high level plotting function (plot2d,
plot3d, ...). If the arguments are matrices, each line of the matrices is displayed on a different line.
Enter the command xtitle() to see a demo.
S EE A LSO : titlepage 134
AUTHOR : J.Ph.C.

Scilab Group April 1993 159

zgrid Scilab Function

1.2.133 zgrid zgrid plot

CALLING SEQUENCE :

zgrid()

DESCRIPTION :
plots z-plane grid lines: lines of constant damping factor (zeta) and natural frequency (Wn) are drawn in
within the unit Z-plane circle.
Iso-frequency curves are shown in frequency*step on the interval [0,0.5]. Upper limit corresponds to Shan-
non frequency ( 1/dt > 2*f ).
S EE A LSO : frep2tf 338, freson 339

Scilab Group April 1993 160

zgrid Scilab Function

1.3 Utilities and Elementary Functions

Scilab Group April 1993 161

acosh Scilab Function

1.3.1 abs absolute value, magnitude

CALLING SEQUENCE :

t=abs(x)

PARAMETERS :

x : real or complex vector or matrix

t : real vector or matrix

DESCRIPTION :
abs(x) is the absolute value of the elements of x. When x is complex, abs(x) is the complex
modulus (magnitude) of the elements of x.
EXAMPLE :

abs([1,%i,-1,-%i,1+%i])

1.3.2 acos element wise cosine inverse

CALLING SEQUENCE :

t=acos(x)

PARAMETERS :

x : real or complex vector

t : real or complex vector

DESCRIPTION :
The components of vector t are cosine inverse of the corresponding entries of vector x. Definition domain
is [-1, 1].
acos takes values in :
]0;  [] 1 + 1[
[0]  [0; +1] and [ ]] 1; 0] (real x imag)

EXAMPLE :

x=[1,%i,-1,-%i]
cos(acos(x))

1.3.3 acosh hyperbolic cosine inverse

CALLING SEQUENCE :

[t]=acosh(x)

PARAMETERS :

x : real or complex vector

t : real or complex vector

Scilab Group April 1993 162

addf Scilab Function

DESCRIPTION :
the components of vector t are the ArgCosh of the corresponding entries of vector x. Definition domain
is ]1,+infinity[. It takes his values in

]0; + 1[] ;  ] and [0]  [0; ]

EXAMPLE :

x=[0,1,%i];
cosh(acosh(x))

1.3.4 acoshm matrix hyperbolic inverse cosine

CALLING SEQUENCE :

t=acoshm(x)

PARAMETERS :

x,t : real or complex square matrix

DESCRIPTION :
acoshm is the matrix hyperbolic inverse cosine of the matrix x. Uses the formula t=logm(x+(x+eye())*sqrtm((x-eye())
For non symmetric matrices result may be inaccurate.
EXAMPLE :

A=[1,2;3,4];
coshm(acoshm(A))
A(1,1)=A(1,1)+%i;
coshm(acoshm(A))

S EE A LSO : acosh 162, logm 196, sqrtm 219

1.3.5 acosm matrix wise cosine inverse

CALLING SEQUENCE :

t=acosm(x)

PARAMETERS :

x : real or complex square matrix

t : real or complex square matrix

DESCRIPTION :
t are cosine inverse of the x matrix. Diagonalization method is used. For nonsymmetric matrices result
may be inaccurate.One has t=-%i*logm(x+%i*sqrtm(eye()-x*x))
EXAMPLE :

A=[1,2;3,4];
cosm(acosm(A))

S EE A LSO : acos 162, sqrtm 219, logm 196

Scilab Group April 1993 163

adj2sp Scilab Function

1.3.6 addf symbolic addition

CALLING SEQUENCE :

addf("a","b")

PARAMETERS :

"a","b" : character strings

DESCRIPTION :
addf("a","b") returns the character string "a+b". Trivial simplifications such as addf("0","a")
or addf("1",2") are performed.
EXAMPLE :

addf(’0’,’1’)
addf(’1’,’a’)
addf(’1’,’2’)
’a’+’b’

S EE A LSO : mulf 203, subf 222, ldivf 194, rdivf 208, eval 184, evstr 35

1.3.7 adj2sp converts adjacency form into sparse matrix.

CALLING SEQUENCE :
A = adj2sp(xadj,adjncy,anz) A = adj2sp(xadj,adjncy,anz,mn)
PARAMETERS :

.TP 7
xadj
: integer vector of length (n+1).
.TP 7
adjncy
: integer vector of length nz containing the row indices
for the corresponding elements in anz
.TP 7
anz
: column vector of length nz, containing the non-zero
elements of A
.TP 7
mn
: row vector with 2 entries, \fVmn=size(A)\fR (optional).
.TP 7
A
: real or complex sparse matrix (nz non-zero entries)

DESCRIPTION :

\fVsp2adj\fR converts an adjacency form representation of a matrix

into its standard Scilab representation (utility fonction).
\fVxadj, adjncy, anz\fR = adjacency representation of \fVA\fR i.e:
.LP
\fVxadj(j+1)-xadj(j)\fR = number of non zero entries in row j.
\fVadjncy\fR = column index of the non zeros entries

Scilab Group JUN 1997 164

asin Scilab Function

in row 1, row 2,..., row n.

\fVanz\fR = values of non zero entries in row 1, row 2,..., row n.
\fVxadj\fR is a (column) vector of size n+1 and
\fVadjncy\fR is an integer (column) vector of size \fVnz=nnz(A)\fR.
\fVanz\fR is a real vector of size \fVnz=nnz(A)\fR.

EXAMPLE :

A = sprand(100,50,.05);
[xadj,adjncy,anz]= sp2adj(A);
[n,m]=size(A);
p = adj2sp(xadj,adjncy,anz,[n,m]);
A-p,

S EE A LSO : sp2adj 213, spcompack 215

1.3.8 amell Jacobi’s am function

CALLING SEQUENCE :

[sn]=amell(u,k)

PARAMETERS :

u : real scalar or vector

k : scalar
sn : real scalar or vector

DESCRIPTION :
Computes Jacobi’s elliptic function am(u,k) where k is the parameter and u is the argument. If u is
a vector sn is the vector of the (element wise) computed values. Used in function %sn.
S EE A LSO : delip 180, %sn 446, %asn 445

1.3.9 and - logical and

CALLING SEQUENCE :

b=and(A), b=and(A,’*’)
b=and(A,’r’), b=and(A,1)
b=and(A,’c’), b=and(A,2)
A&B

DESCRIPTION :
and(A) is the logical AND of elements of the boolean matrix A. and(A) returns %T (”true”) iff all
entries of A are %T.
y=and(A,’r’) (or, equivalently, y=and(A,1)) is the rowwise and. It returns in each entry of the row
vector y the and of the rows of x (The and is performed on the row index : y(j)= and(A(i,j),i=1,m)).
y=and(A,’c’) (or, equivalently, y=and(A,2)) is the columnwise and. It returns in each entry of
the column vector y the and of the columns of x (The and is performed on the column index: y(i)=
and(A(i,j),j=1,n))).
A&B gives the element-wise logical and of the booleans matrices A and B .A and B must be matri-
ces with the same dimensions or one from them must be a single boolean.
S EE A LSO : not 204, or 205

Scilab Group April 1993 165

asinhm Scilab Function

1.3.10 asin sine inverse

CALLING SEQUENCE :

[t]=asin(x)

PARAMETERS :

x : real or complex vector/matrix

t : real or complex vector/matrix

DESCRIPTION :
The entries of t are sine inverse of the corresponding entries of x. Definition domain is [-1, 1]. It takes
his values in sets
] =2; =2[] 1 + 1[
[ =2]  [0; +1] and [=2]] 1; 0] (real x imag)

EXAMPLE :

A=[1,2;3,4]
sin(asin(A))

S EE A LSO : sin 210, sinm 211, asinm 167

1.3.11 asinh hyperbolic sine inverse

CALLING SEQUENCE :

[t]=asinh(x)

PARAMETERS :

x : real or complex vector/matrix

t : real or complex vector/matrix

DESCRIPTION :
The entries of t are the hyperbolic sine inverse of the corresponding entries of x. Definition domain is
]-1,i[ It takes his values in sets
] 1 + 1[] =2; =2[
[ 1; 0[[ =2] and [0; 1]  [=2] (real x imag)

EXAMPLE :

A=[1,2;2,3]
sinh(asinh(A))

Scilab Group April 1993 166

atan Scilab Function

1.3.12 asinhm matrix hyperbolic inverse sine

CALLING SEQUENCE :

t=asinhm(x)

PARAMETERS :

x,t : real or complex square matrix

DESCRIPTION :
asinhm is the matrix hyperbolic inverse sine of the matrix x. Uses the formula t=logm(x+sqrtm(x*x+eye())).
Results may be not reliable for non-symmetric matrix.
EXAMPLE :

A=[1,2;2,3]
sinhm(asinhm(A))

S EE A LSO : asinh 166, logm 196, sqrtm 219

1.3.13 asinm matrix wise sine inverse

CALLING SEQUENCE :

t=asinm(x)

PARAMETERS :

x : real or complex square matrix

t : real or complex square matrix

DESCRIPTION :
t are sine inverse of the x matrix. Diagonalization method is used. For non symmetric matrices result
may be inaccurate.
EXAMPLE :

A=[1,2;3,4]
sinm(asinm(A))
asinm(A)+%i*logm(%i*A+sqrtm(eye()-A*A))

S EE A LSO : asin 166, sinm 211

1.3.14 atan 2-quadrant and 4-quadrant inverse tangent

CALLING SEQUENCE :

phi=atan(x)
phi=atan(y,x)

PARAMETERS :

x : real or complex scalar, vector or matrix

phi : real or complex scalar, vector or matrix
x, y : real scalars, vectors or matrices of the same size

Scilab Group April 2001 167

atanhm Scilab Function

phi : real scalar, vector or matrix

DESCRIPTION :
The first form computes the 2-quadrant inverse tangent, which is the inverse of tan(phi). For real x,
phi is in the interval (-pi/2, pi/2). For complex x, atan has two singular, branching points +%i,-%i
and the chosen branch cuts are the two imaginary half-straight lines [i, i*oo) and (-i*oo, -i].
The second form computes the 4-quadrant arctangent (‘atan2’ in Fortran), this is, it returns the argument
(angle) of the complex number x+i*y. The range of atan(y,x) is (-pi, pi].
For real arguments, both forms yield identical values if x>0.
In case of vector or matrix arguments, the evaluation is done element-wise, so that phi is a vector or
matrix of the same size with phi(i,j)=atan(x(i,j)) or phi(i,j)=tan(y(i,j),x(i,j)).
EXAMPLES :

// examples with the second form

x=[1,%i,-1,%i]
phasex=atan(imag(x),real(x))
atan(0,-1)
atan(-%eps,-1)

// branch cuts, [+i, i*oo) and (-i*oo, -i]

atan(-%eps + 2*%i)
atan(+%eps + 2*%i)
atan(-%eps - 2*%i)
atan(+%eps - 2*%i)

// values at the branching points

ieee(2)
atan(%i)
atan(-%i)

S EE A LSO : tan 225, ieee 50

1.3.15 atanh hyperbolic tangent inverse

CALLING SEQUENCE :

t=atanh(x)

PARAMETERS :

x : real or complex vector/matrix

t : real or complex vector/matrix

DESCRIPTION :
The components of vector t are the hyperbolic tangent inverse of the corresponding entries of vector x.
Definition domain is ]-1,1[
This function takes values in
] 1 + 1[] =2; =2[
[ 1; 0[[ =2] and ]0; 1[[=2] (real x imag)

EXAMPLE :

x=[0,%i,-%i]
tanh(atanh(x))

Scilab Group April 1993 168

besseli Scilab Function

1.3.16 atanhm matrix hyperbolic tangent inverse

CALLING SEQUENCE :

t=atanhm(x)

PARAMETERS :

x : real or complex square matrix

t : real or complex square matrix

DESCRIPTION :
atanhm(x) is the matrix hyperbolic tangent inverse of matrix x. Results may be inaccurate if x is not
symmetric.
EXAMPLE :

A=[1,2;3,4];
tanhm(atanhm(A))

S EE A LSO : atanh 168, tanhm 226

1.3.17 atanm square matrix tangent inverse

CALLING SEQUENCE :

[t]=atanm(x)

PARAMETERS :

x : real or complex square matrix

t : real or complex square matrix

DESCRIPTION :
atanm(x) is the matrix arctangent of the matrix x. Result may be not reliable if x is not symmetric.
EXAMPLE :

tanm(atanm([1,2;3,4]))

S EE A LSO : atan 167

1.3.18 besseli Modified I sub ALPHA Bessel functions of the first kind.

CALLING SEQUENCE :

y = besseli(alpha,x)
y = besseli(alpha,x,ice)

PARAMETERS :

x : real vector with non negative entries

alpha : real vector with non negative entries regularly spaced with increment equal to one alpha=alpha0+(n1:n2)
ice : integer flag, with default value 1

Scilab Group September 1997 169

besselk Scilab Function

DESCRIPTION :

besseli(alpha,x) computes I sub ALPHA modified Bessel functions of the first kind, for real,
non-negative order alpha and argument x. alpha and x may be vectors. The output is m-by-n with m
= size(x,’*’), n = size(alpha,’*’) whose (i,j) entry is besseli(alpha(j),x(i)).
If ice is equal to 2 exponentialy scaled Bessel functions is computed
EXAMPLE :

besseli(0.5:3,1:4)
besseli(0.5:3,1:4,2)

S EE A LSO : besselj 170, besselk 170

1.3.19 besselj Modified J sub ALPHA Bessel functions of the first kind.

CALLING SEQUENCE :

y = besselj(alpha,x)

PARAMETERS :

x : real vector with non negative entries

alpha : real vector with non negative entries regularly spaced with increment
equal to one alpha=alpha0+(n1:n2)
ice : integer flag, with default value 1

DESCRIPTION :

besselj(alpha,x) computes J sub ALPHA modified Bessel functions of the first kind, for real,
non-negative order alpha and argument x. alpha and x may be vectors. The output is m-by-n with m
= size(x,’*’), n = size(alpha,’*’) whose (i,j) entry is besselj(alpha(j),x(i)).
EXAMPLE :

besselj(0.5:3,1:4)

S EE A LSO : besseli 169, besselk 170

1.3.20 besselk Modified K sub ALPHA Bessel functions of the second kind.

CALLING SEQUENCE :

y = besselk(alpha,x)
y = besselk(alpha,x,ice)

PARAMETERS :

x : real vector with non negative entries

alpha : real vector with non negative entries regularly spaced with increment equal to one alpha=alpha0+(n1:n2)
ice : integer flag, with default value 1

Scilab Group September 1997 170

bloc2exp Scilab Function

DESCRIPTION :

besselk(alpha,x) computes K sub ALPHA modified Bessel functions of the second kind, for
real, non-negative order alpha and argument x. alpha and x may be vectors. The output is m-by-n
with m = size(x,’*’), n = size(alpha,’*’) whose (i,j) entry is besselk(alpha(j),x(i)).
If ice is equal to 2 exponentialy scaled Bessel functions is computed
EXAMPLE :

besselk(0.5:3,1:4)
besselk(0.5:3,1:4,2)

S EE A LSO : besselj 170, besseli 169, bessely 171

1.3.21 bessely Modified Y sub ALPHA Bessel functions of the second kind.

CALLING SEQUENCE :

y = bessely(alpha,x)

PARAMETERS :

x : real vector with non negative entries

alpha : real vector with non negative entries regularly spaced with increment
equal to one alpha=alpha0+(n1:n2)

DESCRIPTION :
bessely(alpha,x) computes K sub ALPHA modified Bessel functions of the second kind, for real,
non-negative order alpha and argument x. alpha and x may be vectors. The output is m-by-n with m
= size(x,’*’), n = size(alpha,’*’) whose (i,j) entry is bessely(alpha(j),x(i)).
EXAMPLE :

bessely(0.5:3,1:4)

S EE A LSO : besselj 170, besseli 169, besselk 170

1.3.22 binomial binomial distribution

CALLING SEQUENCE :

pr=binomial(p,n)

PARAMETERS :

pr : vector, pr(k) = probability (X=k) , with X=B(n,p).

p : real number
n : integer

DESCRIPTION :
pr=binomial(p,n) return a binomial probability vector. pr(k) = probability (X=k) , with X=B(n,p)
i.e the probability of k success in n independent trials, (p = proba. of one success). pr(k) = C(n,k)
pˆk (1-p)ˆ(n-k) with C(n,k)= n!/(k!(n-k)!) = prod(1:n)/(prod(1:k)*prod(1:n-k)).
EXAMPLE :

Scilab Group April 1993 171

bloc2exp Scilab Function

n=10;p=0.3;plot2d3(0:n,binomial(p,n));
n=100;p=0.3;
mea=n*p;sigma=sqrt(n*p*(1-p));
x=( (0:n)-mea )/sigma;
plot2d(x,sigma*binomial(p,n));
deff(’y=Gauss(x)’,’y=1/sqrt(2*%pi)*exp(-(x.ˆ2)/2)’)
plot2d(x,Gauss(x));

S EE A LSO : cdfbin 638

1.3.23 bloc2exp block-diagram to symbolic expression

CALLING SEQUENCE :

[str]=bloc2exp(blocd)
[str,names]=bloc2exp(blocd)

PARAMETERS :

blocd : list
str : string
names : string

DESCRIPTION :
given a block-diagram representation of a linear system bloc2exp returns its symbolic evaluation. The
first element of the list blocd must be the string ’blocd’. Each other element of this list (blocd(2),blocd(3),...)
is itself a list of one the following types :

list(’transfer’,’name_of_linear_system’)

list(’link’,’name_of_link’,
[number_of_upstream_box,upstream_box_port],
[downstream_box_1,downstream_box_1_portnumber],
[downstream_box_2,downstream_box_2_portnumber],
...)

The strings ’transfer’ and ’links’ are keywords which indicate the type of element in the
block diagram.
Case 1 : the second parameter of the list is a character string which may refer (for a possible further
evaluation) to the Scilab name of a linear system given in state-space representation (syslin list) or in
transfer form (matrix of rationals).
To each transfer block is associated an integer. To each input and output of a transfer block is also associated
its number, an integer (see examples)
Case 2 : the second kind of element in a block-diagram representation is a link. A link links one output
of a block represented by the pair [number of upstream box,upstream box port], to different
inputs of other blocks. Each such input is represented by the pair [downstream box i,downstream box i portnumber].
The different elements of a block-diagram can be defined in an arbitrary order.
For example
[1] S1*S2 with unit feedback.
There are 3 transfers S1 (number n s1=2) , S2 (number n s2=3) and an adder (number n add=4) with
symbolic transfer function [’1’,’1’].
There are 4 links. The first one (named ’U’) links the input (port 0 of fictitious block -1, omitted) to port
1 of the adder. The second and third one link respectively (output)port 1 of the adder to (input)port 1 of
system S1, and (output)port 1 of S1 to (input)port 1 of S2. The fourth link (named ’Y’) links (output)port
1 of S2 to the output (port 0 of fictitious block -1, omitted) and to (input)port 2 of the adder.

Scilab Group April 1993 172

bloc2ss Scilab Function

//Initialization
syst=list(’blocd’); l=1;
//
//Systems
l=l+1;n_s1=l;syst(l)=list(’transfer’,’S1’); //System 1
l=l+1;n_s2=l;syst(l)=list(’transfer’,’S2’); //System 2
l=l+1;n_adder=l;syst(l)=list(’transfer’,[’1’,’1’]); //adder
//
//Links
// Inputs -1 --> input 1
l=l+1;syst(l)=list(’link’,’U’,[-1],[n_adder,1]);
// Internal
l=l+1;syst(l)=list(’link’,’ ’,[n_adder,1],[n_s1,1]);
l=l+1;syst(l)=list(’link’,’ ’,[n_s1,1],[n_s2,1]);
// Outputs // -1 -> output 1
l=l+1;syst(l)=list(’link’,’Y’,[n_s2,1],[-1],[n_adder,2]);
//Evaluation call
w=bloc2exp(syst);

The result is the character string: w=-(s2*s1-eye())s1.

Note that invoked with two output arguments, [str,names]= blocd(syst) returns in names the
list of symbolic names of named links. This is useful to set names to inputs and outputs.

[2] second example

//Initialization
syst=list(’blocd’); l=1;
//
//System (2x2 blocks plant)
l=l+1;n_s=l;syst(l)=list(’transfer’,[’P11’,’P12’;’P21’,’P22’]);
//
//Controller
l=l+1;n_k=l;syst(l)=list(’transfer’,’k’);
//
//Links
l=l+1;syst(l)=list(’link’,’w’,[-1],[n_s,1]);
l=l+1;syst(l)=list(’link’,’z’,[n_s,1],[-1]);
l=l+1;syst(l)=list(’link’,’u’,[n_k,1],[n_s,2]);
l=l+1;syst(l)=list(’link’,’y’,[n_s,2],[n_k,1]);
//Evaluation call
w=bloc2exp(syst);

In this case the result is a formula equivalent to the usual one:

P11+P12*invr(eye()-K*P22)*K*P21;
S EE A LSO : bloc2ss 173
AUTHOR : S. S., F. D. (INRIA)

1.3.24 bloc2ss block-diagram to state-space conversion

CALLING SEQUENCE :

[sl]=bloc2ss(blocd)

Scilab Group April 1993 173

bloc2ss Scilab Function

PARAMETERS :

blocd : list
sl : list

DESCRIPTION :
Given a block-diagram representation of a linear system bloc2ss converts this representation to a state-
space linear system. The first element of the list blocd must be the string ’blocd’. Each other element
of this list is itself a list of one the following types :

list(’transfer’,’name_of_linear_system’)

list(’link’,’name_of_link’,
[number_of_upstream_box,upstream_box_port],
[downstream_box_1,downstream_box_1_portnumber],
[downstream_box_2,downstream_box_2_portnumber],
...)

The strings ’transfer’ and ’links’ are keywords which indicate the type of element in the
block diagram.
Case 1 : the second parameter of the list is a character string which may refer (for a possible further
evaluation) to the Scilab name of a linear system given in state-space representation (syslin list) or in
transfer form (matrix of rationals).
To each transfer block is associated an integer. To each input and output of a transfer block is also associated
its number, an integer (see examples)
Case 2 : the second kind of element in a block-diagram representation is a link. A link links one output
of a block represented by the pair [number of upstream box,upstream box port], to different
inputs of other blocks. Each such input is represented by the pair [downstream box i,downstream box i portnumber].
The different elements of a block-diagram can be defined in an arbitrary order.
For example
[1] S1*S2 with unit feedback.
There are 3 transfers S1 (number n s1=2) , S2 (number n s2=3) and an adder (number n add=4) with
symbolic transfer function [’1’,’1’].
There are 4 links. The first one (named ’U’) links the input (port 0 of fictitious block -1, omitted) to port
1 of the adder. The second and third one link respectively (output)port 1 of the adder to (input)port 1 of
system S1, and (output)port 1 of S1 to (input)port 1 of S2. The fourth link (named ’Y’) links (output)port
1 of S2 to the output (port 0 of fictitious block -1, omitted) and to (input)port 2 of the adder.
//Initialization
syst=list(’blocd’); l=1;
//
//Systems
l=l+1;n_s1=l;syst(l)=list(’transfer’,’S1’); //System 1
l=l+1;n_s2=l;syst(l)=list(’transfer’,’S2’); //System 2
l=l+1;n_adder=l;syst(l)=list(’transfer’,[’1’,’1’]); //adder
//
//Links
// Inputs -1 --> input 1
l=l+1;syst(l)=list(’link’,’U1’,[-1],[n_adder,1]);
// Internal
l=l+1;syst(l)=list(’link’,’ ’,[n_adder,1],[n_s1,1]);
l=l+1;syst(l)=list(’link’,’ ’,[n_s1,1],[n_s2,1]);
// Outputs // -1 -> output 1
l=l+1;syst(l)=list(’link’,’Y’,[n_s2,1],[-1],[n_adder,2]);
With s=poly(0,’s’);S1=1/(s+1);S2=1/s; the result of the evaluation call sl=bloc2ss(syst);
is a state-space representation for 1/(sˆ2+s-1).

Scilab Group April 1993 174

calerf Scilab Function

[2] LFT example

//Initialization
syst=list(’blocd’); l=1;
//
//System (2x2 blocks plant)
l=l+1;n_s=l;syst(l)=list(’transfer’,[’P11’,’P12’;’P21’,’P22’]);
//
//Controller
l=l+1;n_k=l;syst(l)=list(’transfer’,’k’);
//
//Links
l=l+1;syst(l)=list(’link’,’w’,[-1],[n_s,1]);
l=l+1;syst(l)=list(’link’,’z’,[n_s,1],[-1]);
l=l+1;syst(l)=list(’link’,’u’,[n_k,1],[n_s,2]);
l=l+1;syst(l)=list(’link’,’y’,[n_s,2],[n_k,1]);

With

P=syslin(’c’,A,B,C,D);
P11=P(1,1);
P12=P(1,2);
P21=P(2,1);
P22=P(2,2);
K=syslin(’c’,Ak,Bk,Ck,Dk);

bloc2exp(syst) returns the evaluation the lft of P and K.

S EE A LSO : bloc2exp 172
AUTHOR : S. S., F. D. (INRIA)

1.3.25 calerf computes error functions.

CALLING SEQUENCE :
y = calerf(x,flag)
PARAMETERS :

x : real vector
flag : integer indicator
y : real vector (of same size)

DESCRIPTION :
calerf(x,0) computes the error function:

p
y = 2= 
Z x
exp( t2 )dt
0

calerf(x,1) computes the complementary error function:

Z 1
p
y = 2=  exp( t2 )dt
x

y=1 erf (x)

Scilab Group December 1994 175

conj Scilab Function

calerf(x,2) computes the scaled complementary error function:

1
y = exp(x2 )erfc(x) for large x
xsqrt

EXAMPLE :

deff(’y=f(t)’,’y=exp(-tˆ2)’);
calerf(1,0)
2/sqrt(%pi)*intg(0,1,f)

S EE A LSO : erf 182, erfc 183, calerf 175

1.3.26 ceil rounding up

CALLING SEQUENCE :

[y]=ceil(x)

PARAMETERS :

x : a real matrix
y : integer matrix

DESCRIPTION :
ceil(x) returns an integer matrix made of rounded up elements
EXAMPLE :

ceil([1.9 -2.5])-[2,-2]
ceil(-%inf)
x=rand()*10ˆ20;ceil(x)-x

S EE A LSO : round 209, floor 185, int 188

1.3.27 cmb lin symbolic linear combination

CALLING SEQUENCE :

[x]=cmb_lin(alfa,x,beta,y)

DESCRIPTION :
Evaluates alfa*x-beta*y. alfa, beta, x, y are character strings. (low-level routine)
S EE A LSO : mulf 203, addf 164

1.3.28 conj conjugate

CALLING SEQUENCE :

[y]=conj(x)

PARAMETERS :

x,y : real or complex matrix.

Scilab Group April 1993 176

coshm Scilab Function

DESCRIPTION :
conj(x) is the complex conjugate of x.
EXAMPLE :

x=[1+%i,-%i;%i,2*%i];
conj(x)
x’-conj(x) //x’ is conjugate transpose

1.3.29 cos cosine function

CALLING SEQUENCE :

[y]=cos(x)

PARAMETERS :

x : real or complex vector/matrix

DESCRIPTION :
For a vector or a matrix, cos(x) is the cosine of its elements . For matrix cosine use cosm(X) function.

EXAMPLE :

x=[0,1,%i]
acos(cos(x))

S EE A LSO : cosm 178

1.3.30 cosh hyperbolic cosine

CALLING SEQUENCE :

[t]=cosh(x)

PARAMETERS :

x,t : real or complex vectors/matrices

DESCRIPTION :
The elements of t are the hyperbolic cosine of the corresponding entries of vector x.
EXAMPLE :

x=[0,1,%i]
acosh(cosh(x))

S EE A LSO : cos 177, acosh 162

Scilab Group April 1993 177

coth Scilab Function

1.3.31 coshm matrix hyperbolic cosine

CALLING SEQUENCE :

t=coshm(x)
PARAMETERS :

x,t : real or complex square matrix

DESCRIPTION :
coshm is the matrix hyperbolic cosine of the matrix x. t=(expm(x)+expm(-x))/2. Result may be
inaccurate for nonsymmetric matrix.
EXAMPLE :

A=[1,2;2,4]
acoshm(coshm(A))

S EE A LSO : cosh 177, expm 509

1.3.32 cosm matrix cosine function

CALLING SEQUENCE :

t=cosm(x)
PARAMETERS :

x : real or complex square matrix

DESCRIPTION :
cosm(x) is the matrix cosine of the x matrix. t=0.5*(expm(%i*x)+expm(-%i*x)).
EXAMPLE :

A=[1,2;3,4]
cosm(A)-0.5*(expm(%i*A)+expm(-%i*A))

S EE A LSO : cos 177, expm 509

1.3.33 cotg cotangent

CALLING SEQUENCE :

[t]=cotg(x)
PARAMETERS :

x,t : real or complex vectors/matrices

DESCRIPTION :
The elements of t are the cotangents of the corresponding entries of x. t=cos(x)./sin(x)
EXAMPLE :

x=[1,%i];
cotg(x)-cos(x)./sin(x)

S EE A LSO : tan 225

Scilab Group April 1993 178

cumprod Scilab Function

1.3.34 coth hyperbolic cotangent

CALLING SEQUENCE :

[t]=coth(x)

DESCRIPTION :
the elements of vector t are the hyperbolic cotangent of elements of the vector x.
EXAMPLE :

x=[1,2*%i]
t=exp(x);
(t-ones(x)./t).\\(t+ones(x)./t)
coth(x)

S EE A LSO : cotg 178

1.3.35 cothm matrix hyperbolic cotangent

CALLING SEQUENCE :

[t]=cothm(x)

DESCRIPTION :
cothm(x) is the matrix hyperbolic cotangent of the square matrix x.
EXAMPLE :

A=[1,2;3,4];
cothm(A)

S EE A LSO : coth 179

1.3.36 cumprod cumulative product

CALLING SEQUENCE :

y=cumprod(x)
y=cumprod(x,’r’) or y=cumprod(x,1)
y=cumprod(x,’c’) or y=cumprod(x,2)

PARAMETERS :

x : vector or matrix (real or complex)

y : vector or matrix (real or complex)

DESCRIPTION :
For a vector or a matrix x, y=cumprod(x) returns in y the cumulative product of all the entries of x
taken columnwise.
y=cumprod(x,’c’) (or, equivalently, y=cumprod(x,2)) returns in y the cumulative elementwise
product of the columns of x: y(i,:)=cumprod(x(i,:))
y=cumprod(x,’r’) (or, equivalently, y=cumprod(x,2)) returns in y the cumulative elementwise
product of the rows of x: y(:,i)=cumprod(x(:,i)).
EXAMPLE :

Scilab Group April 1993 179

delip Scilab Function

A=[1,2;3,4];
cumprod(A)
cumprod(A,’r’)
cumprod(A,’c’)
rand(’seed’,0);
a=rand(3,4);
[m,n]=size(a);
w=zeros(a);
w(1,:)=a(1,:);
for k=2:m;w(k,:)=w(k-1,:).*a(k,:);end;w-cumprod(a,’r’)

S EE A LSO : cumprod 179, sum 222

1.3.37 cumsum cumulative sum

CALLING SEQUENCE :

y=cumsum(x)
y=cumsum(x,’r’) or y=cumsum(x,1)
y=cumsum(x,’c’) or y=cumsum(x,2)

PARAMETERS :

x : vector or matrix (real or complex)

y : vector or matrix (real or complex)

DESCRIPTION :
For a vector or a matrix x, y=cumsum(x) returns in y the cumulative sum of all the entries of x taken
columnwise.
y=cumsum(x,’c’) (or, equivalently, y=cumsum(x,2)) returns in y the cumulative sum of the columns
of x: y(i,:)=cumsum(x(i,:))
y=cumsum(x,’r’) (or, equivalently, y=cumsum(x,1)) returns in y the cumulative sum of the rows
of x: y(:,i)=cumsum(x(:,i))
EXAMPLE :

A=[1,2;3,4];
cumsum(A)
cumsum(A,’r’)
cumsum(A,’c’)
a=rand(3,4)+%i;
[m,n]=size(a);
w=zeros(a);
w(1,:)=a(1,:);
for k=2:m;w(k,:)=w(k-1,:)+a(k,:);end;w-cumsum(a,’r’)

S EE A LSO : cumprod 179, sum 222

1.3.38 delip elliptic integral

CALLING SEQUENCE :

[r]=delip(x,ck)

PARAMETERS :

Scilab Group April 1993 180

dlgamma Scilab Function

x : real number (or real vector)

ck : real number between -1 and 1
r : real or complex number (or vector)
DESCRIPTION :
returns the value of the elliptic integral with parameter ck :
Z x
1
r= q dx
0 (1 t2 )(1 ck2 t2 )
x real and positive. When called with x a real vector r is evaluated for each entry of x.
EXAMPLE :

ck=0.5;
delip([1,2],ck)
deff(’y=f(t)’,’y=1/sqrt((1-tˆ2)*(1-ckˆ2*tˆ2))’)
intg(0,1,f) //OK since real solution!

S EE A LSO : amell 165, %asn 445, %sn 446

1.3.39 diag diagonal including or extracting

CALLING SEQUENCE :

[y]=diag(vm, [k])
PARAMETERS :

vm : vector or matrix (full or sparse storage)

k : integer (default value 0)
y : vector or matrix
DESCRIPTION :
for vm a (row or column) n-vector diag(vm) returns a diagonal matrix with entries of vm along the
main diagonal.
diag(vm,k) is a (n+abs(k))x(n+abs(k)) matrix with the entries of vm along the kth diagonal.
k=0 is the main diagonal k>0 is for upper diagonals and k<0 for lower diagonals.
For a matrix vm, diag(vm,k) is the column vector made of entries of the kth diagonal of vm. diag(vm)
is the main diagonal of vm. diag(diag(x)) is a diagonal matrix.
If vm is a sparse matrix diag(vm,k) returns a sparse matrix.
To construct a diagonal linear system, use sysdiag.
Note that eye(A).*A returns a diagonal matrix made with the diagonal entries of A. This is valid for any
matrix (constant, polynomial, rational, state-space linear system,...).
EXAMPLE :

diag([1,2])

A=[1,2;3,4];
diag(A) // main diagonal
diag(A,1)

diag(sparse(1:10)) // sparse diagonal matrix

// form a tridiagonal matrix of size 2*m+1

m=5;diag(-m:m) + diag(ones(2*m,1),1) +diag(ones(2*m,1),-1)

S EE A LSO : sysdiag 224, sparse 214

Scilab Group September 1997 181

erf Scilab Function

1.3.40 dlgamma derivative of gammaln function.

CALLING SEQUENCE :

y = dlgamma(x)

PARAMETERS :

x : real vector
y : real vector with same size.

DESCRIPTION :
dlgamma(x) evaluates the derivative of gammaln function at all the elements of x. x must be real.
EXAMPLE :

dlgamma(0.5)

S EE A LSO : gamma 186, gammaln 186

1.3.41 double conversion from integer to double precision representation

CALLING SEQUENCE :

y=double(X)
y=int16(X)
y=int32(X)
y=uint8(X)
y=uint16(X)
y=uint32(X)

PARAMETERS :

X : matrix of floats or integers

y : matrix of floats

DESCRIPTION :
converts data stored using one, two or four bytes integers into double precision floating point representation.
If X entries are already double precision floats, nothing is done.
EXAMPLES :

x=int8([0 12 140])
double(x)

S EE A LSO : int8 188, inttype 54, type 74

1.3.42 erf The error function.

CALLING SEQUENCE :

y = erf(x)

PARAMETERS :

Scilab Group December 1994 182

eval Scilab Function

x : real vector
y : real vector (of same size)
DESCRIPTION :
erf computes the error function:
p Z x
y = 2= ( ) exp( t2 )dt
0

EXAMPLE :
deff(’y=f(t)’,’y=exp(-tˆ2)’);
erf(0.5)-2/sqrt(%pi)*intg(0,0.5,f)

S EE A LSO : erfc 183, erfcx 183, calerf 175

1.3.43 erfc The complementary error function.

CALING SEQUENCE :
y = erfc(x)
PARAMETERS :
x : real vector
y : real vector (of same size)
DESCRIPTION :
erfc computes the complementary error function:
p
Z 1
y = 2= ( ) exp( t2 )dt
x
y=1 erf (x)

EXAMPLE :
erf([0.5,0.2])+erfc([0.5,0.2])

S EE A LSO : erf 182, erfcx 183, calerf 175

1.3.44 erfcx scaled complementary error function.

CALING SEQUENCE :
y = erfcx(x)
PARAMETERS :
x : real vector
y : real vector (of same size)
DESCRIPTION :
erfcx computes the scaled complementary error function:
p
y = exp(x2 )erfc(x) (1= pi)1=xfor largex

S EE A LSO : erf 182, erfc 183, calerf 175

Scilab Group April 1993 183

fix Scilab Function

1.3.45 eval evaluation of a matrix of strings

CALLING SEQUENCE :

[H]= eval(Z)

DESCRIPTION :
returns the evaluation of the matrix of character strings Z.
EXAMPLE :

a=1; b=2; Z=[’a’,’sin(b)’] ; eval(Z) //returns the matrix [1,0.909];

S EE A LSO : evstr 35, execstr 37

1.3.46 eye identity matrix

CALLING SEQUENCE :

X=eye(m,n)
X=eye(A)
X=eye()

PARAMETERS :

A,X : matrices or syslin lists

m,n : integers

DESCRIPTION :
according to its arguments defines an mxn matrix with 1 along the main diagonal or an identity matrix of
the same dimension as A .
Caution: eye(10) is interpreted as eye(A) with A=10 i.e. 1. (It is NOT a ten by ten identity matrix!).
If A is a linear system represented by a syslin list, eye(A) returns an eye matrix of appropriate
dimension: (number of outputs x number of inputs).
eye() produces a identity matrix with undefined dimensions. Dimensions will be defined when this
identity matrix is added to a mtrix with fixed dimensions.
EXAMPLES :

eye(2,3)
A=rand(2,3);eye(A)
s=poly(0,’s’);A=[s,1;s,s+1];eye(A)
A=[1/s,1;s,2];eye(A);
A=ssrand(2,2,3);eye(A)
[1 2;3 4]+2*eye()

S EE A LSO : ones 204, zeros 231

1.3.47 fix rounding towards zero

CALLING SEQUENCE :

[y]=fix(x)

PARAMETERS :

Scilab Group April 1993 184

full Scilab Function

x : a real matrix
y : integer matrix

DESCRIPTION :
fix(x) returns an integer matrix made of nearest rounded integers toward zero,i.e, y=sign(x).*floor(abs(x)).
Same as int.
S EE A LSO : round 209, floor 185, ceil 176

1.3.48 floor rounding down

CALLING SEQUENCE :

[y]=floor(x)

PARAMETERS :

x : a real matrix
y : integer matrix

DESCRIPTION :
floor(x) returns an integer matrix made of nearest rounded down integers.
EXAMPLE :

floor([1.9 -2.5])-[1,-3]
floor(-%inf)
x=rand()*10ˆ20;floor(x)-x

S EE A LSO : round 209, fix 184, ceil 176

1.3.49 frexp dissect floating-point numbers into base 2 exponent and mantissa

CALLING SEQUENCE :

[f,e]=frexp(x)

PARAMETERS :

x : real vector or matrix

f : array of real values, usually in the range 0.5 <= abs(f) < 1.
e : array of integers that satisfy the equation: x = f.*2.ˆe

DESCRIPTION :

This function corresponds to the ANSI C function frexp(). Any zeros in x produce f=0 and e=0.
EXAMPLE :

[f,e]=frexp([1,%pi,-3,%eps])

S EE A LSO : log 195, hat 47, ieee 50, log2 196

Scilab Group January 1995 185

gammaln Scilab Function

1.3.50 full sparse to full matrix conversion

CALING SEQUENCE :

X=full(sp)

PARAMETERS :

sp : real or complex sparse (or full) matrix

X : full matrix

DESCRIPTION :
X=full(sp) converts the sparse matrix sp into its full representation. (If sp is already full then X
equals sp).
EXAMPLE :

sp=sparse([1,2;5,4;3,1],[1,2,3]);
A=full(sp)

S EE A LSO : sparse 214, sprand 218, speye 216

1.3.51 gamma The gamma function.

CALLING SEQUENCE :

y = gamma(x)

PARAMETERS :

x : real vector
y : real vector with same size.

DESCRIPTION :
gamma(x) evaluates the gamma function at all the elements of x. x must be real.
Z 1
y= t( x 1)exp( t)dt
0

gamma(n+1) = n!
EXAMPLE :

gamma(0.5)
gamma(6)-prod(1:5)

S EE A LSO : gammaln 186, dlgamma 182

1.3.52 gammaln The logarithm of gamma function.

CALLING SEQUENCE :

y = gammaln(x)

PARAMETERS :

Scilab Group September 1997 186

imag Scilab Function

x : real vector
y : real vector with same size.

DESCRIPTION :
gammaln(x) evaluates the logarithm of gamma function at all the elements of x, avoiding underflow
and overflow. x must be real.
EXAMPLE :

gammaln(0.5)

S EE A LSO : gamma 186, dlgamma 182

1.3.53 gsort decreasing order sorting

CALLING SEQUENCE :

[s, [k]]=gsort(v )
[s, [k]]=gsort(v,flag1)
[s, [k]]=gsort(v,flag1,flag2)

PARAMETERS :

v,s : real vector/matrix; character string vector/matrix

flag1 : a string ’r’, ’c’,’g’,’lr’ and ’lc’.
flag2 : a string ’i’ for increasing and ’d’ for decreasing order. k : vector or matrix of integers

DESCRIPTION :
gsort is similar to sort with additional properties. The third argument can be used to chose between
increasing or decreasing order. The second argument can be used for lexical orders.
[s,k]=gsort(a,’g’) and [s,k]=gsort(a,’g’,’d’) are the same as [s,k]=gsort(a).
They perform a sort of the entries of matrix a, a being seen as the stacked vector a(:) (columnwise).
[s,k]=gsort(a,’g’,’i’) performs the same operation but in increasing order.
[s,k]=gsort(a,’lr’) sort the rows of the matrix int(a) ( if a is a real matrix) or a (if a is a
character string matrix) in lexical decreasing order. s is obtained by a permutation of the rows of matrix
int(a) (or a) given by the column vector k) in such a way that the rows of s verify s(i,:) >
s(j,:) if i<j. [s,k]=gsort(a,’lr’,’i’) performs the same operation for increasing lexical
order
[s,k]=gsort(a,’lc’) sort the columns of the matrix int(a) ( if a is a real matrix) or a (if a
is a character string matrix) in lexical decreasing order. s is obtained by a permutation of the columns of
matrix int(a) (or a) given by the row vector k) in such a way that the columns of s verify s(:,i) >
s(:,j) if i<j. [s,k]=gsort(a,’lc’,’i’) performs the same operation for increasing lexical
order
EXAMPLE :

alr=[1,2,2;
1,2,1;
1,1,2;
1,1,1];
[alr1,k]=gsort(alr,’lr’,’i’)
[alr1,k]=gsort(alr,’lc’,’i’)

S EE A LSO : find 41

Scilab Group April 1993 187

int8 Scilab Function

1.3.54 imag imaginary part

CALLING SEQUENCE :

[y]=imag(x)

PARAMETERS :

x : real or complex vector or matrix.

y : real vector or matrix.

DESCRIPTION :
imag(x) is the imaginary part of x. (See %i to enter complex numbers).
S EE A LSO : real 208

1.3.55 int integer part

CALLING SEQUENCE :

[y]=int(X)

PARAMETERS :

X : real matrix
y : integer matrix

DESCRIPTION :
int(X) returns the integer part of the real matrix X. Same as fix.
S EE A LSO : round 209, floor 185, ceil 176

1.3.56 int8 conversion to one byte integer representation

int16 - conversion to 2 bytes integer representation
int32 - conversion to 4 bytes integer representation
uint8 - conversion to one byte unsigned integer representation
uint16 - conversion to 2 bytes unsigned integer representation
uint32 - conversion to 4 bytes unsigned integer representation

CALLING SEQUENCE :

y=int8(X)
y=int16(X)
y=int32(X)
y=uint8(X)
y=uint16(X)
y=uint32(X)

PARAMETERS :

X : matrix of floats or integers

y : matrix of integers coded on one, two or four bytes.

DESCRIPTION :
converts and stores data two one, two or four bytes integers. These data types are specialy useful to store
big objects such as images, long signals,...

Scilab Group October 99 188

INTERP Scilab Function

y=int8(X) : return numbers in the range [-128,127]

y=uint8(X) : return numbers in the range [0,255]
y=int16(X) : return numbers in the range [-32768,32767]
y=uint16(X) : return numbers in the range [0, 65535]
y=int32(X) : return numbers in the range [-2147483648,2147483647]
y=uint32(X) : return numbers in the range [0, 4294967295]

EXAMPLE :

int8([1 -120 127 312])

uint8([1 -120 127 312])

x=int32(-200:100:400)
int8(x)

S EE A LSO : double 182, inttype 54, iconvert 49

1.3.57 integrate integration by quadrature

CALLING SEQUENCE :

[x]=integrate(expr,v,x0,x1 [,ea [,er]])

PARAMETERS :

expr : external Scilab

v : string (integration variable)
x0,x1 : real numbers (bounds of integration)
ea,er : real numbers (absolute error bound) Default value: 0
er : real number, (relative error bound) Default value: 1.d-8

DESCRIPTION :
computes : Z x1
x= f (v )dv
x0
The evaluation hopefully satisfies following claim for accuracy: abs(I-x)<= max(ea,er*abs(I))
where I stands for the exact value of the integral.
EXAMPLE :

integrate(’sin(x)’,’x’,0,%pi)
integrate([’if x==0 then 1,’;
’else sin(x)/x,end’],’x’,0,%pi)

S EE A LSO : intg 425, inttrap 192, intsplin 191, ode 431

1.3.58 interp interpolation

CALLING SEQUENCE :

[f0 [,f1 [,f2 [,f3]]]]=interp(xd,x,f,d)

PARAMETERS :

xd : real vector

Scilab Group April 1993 189

intersect Scilab Function

x,f,d : real vectors from spline

fi : vectors (derivatives)

DESCRIPTION :
given three vectors (x,f,d) defining a spline function (see splin) with fi=S(xi), di = S’(xi)
this function evaluates S (resp. S’, S’’, S’’’) at xd(i).
x : vector of xi (x(1) < x(2) < ...)
f : vector of S(xi)
d : vector of S’(xi)
f0 : vector [S(xd(1),S(xd(2)),S(xd(3)),...]
f(1 2 3) : vector of first, second, third derivative of S at xd=[xd(1),xd(2),...] i.e.
f1 = [S’(xd(1)),S’(xd(2)),...]
f2 = [S’’(xd(1)),S’’(xd(2)),...]

S EE A LSO : splin 217, smooth 212, interpln 190

1.3.59 interpln linear interpolation

CALLING SEQUENCE :

[y]=interpln(xyd,x)

PARAMETERS :

xyd : 2 row matrix (xy coordinates of points)

x : vector (abscissae)
y : vector (y-axis values)

DESCRIPTION :
given xyd a set of points in the xy-plane which increasing abscissae and x a set of abscissae, this function
computes y the corresponding y-axis values by linear interpolation.
EXAMPLE :

x=[1 10 20 30 40];
y=[1 30 -10 20 40];
plot2d(x’,y’,[-3],"011"," ",[-10,-40,50,50]);
yi=interpln([x;y],-4:45);
plot2d((-4:45)’,yi’,[3],"000");

S EE A LSO : splin 217, interp 189, smooth 212

1.3.60 intersect returns the vector of common values of two vectors

CALLING SEQUENCE :

[v, [ka,kb]]=intersect(a,b)

PARAMETERS :

a : vector of real numbers or strings

b : vector of real numbers or strings

Scilab Group April 1999 190

intsplin Scilab Function

v : row vector of real numbers or strings

ka : row vector of integers
kb : row vector of integers

DESCRIPTION :
intersect(a,b) returns a sorted row vector of common values of two vectors of a and b.
[v,ka,kb]=intersect(a,b) also returns index vectors ka and kb such that v=a(ka) and v=b(kb).
EXAMPLE :

A=round(5*rand(10,1));
B=round(5*rand(7,1));

intersect(A,B)
[N,ka,kb]=intersect(A,B)

intersect(’a’+string(A),’a’+string(B))

S EE A LSO : unique 230, sort 213, union 230

1.3.61 intsplin integration of experimental data by spline interpolation

CALLING SEQUENCE :

v = intsplin([x,] s)

PARAMETERS :

x : vector of increasing x coordinate data. Default value is 1:size(y,’*’)

s : vector of y coordinate data
v : value of the integral

DESCRIPTION :
computes :
Z x1
v= f (x)dx
x0

Where f is a function described by a set of experimental value:

s(i) = f (x(i))

and
x0 = x(1); x1 = x(n)
Between mesh points function is interpolated using spline’s.
EXAMPLE :

t=0:0.1:%pi
intsplin(t,sin(t))

S EE A LSO : intg 425, integrate 189, inttrap 192, splin 217

Scilab Group April 1993 191

isinf Scilab Function

1.3.62 inttrap integration of experimental data by trapezoidal interpolation

CALLING SEQUENCE :

v = inttrap([x,] s)

PARAMETERS :

x : vector of increasing x coordinate data. Default value is 1:size(y,’*’)

s : vector of y coordinate data
v : value of the integral

DESCRIPTION :
computes : Z x1
v= f (x)dx
x0
Where f is a function described by a set of experimental value:

s(i) = f (x(i))
and
x0 = x(1); x1 = x(n)
Between mesh points function is interpolated linearly.
EXAMPLE :

t=0:0.1:%pi
inttrap(t,sin(t))

S EE A LSO : intg 425, intc 425, intl 426, integrate 189, intsplin 191, splin
217

1.3.63 isdef check variable existence

CALLING SEQUENCE :

isdef(name [,where])

PARAMETERS :

name : a character string

where : an optional character string with default value ’all’

DESCRIPTION :
isdef(name) returns %T if the variable ’var-name’ exists and %F otherwise.
isdef(name,’local’) returns %T if the variable ’var-name’ exists in the local environment
of the current function and %F otherwise.
EXAMPLE :

A=1;
isdef(’A’)
clear A
isdef(’A’)

S EE A LSO : exists 37, whereis 77, type 74, typeof 229, clear 30

Scilab Group April 1993 192

kron Scilab Function

1.3.64 isinf check for infinite entries

CALLING SEQUENCE :
r=isinf(x)
PARAMETERS :
x : real or complex vector or matrix r : boolean vector or matrix
DESCRIPTION :
isinf(x) returns a boolean vector or matrix which contains true entries corresponding with infinite x
entries and false entries corresponding with finite x entries.
EXAMPLE :
isinf([1 0.01 -%inf %inf])
S EE A LSO : isnan 193

1.3.65 isnan check for ”Not a Number” entries

CALLING SEQUENCE :
r=isnan(x)
PARAMETERS :
x : real or complex vector or matrix r : boolean vector or matrix
DESCRIPTION :
isnan(x) returns a boolean vector or matrix which contains true entries corresponding with ”Not a
Number” x entries and false entries corresponding with regular x entries.
EXAMPLE :
isnan([1 0.01 -%nan %inf-%inf])
S EE A LSO : isinf 193

1.3.66 isreal check if a variable as real or complex entries

CALLING SEQUENCE :
t=isreal(x)
t=isreal(x,eps)
PARAMETERS :
x : vector or matrix with floating point entries or coefficients
t : a boolean
DESCRIPTION :
isreal(x) returns true if x is stored as a real variable and false if x stores complex numbers.
isreal(x,eps) returns true if x is stored as a real variable or if maximum absolute value of imaginary
floating points if less or equal than eps.
EXAMPLE :
isreal([1 2])
isreal(1+0*%i)
isreal(1+0*%i,0)
isreal(1+%s)
isreal(sprand(3,3,0.1))

Scilab Group April 1993 193

lex sort Scilab Function

1.3.67 kron Kronecker product (.*.)

CALLING SEQUENCE :

kron(x,y)
x.*.y

DESCRIPTION :
Kronecker tensor product of two matrices x and y. Same as x.*.y . x and y can be sparse matrices.
EXAMPLE :

A=[1,2;3,4];
kron(A,A)
A.*.A
sparse(A).*.sparse(A)
A(1,1)=%i;
kron(A,A)

1.3.68 ldivf left symbolic division

CALLING SEQUENCE :

ldivf(’d’,’c’)

DESCRIPTION :
returns the string ’cnd’ Trivial simplifications such as ’1nc’ = ’c’ are performed.
EXAMPLE :

ldivf(’1’,’1’)
ldivf(’a’,’0’)
ldivf(’a’,’x’)
ldivf(’2’,’4’)

S EE A LSO : rdivf 208, addf 164, mulf 203, evstr 35

1.3.69 lex sort lexicographic matrix rows sorting

CALLING SEQUENCE :

[N, [k]]=lex_sort(M [,sel] [,’unique’])

PARAMETERS :

M : real matrix
N : real matrix
k : column vector of integers

DESCRIPTION :
N=lex sort(M) sorts the rows (as a group) of the matrix M in ascending order. If required the output
argument k contains the ordering: [N,k]=lex sort(M) returns k such as N is uequal to M(k,:)
.
N=lex sort(M,sel [,’unique’]) produces the same result as the following sequence of instruc-
tions:

Scilab Group April 1999 194

log10 Scilab Function

[N,k]=lex_sort(M(:,sel) [,’unique’]);
N=M(k,:)

The ’unique’ flag has to be given if one wants to retain only unique rows in the result. Note that
lex sort(M,sel,’unique’) retains only rows such that M(:,sel) are unique.
EXAMPLE :

M=round(2*rand(20,3));

lex_sort(M)
lex_sort(M,’unique’)
[N,k]=lex_sort(M,[1 3],’unique’)

S EE A LSO : sort 213

1.3.70 linspace linearly spaced vector

CALLING SEQUENCE :

[v]=linspace(x1,x2 [,n])

PARAMETERS :

x1,x2 : real or complex scalars

n : integer (number of values) (default value = 100)
v : real or complex row vector

DESCRIPTION :
Linearly spaced vector. linspace(x1, x2) generates a row vector of n (default value=100) linearly
equally spaced points between x1 and x2.
EXAMPLE :

linspace(1,2,10)

S EE A LSO : logspace 197

1.3.71 log natural logarithm

CALLING SEQUENCE :

y=log(x)

PARAMETERS :

x : constant vector or constant matrix

DESCRIPTION :
log(x) is the ”element-wise” logarithm. y(i,j)=log(x(i,j)). For matrix logarithm see logm.
EXAMPLE :

exp(log([1,%i,-1,-%i]))

S EE A LSO : exp 508, logm 196, ieee 50

Scilab Group April 1993 195

logspace Scilab Function

1.3.72 log10 logarithm

CALLING SEQUENCE :
y=log10(x)
PARAMETERS :
x : vector or matrix
DESCRIPTION :
decimal logarithm.If x is a vector log10(x)=[log10(x1),...,log10(xn)].
EXAMPLE :
10.ˆlog10([1,%i,-1,-%i])
S EE A LSO : log 195, hat 47, ieee 50

1.3.73 log2 base 2 logarithm

CALLING SEQUENCE :
y=log2(x)
PARAMETERS :
x : vector or matrix
DESCRIPTION :
decimal logarithm.If x is a vector log2(x)=[log2(x1),...,log2(xn)].
EXAMPLE :
2.ˆlog2([1,%i,-1,-%i])
S EE A LSO : log 195, hat 47, ieee 50, log10 196, frexp 185

1.3.74 logm square matrix logarithm

CALLING SEQUENCE :
y=logm(x)
PARAMETERS :
x : square matrix
DESCRIPTION :
logm(x) is the matrix logarithm of x. The result is complex if x is not positive or definite positive. If x
is a symmetric matrix, then calculation is made by schur form. Otherwise, x is assumed diagonalizable.
One has expm(logm(x))=x
EXAMPLE :
A=[1,2;3,4];
logm(A)
expm(logm(A))
A1=A*A’;
logm(A1)
expm(logm(A1))
A1(1,1)=%i;
expm(logm(A1))
S EE A LSO : expm 509, log 195

Scilab Group April 1993 196

maxi Scilab Function

1.3.75 logspace logarithmically spaced vector

CALLING SEQUENCE :

logspace(d1,d2, [n])

PARAMETERS :

d1,d2 : real or complex scalar (special meaning for %pi)

n : integer (number of values) (default value = 50)

DESCRIPTION :
returns a row vector of n logarithmically equally spaced points between 10ˆd1 and 10ˆd2. If d2=%pi
then the points are between 10ˆd1 and pi.
EXAMPLE :

logspace(1,2,10)

S EE A LSO : linspace 195

1.3.76 max maximum

CALLING SEQUENCE :

[m [,k]]=max(A)
[m [,k]]=max(A,’c’) or [m [,k]]=max(A,’r’)
[m [,k]]=max(A1,A2,...,An)
[m [,k]]=max(list(A1,A2,...,An))

PARAMETERS :

A : real vector or matrix.

A1,...,An : a set of real vectors or matrices, all of the same size or scalar.

DESCRIPTION :
For A, a real vector or matrix, max(A) is the largest element A. [m,k]=max(A) gives in addition the
index of the maximum. A second argument of type string ’r’ or ’c’ can be used : ’r’ is used to get
a row vector m such that m(j) contains the maximum of the j th column of A (A(:,j)), k(j) gives
the row indice which contain the maximum for column j. ’c’ is used for the dual operation on the rows
of A.
m=max(A1,A2,...,An), where all the Aj are matrices of the same sizes,returns a vector or a ma-
trix m of size size(m)=size(A1) such that m(i)= max( Aj(i)), j=1,...,n. [m,k]=max(A1,A2,...,An)
gives in addition the vector or matrix k. for a fixed i, k(i) is the number of the first Aj(i) achieving
the maximum.
[m,k]=max(list(A1,...,An)) is an equivalent syntax of [m,k]=max(A1,A2,...,An)
EXAMPLE :

[m,n]=max([1,3,1])
[m,n]=max([3,1,1],[1,3,1],[1,1,3])
[m,n]=max([3,-2,1],1)
[m,n]=max(list([3,1,1],[1,3,1],[1,1,3]))
[m,n]=max(list(1,3,1))

S EE A LSO : sort 213, find 41, mini 200

Scilab Group April 1993 197

mean Scilab Function

1.3.77 maxi maximum

CALLING SEQUENCE :

[m [,k]]=maxi(A)
[m [,k]]=maxi(A,’c’) or [m [,k]]=maxi(A,’r’)
[m [,k]]=maxi(A1,A2,...,An)
[m [,k]]=maxi(list(A1,A2,...,An))
PARAMETERS :

A : real vector or matrix.

A1,...,An : a set of real vectors or matrices, all of the same size or scalar.
DESCRIPTION :
For A, a real vector or matrix, maxi(A) is the largest element A. [m,k]=maxi(A) gives in addition
the index of the maximum. A second argument of type string ’r’ or ’c’ can be used : ’r’ is used
to get a row vector m such that m(j) contains the maximum of the j th column of A (A(:,j)), k(j)
gives the row indice which contain the maximum for column j. ’c’ is used for the dual operation on the
rows of A.
m=maxi(A1,A2,...,An), where all the Aj are matrices of the same sizes,returns a vector or a ma-
trix m of size size(m)=size(A1) such that m(i)= max( Aj(i)), j=1,...,n. [m,k]=maxi(A1,A2,...,An)
gives in addition the vector or matrix k. for a fixed i, k(i) is the number of the first Aj(i) achieving
the maximum.
[m,k]=maxi(list(A1,...,An)) is an equivalent syntax of [m,k]=maxi(A1,A2,...,An)

EXAMPLE :

[m,n]=maxi([1,3,1])
[m,n]=maxi([3,1,1],[1,3,1],[1,1,3])
[m,n]=maxi([3,-2,1],1)
[m,n]=maxi(list([3,1,1],[1,3,1],[1,1,3]))
[m,n]=maxi(list(1,3,1))

S EE A LSO : sort 213, find 41, mini 200

1.3.78 mean mean (row mean, column mean) of vector/matrix entries

CALLING SEQUENCE :

y=mean(x)
y=mean(x,’r’)
y=mean(x,’c’)
PARAMETERS :

x : real vector or matrix

y : scalar or vector
DESCRIPTION :
For a vector or a matrix x, y=mean(x) returns in the scalar y the mean of all the entries of x.
y=mean(x,’r’) (or, equivalently, y=mean(x,1)) is the rowwise mean. It returns in each entry of the
column vector y the mean of each row of x.
y=mean(x,’c’) (or, equivalently, y=mean(x,2)) is the columnwise mean. It returns in each
entry of the row vector y the mean of each column of x.
EXAMPLE :

Scilab Group Januray 1998 198

min Scilab Function

A=[1,2,10;7,7.1,7.01];
mean(A)
mean(A,’r’)
mean(A,’c’)

S EE A LSO : sum 222, median 199, st_deviation 221

1.3.79 median median (row median, column median) of vector/matrix entries

CALLING SEQUENCE :

y=median(x)
y=median(x,’r’)
y=median(x,’c’)

PARAMETERS :

x : real vector or matrix

y : scalar or vector

DESCRIPTION :
For a vector or a matrix x, y=median(x) returns in the scalar y the median of all the entries of x.
y=median(x,’r’) (or, equivalently, y=median(x,1)) is the rowwise median. It returns in each
entry of the column vector y the median of each row of x.
y=median(x,’c’) (or, equivalently, y=median(x,2)) is the columnwise median. It returns in
each entry of the row vector y the median of each column of x.
EXAMPLE :

A=[1,2,10;7,7.1,7.01];
median(A)
median(A,’r’)
median(A,’c’)

S EE A LSO : sum 222, mean 198

1.3.80 min minimum

CALLING SEQUENCE :

[m [,k]]=min(A)
[m [,k]]=min(A,’c’) or [m [,k]]=min(A,’r’)
[m [,k]]=min(A1,A2,...,An)
[m [,k]]=min(list(A1,A2,...,An))

PARAMETERS :

A : real vector or matrix.

A1,...,An : a set of real vectors or matrices, all of the same size or scalar.

DESCRIPTION :

For A, a real vector or matrix, min(A) is the smallest element A. [m,k]=min(A) gives in addition
the index of the minimum. A second argument of type string ’r’ or ’c’ can be used : ’r’ is used
to get a row vector m such that m(j) contains the minimum of the j th column of A (A(:,j)), k(j)

Scilab Group April 1993 199

minus Scilab Function

gives the row indice which contain the minimum for column j. ’c’ is used for the dual operation on the
rows of A.
m=min(A1,A2,...,An), where all the Aj are matrices of the same sizes,returns a vector or a ma-
trix m of size size(m)=size(A1) such that m(i)= min( Aj(i)), j=1,...,n. [m,k]=min(A1,A2,...,An)
gives in addition the vector or matrix k. for a fixed i, k(i) is the number of the first Aj(i) achieving
the minimum.
[m,k]=min(list(A1,...,An)) is an equivalent syntax of [m,k]=min(A1,A2,...,An)
EXAMPLE :

[m,n]=min([1,3,1])
[m,n]=min([3,1,1],[1,3,1],[1,1,3])
[m,n]=min(list([3,1,1],[1,3,1],[1,1,3]))
[m,n]=min(list(1,3,1))

S EE A LSO : sort 213, find 41, max 197

1.3.81 mini minimum

CALLING SEQUENCE :

[m [,k]]=mini(A)
[m [,k]]=mini(A,’c’) or [m [,k]]=mini(A,’r’)
[m [,k]]=mini(A1,A2,...,An)
[m [,k]]=mini(list(A1,A2,...,An))

PARAMETERS :

A : real vector or matrix.

A1,...,An : a set of real vectors or matrices, all of the same size or scalar.

DESCRIPTION :
For A, a real vector or matrix, mini(A) is the smallest element A. [m,k]=mini(A) gives in addition
the index of the minimum. A second argument of type string ’r’ or ’c’ can be used : ’r’ is used
to get a row vector m such that m(j) contains the minimum of the j th column of A (A(:,j)), k(j)
gives the row indice which contain the minimum for column j. ’c’ is used for the dual operation on the
rows of A.
m=mini(A1,A2,...,An), where all the Aj are matrices of the same sizes,returns a vector or a ma-
trix m of size size(m)=size(A1) such that m(i)= mini( Aj(i)), j=1,...,n. [m,k]=mini(A1,A2,...,An)
gives in addition the vector or matrix k. for a fixed i, k(i) is the number of the first Aj(i) achieving
the minimum.
[m,k]=mini(list(A1,...,An)) is an equivalent syntax of [m,k]=mini(A1,A2,...,An)

EXAMPLE :

[m,n]=mini([1,3,1])
[m,n]=mini([3,1,1],[1,3,1],[1,1,3])
[m,n]=mini(list([3,1,1],[1,3,1],[1,1,3]))
[m,n]=mini(list(1,3,1))

S EE A LSO : sort 213, find 41, maxi 198, min 199

Scilab Group April 1993 200

mps2linpro Scilab Function

1.3.82 minus - substraction operator, sign changes

CALLING SEQUENCE :

X-Y
-Y

PARAMETERS :

X : scalar or vector or matrix of numbers, polynomials or rationals. It may also be a syslin list
Y : scalar or vector or matrix of numbers, polynomials or rationals. It may also be a syslin list

DESCRIPTION :
Substraction
For numeric operands substraction as its usual meaning. If one of the operands is a matrix and the other one
a scalar the the operation is performed element-wise. if Y==[] X is returned; if X==[] -Y is returned.
Substraction may also be defined for other data types through ”soft-coded” operations.
EXAMPLE :

[1,2]-1
[]-2

%s-2
1/%s-2
"cat"+"enate"

S EE A LSO : addf 164, mtlb_mode 60

1.3.83 modulo symetric arithmetic remainder modulo m

pmodulo - positive arithmetic remainder modulo m

CALLING SEQUENCE :

i=modulo(n,m)
i=pmodulo(n,m)

PARAMETERS :
n,m: integers
DESCRIPTION :
modulo computes i= n (modulo m) i.e. remainder of n divided by m (n and m integers).
i = n - m .* int (n ./ m). Here the answer may be negative if n or m are negative.
pmodulo computes i = n - m .* floor (n ./ m), the answer is positive or zero
EXAMPLE :

n=[1,2,10,15];m=[2,2,3,5];
modulo(n,m)

modulo(-3,9)
pmodulo(-3,9)

Scilab Group MAY 1998 201

mulf Scilab Function

1.3.84 mps2linpro convert lp problem given in MPS format to linpro format

CALLING SEQUENCE :

lp = mps2linpro(mps)
[p,C,b,ci,cs,mi] = mps2linpro(mps)

PARAMETERS :

mps : either a character string, path of the MPS file, or an mps data structure returned by readmps
lp : a linpro data tlist with following fields:
p : real (column) vector (dimension n)
C : real matrix (dimension (mi + md) x n) (If no constraints are given, you can set C = [])
b : RHS vector (dimension 1 x (mi + md))
ci : (column) vector of lower-bounds (dimension n). If there are no lower bound constraints, put ci =
[]. If some components of x are bounded from below, set the other (unconstrained) values of ci
to a very large negative number (e.g. ci(j) = -(% eps)ˆ(-1).
cs : (column) vector of upper-bounds. (Same remarks as above).
mi : number of equality constraints (i.e. C(1:mi,:)*x = b(1:mi))

DESCRIPTION :
mps2linpro forms Linear programing data compatible with linpro out of MPS data format.
S EE A LSO : linpro 429, readmps 256

1.3.85 mtlb sparse convert sparse matrix

CALLING SEQUENCE :

Y=mtlb_sparse(X)

PARAMETERS :

X : sparse matrix
Y : sparse matrix in Matlab format

DESCRIPTION :
Y=mtlb sparse(X) is used to convert X, a Scilab sparse matrix, to Matlab format. Y is the a variable
with type 7, i.e. type(Y) is equal to 7. This function should be used in mexfiles (a Matlab mexfile
containing sparse matrices can be used only if the Scilab sparse matrices are converted to that format). The
functions full and spget work with this format.
Other operations and functions using this format can be overloaded with Scilab functions using the prefix
”%msp”. For instance the function %msp p(x) (see SCIDIR/macros/percent directory) is used to display
such ”type 7” objects.
EXAMPLE :

X=sparse(rand(2,2)); Y=mtlb_sparse(X);
Y, full(Y), [ij,v,mn]=spget(Y)

S EE A LSO : full 186, spget 216

Scilab Group April 1993 202

norm Scilab Function

1.3.86 mulf symbolic multiplication

CALLING SEQUENCE :

mulf(’d’,’c’)

DESCRIPTION :
returns the string ’c*d’ Trivial simplifications such as ’1*c’ = ’c’ are performed.
EXAMPLE :

mulf(’1’,’a’)
mulf(’0’,’a’)
’a’+’b’ //Caution...

S EE A LSO : rdivf 208, addf 164, subf 222

1.3.87 nnz number of non zero entries in a matrix

CALLING SEQUENCE :

n=nnz(X)

PARAMETERS :

X : real or complex sparse (or full) matrix

n : integer, the number of non zero elements in X

DESCRIPTION :
nnz counts the number of non zero entries in a sparse or full matrix
EXAMPLE :

sp=sparse([1,2;4,5;3,10],[1,2,3]);
nnz(sp)
a=[1 0 0 0 2];
nnz(a)

S EE A LSO : spget 216

1.3.88 norm matrix norms

CALLING SEQUENCE :

[y]=norm(x [,flag])

PARAMETERS :

x : real or complex vector or matrix (full or sparse storage)

flag : string (type of norm) (default value =2)

DESCRIPTION :
For matrices

norm(x) : or norm(x,2) is the largest singular value of x (max(svd(x))).

norm(x,1) : The l 1 norm x (the largest column sum : maxi(sum(abs(x),’r’)) ).

Scilab Group April 1993 203

ones Scilab Function

norm(x,’inf’),norm(x,%inf) : The infinity norm of x (the largest row sum : maxi(sum(abs(x),’c’))

).
norm(x,’fro’) : Frobenius norm i.e. sqrt(sum(diag(x’*x)))
For vectors
norm(v,p) : l p norm (sum(v(i)ˆp))ˆ(1/p) .
norm(v) : =norm(v,2) : l 2 norm
norm(v,’inf’) : max(abs(v(i))).

EXAMPLE :

A=[1,2,3];
norm(A,1)
norm(A,’inf’)
A=[1,2;3,4]
max(svd(A))-norm(A)

A=sparse([1 0 0 33 -1])
norm(A)

S EE A LSO : h_norm 382, dhnorm 376, h2norm 381, abs 162

1.3.89 not - logical not

CALLING SEQUENCE :

˜A

DESCRIPTION :
˜A gives the element-wise negation of the elements of the boolean matrix A.
EXAMPLES :

˜[%t %t %f]

S EE A LSO : and 165, or 205, find 41

1.3.90 ones matrix made of ones

CALLING SEQUENCE :

y=ones(m1,m2,...)
y=ones(x)
y=ones()

PARAMETERS :

x,y : matrices
m1, m2,.. : integers

DESCRIPTION :
Returns a matrix made of ones.
ones(m1,m2) returns a (m1,m2) matrix full of ones.
ones(m1,m2,..,mn) : creates a (m1,m2,..,mn) matrix full of ones.

Scilab Group April 1993 204

pertrans Scilab Function

ones(x) returns a matrix full of ones with the same size that x.
ones(x) is also valid for x a syslin list.
Note that ones(3) is ones(a) with a=3 i.e it is NOT a 3x3 matrix!
ones() is eqivalent to ones(1,1).
EXAMPLE :
ones(3)
ones(3,3)
ones(2,3,2)

S EE A LSO : eye 184, zeros 231

1.3.91 or - logical or

CALLING SEQUENCE :
or(A), or(A,’*’)
or(A,’r’), or(A,1)

or(A,’c’), or(A,2)
A|B
DESCRIPTION :
or(A) gives the or of the elements of the boolean matrix A. or(A) is true (%t) iff at least one entry
of A is %t.
y=or(A,’r’) (or, equivalently, y=or(A,1)) is the rowwise or. It returns in each entry of the row
vector y the or of the rows of x (The or is performed on the row index : y(j)= or(A(i,j),i=1,m)).
y=or(A,’c’) (or, equivalently, y=or(A,2)) is the columnwise or. It returns in each entry of the col-
umn vector y the or of the columns of x (The or is performed on the column index: y(i)= or(A(i,j),j=1,n))).
AjB gives the element-wise logical or of the booleans matrices A and B .A and B must be matrices
with the same dimensions or one from them must be a single boolean.
EXAMPLES :
or([%t %t %f])
[%t %t %f]|[%f %t %t]
[%t %t %f]|%f

S EE A LSO : and 165, not 204, find 41

1.3.92 pen2ea pencil to E,A conversion

CALLING SEQUENCE :
[E,A]=pen2ea(Fs)
PARAMETERS :
Fs : matrix pencil s*E-A
E,A : two matrices such that Fs=s*E-A
DESCRIPTION :
Utility function. Given the pencil Fs=s*E-A, returns the matrices E and A.
EXAMPLE :
E=[1,0];A=[1,2];s=poly(0,’s’);
[E,A]=pen2ea(s*E-A)

Scilab Group April 1993 205

rand Scilab Function

1.3.93 pertrans pertranspose

CALLING SEQUENCE :

[Y]=pertrans(X)

PARAMETERS :

X : real or complex matrix

Y : real or complex matrix

DESCRIPTION :
Y=pertrans(X) returns the pertranspose of X, i.e. the symmetric of X w.r.t the second diagonal (utility
function).
EXAMPLE :

A=[1,2;3,4]
pertrans(A)

1.3.94 prod product

CALLING SEQUENCE :

y=prod(x)
y=prod(x,’r’) or y=prod(x,1)
y=prod(x,’c’) or y=prod(x,2)

PARAMETERS :

x : real or complex vector or matrix

y : real or complex scalar or matrix

DESCRIPTION :
For a vector or a matrix x, y=prod(x) returns in the scalar y the prod of all the entries of x, , e.g.
prod(1:n) is n!
y=prod(x,’r’) (or, equivalently, y=prod(x,1))computes the rows elementwise product of x. y is
the row vector: y(i)=prod(x(i,:)).
y=prod(x,’c’) (or, equivalently, y=prod(x,2)) computes the columns elementwise product of x.
y is the column vector: y(i)=prod(x(:,i)).
prod is not implemented for sparse matrices.
EXAMPLE :

A=[1,2;0,100];
prod(A)
prod(A,’c’)
prod(A,’r’)

S EE A LSO : sum 222, cumprod 179

Scilab Group April 1993 206

rat Scilab Function

1.3.95 rand random number generator

CALLING SEQUENCE :

rand(m1,m2,.. [,key])
rand(x [, key])
rand()

rand(key)
rand("seed" [,n])
rand("info")

PARAMETERS :

mi : integers
key : character string with value in "uniform", "normal"
x : a matrix. Only its dimensions are taken into account.

DESCRIPTION :
random matrix generator.
Without key argument the syntaxes below produce random matrices with the current random generator
(default is ”uniform”)

rand(m1,m2) is a random matrix of dimension m1 by m2.

rand(m1,m2,..,mn) is a random matrix of dimension m1 by m2,.. by mn.
rand(a) is a random matrix of same size as a. rand(a) is complex if a is a complex matrix
rand() : with no arguments gives a scalar whose value changes each time it is referenced.

If present, the key argument allows to specifie an other random generator.

rand(’uniform’) The current random generator is set to a uniform random number generator. Ran-
dom numbers are uniformly distributed in the interval (0,1).
rand(’normal’) The current random generator is set to a Gaussian (with mean 0 and variance 1)
random number generator .
str=rand(’info’) return the type of the default random generator (’uniform’ or ’normal’)
IT is possible to (re-)initialize the seed of the rand generator:
rand(’seed’) returns the current value of the seed.
rand(’seed’,n) puts the seed to n. (n=0 at first call).

EXAMPLE :

x=rand(10,10,’uniform’)
rand(’normal’)
rand(’info’)
y=rand(x,’normal’);
x=rand(2,2,2)

S EE A LSO : ssrand 220

1.3.96 rat Floating point rational approximation

CALLING SEQUENCE :

Scilab Group April 1993 207

round Scilab Function

[N,D]=rat(x [,tol])
y=rat(x [,tol])

PARAMETERS :

x : real vector or matrix

n : integer vector or matrix
d : integer vector or matrix
y : real vector or matrix

DESCRIPTION :
[N,D] = rat(x,tol) returns two integer matrices so that N./D is close tox in the sense that
abs(N./D - X) <= tol*abs(x). The rational approximations are generated by truncating con-
tinued fraction expansions. tol = 1.e-6*norm(X,1) is the default. y = rat(x,tol) return
the quotient N./D
S EE A LSO : int 188, round 209
EXAMPLES :

[n,d]=rat(%pi)
[n,d]=rat(%pi,1.d-12)
n/d-%pi

1.3.97 rdivf right symbolic division

CALLING SEQUENCE :

["r"]=ldivf("d","c")

PARAMETERS :

"d","c","r" : strings

DESCRIPTION :
returns the string "c/d" Trivial simplifications such as "c/1" = "c" are performed.
EXAMPLE :

ldivf(’c’,’d’)
ldivf(’1’,’2’)
ldivf(’a’,’0’)

S EE A LSO : ldivf 194

1.3.98 real real part

CALLING SEQUENCE :

[y]=real(x)

PARAMETERS :

x : real or complex vector or matrix

y : real matrix

DESCRIPTION :
real(x) is the real part of x (See %i to enter complex numbers).
S EE A LSO : imag 188

Scilab Group April 1993 208

sin Scilab Function

1.3.99 round rounding

CALLING SEQUENCE :

y=round(x)

PARAMETERS :

x : real or complex matrix

y : integer or complex (with integer real and imag) matrix

DESCRIPTION :
round(x) rounds the elements of x to the nearest integers.
EXAMPLE :

round([1.9 -2.5])-[2,-3]
round(1.6+2.1*%i)-(2+2*%i)
round(-%inf)
x=rand()*10ˆ20;round(x)-x

S EE A LSO : int 188, floor 185, ceil 176

1.3.100 sign sign function

DESCRIPTION :
X=sign(A) returns the matrix made of the signs of A(i,j).For complex A, sign(A) = A./abs(A).
function.
EXAMPLE :

sign(rand(2,3))
sign(1+%i)

S EE A LSO : abs 162

1.3.101 signm matrix sign function

DESCRIPTION :

For square and Hermitian matrices X=sign(A) is matrix sign function.

EXAMPLE :

A=rand(4,4);B=A+A’;X=sign(B);spec(X)

S EE A LSO : sign 209

Scilab Group April 1993 209

sinm Scilab Function

1.3.102 sin sine function

CALLING SEQUENCE :

[t]=sin(x)

PARAMETERS :

x : real or complex vector or matrix

DESCRIPTION :
For a vector or a matrix, sin(x) is the sine of its elements . For matrix sine use sinm(X) function.
EXAMPLE :

asin(sin([1,0,%i]))

S EE A LSO : sinm 211

1.3.103 sinh hyperbolic sine

CALLING SEQUENCE :

[t]=sinh(x)

PARAMETERS :

x,t : real or complex vectors/matrices

DESCRIPTION :
the elements of vector t are the hyperbolic sine of elements of vector x.
EXAMPLE :

asinh(sinh([0,1,%i]))

S EE A LSO : asinh 166

1.3.104 sinhm matrix hyperbolic sine

CALLING SEQUENCE :

t=sinhm(x)

PARAMETERS :

x,t : real or complex square matrix

DESCRIPTION :
sinhm is the matrix hyperbolic sine of the matrix x. t=(expm(x)-expm(-x))/2
EXAMPLE :

A=[1,2;2,3]
asinhm(sinhm(A))
A(1,1)=%i;sinhm(A)-(expm(A)-expm(-A))/2 //Complex case

S EE A LSO : sinh 210

Scilab Group April 1993 210

size Scilab Function

1.3.105 sinm matrix sine function

CALLING SEQUENCE :

t=sinm(x)

PARAMETERS :

x : real or complex square matrix

DESCRIPTION :
sinm(x) is matrix sine of x matrix.
EXAMPLE :

A=[1,2;2,4];
sinm(A)+0.5*%i*(expm(%i*A)-expm(-%i*A))

S EE A LSO : sin 210, asinm 167

1.3.106 size size of objects

CALLING SEQUENCE :

y=size(x [,sel])
[nr,nc]=size(x)

PARAMETERS :

x : matrix (including transfer matrix) or list or linear system (syslin)

y : 1x2 integer vector or integer number
sel : a scalar or a character string
nr,nc : two integers

DESCRIPTION :

Applied to : a matrix (constant, polynomial, string, boolean, rational) x, with only one lhs argument
size returns a 1x2 vector [number of rows, number of columns].
Called with LHS=2, returns nr,nc = [number of rows, number of columns].
sel may be used to specify what dimension to get:
1 or ’r’ : to get the number of rows
2 or ’c’ : to get the number of columns
’*’ : to get the product of rows and column numbers
Applied to: a list it returns the number of elements. In this case only y=size(x) syntax can be
used
Applied to: a linear system, y=size(x) returns in y the (row) vector [number of outputs, number
if inputs] i.e. the dimension of the corresponding transfer matrix. The syntax [nr,nc]=size(x)
is also valid (with (nr,nc)=(y(1),y(2)).
If x is a linear system in state-space form, then [nr,nc,nx]=size(x) returns in addition the
dimension nx of the A matrix of x.
Applied to: an hypermatrix y=size(x) returns the vector of hypermatrix dimensions. [n1,n2,...nn]=size(x)
returns the hypermatrix dimensions. ni=size(x,i) returns the ith dimension and size(x,’*’) re-
turns the product of dimensions.

EXAMPLES :

Scilab Group April 1993 211

sort Scilab Function

[n,m]=size(rand(3,2))
[n,m]=size([’a’,’b’;’c’,’d’])
x=ssrand(3,2,4);[ny,nu]=size(x)
[ny,nu]=size(ss2tf(x))
[ny,nu,nx]=size(x)

S EE A LSO : length 281, syslin 224

1.3.107 smooth smoothing by spline functions

CALLING SEQUENCE :

[pt]=smooth(ptd [,step])

PARAMETERS :

ptd : (2xn) real vector

step : real (discretization step of abscissae) (default=0.01*magnitude(v))
pt : (2xn) real vector

DESCRIPTION :
this function computes interpolation by spline functions for a given set of points in the plane. The coor-
dinates are (ptd(1,i),ptd(2,i)). The components ptd(1,:) must be in ascending order. The
default value for the step is abs(maxi(ptd(1,:))-mini(ptd(1,:)))/100
EXAMPLE :

x=[1 10 20 30 40];
y=[1 30 -10 20 40];
plot2d(x’,y’,[3],"011"," ",[-10,-40,50,50]);
yi=smooth([x;y],0.1);
plot2d(yi(1,:)’,yi(2,:)’,[1],"000");

S EE A LSO : splin 217, interp 189, interpln 190

1.3.108 solve symbolic linear system solver

CALLING SEQUENCE :

[x]=solve(A,b)

PARAMETERS :

A,b,c : matrix (resp. vectors) of character strings

DESCRIPTION :
solves A*x = b when A is an upper triangular matrix made of character strings.
EXAMPLE :

A=[’1’,’a’;’0’,’2’]; //Upper triangular

b=[’x’;’y’];
w=solve(A,b)
a=1;x=2;y=5;
evstr(w)
inv([1,1;0,2])*[2;5]

S EE A LSO : trianfml 228

Scilab Group April 1993 212

sp2adj Scilab Function

1.3.109 sort decreasing order sorting

CALLING SEQUENCE :

[s, [k]]=sort(v)
[s, [k]]=sort(v,’r’)
[s, [k]]=sort(v,’c’)

PARAMETERS :

v : real or complex vector/matrix; sparse vector; character string vector/matrix

s : real or complex vector or matrix; sparse vector; character string vector/matrix
k : vector or matrix of integers

DESCRIPTION :
s=sort(v) sorts v in decreasing order. If v is a matrix, sorting is done columnwise, v being seen
as the stacked vector v(:). [s,k]=sort(v) gives in addition the indices of entries of s in v, i.e.
v(k(:)) is the vector s.
s=sort(v,’r’) sorts the rows of v in decreasing order i.e. each column of s is obtained from each
column of v by reordering it in decreasing order. [s,k]=sort(v,’r’) returns in addition in each
column of k the indices such that v(k(:,i),i)=s(:,i) for each column index i.
s=sort(v,’c’) sorts the columns of v in decreasing order i.e. each row of s is obtained from each
row of v by reordering it in decreasing order. [s,k]=sort(v,’c’) returns in addition in each row of
k the indices such that v(i,k(i,:))=s(i,:) for each row index i.
Complex matrices or vectors are sorted w.r.t their magnitude.
y=sort(A) is valid when A is a sparse vector. Column/row sorting is not implemented for sparse ma-
trices.
EXAMPLE :

[s,p]=sort(rand(1,10));
//p is a random permutation of 1:10
A=[1,2,5;3,4,2];
[Asorted,q]=sort(A);A(q(:))-Asorted(:)
v=1:10;
sort(v)
sort(v’)
sort(v,’r’) //Does nothing for row vectors
sort(v,’c’)

S EE A LSO : find 41

1.3.110 sp2adj converts sparse matrix into adjacency form

CALLING SEQUENCE :
[xadj,adjncy,anz]= sp2adj(A)
PARAMETERS :

.TP 7
A
: real or complex sparse matrix (nz non-zero entries)
.TP 7
xadj
: integer vector of length (n+1).

Scilab Group JUN 1997 213

sparse Scilab Function

.TP 7
adjncy
: integer vector of length nz containing the row indices
for the corresponding elements in anz
.TP 7
anz
: column vector of length nz, containing the non-zero
elements of A

DESCRIPTION :

\fVsp2adj\fR converts a sparse matrix into its adjacency form (utility

fonction).
\fVA = n x m\fR sparse matrix. \fVxadj, adjncy, anz\fR = adjacency
representation of \fVA\fR i.e:
.LP
\fVxadj(j+1)-xadj(j)\fR = number of non zero entries in row j.
\fVadjncy\fR = column index of the non zeros entries
in row 1, row 2,..., row n.
\fVanz\fR = values of non zero entries in row 1, row 2,..., row n.
\fVxadj\fR is a (column) vector of size n+1 and
\fVadjncy\fR is an integer (column) vector of size \fVnz=nnz(A)\fR.
\fVanz\fR is a real vector of size \fVnz=nnz(A)\fR.

EXAMPLE :

A = sprand(100,50,.05);
[xadj,adjncy,anz]= sp2adj(A);
[n,m]=size(A);
p = adj2sp(xadj,adjncy,anz,[n,m]);
A-p,

S EE A LSO : adj2sp 164, sparse 214, spcompack 215, spget 216

1.3.111 sparse sparse matrix definition

CALLING SEQUENCE :

sp=sparse(X)
sp=sparse(ij,v [,mn])

PARAMETERS :

X : real or complex full (or sparse) matrix

ij : two columns integer matrix (indices of non-zeros entries)
mn : integer vector with two entries (row-dimension, column-dimension)
sp : sparse matrix

DESCRIPTION :
sparse is used to build a sparse matrix. Only non-zero entries are stored.
sp = sparse(X) converts a full matrix to sparse form by squeezing out any zero elements. (If X is
already sparse sp is X).
sp=sparse(ij,v [,mn]) builds an mn(1)-by-mn(2) sparse matrix with sp(ij(k,1),ij(k,2))=v(k).
ij and v must have the same column dimension. If optional mn parameter is not given the sp matrix
dimensions are the max value of ij(:,1) and ij(:,2) respectively.

Scilab Group January 1995 214

spcompack Scilab Function

Operations (concatenation, addition, etc,) with sparse matrices are made using the same syntax as for full
matrices.
Elementary functions are also available (abs,maxi,sum,diag,...) for sparse matrices.
Mixed operations (full-sparse) are allowed. Results are full or sparse depending on the operations.
EXAMPLE :

sp=sparse([1,2;4,5;3,10],[1,2,3])
size(sp)
x=rand(2,2);abs(x)-full(abs(sparse(x)))

S EE A LSO : full 186, spget 216, sprand 218, speye 216, lufact 520

1.3.112 spcompack converts a compressed adjacency representation

CALLING SEQUENCE :
adjncy = spcompak(xadj,xlindx,lindx)
PARAMETERS :

.TP 7
xadj
: integer vector of length (n+1).
.TP 7
xlindx
: integer vector of length n+1 (pointers).
.TP 7
lindx
: integer vector
.TP 7
adjncy
: integer vector

DESCRIPTION :

Utility fonction \fVspcompak\fR is used to convert a compressed adjacency

representation into standard adjacency representation.

EXAMPLE :

// A is the sparse matrix:

A=[1,0,0,0,0,0,0;
0,1,0,0,0,0,0;
0,0,1,0,0,0,0;
0,0,1,1,0,0,0;
0,0,1,1,1,0,0;
0,0,1,1,0,1,0;
0,0,1,1,0,1,1];
A=sparse(A);
//For this matrix, the standard adjacency representation is given by:
xadj=[1,2,3,8,12,13,15,16];
adjncy=[1, 2, 3,4,5,6,7, 4,5,6,7, 5, 6,7, 7];
//(see sp2adj).
// increments in vector xadj give the number of non zero entries in each
column
// ie there is 2-1=1 entry in the column 1
// there is 3-2=1 entry in the column 2

Scilab Group JUN 1997 215

spget Scilab Function

// there are 8-3=5 entries in the column 3

// 12-8=4 4
//etc
//The row index of these entries is given by the adjncy vector
// for instance,
// adjncy (3:7)=adjncy(xadj(3):xadj(4)-1)=[3,4,5,6,7]
// says that the 5=xadj(4)-xadj(3) entries in column 3 have row
// indices 3,4,5,6,7.
//In the compact representation, the repeated sequences in adjncy
//are eliminated.
//Here in adjncy the sequences 4,5,6,7 and 7 are eliminated.
//The standard structure (xadj,adjncy) takes the compressed form (lindx,xlindx)
lindx=[1, 2, 3,4,5,6,7, 5, 6,7];
xlindx=[1,2,3,8,9,11];
//(Columns 4 and 7 of A are eliminated).
//A can be reconstructed from (xadj,xlindx,lindx).
[xadj,adjncy,anz]= sp2adj(A);
adjncy - spcompack(xadj,xlindx,lindx)

S EE A LSO : sp2adj 213, adj2sp 164, spget 216

1.3.113 speye sparse identity matrix

CALING SEQUENCE :

Isp=speye(nrows,ncols)
Isp=speye(A)

PARAMETERS :

nrows : integer (number of rows)

ncols : integer (number os columns)
A : sparse matrix
sp : sparse identity matrix

DESCRIPTION :
Isp=speye(nrows,ncols) returns a sparse identity matrix Isp with nrows rows, ncols columns.
(Non square identity matrix have a maximal number of ones along the main diagonal).
Isp=speye(A) returns a sparse identity matrix with same dimensions as A. If [m,n]=size(A),
speye(m,n) and speye(A) are equivalent. In particular speye(3) is not equivalent to speye(3,3).

EXAMPLE :

eye(3,3)-full(speye(3,3))

S EE A LSO : sparse 214, full 186, eye 184, spzeros 218, spones 218

1.3.114 spget retrieves entries of sparse matrix

CALLING SEQUENCE :

[ij,v,mn]=spget(sp)

PARAMETERS :

Scilab Group January 1995 216

spones Scilab Function

sp : real or complex sparse matrix

ij : two columns integer matrix (indices of non-zeros entries)
mn : integer vector with two entries (row-dimension, column-dimension)
v : column vector

DESCRIPTION :
spget is used to convert the internal representation of sparse matrices into the standard ij, v repre-
sentation.
Non zero entries of sp are located in rows and columns with indices in ij.
EXAMPLE :

sp=sparse([1,2;4,5;3,10],[1,2,3])
[ij,v,mn]=spget(sp);

S EE A LSO : sparse 214, sprand 218, speye 216, lufact 520

1.3.115 splin spline function

CALLING SEQUENCE :

d=splin(x,f [,"periodic"])

PARAMETERS :

x : real vector
f : real vector of same size as x
"periodic" : string flag (a periodic spline is looked for)

DESCRIPTION :
Given values fi of a function f at given points xi (fi=f(xi)) this primitive computes a third or-
der spline function S which interpolates the function f. The components of x must be in increasing
order. For a periodic spline f(1) must equal f(n); S is defined through the triple (x,f,d) where
d=spline(x,f) is the vector of the estimated derivatives of S at xi (fi=S(xi),di=S’(xi)). This
function should be used in conjunction with interp.
In the case ”periodic” n must be choosen >= 3. In the non periodic case, n must be >= 4 (but n=3 gives
some kind of results) and the boundary/end conditions for the spline are of type ”not-a-knot conditions”
and prescribe (if x1, x2, ..., xn are the interpolation nodes) :

S’’’(x2-) = S’’’(x2+)
S’’’(x{n-1}-) = S’’’(x{n-1}+)

so the first cubic polynomial p1 is equal to the second p2 and the same is valid for the 2 last ones :
pfn-2g=pfn-1g.
EXAMPLE :

x=0:0.5:10;f=sin(x);
d=splin(x,f);
S=interp(0:0.1:10,x,f,d);
plot2d(x’,f’,-1);
plot2d((0:0.1:10)’,S’,2,’000’)

S EE A LSO : interp 189, smooth 212

Scilab Group January 1995 217

spzeros Scilab Function

1.3.116 spones sparse matrix

SYNTAX :
sp=spones(A)
PARAMETERS :

A : sparse matrix
sp : sparse matrix

DESCRIPTION :
sp=spones(A) generates a matrix with the same sparsity structure as A, but with ones in the nonzero
positions;
EXAMPLE :

A=sprand(10,12,0.1);
sp=spones(A)
B = A˜=0
bool2s(B)

S EE A LSO : sparse 214, full 186, eye 184, speye 216, spzeros 218

1.3.117 sprand sparse random matrix

CALING SEQUENCE :

sp=sprand(nrows,ncols,fill [,typ])

PARAMETERS :

nrows : integer (number of rows)

ncols : integer (number os columns)
fill : filling coefficient (density)
typ : character string (’uniform’ (default) or ’normal’)
sp : sparse matrix

DESCRIPTION :
sp=sprand(nrows,ncols,fill) returns a sparse matrix sp with nrows rows, ncols columns
and approximately fill*nrows*ncols non-zero entries.
If typ=’uniform’ uniformly distributed values are generated. If typ=’normal’ normally dis-
tributed values are generated.
EXAMPLE :

W=sprand(100,1000,0.001);

S EE A LSO : sparse 214, full 186, rand 207, speye 216

1.3.118 spzeros sparse zero matrix

SYNTAX :
sp=spzeros(nrows,ncols)
sp=spzeros(A)
PARAMETERS :

Scilab Group January 1995 218

squarewave Scilab Function

nrows : integer (number of rows)

ncols : integer (number os columns)
A : sparse matrix
sp : sparse zero matrix
DESCRIPTION :
sp=spzeros(nrows,ncols,fill) returns a sparse zero matrix sp with nrows rows, ncols
columns. (Equivalent to sparse([],[],[nrow,ncols]))
sp=spzeros(A) returns a sparse zero matrix with same dimensions as A. If [m,n]=size(A), spzeros(m,n)
and spzeros(A) are equivalent. In particular spzeros(3) is not equivalent to spzeros(3,3).
EXAMPLE :

sum(spzeros(1000,1000))

S EE A LSO : sparse 214, full 186, eye 184, speye 216, spones 218

1.3.119 sqrt square root

CALLING SEQUENCE :

y=sqrt(x)
PARAMETERS :

x : real or complex scalar or vector

DESCRIPTION :
sqrt(x) is the vector of the square root of the x elements. Result is complex if x is negative.
EXAMPLE :

sqrt([2,4])
sqrt(-1)

S EE A LSO : hat 47, sqrtm 219

1.3.120 sqrtm matrix square root

CALLING SEQUENCE :

y=sqrtm(x)
PARAMETERS :

x : real or complex square matrix

DESCRIPTION :
y=sqrt(x) is the matrix square root of the x x matrix (x=yˆ2) Result may not be accurate if x is not
symmetric.
EXAMPLE :

x=[0 1;2 4]
w=sqrtm(x);
norm(w*w-x)
x(1,2)=%i;
w=sqrtm(x);norm(w*w-x,1)

S EE A LSO : expm 509, sqroot 537

Scilab Group Sept 1999 219

ssrand Scilab Function

1.3.121 squarewave generates a square wave with period 2*%pi

CALLING SEQUENCE :

x=squarewave(t [,%])

PARAMETERS :

t : real vector, time discretization

x : real vector, the wave value at each time point in set (-1,+1)
% : real positive scalar, the percent of the period in which the signal is positive. Defaut value is 50

DESCRIPTION :
squarewave(t) generates the vector of the values of the square wave with period 2*%pi at each date
given in the t vector.
squarewave(t,%) generates a square wave such that % is the percent of the period in which the
signal is positive.
EXAMPLE :

t=(0:0.1:5*%pi)’;
plot2d1(’onn’,t,[2*sin(t),1.5*squarewave(t),squarewave(t,10)])

S EE A LSO : sin 210, cos 177

1.3.122 ssprint pretty print for linear system

CALLING SEQUENCE :

ssprint(sl [,out])

PARAMETERS :

sl : list (syslin list)

out : output (default value out=%io(2))

DESCRIPTION :
pretty print of a linear system in state-space form sl=(A,B,C,D) syslin list.
EXAMPLE :

a=[1 1;0 1];b=[0 1;1 0];c=[1,1];d=[3,2];

ssprint(syslin(’c’,a,b,c,d))
ssprint(syslin(’d’,a,b,c,d))

S EE A LSO : texprint 665

1.3.123 ssrand random system generator

CALLING SEQUENCE :

sl=ssrand(nout,nin,nstate)
[sl,U]=ssrand(nout,nin,nstate,flag)

PARAMETERS :

Scilab Group April 1993 220

st deviation Scilab Function

nout : integer (number of output)

nin : integer (number of input)
nstate : integer (dimension of state-space)
flag : list made of one character string and one or several integers
sl : list (syslin list)
U square (nstate x nstate) nonsingular matrix

DESCRIPTION :
sl=ssrand(nout,nin,nstate) returns a random strictly proper (D=0) state-space system of size
[nout,nint] represented by a syslin list and with nstate state variables.
[sl,U]=ssrand(nout,nin,nstate,flag) returns a test linear system with given properties spec-
ified by flag. flag can be one of the following:
flag=list(’co’,dim_cont_subs)
flag=list(’uo’,dim_unobs_subs)
flag=list(’ncno’,dim_cno,dim_ncno,dim_co,dim_nco)
flag=list(’st’,dim_cont_subs,dim_stab_subs,dim_stab0)
flag=list(’dt’,dim_inst_unob,dim_instb0,dim_unobs)
flag=list(’on’,nr,ng,ng0,nv,rk)
flag=list(’ui’,nw,nwu,nwui,nwuis,rk)
The complete description of the Sys is given in the code of the ssrand function (in SCIDIR/macros/util).
For example with flag=list(’co’,dim cont subs) a non-controllable system is return and dim cont subs
is the dimension of the controllable subspace of Sys. The character strings ’co’,’uo’,’ncno’,’st’,’dt’,’on’,’ui’
stand for ”controllable”, ”unobservable”, ”non-controllable-non-observable”, ”stabilizable”,”detectable”,”output-
nulling”,”unknown-input”.
EXAMPLE :

//flag=list(’st’,dim_cont_subs,dim_stab_subs,dim_stab0)
//dim_cont_subs<=dim_stab_subs<=dim_stab0
//pair (A,B) U-similar to:
// [*,*,*,*; [*;
// [0,s,*,*; [0;
//A= [0,0,i,*; B=[0;
// [0,0,0,u] [0]
//
// (A11,B1) controllable s=stable matrix i=neutral matrix u=unstable matrix
[Sl,U]=ssrand(2,3,8,list(’st’,2,5,5));
w=ss2ss(Sl,inv(U)); //undo the random change of basis => form as above
[n,nc,u,sl]=st_ility(Sl);n,nc

S EE A LSO : syslin 224

1.3.124 st deviation standard deviation (row or column-wise) of vector/matrix

entries

CALLING SEQUENCE :

y=st_deviation(x)
y=st_deviation(x,’r’)
y=st_deviation(x,’c’)

PARAMETERS :

x : real vector or matrix

Scilab Group Januray 1998 221

sum Scilab Function

y : scalar or vector

DESCRIPTION :
st deviation computes the ”sample” standard deviation, that is, it is normalized by N-1, where N is the
sequence length.
For a vector or a matrix x, y=st deviation(x) returns in the scalar y the standard deviation of all
the entries of x.
y=st deviation(x,’r’) (or, equivalently, y=st deviation(x,1)) is the rowwise standard de-
viation. It returns in each entry of the column vector y the standard deviation of each row of x.
y=st deviation(x,’c’) (or, equivalently, y=st deviation(x,2)) is the columnwise st deviation.
It returns in each entry of the row vector y the standard deviation of each column of x.
EXAMPLE :

A=[1,2,10;7,7.1,7.01];
st_deviation(A)
st_deviation(A,’r’)
st_deviation(A,’c’)

S EE A LSO : sum 222, median 199, mean 198

1.3.125 subf symbolic subtraction

CALLING SEQUENCE :

["c"]=subf("a","b")

PARAMETERS :

"a","b","c" : strings

DESCRIPTION :
returns the character string c="a-b" Trivial simplifications such as subf("0","a") or subf("1","2")
are performed.
EXAMPLE :

subf(’0’,’a’)
subf(’2’,’1’)
subf(’a’,’0’)

S EE A LSO : mulf 203, ldivf 194, rdivf 208, eval 184, evstr 35

1.3.126 sum sum (row sum, column sum) of vector/matrix entries

CALLING SEQUENCE :

y=sum(x)
y=sum(x,’r’) or y=sum(x,1)

y=sum(x,’c’) or y=sum(x,2)

PARAMETERS :

x : vector or matrix (real, complex, sparse or polynomial)

y : scalar or vector

Scilab Group April 1993 222

sysconv Scilab Function

DESCRIPTION :
For a vector or a matrix x, y=sum(x) returns in the scalar y the sum of all the entries of x.
y=sum(x,’r’) (or, equivalently, y=sum(x,1)) is the rowwise sum. It returns in each entry of the row
vector y the sum of the rows of x (The sum is performed on the row indice : y(j)= sum(x(i,j),i=1,m)).
y=sum(x,’c’) (or, equivalently, y=sum(x,2)) is the columnwise sum. It returns in each entry of
the column vector y the sum of the columns of x (The sum is performed on the column indice: y(i)=
sum(x(i,j),j=1,n))).
EXAMPLE :

A=[1,2;3,4];
trace(A)-sum(diag(A))
sum(A,’c’)-A*ones(2,1)
sum(A+%i)
A=sparse(A);sum(A,’c’)-A*ones(2,1)
s=poly(0,’s’);
M=[s,%i+s;sˆ2,1];
sum(M),sum(M,2)

S EE A LSO : cumsum 180, prod 206

1.3.127 sysconv system conversion

CALLING SEQUENCE :

[s1,s2]=sysconv(s1,s2)

PARAMETERS :
s1,s2 : list (linear syslin systems)
DESCRIPTION :
Converts s1 and s2 into common representation in order that system interconnexion operations can be
applied. Utility function for experts. The conversion rules in given in the following table.
"c" : continuous time system
"d" : discrete time system
n : sampled system with sampling period n
[] : system with undefined time domain
For mixed systems s1 and s2 are put in state-space representation.

s1\\s2| "c" | "d" | n2 | [] |

---------------------------------------------------------------
"c" | nothing |uncompatible | c2e(s1,n2) | c(s2) |
---------------------------------------------------------------
"d" |uncompatible| nothing | e(s1,n2) | d(s2) |
---------------------------------------------------------------
n1 | c2e(s2,n1) | e(s2,n1) | n1<>n2 uncomp | e(s2,n1) |
| | | n1=n2 nothing | |
---------------------------------------------------------------
[] | c(s1) | d(s1) | e(s1,n2) | nothing |
---------------------------------------------------------------

With the following meaning:

n1,n2 : sampling period
c2e(s,n) : the continuous-time system s is transformed into a sampled system with sampling period n.
c(s) : conversion to continuous (time domain is "c")

Scilab Group April 1993 223

syslin Scilab Function

d(s) : conversion to discrete (time domain is "d")

e(s,n) : conversion to samples system with period n

EXAMPLE :

s1=ssrand(1,1,2);
s2=ss2tf(s1);
[s1,s2]=sysconv(s1,s2);

S EE A LSO : syslin 224, ss2tf 363, tf2ss 367

1.3.128 sysdiag block diagonal system connection

CALLING SEQUENCE :

r=sysdiag(a1,a2,...,an)

DESCRIPTION :
Returns the block-diagonal system made with subsystems put in the main diagonal
ai : subsystems (i.e. gains, or linear systems in state-space or transfer form)
Used in particular for system interconnections.
REMARK :
At most 17 arguments.
EXAMPLES :

s=poly(0,’s’)
sysdiag(rand(2,2),1/(s+1),[1/(s-1);1/((s-2)*(s-3))])
sysdiag(tf2ss(1/s),1/(s+1),[1/(s-1);1/((s-2)*(s-3))])

s=poly(0,’s’)
sysdiag(rand(2,2),1/(s+1),[1/(s-1);1/((s-2)*(s-3))])
sysdiag(tf2ss(1/s),1/(s+1),[1/(s-1);1/((s-2)*(s-3))])

S EE A LSO : brackets 28, insertion 51, feedback 335

1.3.129 syslin linear system definition

CALLING SEQUENCE :

[sl]=syslin(dom,A,B,C [,D [,x0] ])

[sl]=syslin(dom,N,D)
[sl]=syslin(dom,H)

PARAMETERS :

dom : character string (’c’, ’d’), or [] or a scalar.

A,B,C,D : matrices of the state-space representation (D optional with default value zero matrix). For
improper systems D is a polynomial matrix.
x0 : vector (initial state; default value is 0)
N, D : polynomial matrices
H : rational matrix or linear state space representation
sl : tlist (”syslin” list) representing the linear system

Scilab Group April 1993 224

TAN Scilab Function

DESCRIPTION :
syslin defines a linear system as a list and checks consistency of data.
dom specifies the time domain of the system and can have the following values:
dom=’c’ for a continuous time system, dom=’d’ for a discrete time system, n for a sampled system
with sampling period n (in seconds).
dom=[] if the time domain is undefined
State-space representation:

sl=syslin(dom,A,B,C [,D [,x0] ])

represents the system :

s x = A*x + B*u
y = C*x + D*u
x(0) = x0

The output of syslin is a list of the following form: sl=tlist([’lss’,’A’,’B’,’C’,’D’,’X0’,’dt’],A,B,C,

Note that D is allowed to be a polynomial matrix (improper systems).
Transfer matrix representation:

sl=syslin(dom,N,D)
sl=syslin(dom,H)

The output of syslin is a list of the following form : sl=tlist([’r’,’num’,’den’,’dt’],N,D,dom)

or sl=tlist([’r’,’num’,’den’,’dt’],H(2),H(3),dom).
Linear systems defined as syslin can be manipulated as usual matrices (concatenation, extraction, trans-
pose, multiplication, etc) both in state-space or transfer representation.
Most of state-space control functions receive a syslin list as input instead of the four matrices defining
the system.
EXAMPLES :

A=[0,1;0,0];B=[1;1];C=[1,1];
S1=syslin(’c’,A,B,C) //Linear system definition
S1("A") //Display of A-matrix
S1("X0"), S1("dt") // Display of X0 and time domain
s=poly(0,’s’);
D=s;
S2=syslin(’c’,A,B,C,D)
H1=(1+2*s)/sˆ2, S1bis=syslin(’c’,H1)
H2=(1+2*s+sˆ3)/sˆ2, S2bis=syslin(’c’,H2)
S1+S2
[S1,S2]
ss2tf(S1)-S1bis
S1bis+S2bis
S1*S2bis
size(S1)

S EE A LSO : tlist 73, lsslist 57, rlist 69, ssrand 220, ss2tf 363, tf2ss 367,
dscr 333, abcd 318

1.3.130 tan tangent

CALLING SEQUENCE :

[t]=tan(x)

Scilab Group April 1993 225

tanm Scilab Function

PARAMETERS :

x : vector or matrix
t : vector or matrix

DESCRIPTION :
The elements of t are the tangent of the elements of x.
EXAMPLE :

x=[1,%i,-1,-%i]
tan(x)
sin(x)./cos(x)

S EE A LSO : atan 167, tanm 227

1.3.131 tanh hyperbolic tangent

CALLING SEQUENCE :

t=tanh(x)

DESCRIPTION :
the elements of t are the hyperbolic tangents of the elements of x
EXAMPLE :

x=[1,%i,-1,-%i]
tanh(x)
sinh(x)./cosh(x)

S EE A LSO : atanh 168, tan 225, tanhm 226

1.3.132 tanhm matrix hyperbolic tangent

CALLING SEQUENCE :

t=tanhm(x)

PARAMETERS :

x,t : real or complex square matrix

DESCRIPTION :
tanhm is the matrix hyperbolic tangent of the matrix x.
S EE A LSO : tanh 226

Scilab Group April 1993 226

trfmod Scilab Function

1.3.133 tanm matrix tangent

CALLING SEQUENCE :

[t]=tanm(x)

PARAMETERS :

x : square real or complex matrix

t : square matrix

DESCRIPTION :
tanm(x) is the matrix tangent of the square matrix x
EXAMPLE :

A=[1,2;3,4];
tanm(A)

S EE A LSO : tan 225, expm 509, sinm 211, atanm 169

1.3.134 toeplitz toeplitz matrix

CALING SEQUENCE :

A=toeplitz(c [,r])

PARAMETERS :

a,c,r : constant, polynomial or character chain matrices

DESCRIPTION :
returns the Toeplitz matrix whose first row is r and first column is c. c(1) must be equal to r(1).
toeplitz(c) returns the symmetric Toeplitz matrix.
EXAMPLE :

A=toeplitz(1:5);
//
T=toeplitz(1:5,1:2:7);T1=[1 3 5 7;2 1 3 5;3 2 1 3;4 3 2 1;5 4 3 2];
T-T1
//
s=poly(0,’s’);
t=toeplitz([s,s+1,sˆ2,1-s]);
t1=[s,1+s,s*s,1-s;1+s,s,1+s,s*s;s*s,1+s,s,1+s;1-s,s*s,1+s,s]
t-t1
//
t=toeplitz([’1’,’2’,’3’,’4’]);
t1=[’1’,’2’,’3’,’4’;’2’,’1’,’2’,’3’;’3’,’2’,’1’,’2’;’4’,’3’,’2’,’1’]

S EE A LSO : matrix 58

Scilab Group April 1993 227

trisolve Scilab Function

1.3.135 trfmod poles and zeros display

CALLING SEQUENCE :
[hm]=trfmod(h [,job])
DESCRIPTION :
To visualize the pole-zero structure of a SISO transfer function h .
job=’p’ : visualization of polynomials (default)
job=’f’ : visualization of natural frequencies and damping
Interactive simplification of h. trfmod opens a dialog window.
S EE A LSO : poly 65, simp 497

1.3.136 trianfml symbolic triangularization

CALLING SEQUENCE :
[f [,sexp]]=trianfml(f [,sexp])
DESCRIPTION :
Triangularization of the symbolic matrix f ; triangularization is performed by elementary row operations;
sexp is a set of common expressions stored by the algorithm.
EXAMPLE :
A=[’1’,’2’;’a’,’b’]
W=trianfml([A,string(eye(2,2))])
U=W(:,3:4)
a=5;b=6;
A=evstr(A)
U=evstr(U)
U*A
evstr(W(:,1:2))
S EE A LSO : addf 164, mulf 203, solve 212, trisolve 229

1.3.137 tril lower triangular part of matrix

CALLING SEQUENCE :
tril(x [,k])
PARAMETERS :
x : matrix (real, complex, polynomial, rational)
k : integer (default value 0)
DESCRIPTION :
Lower triangle part of a matrix. tril(x,k) is made by entries below the kth diagonal : k>0 (upper
diagonal) and k<0 (diagonals below the main diagonal).
EXAMPLE :
s=poly(0,’s’);
tril([s,s;s,1])
tril([1/s,1/s;1/s,1])
S EE A LSO : triu 229, ones 204, eye 184, diag 181

Scilab Group April 1993 228

typeof Scilab Function

1.3.138 trisolve symbolic linear system solver

CALLING SEQUENCE :

[x [,sexp]] = trisolve(A,b [,sexp])

PARAMETERS :

A,b : matrices of strings

DESCRIPTION :
symbolically solves A*x =b , A being assumed to be upper triangular.
sexp is a vector of common subexpressions in A, b, x.
EXAMPLE :

A=[’x’,’y’;’0’,’z’];b=[’0’;’1’];
w=trisolve(A,b)
x=5;y=2;z=4;
evstr(w)
inv(evstr(A))*evstr(b)

S EE A LSO : trianfml 228, solve 212

AUTHOR : F.D, S.S

1.3.139 triu upper triangle

DESCRIPTION :
Upper triangle. See tril.

1.3.140 typeof object type

CALLING SEQUENCE :

[t]=typeof(object)

PARAMETERS :

object : Scilab object

t : string

DESCRIPTION :
t=typeof(object) returns one of the following strings:
"constant" if object is a real or complex constant matrix
"polynomial" if object is a polynomial matrix
"function" if object is a function
"string" if object is a matrix made of character strings
"boolean" if object is a boolean matrix
"list" if object is a list
"rational" if object is a rational matrix (transfer matrix)
"state-space" if object is a state-space model (see syslin)
"sparse" if object is a (real) sparse matrix.
"boolean sparse" if object is a boolean sparse matrix.

Scilab Group April 1993 229

unique Scilab Function

EXAMPLE :

typeof(1)
typeof(poly(0,’x’))
typeof(1/poly(0,’x’))
typeof(%t)
w=sprand(100,100,0.001);
typeof(w)
typeof(w==w)
deff(’y=f(x)’,’y=2*x’);
typeof(f)

S EE A LSO : type 74, strings 284, syslin 224, poly 65

1.3.141 union extract union components of a vector

CALLING SEQUENCE :

[v, [ka,kb]]=union(a,b)

PARAMETERS :

a : vector of real numbers or strings

b : vector of real numbers or strings
v : row vector of real numbers or strings
ka : row vector of integers
kb : row vector of integers

DESCRIPTION :
union(a,b) returns a sorted row vector which retains the unique entries of [a(:);b(:)].
[v,ka,kb]=union(a,b) also returns index vectors ka and kb such that v is a sorted combination
of the entries a(ka) and b(kb).
EXAMPLE :

A=round(5*rand(10,1));
B=round(5*rand(7,1));

union(A,B)
[N,ka,kb]=union(A,B)

union(’a’+string(A),’b’+string(B))

S EE A LSO : unique 230, sort 213

1.3.142 unique extract unique components of a vector

CALLING SEQUENCE :

[N, [k]]=unique(M)

PARAMETERS :

Scilab Group April 1999 230

zeros Scilab Function

M : vector of real numbers or strings

N : vector of real numbers or strings
k : vector of integers

DESCRIPTION :
unique(M) returns a vector which retains the unique entries of M in ascending order.
If required the output argument k contains the position of the first encountered unique entries.
EXAMPLE :

M=round(2*rand(20,1));

unique(M)
[N,k]=unique(M)

unique(string(M))
[N,k]=unique(string(M))

S EE A LSO : union 230, sort 213, lex_sort 194

1.3.143 zeros matrix made of zeros

CALLING SEQUENCE :

y=zeros()
y=zeros(x)
y=zeros(m1,m2,..)

PARAMETERS :

x,y : matrices
m1, m2,.. : integers

DESCRIPTION :
Creates matrix of zeros (same as 0*ones).
zeros(m1,m2) : for an (m1,m2) matrix.
zeros(m1,m2,..,mn) : creates a (m1,m2,..,mn) matrix filled with zeros
zeros(A) : for a matrix of same size of A.
zeros(3) : is zeros(a) with a=3 i.e it is NOT a 3x3 matrix!
zeros() : returns a single zero
If x is a syslin list (linear system in state-space or transfer form), zeros(x) is also valid and returns
a zero matrix.
EXAMPLE :

zeros(3)
zeros(3,3)
zeros(2,3,2)

S EE A LSO : eye 184, ones 204, spzeros 218

Scilab Group April 1993 231

zeros Scilab Function

1.4 Input/Output functions

Scilab Group April 1993 232

file Scilab Function

1.4.1 diary diary of session

CALLING SEQUENCE :

diary(’file-name’)

DESCRIPTION :
diary creates a file which contains a copy of the current Scilab session. diary(0) interrupts the diary.

S EE A LSO : exec 36, unix 310

1.4.2 disp displays variables

CALLING SEQUENCE :

disp(x1,[x2,...xn])

DESCRIPTION :
displays xi with the current format. xi’s are arbitrary objects (matrices of constants, strings, functions,
lists, ...)
Display of objects defined by tlist may be overloaded by the definition of a function. This function must
have no output argument a single input argument ant it’s name is formed as follow %<tlist type> p
where %<tlist type> stands for the first entry of the tlist type component.
S EE A LSO : write 262, read 254, print 251, string 284, tlist 73
EXAMPLES :

disp([1 2],3)
deff(’[]=%t_p(l)’,’disp(l(3),l(2))’)
disp(tlist(’t’,1,2))

1.4.3 dispfile display opened files properties

CALLING SEQUENCE :

dispfiles([units])

PARAMETERS :

units : a vector of numbers, the file’s logical units. By default all opened files.

DESCRIPTION :
dispfiles displays properties of currently opened files.
EXAMPLE :

dispfiles()

S EE A LSO : file 234, mopen 244

AUTHOR : S. Steer

Scilab Group April 1993 233

file Scilab Function

1.4.4 file file management

CALLING SEQUENCE :

[unit [,err]]=file(’open’, file-name [,status] [,access [,recl]] [,format])

file(action,unit)
[units [,typ [,nams [,mod [,swap]]]]] = file([unit])

PARAMETERS :

file-name : string, file name of the file to be opened

status : string, The status of the file to be opened
"new" : file must not exist new file (default)
"old" : file must already exists.
"unknown" : unknown status
"scratch" : file is to be deleted at end of session
access : string, The type of access to the file
"sequential" : sequential access (default)
"direct" : direct access.
format : string,
"formatted" : for a formatted file (default)
"unformatted" : binary record.
recl : integer,is the size of records in bytes when access="direct"
unit : integer, logical unit descriptor of the opened file
units : integer vector, logical unit descriptor of the opened files. Units 1 5 and 6 are reserved by the
system for history file , input and output devices.
typs : Character string vector, type (C or Fortran) of opened files.
nams : Character string vector, pathnames of opened files.
mod : file opening mode. Formed by three digits abc

Fortran files a : 0 stands for formatted and 1 for unformatted (binary)

b : 0 stands for sequential acces and 1 for direct access
c : 0 stands for ”new”, 1 for ”old”, 2 for ”scratch” and 3 for ”unknown”

a : is 1 if file has been opened with a ”b” (binary) mode

C files
b : is 1 if file has been opened with a ”+” (updating) mode
c : 1 stands for ”r” (read), 2 stands for ”w” (write) and 3 for ”a” (append)
swap : automatic swap switch. swap=1 if automatic swap is on. swap is always 0 for Fortran files.
err : integer, error message number (see error), if open fails. If err is omitted an error message is issued.
action : is one of the following strings:
"close" : closes the file(s) given by the logical unit descriptors given in units
"rewind" : puts the pointer at beginning of file
"backspace" : puts the pointer at beginning of last record.
"last" : puts the pointer after last record.

DESCRIPTION :
selects a logical unit unit and manages the file file-name.
[unit [,err]]=file(’open’, file-name [,status] [,access [,recl]] [,format])
allows to open a file with specified properties and to get the associated unit number unit. This unit number
may be used for further actions on this file or as file descriptor in read, write, readb, writb,save,
load function calls.
file(action,unit) allows to close the file , or move the current file pointer .
file() returns the logical unit descriptors of the opened files. So file(’close’,file() ) closes
all user opened files (C or Fortran type).
EXAMPLE :

Scilab Group April 1993 234

fprintf Scilab Function

u=file(’open’,TMPDIR+’/foo’,’unknown’)
for k=1:4
a=rand(1,4)
write(u,a)
end
file(’rewind’,u)
x=read(u,2,4)
file(’close’,u)
//
u1=file(’open’,TMPDIR+’/foo’,’unknown’)
u2=mopen(TMPDIR+’/foo1’,’wb’)
[units,typs,nams]=file()

S EE A LSO : save 258, load 239, write 262, read 254, writb 261, readb 255,
xgetfile 263, mopen 244, mclose 240

1.4.5 fileinfo Provides information about a file

CALLING SEQUENCE :

[x,ierr]=fileinfo(file)

PARAMETERS :

file : a character string, the file pathname

x : an integer vector of size 6 containing information or an empty matrix if file does not exist.
ierr : error indicator, 0, if no error has occured

DESCRIPTION :
x=fileinfo(file) returns

x(1) : The file size

x(2) : The file mode
x(3) : The user id
x(4) : the group id
x(5) : The device number
x(6) : The date of last modification

EXAMPLES :

w=fileinfo(SCI+’/scilab.star’)
getdate(w(6))

S EE A LSO : getdate 314, file 234, dispfiles ??, newest 250

1.4.6 fprintf Emulator of C language fprintf function

CALLING SEQUENCE :

fprintf(file,format,value_1,..,value_n)

PARAMETERS :

Scilab Group May 1994 235

fscanf Scilab Function

format : a Scilab string. Specifies a character string combining literal characters with conversion speci-
fications.
value i : Specifies the data to be converted according to the format parameter.
str : column vector of character strings
file : a Scilab string specifying a file name or a logical unit number (see file)

DESCRIPTION :
The fprintf function converts, formats, and writes its value parameters, under control of the format
parameter, to the file specified by its file parameter.
The format parameter is a character string that contains two types of objects:

Literal characters : which are copied to the output stream.

Conversion specifications : each of which causes zero or more items to be fetched from the
value parameter list. see printf conversion for details

If any values remain after the entire format has been processed, they are ignored.
EXAMPLES :

u=file(’open’,’results’,’unknown’) //open the result file

t=0:0.1:2*%pi;
for tk=t
fprintf(u,’time = %6.3f value = %6.3f’,tk,sin(tk)) // write a line
end
file(’close’,u) //close the result file

S EE A LSO : string 284, print 251, write 262, format 42, disp 233, file 234,
printf 252, sprintf 260

1.4.7 fprintfMat print a matrix in a file.

CALLING SEQUENCE :

fprintfMat(fil,M,format)

PARAMETERS :

fil : a string, path of the file

format : a character string, a C like format.
M : A matrix of real numbers.

DESCRIPTION :

The fprintfMat function prints a matrix in a formated file. Each row of the matrix give a line in the file.
EXAMPLE :

n=50;
a=rand(n,n,’u’);
fprintfMat(TMPDIR+’/Mat’,a,’%5.2f’);
a1=fscanfMat(TMPDIR+’/Mat’);

S EE A LSO : mclose 240, meof 241, mfprintf 245, mfscanf 248, fscanfMat 237,
mget 242, ?? mgetstr, mopen, mprintf, mput, mputstr, mscanf, mseek, mtell

Scilab Group May 1994 236

getio Scilab Function

1.4.8 fscanf Converts formatted input read on a file

CALLING SEQUENCE :
[v_1,...v_n]=fscanf (file,format)
PARAMETERS :
format :Specifies the format conversion.
file :Specifies the input file name or file number.
DESCRIPTION :
The fscanf functions read character data on the file specified by the file argument , interpret it according
to a format, and returns the converted results.
The format parameter contains conversion specifications used to interpret the input.
The format parameter can contain white-space characters (blanks, tabs, newline, or formfeed) that,
except in the following two cases, read the input up to the next nonwhite-space character. Unless there is a
match in the control string, trailing white space (including a newline character) is not read.
- Any character except % (percent sign), which must match the next character of the input stream.
- A conversion specification that directs the conversion of the next input field. see scanf conversion
for details.
S EE A LSO : printf 252, read 254, scanf 259, sscanf 260

1.4.9 fscanfMat Reads a Matrix from a text file.

CALLING SEQUENCE :
M=fscanfMat(filename);
PARAMETERS :
filename : a character string giving the name of the file to be scanned.
M : Output variable. A matrix of real numbers.
DESCRIPTION :
The fscanfMat function is used to read a scalar matrix from a text file. The first non-numeric lines of
the file are ignored and all the remaining lines must have the same number of columns (column separator
are assumed to be white spaces or tab characters). The number of columns of the matrix will follow the
number of columns found in the file and the number of lines is fetched by detecting eof in the input file.
This function can be used to read back numerical data saved with the fprintfMat.
EXAMPLE :
fd=mopen(TMPDIR+’/Mat’,’w’);
mfprintf(fd,’Some text.....\n’);
mfprintf(fd,’Some text again\n’);
a=rand(6,6);
for i=1:6 ,
for j=1:6, mfprintf(fd,’%5.2f ’,a(i,j));end;
mfprintf(fd,’\n’);
end
mclose(fd);
a1=fscanfMat(TMPDIR+’/Mat’)
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

Scilab Group december 2000 237

lines Scilab Function

1.4.10 getio get Scilab input/output logical units

CALLING SEQUENCE :

ios=getio()

PARAMETERS :

ios : a vector [rio rte wio wte]

rio : current logical unit for reading instructions
rte : logical unit assigned for input in main scilab window
wio : logical unit relative to the diary file if any. wio=0 stands for no diary file opened
wte : logical unit assigned for output in main scilab window

DESCRIPTION :
getio returns logical units assigned for main scilab input and output
S EE A LSO : %io ??, file 234, exec 36

1.4.11 input prompt for user input

CALLING SEQUENCE :

[x]=input(message,["string"])

PARAMETERS :

message : character string

"string" : the character string "string" (may be abbreviated to "s")
x : real number (or character string if "string" is in the calling sequence)

DESCRIPTION :
input(message) gives the user the prompt in the text string and then waits for input from the keyboard.
The input can be expression which is evaluated by evstr.
Invoked with two arguments, the output is a character string which is the expression entered at keyboard.
EXAMPLE :

//x=input("How many iterations?")

//x=input("What is your name?","string")

S EE A LSO : file 234, read 254, write 262, evstr 35, x_dialog 292, x_mdialog
293

1.4.12 lines rows and columns used for display

CALLING SEQUENCE :

lines([nl [,nc]])
nlc=lines()

PARAMETERS :

nl : an integer, the number of lines for vertical paging control. If 0

no vertical paging control is done.

Scilab Group April 1993 238

abs Scilab Function

nc : an integer, the number of column of output. Used for formatting output

nlc : a 1x2 vector [nl,nc]

DESCRIPTION :
lines handles Scilab display paging.
lines() returns the vector [# columns, # rows] currently used by Scilab for displaying the results.
lines(nl) sets the number of displayed lines (before user is asked for more) to nl.
lines(0) disables vertical paging
lines(nl,nc) changes also the size of the output to nc columns.
When Scilab is launched without -nw option, the lines parameters are automatically set according
to the output window size.
S EE A LSO : disp 233, print 251

1.4.13 load load saved variable

CALLING SEQUENCE :

load(filename [,x1,...,xn])
load(fd [,x1,...,xn])

PARAMETERS :

filename : character string containing the path of the file

fd : a file descriptor given by a call to mopen
xi : arbitrary Scilab variable name(s) given as strings.

DESCRIPTION :
The load command can be used to reload in the Scilab session variables previously saved in a file with
the save command.
load(filename) loads the variables saved in file given by its path filename.
load(fd) loads the variables saved in file given by its descriptor fd.
load(filename,’x’,’y’) or load(fd,’x’,’y’) loads only variables x,y.
COMPATIBLITY :
Even if the binary file format has changed with 2.5 version, load(filename,...) is able to read
old format files. Previous file format can be accessed for a while using function oldsave ans oldload.
EXAMPLES :

a=eye(2,2);b=ones(a);
save(’vals.dat’,a,b);
clear a
clear b
load(’vals.dat’,’a’,’b’);

S EE A LSO : save 258, getf 272, mopen 244

1.4.14 manedit editing a manual item

CALLING SEQUENCE :

manedit(manitem ,[editor])

PARAMETERS :

Scilab Group April 1993 239

meof Scilab Function

manitem : character string (usually, name of a function)

editor : character string

DESCRIPTION :
edit(manitem ,[editor]) opens the file manitem in the editor given by editor.
Default editor is Emacs. This function should be customized according to your needs.
EXAMPLE :

//manedit(’lqg’)

S EE A LSO : whereis 77, edit 267

1.4.15 mclearerr reset binary file access errors

CALLING SEQUENCE :

mclearerr([fd])

PARAMETERS :

fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.

DESCRIPTION :
The function clearerr is used to resets the error indicator and EOF indicator to zero.
S EE A LSO : mclose 240, mopen 244, mput 246, mget 242, mgetstr 244, mputstr
247, meof 241, mseek 248, mtell 249, ?? file, read, write, save, load

1.4.16 mclose close an opened file

CALLING SEQUENCE :

err=mclose([fd])
mclose(’all’)

PARAMETERS :

fd : scalar. The fd parameter returned by the function mopen is used as a file descriptor (it’s a positive
integer).
err : a scalar. Error indicator : vector

DESCRIPTION :
mclose must be used to close a file opened by mopen. If fd is omitted mclose closes the last opend
file.
mclose(’all’) closes all files opened by file(’open’,..) or mopen
S EE A LSO : meof 241, mfprintf 245, fprintfMat 236, mfscanf 248, fscanfMat
237, mget 242, mgetstr 244, mopen 244, ?? mprintf, mput, mputstr, mscanf, mseek, mtell, file

Scilab Group April 1999 240

mfscanf Scilab Function

1.4.17 meof check if end of file has been reached

CALLING SEQUENCE :

err=meof(fd)

PARAMETERS :

fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
err : scalar. Error indicator

DESCRIPTION :
The function meof will return a non null value if end of file has been reached in a previous call to mget
or mgetstr. The function clearerr is used to reset the error flag and EOF flag to zero.
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, ?? mgetstr, mopen, mprintf, mput, mputstr, mscanf, mseek, mtell

1.4.18 mscanf interface to the C scanf function

mfscanf - interface to the C fscanf function
msscanf - interface to the C sscanf function

CALLING SEQUENCE :

[n,v_1,...v_n]=mfscanf(fd,format)
L=mfscanf(fd,format)

[n,v_1,...v_n]=mscanf(format)
L=mscanf(format)

[n,v_1,...v_m]=msscanf(format,str)
L=msscanf(format)

PARAMETERS :

format : a Scilab string describing the format to use to write the remaining operands. The format operand
follows, as close as possible, the C printf format operand syntax.
fd :The fd parameter returned by the function mopen is used as a file descriptor (it’s a positive integer).
When specifying the fd parameter, the value -1 refers to the default file ( i.e the last opened file).
str : a Scilab string.
n : an integer, the number of data read or -1 if EOL has been encountered before any datum has been read.
v i : Each function reads characters, interprets them according to a format, and stores the results in its
output arguments. If more than $n$ output arguments are provided, the last ones v n+1,...v m
are set to empty matrices.
L : a matrix of strings or numbers if data read are homogeous or an mlist of type (cblock) containing a
sequence of homogeneous matrices

DESCRIPTION :
The mfscanf function reads characters from the stream fd.
The mscanf function reads characters from Scilab window.
The msscanf function reads characters from the Scilab string str.
EXAMPLES :

Scilab Group May 1999 241

mget Scilab Function

s=’1 1.3’
[n,a,b]=msscanf(s,"%i %e")
msscanf(s,"%i %e")

msscanf(" 12\\n",’%c%c%c%c’) //scan characters

msscanf(’0xabc’,’%x’) //scan with hexadecimal format

msscanf(’012345abczoo’,’%[0-9abc]%s’) //[] notation

//create a file with data

u=mopen(TMPDIR+’/foo’,’w’);
t=0.5;mfprintf(u,"%6.3f %6.3f\\n",t,sin(t))
t=0.6;mfprintf(u,"%6.3f %6.3f\\n",t,sin(t))
mclose(u);
//read the file
u=mopen(TMPDIR+’/foo’,’r’);
[n,a,b]=mfscanf(u,’%e %e’)
l=mfscanf(u,’%e %e’)
mclose(u);

S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.19 mget reads byte or word in a given binary format and convert to double
mgeti - reads byte or word in a given binary format return an int type

CALLING SEQUENCE :

x=mget([n,type,fd])
x=mgeti([n,type,fd])
PARAMETERS :

n :a positive scalar: The number of items to be read.

fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
type : a string. Give the binary format used to write all the entries of x.
x : a vector of floating point or integer type numbers
DESCRIPTION :
The mget function reads data in the input specified by the stream parameter fd and returns a vector of
floating point data. The mgeti function reads data in the input specified by the stream parameter fd and
returns a vector of integer data.
Data is read at the position at which the file pointer is currently pointing and advances the indicator appro-
priately.
The type parameter is a conversion specifier which may be set to any of the following flag characters
(with default value ”l”):
"l","i","s","ul","ui","us","d","f","c","uc" : for reading respectively a long, an int, a
short, an unsigned long, an unsigned int, an unsigned short, a double, a float, a char and an unsigned
char. The bytes which are read are automatically swapped if necessary (by checking little-endian
status). This default swapping mode can be suppressed by adding a flag in the mopen function.
Format ”l”, ”d” and ”f” are valid only with the mget function.

Scilab Group April 1999 242

mgetstr Scilab Function

"..l" or "..b" : It is also possible to read in little-endian or big-endian mode by adding a ’l’ or ’b’
character at the end of a type specification. For example ”db” will read a double in big-endian mode.

EXAMPLE :

file1 = ’test1.bin’;
file2 = ’test2.bin’;
fd1=mopen(file1,’wb’);
fd2=mopen(file2,’wb’);
mput(1996,’ull’,fd1);
mput(1996,’ull’,fd2);
mclose(fd1);
mclose(fd2);

fd1=mopen(file1,’rb’);
if 1996<>mget(1,’ull’,fd1) ;write(%io(2),’Bug’);end;
fd2=mopen(file2,’rb’);
if 1996<>mget(1,’ull’,fd2) ;write(%io(2),’Bug’);end;
mclose(fd1);
mclose(fd2);

S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.20 mgetl read lines from an ascii file

CALLING SEQUENCE :

txt=mgetl(file_desc [,m])

PARAMETERS :

file desc :a character string giving the file name or a logical unit returned by mopen
m : an integer scalar. Default value is -1.
txt : a column vector of string

DESCRIPTION :
mgetl function allows to read a lines from an ascii file.
If m is omitted or is -1 all lines till end of file occurs are read.
If m is given mgetl tries to read exactly m lines, if an end of file occurs before m lines are read an error
is issued. This option is useful to sequentialy read part of a file as follow
mgetl allows to read files coming from Unix, Windows, or Mac operating systems.
EXAMPLE :

mgetl(’SCI/scilab.star’,5)

mgetl SCI/macros/elem/and.sci

fd=mopen(’SCI/scilab.star’,’r’)
mgetl(fd,10)
mclose(fd)

S EE A LSO : mputl 247, mclose 240, mfscanf 248, mget 242, mgetstr 244, mopen
244, read 254
AUTHOR : S. Steer

Scilab Group April 1993 243

mopen Scilab Function

1.4.21 mgetstr read a character string

CALLING SEQUENCE :

str=mgetstr([n,fd])

PARAMETERS :

n :a positive scalar: The number of character to read.

fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
str : a character string

DESCRIPTION :
mgetstr function allows to read a character string in a binary file. If EOF is reached before read completion
only the properly read values will be returned.
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.22 mopen open a file

CALLING SEQUENCE :

[fd,err]=mopen(file [, mode, swap ])

PARAMETERS :

file : a character string. The pathname of the file to open.

mode : a character string that controls whether the file is opened for reading (r), writing (w), or appending
(a) and whether the file is opened for updating (+). The mode can also include a b parameter to
indicate a binary file.
swap : a scalar. If swap is present and swap=0 then automatic bytes swap is disabled.
err : a scalar. Error indicator
fd : scalar. The fd parameter returned by the function mopen is used as a file descriptor (it’s a positive
integer).

DESCRIPTION :
mopen may be used to open a file in a way compatible with the C fopen procedure. Without swap
argument the file is supposed to be coded in ”little endian IEEE format” and data are swaped if necessary
to match the IEEE format of the processor.
The mode parameter controls the access allowed to the stream. The parameter can have one of the following
values. In this list of values, the b character indicates a binary file

r or rb : Opens the file for reading.

w or wb : Creates a new file for writing, or opens and truncates a file to zero length.
a or ab : Appends (opens a file for writing at the end of the file, or creates a file for writing).
r+ or r+b : Opens a file for update (reading and writing).
w+ or w+b : Truncates to zero length or creates a file for update.
a+ or a+b :Appends (opens a file for update, writing at the end of the file, or creates a file for writing).
When you open a file for update, you can perform both input and output operations on the resulting
stream. However, an output operation cannot be directly followed by an input operation without a
file-positioning operation (mseek() function). Also, an input operation cannot be directly followed

Scilab Group April 1999 244

mprintf Scilab Function

by an output operation without an intervening file positioning operation, unless the input operation
encounters the end of the file.
When you open a file for append (that is, when the mode parameter is a or a+), it is impossible to
overwrite information already in the file. You can use the fseek() function to reposition the file pointer
to any position in the file, but when output is written to the file, the current file pointer is ignored. All
output is written at the end of the file and the file pointer is repositioned to the end of the output.

To open files in a way compatible with Fortran like functions use function file.
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.23 mfprintf converts, formats, and writes data to a file

mprintf - converts, formats, and writes data to the main scilab window
msprintf - converts, formats, and writes data in a string

CALLING SEQUENCE :

mfprintf(fd,format,a1,...,an);
mprintf(format,a1,...,an);
str=msprintf(format,a1,...,an);

PARAMETERS :

fd : scalar, file descriptor given by mopen (it’s a positive integer). The value -1 refers to the default
file ( i.e the last opened file).
format : a Scilab string describing the format to use to write the remaining operands. The format operand
follows, as close as possible, the C printf format operand syntax.
str : a character string, string to be scanned.
a1,...,an : Specifies the data to be converted and printed according to the format parameter.

DESCRIPTION :
The mprintf, mfprintf, and msprintf functions are interface for C-coded version of printf,
fprintf and sprintf functions.
The mprintf function writes formatted operands to the standard Scilab output (i.e the Scilab window).
The argument operands are formatted under control of the format operand.
The mfprintf function writes formatted operands to the file specified by the file desciptor fd. The
argument operands are formatted under control of the format operand.
The msprintf writes formatted operands in its returned value (a Scilab string). The argument operands
are formatted under control of the format operand. Note that, in this case, the escape sequences (", ,..")
are treated as a normal sequence of characters.
All these functions may be used to output column vectors of numbers and string vectors without an explicit
loop on the elements. In that case these functions iterates on the rows. The shortest vector gives the number
of time the format has to be iterated.
An homogeneous sequence of identical type parameters can be replaced by a matrix
EXAMPLE :

mprintf(’At iteration %i, Result is:\nalpha=%f’,33,0.535)

msprintf(’%5.3f %5.3f’,123,0.732)
msprintf(’%5.3f\\n%5.3f’,123,0.732)

A=rand(5,2);
// vectorized forms: the format directive needs
// two operand, each column of A is used as an operand.

Scilab Group Aug 1999 245

mput Scilab Function

// and the mprintf function is applied on each row of A

mprintf(’%5.3f\\t%5.3f\\n’,A)

colors=[’red’;’green’;’blue’;’pink’;’black’];
RGB=[1 0 0;0 1 0;0 0 1;1 0.75 0.75;0 0 0];
mprintf(’%d\\t%s\\t%f\\t%f\\t%f\\n’,(1:5)’,colors,RGB)

S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.24 mput writes byte or word in a given binary format

CALLING SEQUENCE :

mput(x [,type,fd])

PARAMETERS :

x : a vector of floating point or integer type numbers

fd : scalar. The fd parameter returned by the function. Default value is -1 which stands for the last
(mopen) opened file.
type : a string. Give the binary format used to write all the entries of x.

DESCRIPTION :
The mput function writes data to the output specified by the stream parameter fd. Data is written at the
position at which the file pointer is currently pointing and advances the indicator appropriately.
The tye parameter is a conversion specifier which may be set to any of the following flag characters (with
default value ”l”):

"l","i","s","ul","ui","us","d","f","c","uc" : for writing respectively a long, an int, a

short, an unsigned long, an unsigned int, an unsigned short, a double, a float, a char and an unsigned
char. The bytes which are wrote are automatically swapped if necessary (by checking little-endian
status) in order to produce machine independent binary files ( in little-endian mode). This default
swapping mode can be suppressed by adding a flag in the mopen function.
"..l" or "..b" : It is also possible to write in little-endian or big-endian mode by adding a ’l’ or
’b’ character at the end of a type specification. For example ”db” will write a double in big-endian
mode.

EXAMPLE :

filen = ’test.bin’;
mopen(filen,’wb’);
mput(1996,’l’);mput(1996,’i’);mput(1996,’s’);mput(98,’c’);
// force little-endian
mput(1996,’ll’);mput(1996,’il’);mput(1996,’sl’);mput(98,’cl’);
// force big-endian
mput(1996,’lb’);mput(1996,’ib’);mput(1996,’sb’);mput(98,’cb’);
//
mclose();
mopen(filen,’rb’);
if 1996<>mget(1,’l’) then pause,end
if 1996<>mget(1,’i’) then pause,end
if 1996<>mget(1,’s’) then pause,end

Scilab Group April 1993 246

mscanf Scilab Function

if 98<>mget(1,’c’) then pause,end

// force little-endian
if 1996<>mget(1,’ll’) then pause,end
if 1996<>mget(1,’il’) then pause,end
if 1996<>mget(1,’sl’) then pause,end
if 98<>mget(1,’cl’) then pause,end
// force big-endian
if 1996<>mget(1,’lb’) then pause,end
if 1996<>mget(1,’ib’) then pause,end
if 1996<>mget(1,’sb’) then pause,end
if 98<>mget(1,’cb’) then pause,end
//
mclose();

S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.25 mputl writes strings in an ascii file

CALLING SEQUENCE :

mputl(txt [,file_desc])

PARAMETERS :

file desc :a character string giving the file name or a logical unit returned by mopen. If omitted lines
are written in the last file opened by mopen.
txt : a vector of strings.

DESCRIPTION :
mputl function allows to write a vector of strings as a sequence of lines in an ascii file.
S EE A LSO : mputl 247, mclose 240, mfprintf 245, mput 246, mputstr 247, mopen
244, write 262
AUTHOR : S. Steer

1.4.26 mputstr write a character string in a file

CALLING SEQUENCE :

mputstr(str [, fd]);

PARAMETERS :

fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
str : a character string

DESCRIPTION :
mputstr function allows to write a character string in a binary file.
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

Scilab Group Aug 1999 247

mseek Scilab Function

1.4.27 mfscanf scan data from file

mscanf - scan data from input
msscanf - scan data from string

CALLING SEQUENCE :

[n,a1,...,am]=mfscanf(fd,format);
data=mfscanf(fd,format);

[n,a1,...,am]=mscanf(format);
data=mscanf(format);

[n,a1,...,am]=msscanf(str,format);
data=msscanf(str,format);

PARAMETERS :

fd : scalar, file descriptor given by mopen (it’s a positive integer). The value -1 refers to the default
file ( i.e the last opened file).
format : a character string, a C like format.
str : a character string, string to be scanned.
n : a scalar integer, the number or data really read.
a1,...,am : Output variables. if m>n the n+1:n last ai’ are set to [].
data : a list formed by the data really read.

DESCRIPTION :
The mscanf(), mfscanf(), and msscanf() functions are interface for C-coded version of fscanf, sscanf
and scanf functions.
The mscanf(), mfscanf(), and msscanf() functions read character data, interpret it according to a format
(see cformat), and store the converted results into variables. The format parameter contains conversion
specifications used to interpret the input.
These functions read their input from the following sources:
mscanf() : Reads from the Scilab input.
mfscanf() : Reads from the file given by the file descriptor fd.
msscanf() : Reads from the character string specified by the str parameter.

EXAMPLE :

[n,a1,a2]=msscanf(’123 456’,’%i %s’)

[n,a1,a2,a3]=msscanf(’123 456’,’%i %s’)
data=msscanf(’123 456’,’%i %s’)

fd=mopen(SCI+’/scilab.star’,’r’)
mfscanf(fd,’%s %s %s’)
mclose(fd)

S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.28 mseek set current position in binary file.

CALLING SEQUENCE :

Scilab Group April 1993 248

newest Scilab Function

mseek(n [,fd, flag])

PARAMETERS :
n :a positive scalar: The offset from origin in number of bytes.
fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
flag : a string. specifies the origin. Default value ’set’.
DESCRIPTION :
The function mseek() sets the position of the next input or output operation on the stream fd. The new
position is at the signed distance given by n bytes from the beginning, from the current position, or from
the end of the file, according to the flag value which can be ’set’, ’cur’ or ’end’.
mseek() allows the file position indicator to be set beyond the end of the existing data in the file. If
data is later written at this point, subsequent reads of data in the gap will return zero until data is actually
written into the gap. mseek(), by itself, does not extend the size of the file.
EXAMPLE :
file3=’test3.bin’
fd1= mopen(file3,’wb’);
for i=1:10, mput(i,’d’); end
mseek(0);
mput(678,’d’);
mseek(0,fd1,’end’);
mput(932,’d’);
mclose(fd1)
fd1= mopen(file3,’rb’);
res=mget(11,’d’)
res1=[1:11]; res1(1)=678;res1($)=932;
if res1<>res ;write(%io(2),’Bug’);end;
mseek(0,fd1,’set’);
// trying to read more than stored data
res1=mget(100,’d’,fd1);
if res1<>res ;write(%io(2),’Bug’);end;
meof(fd1)
mclearerr(fd1)
mclose(fd1);
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

1.4.29 mtell binary file management

CALLING SEQUENCE :
mtell([fd])
PARAMETERS :
fd : scalar. The fd parameter returned by the function mopen. -1 stands for last opened file. Default
value is -1.
DESCRIPTION :
The function mtell() returns the offset of the current byte relative to the beginning of the file associated
with the named stream fd.
S EE A LSO : mclose 240, meof 241, mfprintf 245, fprintfMat 236, mfscanf 248,
fscanfMat 237, mget 242, mgetstr 244, mopen 244, mprintf 245, mput 246, mputstr
247, mscanf 248, mseek 248, mtell 249

Scilab Group July 2000 249

oldsave Scilab Function

1.4.30 newest returns newest file of a set of files

CALLING SEQUENCE :

k=newest(paths)
k=newest(path1,path2,...,pathn)

PARAMETERS :

k : the index of the newest file

paths : a character string vector (or list), paths(i) is the pathname of ith file
pathi : a character string, the pathname of ith file

DESCRIPTION :
Given a set of pathnames newest returns the index of the newest one. Non existant files are supposed to be
the oldest.
EXAMPLE :

newest(’SCI/macros/xdess/bode.sci’,’SCI/macros/xdess/bode.bin’)
newest(’SCI/macros/xdess/bode.’+[’sci’,’bin’])

S EE A LSO : fileinfo 235

1.4.31 oldload load saved variable in 2.4.1 and previous formats

CALLING SEQUENCE :

oldload(’file-name’ [,x1,...,xn])

PARAMETERS :

file-name : character string

xi : arbitrary Scilab variable name(s) given as strings.

DESCRIPTION :
The oldload function is obsolete and is retained only for compatibility purpose.
The oldload command can be used to reload in the Scilab session variables previously saved in a file
with the save command.
oldload(’file-name’) loads the variables saved in file ’file-name’.
oldload(’file-name’,’x’,’y’,...,’z’) loads only variables x,y,...,z stored in file ’file-name’.

EXAMPLES :

a=eye(2,2);b=ones(a);
oldsave(’TMPDIR/vals.dat’,a,b);
clear a
clear b
oldload(’TMPDIR/vals.dat’,’a’,’b’);

S EE A LSO : save 258, getf 272

Scilab Group April 1999 250

printf Scilab Function

1.4.32 oldsave saving variables in 2.4.1 and previous format

CALLING SEQUENCE :

oldsave(filename [,x1,x2,...,xn])

PARAMETERS :

filename : character string or a logical unit returned by file(’open’,...)

xi : arbitrary Scilab variable(s)

DESCRIPTION :
The oldsave function is obsolete and is retained only for compatibility purpose.
The oldsave command can be used to save Scilab current variables in binary form in a file.
oldsave(filename) saves all current variables in the file defined by filename.
oldsave(file-name,x,y) saves only named variables x and y.
Saved variables can be reloaded by the load or oldload command.
EXAMPLES :

a=eye(2,2);b=ones(a);
oldsave(’TMPDIR/val.dat’,a,b);
clear a
clear b
oldload(’TMPDIR/val.dat’,’a’,’b’);

S EE A LSO : load 239, file 234

1.4.33 print prints variables in a file

CALLING SEQUENCE :

print(’file-name’,x1,[x2,...xn])

DESCRIPTION :
prints xi on file ’file-name’ with the current format, i.e. the format used by scilab to display the
variables. All types of variables may be ”print”’ed
Note : xi must be a named variable, with expressions variable name part of the display is unpredictable.
print(%io(2),...) prints on Scilab’s window. this syntax may be used to display variables within
a macro.
EXAMPLES :

a=rand(3,3);p=poly([1,2,3],’s’);l=list(1,’asdf’,[1 2 3]);
print(%io(2),a,p,l)
write(%io(2),a)

S EE A LSO : write 262, read 254, format 42, printf 252, disp 233

Scilab Group May 1994 251

printf conversion Scilab Documentation

1.4.34 printf Emulator of C language printf function

CALLING SEQUENCE :

printf(format,value_1,..,value_n)

PARAMETERS :

format : a Scilab string. Specifies a character string combining literal characters with conversion speci-
fications.
value i : Specifies the data to be converted according to the format parameter.
str : column vector of character strings
file : a Scilab string specifying a file name or a logical unit number (see file)

DESCRIPTION :
The printf function converts, formats, and writes its value parameters, under control of the format
parameter, to the standard output.
The format parameter is a character string that contains two types of objects:

Literal characters : which are copied to the output stream.

Conversion specifications : each of which causes zero or more items to be fetched from the
value parameter list. see printf conversion for details

If any values remain after the entire format has been processed, they are ignored.
EXAMPLES :

printf(’Result is:\\nalpha=%f",0.535)

S EE A LSO : string 284, print 251, write 262, format 42, disp 233, file 234,
fprintf 235, sprintf 260

1.4.35 printf conversion printf, sprintf, fprintf conversion specifications

DESCRIPTION :
Each conversion specification in the printf , sprintf , fprintf format parameter has the fol-
lowing syntax:

- A % (percent) sign.
- Zero or more options, which modify the meaning of the conversion specification. The following list
contains the option characters and their meanings:
- : Left align, within the field, the result of the conversion.
+ : Begin the result of a signed conversion with a sign (+ or -).
"space" : Prefix a space character to the result if the first character of a signed conversion is not a sign.
If both the (space) and + options appear, the (space) option is ignored.
# : Convert the value to an alternate form. For c, d, i, s, and u conversions, the # option has no effect.
For o conversion, # increases the precision to force the first digit of the result to be a 0 (zero).
For x and X conversions, a nonzero result has 0x or 0X prefixed to it. For e, E, f, g, and
G conversions, the result always contains a decimal point, even if no digits follow it. For g and G
conversions, trailing zeros are not removed from the result.
0 : Pad to the field width, using leading zeros (following any indication of sign or base) for d, i, o, u, x,
X, e, E, f, g, and G conversions; no space padding is performed. If the 0 and -- (dash) flags both
appear, the 0 flag is ignored. For d, i, o u, x, and X conversions, if a precision is specified, the 0
flag is also ignored.

Scilab Group May 1994 252

printf conversion Scilab Documentation

An optional decimal digit string that specifies the minimum field width. If the converted value has fewer
characters than the field width, the field is padded on the left to the length specified by the field width. If
the left-adjustment option is specified, the field is padded on the right.
An optional precision. The precision is a . (dot) followed by a decimal digit string. If no precision is
given, the parameter is treated as 0 (zero). The precision specifies:

- The minimum number of digits to appear for d, u, o, x, or X conversions

- The number of digits to appear after the decimal point for e, E, and f conversions
- The maximum number of significant digits for g and G conversions
- The maximum number of characters to be printed from a string in an s conversion
- A character that indicates the type of conversion to be applied:
% : Performs no conversion. Displays %.
d,i :Accepts an integer value and converts it to signed decimal notation. The precision specifies the
minimum number of digits to appear. If the value being converted can be represented in fewer digits,
it is expanded with leading zeros. The default precision is 1. The result of converting a zero value
with a precision of zero is a null string. Specifying a field width with a zero as a leading character
causes the field width value to be padded with leading zeros.
u :Accepts an integer value and converts it to unsigned decimal notation. The precision specifies the
minimum number of digits to appear. If the value being converted can be represented in fewer digits,
it is expanded with leading zeros. The default precision is 1. The result of converting a zero value
with a precision of zero is a null string. Specifying a field width with a zero as the leading character
causes the field width value to be padded with leading zeros.
o :Accepts an integer value and converts it to unsigned octal notation. The precision specifies the mini-
mum number of digits to appear. If the value being converted can be represented in fewer digits, it is
expanded with leading zeros. The default precision is 1. The result of converting a zero value with a
precision of zero is a null string. Specifying a field width with a zero as the leading character causes
the field width value to be padded with leading zeros. An octal value for field width is not implied.
x, X :Accepts an integer value and converts it to unsigned hexadecimal notation. The letters “abcdef”
are used for the x conversion; the letters “ABCDEF” are used for the X conversion. The precision
specifies the minimum number of digits to appear. If the value being converted can be represented in
fewer digits, it is expanded with leading zeros. The default precision is 1. The result of converting a
zero value with a precision of zero is a null string. Specifying a field width with a zero as the leading
character causes the field width value to be padded with leading zeros.
f : Accepts a float or double value and converts it to decimal notation in the format %[–]ddd.ddd.
The number of digits after the decimal point is equal to the precision specification.
- If no precision is specified, six digits are output.
- If the precision is zero, no decimal point appears and the system outputs a number rounded to the integer
nearest to value.
- If a decimal point is output, at least one digit is output before it.
e, E :Accepts a real and converts it to the exponential form %[–]d.ddde+/–dd. There is one digit
before the decimal point, and the number of digits after the decimal point is equal to the precision
specification.
- If no precision is specified, , six digits are output.
- If the precision is zero, , no decimal point appears.
- The E conversion character produces a number with E instead of e before the exponent. The exponent
always contains at least two digits. If the value is zero, the exponent is zero.
g, G : Accepts a real and converts it in the style of the e, E, or f conversion characters, with the precision
specifying the number of significant digits. Trailing zeros are removed from the result. A decimal
point appears only if it is followed by a digit. The style used depends on the value converted. Style e
(E, if G is the flag used) results only if the exponent resulting from the conversion is less than -4, or
if it is greater or equal to the precision.
c :Accepts and displays an integer value converted to a character.
s :Accepts a string value and displays characters from the string to the end or the number of characters
indicated by the precision is reached. If no precision is specified, all characters up to the end are
displayed.

Scilab Group May 1994 253

read Scilab Function

A field width or precision can be indicated by an * (asterisk) instead of a digit string. In this case,
an integer value parameter supplies the field width or precision. The value parameter converted
for output is not fetched until the conversion letter is reached, so the parameters specifying field width
or precision must appear before the value to be converted (if any).
If the result of a conversion is wider than the field width, the field is expanded to contain the converted
result.
The representation of the plus sign depends on whether the + or (space) formatting option is speci-
fied.

S EE A LSO : printf 252, fprintf 235, sprintf 260

1.4.36 read matrices read

CALLING SEQUENCE :

[x]=read(file-desc,m,n,[format])
[x]=read(file-desc,m,n,k,format)

PARAMETERS :

file-desc : character string specifying the file name or integer value specifying logical unit (see file).
m, n : integers (dimensions of the matrix x). Set m=-1 if you do not know the numbers of rows, so the
whole file is read.
format : character string, specifies a "Fortran" format. This character string
must begin with a right parenthesis and end with a left parenthesis. Formats cannot mix floating point
or character edition modes.
k : integer or vector of integer

DESCRIPTION :
reads row after row the mxn matrix x (n=1 for character chain) in the file file-desc (string or
integer). Each row of the matrix x begin in a new line of file-desc file. Depending on format, a
given row of the x matrix may be read from more than one line of file-desc file.
The type of the result will depend on the specified format. If format contains only (d,e,f,g) descriptors
the function tries to read numerical data (the result is matrix of real numbers).
If format contains only a descriptors the function tries to read character strings (the result is a character
string column vector). In this case n must be equal to 1.
Examples for format:
(1x,e10.3,5x,3(f3.0))
(10x,a20)
.LP
When format is omitted datas are read using numerical free format:
blank, comma and slash may be used as data separators, n*v may be use
to represent n occurrences of value n.

.LP
A direct access file can be used if using the parameter \fVk\fR which is
is the vector of record numbers to be read (one record per row),
thus \fVm\fR must be \fVm=prod(size(k))\fR.
.LP
To read on the keyboard use \fVread(%io(1),...)\fR.
.SH REMARK
Last line of data files must be terminated by a newline to be taken
into account.

Scilab Group April 1993 254

readc Scilab Function

.SH EXAMPLE
.nf
if MSDOS then unix(’del foo’);
else unix(’rm -f foo’); end
A=rand(3,5); write(’foo’,A);
B=read(’foo’,3,5)
B=read(’foo’,-1,5)
read(%io(1),1,1,’(a)’) // waits for user’s input

S EE A LSO : file 234, readb 255, write 262, x_dialog 292, mscanf 248, mfscanf
248, msscanf 248, fscanfMat 237

1.4.37 read4b fortran file binary read

CALLING SEQUENCE :

x=read4b(file-name,m,n [,rec])

PARAMETERS :

file-name : string or integer

m, n : integers (dimensions of the matrix x). Set m=-1 if you do not know the numbers of rows, so all the
file is read
rec : vector of positive integers. the selected records for direct access. This vector size must be equal to
the number of rows of desired x.

DESCRIPTION :
binary read of the matrix x in the file file-name. Matrix entries are supposed to have been stored on 4
byte words.
For direct record access, file must have been previously opened using file function to set the record length.
file-name must be the result of the file function.
S EE A LSO : file 234, write 262, writb 261, mget 242, write4b 262

1.4.38 readb fortran file binary read

CALLING SEQUENCE :

x=readb(file-name,m,n [,rec])

PARAMETERS :

file-name : string or integer

m, n : integers (dimensions of the matrix x). Set m=-1 if you do not know the numbers of rows, so all the
file is read
rec : vector of positive integers. the selected records for direct access. This vector size must be equal to
the number of rows of desired x.

DESCRIPTION :
binary read of the matrix x in the file file-name. Matrix entries are supposed to have been stored on 8
byte words.
For direct record access, file must have been previously opened using file function to set the record length.
file-name must be the result of the file function.
S EE A LSO : file 234, write 262, writb 261, mget 242, read4b 255

Scilab Group April 1993 255

readmps Scilab Function

1.4.39 readc read a character string

CALLING SEQUENCE :

[c]=readc_(unit)
[c]=readc_()

DESCRIPTION :
readc reads a character string. This function allows one to interrupt an exec file without pause; the
exec file stops until carriage return is made.
S EE A LSO : read 254

1.4.40 readmps reads a file in MPS format

CALLING SEQUENCE :

mps= readmps (file-name,bounds [,maxsizes]);

PARAMETERS :

file-name : character string, path of the MPS file

bounds : 2-vector [lowbound,upbound] , default lower ans upper bounds
maxsizes : 3-vector [maxm,maxn,maxnza] Maximum number of contraints and variables, maxi-
mum number of nonzeros entries in the LP constraint matrix. If omitted readmps reads the file once
just to compute these numbers.
mps : tlist with following fields
irobj : integer (index of the objective row).
namec : character string (Name of the objective).
nameb : character string (Name of the right hand side).
namran : character string (Name of the ranges section).
nambnd : character string (Name of the bounds section).
name : character string (Name of the LP problem).
rownames : character string column vector (Name of the rows). colnames : character string row vector
(Name of the columns).
rowstat : integer vector, row types:
1 : row type is ”=”
2 : row type is ”>=”
3 : row type is ”<=”
4 : objective row
5 : other free row
rowcode : real matrix [hdrowcd,lnkrow] with
hdrowcd : real vector (Header to the linked list of rows with the same codes).
lnkrow : integer vector (Linked list of rows with the same codes).
colcode : real matrix [hdcolcd,lnkcol] with
hdcolcd : integer vector (Header to the linked list of columns with the same codes).
lnkcol : integer vector (Linked list of columns with the same codes).
rownmbs : integer vector (Row numbers of nonzeros in columns of matrix A.)
colpnts : integer vector (Pointers to the beginning of columns of matrix A).
acoeff : real vector (Array of nonzero elements for each column).
rhs :real vector ( Right hand side of the linear program).
ranges : real vector of constraint ranges.
bounds : real matrix [lbounds,ubounds] with
ubounds : full column vector of upper bounds

Scilab Group MAY 1998 256

readmps Scilab Function

lbounds : full column vector of lower bounds

stavar : full column vector of variable status
0 :standard (non negative) variable
1 : upper bounded variable
2 : lower bounded variable
3 : lower and upper bounded variable
4 : minus infinity type variable i.e -inf<x<=u
5 : plus infinity type variable i.e l<=x< inf
6 : fixed type variable i.e l=x=u
-k : free variable

DESCRIPTION :
readmps. Utility function: reads a file containing description of an LP problem given in MPS format. It
is an interface with the program rdmps1.f of hopdm (J. Gondzio). For a description of the variables, see
the file rdmps1.f.
MPS format is a standard ASCII medium for LP codes. MPS format is described in more detail in Murtagh’s
book:
Murtagh B. (1981). Advanced Linear Programming, McGrew-Hill, New York, 1981.
EXAMPLE :

//Let the LP problem:

//objective:
// min XONE + 4 YTWO + 9 ZTHREE
//constraints:
// LIM1: XONE + YTWO < = 5
// LIM2: XONE + ZTHREE > = 10
// MYEQN: - YTWO + ZTHREE = 7
//Bounds
// 0 < = XONE < = 4
// -1 < = YTWO < = 1

//Generate MPS file

txt=[’NAME TESTPROB’
’ROWS’
’ N COST’
’ L LIM1’
’ G LIM2’
’ E MYEQN’
’COLUMNS’
’ XONE COST 1 LIM1 1’
’ XONE LIM2 1’
’ YTWO COST 4 LIM1 1’
’ YTWO MYEQN -1’
’ ZTHREE COST 9 LIM2 1’
’ ZTHREE MYEQN 1’
’RHS’
’ RHS1 LIM1 5 LIM2 10’
’ RHS1 MYEQN 7’
’BOUNDS’
’ UP BND1 XONE 4’
’ LO BND1 YTWO -1’
’ UP BND1 YTWO 1’
’ENDATA’];
u=file(’open’,’/tmp/test.mps’,’unknown’)

Scilab Group MAY 1998 257

scanf Scilab Function

write(u,txt,’(a)’);file(’close’,u)
//Read the MPS file
P=readmps(’/tmp/test.mps’,[0 10ˆ30])
//Convert it to linpro format
LP=mps2linpro(P)
//Solve it with linpro
[x,lagr,f]=linpro(LP(2:$))

S EE A LSO : mps2linpro 202

1.4.41 save saving variables in binary files

CALLING SEQUENCE :

save(filename [,x1,x2,...,xn])
save(fd [,x1,x2,...,xn])
PARAMETERS :

filename : character string containing the path of the file

fd : a file descriptor given by a call to mopen
xi : arbitrary Scilab variable(s)
DESCRIPTION :
The save command can be used to save Scilab current variables in a binary file. The file can be given
either by its paths or by its descriptor previously given by mopen.
save(filename) saves all current variables in the file defined by filename.
save(fd) saves all current variables in the file defined by the descriptor
fd.
save(filename,x,y) or save(fd,x,y) saves only named variables x and y.
Saved variables can be reloaded by the load command.
EXAMPLES :

a=eye(2,2);b=ones(a);
save(’val.dat’,a,b);
clear a
clear b
load(’val.dat’,’a’,’b’);

// sequential save into a file

fd=mopen(’TMPDIR/foo’,’wb’)
for k=1:4, x=kˆ2;save(fd,x,k),end
mclose(fd)
fd=mopen(’TMPDIR/foo’,’rb’)
for i=1:4, load(fd,’x’,’k’);x,k,end
mclose(fd)

// appending variables to an old save file

fd=mopen(’TMPDIR/foo’,’r+’)
mseek(0,fd,’end’)
lst=list(1,2,3)
save(fd,lst)
mclose(fd)

S EE A LSO : load 239, mopen 244

Scilab Group May 1994 258

printf Scilab Function

1.4.42 scanf Converts formatted input on standard input

CALLING SEQUENCE :

[v_1,...v_n]=scanf (format);

PARAMETERS :

format :Specifies the format conversion.

DESCRIPTION :
The scanf functions get character data on standard input (%io(1)), interpret it according to a format, and
returns the converted results.
The format parameter contains conversion specifications used to interpret the input.
The format parameter can contain white-space characters (blanks, tabs, newline, or formfeed) that,
except in the following two cases, read the input up to the next nonwhite-space character. Unless there is a
match in the control string, trailing white space (including a newline character) is not read.
- Any character except % (percent sign), which must match the next character of the input stream.
- A conversion specification that directs the conversion of the next input field. see scanf conversion
for details.

S EE A LSO : printf 252, read 254, fscanf 237, sscanf 260

1.4.43 scanf conversion scanf, sscanf, fscanf conversion specifications

DESCRIPTION :
Each conversion specification in the format parameter contains the following elements:
+ The character % (percent sign)
+ The optional assignment suppression character *
+ An optional numeric maximum field width
+ A conversion code
The conversion specification has the following syntax:
[*][width][size]convcode.
The results from the conversion are placed in v i arguments unless you specify assignment suppression
with * (asterisk). Assignment suppression provides a way to describe an input field that is to be skipped.
The input field is a string of nonwhite-space characters. It extends to the next inappropriate character or
until the field width, if specified, is exhausted.
The conversion code indicates how to interpret the input field. You should not specify the v i parameter
for a suppressed field. You can use the following conversion codes:

% :Accepts a single % (percent sign) input at this point; no assignment is done.

d, i :Accepts a decimal integer;
u :Accepts an unsigned decimal integer;
o :Accepts an octal integer;
x :Accepts a hexadecimal integer;
e,f,g :Accepts a floating-point number. The next field is converted accordingly and stored through the
corresponding parameter, which should be a pointer to a float. The input format for floating-point
numbers is a string of digits, with the following optional characteristics:
+ It can be a signed value.
+ It can be an exponential value, containing a decimal point followed by an exponent field, which consists
of an E or an e followed by an (optionally signed) integer.

Scilab Group May 1994 259

startup Scilab Function

+ It can be one of the special values INF, NaN,

s :Accepts a string of characters.
c :character value is expected. The normal skip over white space is suppressed.

S EE A LSO : scanf 259, scanf 259, fscanf 237

1.4.44 sprintf Emulator of C language sprintf function

CALLING SEQUENCE :

str=sprintf(format,value_1,..,value_n)
PARAMETERS :

format : a Scilab string. Specifies a character string combining literal characters with conversion speci-
fications.
value i : Specifies the data to be converted according to the format parameter.
str : column vector of character strings
DESCRIPTION :
The sprintf function converts, formats, and stores its value parameters, under control of the format
parameter.
The format parameter is a character string that contains two types of objects:
Literal characters : which are copied to the output stream.
Conversion specifications : each of which causes zero or more items to be fetched from the
value parameter list. see printf conversion for details
If there are not enough items for format in the value parameter list, sprintf generate an error.
If any values remain after the entire format has been processed, they are ignored.
Note: sprintf is obsolete, use msprintf instead.
EXAMPLES :

fahr=120
sprintf(’%3d Fahrenheit = %6.1f Celsius’,fahr,(5/9)*(fahr-32))

S EE A LSO : string 284, print 251, write 262, format 42, disp 233, file 234,
printf 252, fprintf 235, msprintf 245

1.4.45 sscanf Converts formatted input given by a string

CALLING SEQUENCE :

[v_1,...v_n]=sscanf (string,format)
PARAMETERS :

format :Specifies the format conversion. :Specifies the input file name or file number.
string :Specifies input to be read.
DESCRIPTION :
The sscanf functions interpret character string according to a format, and returns the converted results.
The format parameter contains conversion specifications used to interpret the input.
The format parameter can contain white-space characters (blanks, tabs, newline, or formfeed) that,
except in the following two cases, read the input up to the next nonwhite-space character. Unless there is a
match in the control string, trailing white space (including a newline character) is not read.

Scilab Group April 1993 260

write Scilab Function

- Any character except % (percent sign), which must match the next character of the input stream.
- A conversion specification that directs the conversion of the next input field. see scanf conversion
for details.

S EE A LSO : printf 252, read 254, scanf 259, fscanf 237

1.4.46 startup startup file

DESCRIPTION :
The startup files .scilab (in your home directory) and .scilab in your working directory are au-
tomatically executed (if present) when Scilab is invoked, in addition with the file scilab.star in the
Scilab directory.
REMARK :
Last line of startup file must be terminated by a newline to be taken into account.

1.4.47 warning warning messages

CALLING SEQUENCE :

warning(’string’)

DESCRIPTION :
prints the character string ’string’ in a warning message
S EE A LSO : error 35

1.4.48 writb fortran file binary write

CALLING SEQUENCE :

writb(file-name,a [,rec])

PARAMETERS :

file-name : string or integer

rec : vector of positive integers. the selected records for direct access. This vector size must be equal to
the number of rows of a

DESCRIPTION :
writes in binary format the matrix a in the file ’filename’.. Matrix entries are stored on 4 byte words
For direct record access, file must have been previously opened using file function to set the record length.
file-name must be the result of the file function.
S EE A LSO : file 234, readb 255, write 262, mput 246, write4b 262

Scilab Group April 1993 261

xgetfile Scilab Function

1.4.49 write write in a formatted file

DESCRIPTION :

write(file-desc,a,[format])
write(file-desc,a,k,format)

PARAMETERS :

file-desc : character string specifying the file name or integer value specifying logical unit (see file).
a : real matrix or column vector of character strings.
format : character string, specifies a ”Fortran” format. This character string must begin with a right
parenthesis and end with a left parenthesis. Formats cannot mix floating point , integer or character
edition modes
k : integer vector

DESCRIPTION :
writes row-by-row a real matrix or a column vector of character strings in a formatted file. Each row of
the a argument begin in a new line of file-desc file. Depending on format a given row of the a
argument may be written in more than one line of file-desc file.
Format examples : (1x,e10.3,5x,3(f3.0)) , (10x,a20) ;
See a Fortran book for more precision.
Direct access files : x=write(file desc,a,k,format). Here k is the vector of records (one record
by row, i.e. m=prod(size(k))
write(%io(2),....) writes on Scilab’s window.
EXAMPLE :

if MSDOS then unix(’del asave’);

else unix(’rm -f asave’); end
A=rand(5,3); write(’asave’,A); A=read(’asave’,5,3);
write(%io(2),A,’(’’ | ’’,3(f10.3,’’ | ’’))’)
write(%io(2),string(1:10))
write(%io(2),strcat(string(1:10),’,’))
write(%io(2),1:10,’(10(i2,3x))’)

if MSDOS then unix(’del foo’);

else unix(’rm -f foo’); end
write(’foo’,A)

S EE A LSO : file 234, writb 261, read 254, print 251, string 284, mfprintf
245, mprintf 245, msprintf 245, fprintfMat 236

1.4.50 write4b fortran file binary write

CALLING SEQUENCE :

write4b(file-name,a [,rec])

PARAMETERS :

file-name : string or integer

rec : vector of positive integers. the selected records for direct access. This vector size must be equal to
the number of rows of a

Scilab Group Jan 1996 262

xgetfile Scilab Function

DESCRIPTION :
writes in binary format the matrix a in the file ’filename’. Matrix entries are stored on 8 byte words
For direct record access, file must have been previously opened using file function to set the record length.
file-name must be the result of the file function.
S EE A LSO : file 234, readb 255, write 262, mput 246, read4b 255

1.4.51 xgetfile dialog to get a file path

CALLING SEQUENCE :

path=xgetfile([title=’string’])
path=xgetfile(file_mask,[title=’string’])
path=xgetfile(file_mask,dir,[title=’string’])
path=xgetfile(file_mask,dir,’string’)

PARAMETERS :

file mask : a character string which gives the file mask to use for file selection. file mask is written
with Unix convention. the default value is ’*’.
dir : a character string which gives the initial directory used for file search. by default xgetfile uses the
previously selected directory.
path : is the user selected file path if user answers ”Ok” or the ” ” string if user answers ”Cancel”
title=’string’ :Optional arguments which gives the title for the xgetfile window.

DESCRIPTION :
Creates a dialog window for file selection
EXAMPLE :

xgetfile()
xgetfile(’*.sci’,’SCI/macros/xdess’)
xgetfile(title=’Choose a file name ’)

S EE A LSO : x_dialog 292, file 234, read 254, write 262, exec 36, getf 272

Scilab Group Jan 1996 263

xgetfile Scilab Function

1.5 Handling of functions and libraries

Scilab Group Jan 1996 264

comp Scilab Function

1.5.1 addinter new functions interface incremental linking at run time

CALLING SEQUENCE :

addinter(files,spname,fcts)

PARAMETERS :

files : a character string or a vector of character string contain object files used to define the new Scilab
interface routine (interface code, user routines or libraries, system libraries).
spname : a character string. Name of interface routine entry point
fcts : vector of character strings. The name of new Scilab function implemented in the new interface (in
fin the order ).

DESCRIPTION :
addinter performs incremental linking of a compiled C or Fortran new Scilab interface routine (see
intersci documentation) and define corresponding scilab functions.
For machines using dlopen functionality one can unlink an interface with ulink ( use the command
link(’show’) to get the number of the shared library ). And to reload a new version of an interface a
call to ulink is necessary to get rid of the old version.
See link for more precision on use.
S EE A LSO : link 303, intersci 303, newfun 274, clearfun 265

1.5.2 argn number of arguments in a function call

CALLING SEQUENCE :

[lhs [,rhs] ]=argn()

lhs=argn(1)
rhs=argn(2)

DESCRIPTION :
This function is used inside a function definition. It gives the number of actual inputs rhs and output lhs
parameters passed to the function when the function is called. It is usually used in function definitions to
deal with optional arguments.
S EE A LSO : function 268, varargin 277

1.5.3 clearfun remove primitive.

CALLING SEQUENCE :

clearfun(’name’)

DESCRIPTION :
clearfun(’name’) removes the primitive ’name’ from the set of primitives (built-in functions)
. This function allows to rename a primitive : a Scilab primitive can be replaced by a user-defined function.
For experts...
S EE A LSO : newfun 274, funptr 45

Scilab Group April 1993 265

delbpt Scilab Function

1.5.4 comp scilab function compilation

CALLING SEQUENCE :

comp(function [,opt])

PARAMETERS :

function : an not compiled scilab function (type 11)

opt : integer flag with value 0 (default) or 1.

DESCRIPTION :
comp(function) compiles the function function. Compiled and interpreted functions are
equivalent but usually compiled functions are much faster. The functions provided in the standard libraries
are compiled.
The command: getf(’filename’) loads the functions in file ’filename’ and compiles
them. So comp has to be used in very particular cases.
The opt==1 option is specific to code analysis purpose (see macr2lst)
REMARKS :
commands who, help, what cannot be compiled.
S EE A LSO : deff 266, getf 272, whereis 77, macr2lst 273, lib 272

1.5.5 deff on-line definition of function

CALLING SEQUENCE :

deff(’[s1,s2,...]=newfunction(e1,e2,....)’,text [,opt])

PARAMETERS :

e1,e2,..., : input variables.

s1,s2,..., : output variables.
text : matrix of character strings
opt : optional character string
’c’ : function is ”compiled” to be more efficient (default)
’n’ : function is not ”compiled”

DESCRIPTION :
On-line definition of function (user defined function): the name of the created function is newfunction.
text is a sequence of instructions usually set as a vector of character strings.
This command can be used inside a function and the new function can be an input or output of any other
function.
Usually, functions are defined in a file and loaded into Scilab by getf
Some time, in particular when you want to use define strings within deff text is rather difficult to
write. A more tractable way may be to define your function in a file as usual, to load it into Scilab by getf
(without ’c’ option) and use sci2exp to get corresponding deff instructions.
EXAMPLES :

deff(’[x]=myplus(y,z)’,’x=y+z’)
//
deff(’[x]=mymacro(y,z)’,[’a=3*y+1’; ’x=a*z+y’])

S EE A LSO : getf 272, comp 266, exec 36, function 268

Scilab Group April 1993 266

funcprot Scilab Function

1.5.6 delbpt delete breakpoint

CALLING SEQUENCE :

delbpt(’macroname’ [,linenumb])

DESCRIPTION :
deletes the breakpoint at line linenumb in the function macroname. If linenumb is omitted all the
breakpoints in the function are deleted.
EXAMPLE :

setbpt(’foo’,1),setbpt(’foo’,10),delbpt(’foo’,10),dispbpt()
delbpt(’foo’,1)

S EE A LSO : setbpt 276, dispbpt 267, pause 64, resume 68

1.5.7 dispbpt display breakpoints

CALLING SEQUENCE :

dispbpt()

DESCRIPTION :
dispbpt() displays all active breakpoints actually inserted in functions.
S EE A LSO : setbpt 276, delbpt 267, pause 64, resume 68

1.5.8 edit function editing

CALLING SEQUENCE :

newname=edit(functionname [, editor])

PARAMETERS :

functionname : character string

editor : character string

DESCRIPTION :
If functionname is the name of a defined scilab function edit(functionname ,[editor]) try to
open the associated file functionname.sci. If this file can’t be modified edit first create a copy of
this file in the TMPDIR directory.
If functionname is the name of a undefined scilab function edit create a functionname.sci file in the
TMPDIR directory.
When leaving the editor the modified or defined function is loaded into Scilab under the name newname.
The editor character string can be used to specify your favourite text editor.
Default editor is Emacs. This function should be customized according to your needs.
EXAMPLE :

//newedit=edit(’edit’) //opens editor with text of this function

//myfunction=edit(’myfunction’) //opens editor for a new function

S EE A LSO : manedit 239

Scilab Group Jan 1997 267

function Scilab keyword

1.5.9 funcprot switch scilab functions protection mode

CALLING SEQUENCE :

prot=funcprot()
funcprot(prot)

PARAMETERS :

prot : integer with possible values 0,1,2

DESCRIPTION :
Scilab functions are variable, funcprot allows the user to specify what scilab do when such variables are
redefined.

* If prot==0 nothing special is done

* If prot==1 scilab issues a warning message when a function is redefined (default mode)
* If prot==2 scilab issues an error when a function is redefined

EXAMPLE :

funcprot(1)
deff(’[x]=foo(a)’,’x=a’)
deff(’[x]=foo(a)’,’x=a+1’)
foo=33
funcprot(0)
deff(’[x]=foo(a)’,’x=a’)
deff(’[x]=foo(a)’,’x=a+1’)
foo=33

1.5.10 function opens a function definition

endfunction - closes a function definition

SYNTAX :

function <lhs_arguments>=<function_name><rhs_arguments>
<statements>
endfunction

Where

<function name> stands for the name of the function

<rhs arguments> stands for the input argument list. It may be
- a comma separated sequence of variable names enclosed in parenthesis, like (x1,...,xm). Last
variable name can be the key word varargin (see varargin)
- the sequence () or nothing,if the function has no input argument.
<lhs arguments> stands for the output argument list. It may be
- a comma separated sequence of variable names enclosed in brackets, like [y1,...,yn]. Last variable
name can be the key word varargout (see varargout)
- the sequence [] ,if the function has no input argument. In this case the syntax may also be: function
<function name><rhs arguments>
<statements> stands for a set of scilab instructions (statements)

Scilab Group April 1993 268

functions Scilab Data type

DESCRIPTION :
This syntax may be used to define function (see functions) inline or in a script file (see exec). For compat-
ibility with old Scilab versions, functions defined in a script file containing only function definitions can be
”loaded” into Scilab using the getf function.
The function <lhs arguments>=<function name><rhs arguments> sequence cannot
be split over several lines. This sequence can be followed by statements in the same line if a comma of
semi column is added at its end.
function definitions can be nested
EXAMPLE :

//inline definition (see function)

function [x,y]=myfct(a,b)
x=a+b
y=a-b
endfunction

[x,y]=myfct(3,2)

//a one line function definition

function y=sq(x),y=xˆ2,endfunction

sq(3)

//nested functions definition

function y=foo(x)
a=sin(x)
function y=sq(x), y=xˆ2,endfunction
y=sq(a)+1
endfunction

foo(%pi/3)

// definition in an script file (see exec)

exec SCI/macros/elem/asin.sci;

S EE A LSO : functions 269, exec 36, getf 272

1.5.11 functions Scilab procedures and Scilab objects

DESCRIPTION :
Functions are Scilab procedures (”macro”, ”function” and ”procedure” have the save meaning).
FUNCTION DEFINITION :
Usually, they are defined in files with an editor and loaded into Scilab by getf or through a library (see
lib or genlib). But They can also be defined on-line (see deff or function o.
A function is defined by two components:

- a ”syntax definition” part as follows:

[y1,...,yn]=foo(x1,...,xm)
[y1,...,yn,varargout]=foo(x1,...,xm,varargin)

Scilab Group April 1993 269

genlib Scilab Function

- a sequence of scilab instructions.

The ”syntax definition” line gives the ”full” calling syntax of this function. The yi are output
variables calculated as functions of input variables xi and variables existing in Scilab when the
function is executed.

CALLING FUNCTION :
Usually function calling syntax is [y1,...,yn]=foo(x1,...,xm). Shorter input or output argument
list than definition ones may be used. In such cases, only the first variables from the left are used of set.
The argn function may be used to get the actual number of calling arguments.
It is also possible to use ”named argument” to specify input arguments: suppose function fun1 de-
fined as y1=fun1(x1,x2,x3) then it call be called with a syntax like y=fun1(x1=33,x3=[1 2
3]) within fun1 x2 will be undefined. It is possible to check for defined variables with the exists
function
When a function has no left hand side argument and is called only with character
string arguments, the callling syntax may be simplified fun(’a’,’toto’,’a
string’) can be replaced by fun a toto ’a string’
MISCELLANEOUS :
Functions are Scilab objects (with type numbers 13 or 11). They and can be manipulated (built, saved,
loaded, passed as arguments,..) as other variable types.
Collections of functions can be collected in libraries. Functions which begin with % sign (e.g. %foo) are
often used to overload (see overloading) operations or functions for new data type.
EXAMPLE :

//inline definition (see function)

function [x,y]=myfct(a,b)
x=a+b
y=a-b
endfunction

[x,y]=myfct(3,2)

//inline definition (see deff)

deff(’[x,y]=myfct(a,b)’,[’x=a+b’;
’y=a-b’])
// definition in an ascii file (see exec)
exec SCI/macros/elem/asin.sci;

// definition in an ascii file (see getf)

getf SCI/macros/elem/asin.sci;

S EE A LSO : function 268, deff 266, getf 272, comp 266, lib 272, getd 271,
genlib 270, exists 37, varargin 277, varargout 277

1.5.12 genlib build library from all functions in given directory

CALLING SEQUENCE :

genlib(lib-name [,dir-name])

PARAMETERS :

lib-name: Scilab string. The variable name of the library to (re)create.

Scilab Group Nov 2000 270

getf Scilab Function

dir-name: Scilab string. The name of the directory to look for .bin-files; default value is the current
directory.

DESCRIPTION :
For each .sci file in dir-name, genlib executes a getf and saves the functions to the correspond-
ing .bin file. The .sci file must not contain anything but Scilab functions. If a .bin file is newer
than the associated .sci file, genlib does not translate and save the file.
When all .sci files have been processed, genlib creates a library variable named lib-name and
saves it in the file lib in dir-name.
RESTRICTIONS :
Scilab tacitly assumes that file foo.sci defines only a single function named foo.
S EE A LSO : getf 272, save 258, lib 272

1.5.13 get function path get source file path of a library function

CALLING SEQUENCE :

path=get_function_path(fun_name)

PARAMETERS :

fun name : a string, the name of the function

path : a string, the absolute pathname of the function source file (.sci) or [].

DESCRIPTION :
Given the name of a function get function path returns the absolute pathname of the function source file if
the function is defined in a Scilab library (see lib) or [] if name does not match any library function.
EXAMPLE :

get_function_path(’median’)

S EE A LSO : lib 272, string 284

1.5.14 getd getting all functions defined in a directory

CALLING SEQUENCE :

getd(path)

PARAMETERS :

path : Scilab string. The directory pathname

DESCRIPTION :
loads all .sci files (containing Scilab functions) defined in the path directory.
EXAMPLE :

getd(’SCI/macros/auto’)

S EE A LSO : getf 272, lib 272, getcwd 67, pwd 67, chdir 297

Scilab Group April 1993 271

lib Scilab Function

1.5.15 getf defining a function from a file

CALLING SEQUENCE :

getf(file-name [,opt])

PARAMETERS :

filename : Scilab string.

opt : optional character string
"c" : loaded functions are ”compiled” to be more efficient (default)
"n" : loaded functions are not ”compiled”
"p" : loaded functions are ”compiled” and prepared for profiling (see profile)

DESCRIPTION :
loads one or several functions (see functions) defined in the file ’file-name’. The string opt=’n’
means that the functions are not compiled (pre-interpreted) when loaded. This can be useful for some
debugging purpose (see comp). By default, functions are compiled when loaded (i.e. opt=’c’ is used).
In the file a function must begin by a ”syntax definition” line as follows:
function [y1,...,yn]=foo(x1,...,xm)
followed by a sequence of scilab instructions.
The ”syntax definition” line gives the ”full” calling syntax of this function. The yi are output variables
calculated as functions of input variables xi and variables existing in Scilab when the function is executed.
Shorter input or output argument list may be used.
Many functions may be written in the same file. A function is terminated by an endfunction keyword.
For compatibility with previous versions a function may also be terminated by the following function
keyword or the EOF mark.

REMARK :
getf is an old way for loading functions into scilab from a file, If functions in a file are terminated by an
endfunction keyword, the file maybe loaded using the exec function instead of getf. In this case
default option opt is used.
EXAMPLE :

getf(’SCI/macros/xdess/plot.sci’)

getf SCI/macros/xdess/plot.sci

S EE A LSO : functions 269, function 268, genlib 270, getd 271, exec 36, edit
267, comp 266

1.5.16 lib library definition

CALLING SEQUENCE :

xlib = lib(’lib-dir’)

PARAMETERS :
lib-dir: character string
DESCRIPTION :
lib-dir is a character string defining a directory that contains compiled Scilab function (.bin) files.
In addition to these files lib-dir must have a file called names, that contains the names of the functions

Scilab Group Nov 2000 272

macrovar Scilab Function

defined in lib-dir. On success, all functions in lib-dir are available from within Scilab. They are
loaded on demand when called for the first time.
Binary files can be created from within Scilab with the command save.
Scilab’s standard libraries are defined using lib on the SCIDIR/macros/* subdirectories.
As an example, given the following definitions

deff(’z = myplus(x, y)’, ’z = x + y’)

deff(’z = yourplus(x, y)’, ’x = x - y’)
lib_dir = ’/home/joeuser/myscidir’

myplus and yourplus are compiled into lib dir with the commands

save(lib_dir + ’/myplus.bin’, myplus)

save(lib_dir + ’/yourplus.bin’, yourplus)

A library can now be created from the two .bin files with the command

xlib = lib(lib_path + ’/’)

xlib is a Scilab variable of type ”library”. A library variable usually is saved for later loading, either
on-line or from the user-specific startup file ($HOME/.scilab).
RESTRICTIONS :
Scilab tacitly assumes that file foo.bin defines only a single function named foo.
S EE A LSO : genlib 270, save 258, deff 266, getf 272, whereis 77

1.5.17 macr2lst function to list conversion

CALLING SEQUENCE :

[txt]=macr2lst(function-name)

DESCRIPTION :
This primitive converts a compiled Scilab function function-name into a list which codes the internal
representation of the function. For use with mac2for.
S EE A LSO : macrovar 274

1.5.18 macro Scilab procedure and Scilab object

DESCRIPTION :
Macros are Scilab procedures (”macro”, ”function” and ”procedure” have the save meaning). Usually, they
are defined in files with an editor and loaded into Scilab by getf or through a library.
They can also be defined on-line (see deff). A file which contains a macro must begin as follows:

function [y1,...,yn]=foo(x1,...,xm)

The yi are output variables calculated as functions of input variables and variables existing in Scilab
when the macro is executed. A macro can be compiled for faster execution. Collections of macros can be
collected in libraries. Macros which begin with % sign (e.g. %foo) and whose arguments are lists are used
to perform specific operations: for example, z=%rmr(x,y) is equivalent to z=x*y when x and z are
rationals (i.e. x=list(’r’,n,d,[]) with n and d polynomials).
S EE A LSO : deff 266, getf 272, comp 266, lib 272

Scilab Group April 1993 273

plotprofile Scilab Function

1.5.19 macrovar variables of function

CALLING SEQUENCE :

vars=macrovar(function)

PARAMETERS :

vars : list list(in,out,globals,called,locals)

function : name of a function

DESCRIPTION :
Returns in a list the set of variables used by a function. vars is a list made of five column vectors of
character strings
in : input variables (vars(1))
out : output variables (vars(2))
globals : global variables (vars(3))
called : names of functions called (vars(4))
locals : local variables (vars(5))
EXAMPLE :

deff(’y=f(x1,x2)’,’loc=1;y=a*x1+x2-loc’)
vars=macrovar(f)

S EE A LSO : string 284, macr2lst 273

1.5.20 newfun add a name in the table of functions

CALLING SEQUENCE :

newfun("function-name",nameptr)

DESCRIPTION :
Utility function (for experts only). Adds the name "function-name" in the table of functions known
to the interpreter. "nameptr" is an integer 100*fun+fin where fun and fin is the internal coding
of the primitive "function-name". This function is useful to associate a primitive to a routine interfaced
in "matusr.f" (fun=14). Used with funptr and clearfun one can redefine a primitive by a
function with same name.
S EE A LSO : clearfun 265

1.5.21 plotprofile extracts and displays execution profiles of a Scilab function

CALLING SEQUENCE :

plotprofile(fun)

PARAMETERS :

fun : a Scilab function

Scilab Group july 2000 274

profile Scilab Function

DESCRIPTION :
To use plotprofile the Scilab function must have been prepared for profiling (see getf).
For such functions, When such a function is executed the systems counts how many time each line is
executed and how may cpu time is spend for each line execution. These data are stored within the function
data structure. The plotprofile in an interactive function which displays this results in a graphic
window. When a line is clicked text of the function is displayed with the selected line hilited.
NOTE: you have to click on the ”Exit” item in the graphics windows to exit from ”plotprofile”.
Function text is rebuild with fun2string.
EXAMPLE :

//define function and prepare it for profiling

deff(’x=foo(n)’,[’if n==0 then’
’ x=[]’
’else’
’ x=0’
’ for k=1:n’
’ s=svd(rand(n+10,n+10))’
’ x=x+s(1)’
’ end’
’end’],’p’)
//call the function
foo(30)
//get execution profiles
plotprofile(foo) // click on Exit to exit

S EE A LSO : profile 275, showprofile 276, fun2string 661

1.5.22 profile extract execution profiles of a Scilab function

CALLING SEQUENCE :

c=profile(fun)

PARAMETERS :

fun : a Scilab function

c : a nx3 matrix containig the execution profiles

DESCRIPTION :
To use profile the Scilab function must have been prepared for profiling (see getf).
For such function, When such a function is executed the systems counts how many time each line is
executed and how may cpu time is spend for each line execution. These data are stored within the function
data structure. The profile function allows to extract these data and return them in the two first columns of
c. The c third column gives a measure of interpetor effort for one execution of corresponding line. Ith line
of c corresponds to Ith line of the function (included first)
Note that, due to the precision of the processor clock (typically one micro second), some executed lignes
may appear with 0 cpu time even if total cpu time really spend in their execution is large.
EXAMPLE :

//define function and prepare it for profiling

deff(’x=foo(n)’,[’if n==0 then’
’ x=[]’
’else’
’ x=0’
’ for k=1:n’

Scilab Group july 2000 275

showprofile Scilab Function

’ s=svd(rand(n+10,n+10))’
’ x=x+s(1)’
’ end’
’end’],’p’)
//call the function
foo(10)
//get execution profiles
profile(foo)
//call the function
foo(20)
profile(foo) //execution profiles are cumulated

S EE A LSO : getf 272, deff 266, plotprofile 274, showprofile 276

1.5.23 setbpt setting breakpoints

CALLING SEQUENCE :

setbpt(macro-name [,line-num])

PARAMETERS :

macro-name : string
line-num : integer

DESCRIPTION :
setbpt interactively inserts a breakpoint in the line number line-num (default value is 1) of the
function macro-name
When reaching the breakpoint, Scilab evaluates the specified line , prints the number of the line and the
name of the function. If the function is not compiled ( see comp ) the line is printed on the screen. Then
Scilab goes into a pause mode in which the user can check current values. The pause is exited with
resume or abort. Redefining the function does not clear the breakpoints, the user must explicitly delete
breakpoints using delbpt. The maximum number of functions with breakpoints enabled must be less than
20 and the maximum number of breakpoints is set to 100.
S EE A LSO : delbpt 267, dispbpt 267, pause 64, resume 68

1.5.24 showprofile extracts and displays execution profiles of a Scilab function

CALLING SEQUENCE :

showprofile(fun)

PARAMETERS :

fun : a Scilab function

DESCRIPTION :
To use showprofile the Scilab function must have been prepared for profiling (see getf).
For such function, When such a function is executed the systems counts how many time each line is
executed and how may cpu time is spend for each line execution. These data are stored within the function
data structure. The showprofile function outputs profiling results (see rofile) with text of the function
lines.
Function text is rebuild with fun2string.
EXAMPLE :

Scilab Group july 2000 276

varargout Scilab keyword

//define function and prepare it for profiling

deff(’x=foo(n)’,[’if n==0 then’
’ x=[]’
’else’
’ x=0’
’ for k=1:n’
’ s=svd(rand(n+10,n+10))’
’ x=x+s(1)’
’ end’
’end’],’p’)
//call the function
foo(30)
//get execution profiles
showprofile(foo)

S EE A LSO : profile 275, plotprofile 274, fun2string 661

1.5.25 varargin variable numbers of arguments in an input argument list

SYNTAX :
varargin must be the rightmost argument of the function definition input list.
DESCRIPTION :
A function whose input argument list contains varargin can be called with more input arguments than
indicated in the input argument list. The calling arguments passed form varargin keyword onwards
may then be retrieved within the function in a list named varargin.
Suppose that varargin keyword is the n th argument of the formal input argument list, then if the
function is called with less than n-1 input arguments the varargin list is not defined, if the function is
called with n-1 arguments then varargin list is an empty list.
y = function ex(varargin) may be called with any number of input arguments. Within func-
tion ex input arguments may be retrieved in varargin(i) ,i=1:length(varargin)
REMARK :
Named argument syntax like foo(...,key=value) is incompatible with the use of varargin.
EXAMPLE :

deff(’exampl(a,varargin)’,[’[lhs,rhs]=argn(0)’
’if rhs>=1 then disp(varargin),end’])
exampl(1)
exampl()
exampl(1,2,3)
l=list(’a’,%s,%t);
exampl(1,l(2:3))

S EE A LSO : function 268, varargout 277, list 57

1.5.26 varargout variable numbers of arguments in an output argument list

SYNTAX :
varargout must be the rightmost argument of the function definition output list.
DESCRIPTION :
A function whose output argument list contains varargout must be called with more output arguments
than indicated in the output argument list. The calling arguments passed form varargout keyword
onwards are extracted out of the varargout list defined in the function

Scilab Group April 1998 277

varargout Scilab keyword

varagout = function ex() may be called with any number of output arguments. Within func-
tion ex output arguments may be stored in in varargout(i).
EXAMPLE :

deff(’varargout=exampl()’,’varargout=list(1,2,3,4)’)

x=exampl()
[x,y]=exampl()
[x,y,z]=exampl()

S EE A LSO : function 268, varargin 277, list 57

Scilab Group April 1998 278

varargout Scilab keyword

1.6 Strings manipulations

Scilab Group April 1998 279

grep Scilab Function

1.6.1 code2str returns character string associated with Scilab integer codes.

CALLING SEQUENCE :

str=code2str(c)

PARAMETERS :

str : a character string

c : vector of character integer codes

DESCRIPTION :
Returns character string associated with Scilab integer codes.str is such that c(i) is the Scilab integer code
of part(str,i))
EXAMPLE :

code2str([-28 12 18 21 10 11])

S EE A LSO : str2code 282

1.6.2 convstr case conversion

CALLING SEQUENCE :

[y]=convstr(str-matrix, ["flag"])

PARAMETERS :

str-matrix, y : matrices of strings

"flag" : string ("u" for upper or "l" for lower (default value))

DESCRIPTION :
converts the matrix of strings str-matrix into lower case (for "l" ;default value) or upper case (for
"u").
EXAMPLE :

A=[’this’,’is’;’my’,’matrix’];
convstr(A,’u’)

1.6.3 emptystr zero length string

CALLING SEQUENCE :

s=emptystr()
s=emptystr(a)
s=emptystr(m,n)

PARAMETERS :

a : any type of matrix

s : character string matrix
m,n : integers

Scilab Group April 1993 280

length Scilab Function

DESCRIPTION :
Returns a matrix of zero length character strings
With no input argument returns a zero length character string.
With a matrix for input argument returns a zero length character strings matrix of the same size.
With two integer arguments returns a mxn zero length character strings matrix
EXAMPLE :

x=emptystr();for k=1:10, x=x+’,’+string(k);end

S EE A LSO : part 282, length 281, string 284

1.6.4 grep find matches of a string in a vector of strings

CALLING SEQUENCE :

row=grep(str1,str2)
[row,which]=grep(str1,str2)

PARAMETERS :

str1 : a vector of strings.

str2 : a character string or character string vector . The string(s) to search in str1
row : vector of indices: row where a match has been found or an empty matrix if no match found.
which : vector of indices: index of str2 string found or an empty matrix if no match found.

DESCRIPTION :
Foreach entry of str1, grep searches if at least a string in str2 matches a substring. str1 entries
index where at least a match has been found are returned in the row argument. while optionnal which
argument gives the index of first string of str2 found.
EXAMPLE :

txt=[’find matches of a string in a vector of strings’

’search position of a character string in an other string’
’Compare Strings’];

grep(txt,’strings’)
grep(txt,[’strings’ ’Strings’])

[r,w]=grep(txt,[’strings’ ’Strings’])

S EE A LSO : strindex 283

1.6.5 length length of object

CALLING SEQUENCE :

n=length(M)

PARAMETERS :

M : matrix (usual or polynomial or character string) or list

n : integer or integer matrix

Scilab Group April 1993 281

strcat Scilab Function

DESCRIPTION :
For usual or polynomial matrix n is the integer equal to number of rows times number of columns of M.
(Also valid for M a boolean matrix)
For matrices made of character strings (and in particular for a character string) length returns in n the
length of entries of the matrix of character strings M.
The length of a list is the number of elements in the list (also given by size).
length(’123’) is 3. length([1,2;3,4]) is 4.
S EE A LSO : size 211

1.6.6 part extraction of strings

CALLING SEQUENCE :

[c]=part(mp,v)

PARAMETERS :

mp,c : string matrices

v : integer vector.

DESCRIPTION :
Let s[k] stands for the k character of string s ( or the empty character if k >length(s)).
part returns c, a matrix of character strings, such that c(i,j) is the string "s[v(1)]...s[v(n)]"
( s=mp(i,j) ).
EXAMPLE :

c=part([’a’,’abc’,’abcd’],[1,1,2])

S EE A LSO : string 284, length 281

1.6.7 str2code return scilab integer codes associated with a character string

CALLING SEQUENCE :

c=str2code(str)

PARAMETERS :

str : a character string

c : vector of character integer codes

DESCRIPTION :
Return c such that c(i) is the scilab integer code of part(str,i))
EXAMPLE :

str2code(’Scilab’)

S EE A LSO : code2str 280

Scilab Group April 1993 282

string Scilab Function

1.6.8 strcat catenate character strings

CALLING SEQUENCE :

txt=strcat(vstr [,strp])

PARAMETERS :

vstr : vector of strings

strp : string, default value is the emptystr ""
txt : string

DESCRIPTION :
txt=strcat(vstr) catenates character strings : txt=vstr(1)+...+vstr(n)
txt=strcat(vstr,strp) returns txt=strs(1)+strp+...+strp+strs(n). The plus sym-
bol does the same: "a"+"b" is the same as strcat(["a","b"])
EXAMPLE :

strcat(string(1:10),’,’)

S EE A LSO : string 284, strings 284

1.6.9 strindex search position of a character string in an other string.

CALLING SEQUENCE :

ind=strindex(str1,str2)

PARAMETERS :

str1 : a character string. The string where to search occurrences of str2

str2 : a character string or character string vector . The string(s) to search in str1
ind : vector of indexes

DESCRIPTION :
strindex searches indexes where str2(i) is found in str1 for each k it exist a ishuch that
part(str1,ind(k)+(0:length(str2(i))-1)) is the same string than str2(i)
When str2 is a vector and str2
EXAMPLE :

k=strindex(’SCI/demos/scicos’,’/’)
k=strindex(’SCI/demos/scicos’,’SCI/’)
k=strindex(’SCI/demos/scicos’,’!’)
k=strindex(’aaaaa’,’aa’)
k=strindex(’SCI/demos/scicos’,[’SCI’,’sci’])

S EE A LSO : string 284, strings 284

Scilab Group April 1993 283

stripblanks Scilab Function

1.6.10 string conversion to string

CALLING SEQUENCE :

string(x)
[out,in,text]=string(x)

PARAMETERS :

x : real matrix or function

DESCRIPTION :
converts a matrix into a matrix of strings.
If x is a function [out,in,text]=string(x) returns three vectors strings : out is the vector of
output variables, in is the vector of input variables, and text is the (column) vector of the source code
of the function.
If x is a lib variable, text is a character string column vector. The first element contains the path of
library file and the other the name of functions it defines.
Character strings are defined as ’string’ (between quotes) or "string" (between doublequotes);
matrices of strings are defined as usual constant matrices.
Concatenation of strings is made by the + operation.
EXAMPLES :

string(rand(2,2))
deff(’y=mymacro(x)’,’y=x+1’)
[out,in,text]=string(mymacro)
x=123.356; ’Result is ’+string(x)

S EE A LSO : part 282, length 281, quote 67, evstr 35, execstr 37, strsubst
285, strcat 283, strindex 283, sci2exp 307

1.6.11 strings Scilab Object, character strings

DESCRIPTION :

Strings are defined as ’string’ (between quotes) or "string" (between doublequotes); matrices of
strings are defined as usual constant matrices.
Concatenation of two strings is made by a + : string1+string2.
EXAMPLE :

[’this’,’is’; ’a 2x2’,’matrix’]
"matrix"=="mat"+"rix"

S EE A LSO : part 282, length 281, strcat 283

1.6.12 stripblanks strips leading and trailing blanks of strings

CALLING SEQUENCE :

txt=stripblanks(txt)

PARAMETERS :

Scilab Group April 1998 284

strsubst Scilab Function

txt : string or matrix of strings

DESCRIPTION :
stripblanks strips leading and trailing blanks of strings
EXAMPLE :

a=’ 123 ’;
’!’+a+’!’
’!’+stripblanks(a)+’!’
a=[’ 123 ’,’ xyz’]
strcat(stripblanks(a))

1.6.13 strsubst substitute a character string by another in a character string.

CALLING SEQUENCE :

str=strsubst(str1,str2,str3)

PARAMETERS :

str1 : a matrix of character string. The strings where to search occurrences of str2
str2 : a character string. The string to search in str1.
str3 : a character string. The replacement string.
str : a matrix of character string. The result of the substitution on str2 by str3 in str1

DESCRIPTION :
strsubst replaces all occurrences of str2 in str1 by str3.
EXAMPLE :

strsubst(’SCI/demos/scicos’,’SCI’,’.’)
strsubst(’SCI/demos/scicos’,’/’,’ ’)

S EE A LSO : string 284, strings 284

Scilab Group April 1993 285

strsubst Scilab Function

1.7 Dialogs

Scilab Group April 1993 286

addmenu Scilab Function

1.7.1 addmenu interactive button or menu definition

CALLING SEQUENCE :

addmenu(button [,submenus] [,action])

addmenu(gwin,button [,submenus] [,action])

PARAMETERS :

button : a character string. The button name. On Windows operating systems (not X window), an &
can be placed before the character in the name to be used for keyboard shortcut; this character will
be underlined on the GUI.
submenus : a vector of character string. The sub menus items names
action : a list with 2 elements action=list(flag,proc name)
flag : an integer (default value is 0)
flag==0 : the action is defined by a scilab instruction
flag==1 : the action is defined by a C or Fortran procedure
proc name : a character string which gives the name of scilab variable containing the instruction or the
name of procedure to call.
gwin : integer. The number of graphic window where the button is required to be installed

DESCRIPTION :
The function allows the user to add new buttons or menus in the main window or graphics windows
command panels.
If action is not given the action associated with a button must be defined by a scilab instruction given
by the character string variable which name is

button for a main window command

button gwin for a graphic window command
If proc name designes a C or Fortran procedure, this procedure may be interfaced in Fortran subroutine
default/fbutn.f or dynamically linked with scilab using the link function. the calling sequence is in
C: (char* name, int* win,int *entry)
Actions associated with the kth sub menu must be defined by scilab instructions stored in the kth element
of the character string variable which name is

button for a main window command

button gwin for a graphic window command

EXAMPLE :

addmenu(’foo’)
foo=’disp(’’hello’’)’

addmenu(’Hello’,[’Franck’;’Peter’])
Hello=[’disp(’’hello Franck’’)’;’disp(’’hello Peter’’)’]

addmenu(0,’Hello’,[’Franck’;’Peter’])
Hello_0=[’disp(’’hello Franck’’)’;’disp(’’hello Peter’’)’]

addmenu(’Bye’,list(0,’French_Bye’))
French_Bye=’disp(’’Au revoir’’)’

//C defined Callback

// creating Callback code
code=[

Scilab Group December 1995 287

getvalue Scilab Function

’#include ""’+SCI+’/routines/machine.h""’
’void C2F(foo)(name,win,entry)’
’ char *name;’
’ int * win,*entry;’
’{’
’ if (*win==-1) ’
’ sciprint(""menu %s(%i) in Scilab window selected\\r\\n"",name,*entry+1);’
’ else’
’ sciprint(""menu %s(%i) in window %i selected\\r\\n"",name,*entry+1,*win);’
’}’]
//creating foo.c file
mputl(code,TMPDIR+’/foo.c’);
//reating Makefile
ilib_gen_Make(’foo’,’foo’,’’,TMPDIR+’/Makefile’,%f)
// Compiling and linking
link(ilib_compile(’foo’,TMPDIR+’/Makefile’),’foo’)
//add menu
addmenu(’foo’,[’a’,’b’,’c’],list(1,’foo’))

S EE A LSO : setmenu 290, unsetmenu 290, delmenu 288

1.7.2 delmenu interactive button or menu deletion

CALLING SEQUENCE :

delmenu(button)
delmenu(gwin,button)

PARAMETERS :

button : a character string. The button name. On Windows operating systems (not X window), an
@ should be placed before the character in the name used for keyboard shortcut; this character is
underlined on the GUI.
gwin : integer. The number of graphic window where the button is required to be installed

DESCRIPTION :
The function allows the user to delete buttons or menus create by addmenu in the main or graphics
windows command panels. Predefined buttons on Scilab graphic windows can also be deleted.
If possible, it is better to delete first the latest created button for a given window to avoid gaps in
command panels.
EXAMPLE :

addmenu(’foo’)
delmenu(’foo’)

S EE A LSO : setmenu 290, unsetmenu 290, addmenu 287

1.7.3 getvalue xwindow dialog for data acquisition

CALLING SEQUENCE :

[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)

Scilab Group November 1993 288

keyboard Scilab Function

PARAMETERS :

desc : column vector of strings, dialog general comment

labels : n column vector of strings, labels(i) is the label of the ith required value
typ : list(typ1,dim1,..,typn,dimn)
typi : defines the type of the ith value, may have the following values:
"mat" : for constant matrix
"col" : for constant column vector
"row" : for constant row vector
"vec" : for constant vector
"str" : for string
"lis" : for list
dimi : defines the size of the ith value it must be a integer or a 2-vector of integer, -1 stands for undefined
dimension
ini : n column vector of strings, ini(i) gives the suggested response for the ith required value
ok : boolean ,%t if ok button pressed, %f if cancel button pressed
xi : contains the ith value if ok=%t. If left hand side as one more xi than required values the last xi
contains the vector of answered strings.

DESCRIPTION :
This function encapsulate x mdialog function with error checking, evaluation of numerical response, ...

REMARKS :
All valid expressions can be used as answers; for matrices and vectors getvalues automatically adds [
] around the given answer before numeric evaluation.
EXAMPLE :

labels=["magnitude";"frequency";"phase "];
[ok,mag,freq,ph]=getvalue("define sine signal",labels,...
list("vec",1,"vec",1,"vec",1),["0.85";"10ˆ2";"%pi/3"])

S EE A LSO : x_mdialog 293, x_matrix 292, x_dialog 292

AUTHOR : S. Steer

1.7.4 halt stop execution

CALLING SEQUENCE :

halt()

DESCRIPTION :
stops execution until something is entered in the keyboard.
S EE A LSO : pause 64, return 68, exec 36

1.7.5 havewindow return scilab window mode

CALLING SEQUENCE :

havewindow()

DESCRIPTION :
returns %t if scilab has it own window and %f if not, i.e. if scilab has been invoked by ”scilab -nw”. (nw
stands for ”no-window”.

Scilab Group April 1993 289

unsetmenu Scilab Function

1.7.6 keyboard keyboard commands

DESCRIPTION :
Let C- stands for the control key. The following keyboard commands are available:

C-l clears the Scilab window

C-d deletes the current character
C-p calls back the preceding command
C-n go to next command line
C-a moves the cursor to the beginning of command line.
C-b backspace, moves the cursor one character to the left
C-f forwards, moves the cursor one character to the right
C-k kills command line from cursor to the end.
C-y yank, retrieves killed line.
!beg looks for last command line which begins by beg.
C-c interrupts Scilab and pause after carriage return. (Only functions can be interrupted). Clicking on
the stop button enters a C-C.

S EE A LSO : pause 64, read 254, input 238

1.7.7 setmenu interactive button or menu activation

CALLING SEQUENCE :

setmenu(button [,nsub])
setmenu(gwin,button [,nsub])

PARAMETERS :

button : a character string. The button name

gwin : integer. The number of graphic window where the button is installed
nsub : integer. The number of submenu to de-activate (if any). If button has no sub-menu, nsub is
ignored

DESCRIPTION :
The function allows the user to make active buttons or menus created by addmenu in the main or graphics
windows command panels.
EXAMPLE :

addmenu(’foo’) //New button made in main scilab window

unsetmenu(’foo’) //button foo cannot be activated (grey string)
setmenu(’foo’) //button foo can be activated (black string)

S EE A LSO : delmenu 288, unsetmenu 290, addmenu 287

1.7.8 unsetmenu interactive button or menu or submenu de-activation

CALLING SEQUENCE :

unsetmenu(button,[nsub])
unsetmenu(gwin,button,[nsub])

Scilab Group December 1995 290

x choose Scilab Function

PARAMETERS :

button : a character string. The button name

gwin : integer. The number of graphic window where the button is installed
nsub : integer. The number of submenu to de-activate (if any). If button has no sub-menu, nsub is
ignored

DESCRIPTION :
The function allows the user to desactivate buttons or menus created by addmenu in the main or graphics
windows command panels.
EXAMPLE :

//addmenu(’foo’)
//unsetmenu(’foo’)
//unsetmenu(’File’,2)

S EE A LSO : delmenu 288, setmenu 290, addmenu 287

1.7.9 x choices interactive Xwindow choices through toggle buttons

CALLING SEQUENCE :

rep=x_choices(title,items)

PARAMETERS :

title : vector of strings, title for the popup window.

items : a list of items items=list(item1,...,itemn), where each item is also a list of the
following type : item=list(’label’,default choice,choices). default choice
is an integer which gives the default toggle on entry and choices is a row vector of strings which
gives the possible choices.
rep : an integer vector which gives for each item the number of the selected toggle. If user exits dialog
with ”cancel” button rep is set to [].

DESCRIPTION :
Select items through toggle lists and return in rep the selected items
Type x choices() to see an example.
EXAMPLE :

l1=list(’choice 1’,1,[’toggle c1’,’toggle c2’,’toggle c3’]);

l2=list(’choice 2’,2,[’toggle d1’,’toggle d2’,’toggle d3’]);
l3=list(’choice 3’,3,[’toggle e1’,’toggle e2’]);
rep=x_choices(’Toggle Menu’,list(l1,l2,l3));

1.7.10 x choose interactive Xwindow choice

CALLING SEQUENCE :

[num]=x_choose(items,title [,button])

PARAMETERS :

items : column vector of string, items to choose

title : column vector of string, comment for the dialog
button : string, text to appear in the button. Default value is ’Cancel’

Scilab Group April 1993 291

x mdialog Scilab Function

num : integer, choosen item number or 0 if dialog resumed with ”Cancel” button

DESCRIPTION :
Returns in num the number of the chosen item.
EXAMPLE :

n=x_choose([’item1’;’item2’;’item3’],[’that is a comment’;’for the dialog’])

n=x_choose([’item1’;’item2’;’item3’],[’that is a comment’],’Return’)

S EE A LSO : x_choices 291, x_mdialog 293, getvalue 288, unix_g 310

1.7.11 x dialog Xwindow dialog

CALLING SEQUENCE :

result=x_dialog(labels,valueini)

PARAMETERS :

labels : column vector of strings, comment for dialog

valueini : n column vector of strings, initial value suggested
result : response : n column vector of strings if returned with ”Ok” button or [] if returned with ”Cancel”
button

DESCRIPTION :
Creates an X-window multi-lines dialog
EXAMPLE :

//gain=evstr(x_dialog(’value of gain ?’,’0.235’))

//x_dialog([’Method’;’enter sampling period’],’1’)
//m=evstr(x_dialog(’enter a 3x3 matrix ’,[’[0 0 0’;’0 0 0’;’0 0 0]’]))

S EE A LSO : x_mdialog 293, x_matrix 292, evstr 35, execstr 37

1.7.12 x matrix Xwindow editing of matrix

CALLING SEQUENCE :

[result]=x_matrix(label,matrix-init)

PARAMETERS :

label : character string (name of matrix)

matrix-init : real matrix

DESCRIPTION :
For reading or editing a matrix .
EXAMPLE :

//m=evstr(x_matrix(’enter a 3x3 matrix ’,rand(3,3)))

S EE A LSO : x_mdialog 293, x_dialog 292

Scilab Group April 1993 292

x message Scilab Function

1.7.13 x mdialog Xwindow dialog

CALLING SEQUENCE :

result=x_mdialog(title,labels,default_inputs_vector)
result=x_mdialog(title,labelsv,labelsh,default_input_matrix)

PARAMETERS :

title : column vector of strings, dialog general comment

labels : n column vector of strings, labels(i) is the label of the ith required value
default input vector : n column vector of strings, default input vector(i) is the initial
value of the ith required value
labelsv : n vector of strings, labelsv(i) is the label of the ith line of the required matrix
labelsh : m vector of strings, labelsh(j) is the label of the jth column of the required matrix
default input matrix : n x m matrix of strings, default input matrix(i,j) is the initial
value of the (i,j) element of then required matrix
result : n x m matrix of string if returned with ”Ok” button or [] if returned with ”Cancel” button

DESCRIPTION :
X-window vector/matrix interactive input function
EXAMPLES :

txt=[’magnitude’;’frequency’;’phase ’];
sig=x_mdialog(’enter sine signal’,txt,[’1’;’10’;’0’])
mag=evstr(sig(1))
frq=evstr(sig(2))
ph=evstr(sig(3))

rep=x_mdialog([’System Simulation’;’with PI regulator’],...

[’P gain’;’I gain ’],[’ ’;’ ’])

n=5;m=4;mat=rand(n,m);
row=’row’;labelv=row(ones(1,n))+string(1:n)
col=’col’;labelh=col(ones(1,m))+string(1:m)
new=evstr(x_mdialog(’Matrix to edit’,labelv,labelh,string(mat)))

S EE A LSO : x_dialog 292, x_choose 291, x_message 293, getvalue 288, evstr
35, execstr 37

1.7.14 x message X window message

CALLING SEQUENCE :

[num]=x_message(strings [,buttons])

PARAMETERS :

strings : vector of characters strings to be displayed

buttons : character string or 2 vector of character strings which specifies button(s) name(s). Default
value is ”Ok”
num : number of button clicked (if 2 buttons are specified)

Scilab Group April 1993 293

x message modeless Scilab Function

DESCRIPTION :
for displaying a message (diagnostic,... ) and waiting for an answer (button click). The function returns
only after a click on a button.
EXAMPLES :

gain=0.235;x_message(’value of gain is :’+string(gain))

x_message([’singular matrix’;’use least squares’])

r=x_message([’Your problem is ill conditioned’;

’continue ?’],[’Yes’,’No’])

S EE A LSO : x_dialog 292, x_mdialog 293, x_message_modeless 294

1.7.15 x message modeless X window modeless message

CALLING SEQUENCE :

x_message_modeless(strings)

PARAMETERS :

strings : vector of characters strings to be displayed

DESCRIPTION :
for displaying a message (information, user-guide ...). The function returns immediately. The message
window is killed when ”Ok” button is clicked.
EXAMPLES :

x_message_modeless([’This is a modeless message’

’Scilab may continue computation’
’ ’
’Click on ""Ok"" to close the message’])
x_message_modeless(’Now two message windows are opened’)

S EE A LSO : x_dialog 292, x_mdialog 293, x_message 293

Scilab Group April 1993 294

x message modeless Scilab Function

1.8 Utilities

Scilab Group April 1993 295

c link Scilab Function

1.8.1 %helps Variable defining the path of help directories

DESCRIPTION :
The variable %helps is an N x 2 matrix of strings. The kth row of %helps, %helps(k,:) repre-
sents the kth chapter of the manual and is made of two strings:
%helps(k,1) is a pathname for a help directory.
%helps(k,2) is a title for this help directory. For instance, for k=2, we have the graphics chapter
%helps(2,:).
The variable %helps is defined in the Scilab startup file SCI+"/scilab.star".
To add a new help directory, the user should add a row to the variable %helps. (One row for each direc-
tory).
For instance, %helps=[%helps; "Path-Of-My-Help-Dir","My-Title"]; enables the Scilab
help browser to look for help manual items in the directory with pathname ”Path-Of-My-Help-Dir”.
”My-Title” is then the title of a new help chapter which appears in the bottom part of the help window,
raised by clicking on the help button.
A valid help directory must contain:
1- A set of .cat files (e.g. item1.cat, item2.cat etc). The .cat files do do require special
format. Usually, they are built as Unix man pages.
2- A whatis file, which must have a special format. Each row of the whatis must be as follows:
item - what is item @item
item is the item of the help, i.e. the command help item returns the contents of the file item.cat.
what is item is a brief description of the item.
Thewhatis file appears in the top window of the help window, once a chapter has been selected in
the bottom window.
Clicking on one item of the top window opens the manual page.
The command apropos keyword returns the row(s) of all the whatis file(s) in which the key-
word appears.
On Unix-Linux platforms Scilab provides a Makefile for transforming .man pages into .cat pages (see
SCIDIR/examples/man-examples).
S EE A LSO : help 298, apropos 26

1.8.2 G make call make or nmake

CALLING SEQUENCE :

Rfiles=G_make(files,dllname)

PARAMETERS :

files : a character string or a vector of character string.

dllname : a character string.
Rfiles : vector of character string. Rfiles can be used as a first argument when calling addinter
function.

DESCRIPTION :
On Unix like systems (i.e unix or windows/gcwin32) G make calls the make utility for building target
files and returns the value of files in the variable Rfiles. On windows platforms, (i.e when Scilab
was compiled with Microsoft VisualC++). G make calls the nmake utility for building target dllname
and it returns the value of dllname in the variable Rfiles. Of course G make will work if apropriate
Makefiles are provided in the current Scilab directory.
G make can be used to provide OS independant call to addinter. and such examples can be found in the
directory SCIDIR/examples/addinter-examples

Scilab Group April 1993 296

dec2hex Scilab Function

files=G_make([TMPDIR+’/ex1cI.o’,TMPDIR+’/ex1c.o’],’ex1c.dll’);// compilation
addinter(files,’foobar’,’foubare’); // link

S EE A LSO : addinter 265

1.8.3 c link check dynamic link

CALLING SEQUENCE :

c_link(routine-name)
[test,ilib]=c_link(routine-name)
test=c_link(routine-name,num)

PARAMETERS :

routine-name : a character string

num :
test : boolean, indicates if there is a shared library which contains routine-name.
ilib: a scalar, the number of the shared library which contains routine-name

DESCRIPTION :
c link is a boolean function which checks if the routine routine-name is currently linked. This
function returns a boolean value true or false. When used with two return values, the function c link
returns a boolean value in test and the number of the shared library which contains routine-name
in ilib (when test is true).
EXAMPLE :

if c_link(’foo’) then link(’foo.o’,’foo’);end

// to unlink all the shared libarries which contain foo
a=%t; while a ;[a,b]=c_link(’foo’); ulink(b);end

S EE A LSO : link 303, fort 43

1.8.4 chdir changes Scilab current directory

CALLING SEQUENCE :

ierr=chdir(’path-name’)

PARAMETERS :

ierr : an integer, 1 if chdir failed to change directory and 0 elsewhere.

DESCRIPTION :
Change the current Scilab directory to ’path-name’
EXAMPLE :

chdir(TMPDIR);
if MSDOS then
unix_w("dir");
else
unix_w("ls");
end

S EE A LSO : getcwd 67

Scilab Group April 1993 297

hex2dec Scilab Function

1.8.5 dec2hex hexadecimal representation of integers

CALLING SEQUENCE :

h=dec2hex(d)

PARAMETERS :

d : matrix of non negative integers

h : matrix of character strings

DESCRIPTION :
dec2hex(x) returns the hexadecimal representation of a matrix of integers
EXAMPLE :

dec2hex([2748 10;11 3])

1.8.6 demos guide for scilab demos

CALLING SEQUENCE :

demos()

DESCRIPTION :
demos() is an interactive guide to execute various scilab demonstrations The source code of each demo
is in the directory SCIDIR/demos/...

1.8.7 help on-line help command

CALLING SEQUENCE :

help word

DESCRIPTION :
To each documented word corresponds a word.cat ascii file. these files are organised within directories
(chapters). Each chapter must contain *.cat files and a whatis file with one line for each documented
word in the chapter. Each line must have the following format :

word - quick description

List of chapter directories is given in a scilab variable %helps. %helps a two column matrix of
strings. Each line is formed as follow :

chapter_path chapter_title

%helps default value is set by scilab.star file. If you want to add new help chapters you have to add new
lines %helps variables for example in your .scilab startup file.
Note that, once the help has been used, new additions to %helps are not taken into account.
See also Scilab’s manual
S EE A LSO : apropos 26, man 305, formatman 660

Scilab Group April 1993 298

ilib build Scilab Function

1.8.8 hex2dec converts hexadecimal representation of integers to numbers

CALLING SEQUENCE :

d=hex2dec(h)

PARAMETERS :

d : matrix of integers
h : matrix of character strings corresponding to hexadecimal representation

DESCRIPTION :
hex2dec(x) returns the matrix of numbers corresponding to the hexadecimal representation.
EXAMPLE :

hex2dec([’ABC’,’0’,’A’])

1.8.9 ilib build utility for shared library management

CALLING SEQUENCE :

ilib_build(lib_name,table,files,libs [,makename])

PARAMETERS :

lib name : a character string, the generic name of the library without path and extension.
table : 2 column string matrix giving the table of pairs ’scilab-name’, ’interface name’
files : string matrix giving objects files needed for shared library creation
libs : string matrix giving extra libraries needed for shred library creation
makename : character string. The path of the Makefile file without extension.

DESCRIPTION :

This tool is used to create shared libraries and to generate a loader file which can be used to dynamically load
the shared library into Scilab with addinter Many examples are provided in examples/interface-tour-so
directory.
EXAMPLE :

//Here with give a complete example on adding new primitive to Scilab

//create the procedure files
f1=[’extern double fun2();’
’void fun1(x,y)’
’double *x, *y;’
’{*y=fun2(*x)/(*x);}’];

mputl(f1,’fun1.c’)

f2=[’#include <math.h>’
’double fun2(x)’
’double x;’
’{ return( sin(x+1.));}’];
mputl(f2,’fun2.c’);

//creating the interface file

Scilab Group May 2000 299

ilib for link Scilab Function

i=[’#include ""stack-c.h""’
’extern int fun1 _PARAMS(( double *x, double *y));’
’int intfun1(fname)’
’char * fname;’
’{’
’ int m1,n1,l1;’
’ CheckRhs(1,1);’
’ CheckLhs(1,1);’
’ GetRhsVar(1, ""d"", &m1, &n1, &l1);’
’ fun1(stk(l1),stk(l1));’
’ LhsVar(1) = 1;’
’ return 0;’
’}’];
mputl(i,’intfun1.c’)

//creating the shared library (a gateway, a Makefile and a loader are

//generated.

files=[’fun1.o’,’fun2.o’,’intfun1.o’];
ilib_build(’foo’,[’scifun1’,’intfun1’],files,[]);

// load the shared library

exec loader.sce

//using the new primitive

scifun1(33)

S EE A LSO : addinter 265, link 303, ilib_compile 300, ilib_gen_Make 302, ilib_gen_gateway
302, ?? ilib gen loader, ilib for link

1.8.10 ilib compile ilib build utility: executes the makefile produced by
ilib gen Make

CALLING SEQUENCE :

libn=ilib_compile(lib_name,makename)

PARAMETERS :

lib name : : a character string, the generic name of the library without path and extension.
makename : character string. The path of the Makefile file without extension.
libn : character string. The path of the really generated shared library file.

DESCRIPTION :
Utility function used by ilib build
This executes the makefile produced by ilib gen Make, compiles the C and fortran files and generates
the shared library.
Shared libraries can then be used with the link and addinter scilab function for incremental linking.

S EE A LSO : addinter 265, link 303, ilib_build 299, ilib_gen_Make 302, ilib_gen_gateway
302, ?? ilib gen loader, ilib for link

Scilab Group May 2000 300

ilib gen Make Scilab Function

1.8.11 ilib for link utility for shared library management with link

CALLING SEQUENCE :

libn=ilib_for_link(names,files,libs,flag,makename,loadername])

PARAMETERS :

names : a string matrix giving the entry names which are to be linked.
files : string matrix giving objects files needed for shared library creation
libs : string matrix giving extra libraries needed for shred library creation
flag : a string flag (”c” or ”f”) for C or Fortran entry points.
makename : character string. The pathname of the Makefile file without extension (default value Makelib).
loadername : character string. The pathname of the loader file (default value loader.sce).
libn : character string. The path of the really generated shared library file.

DESCRIPTION :

This tool is used to create shared libraries and to generate a loader file which can be used to dynamically
load the shared library into Scilab with the link function. New entry points given by names are then
accessible through the call function or with non linear tools ode, optim,...
Many examples are provided in examples/link-examples-so directory.
EXAMPLE :

f1=[’int ext1c(n, a, b, c)’

’int *n; double *a, *b, *c;’
’{int k;’
’ for (k = 0; k < *n; ++k) ’
’ c[k] = a[k] + b[k];’
’ return(0);}’];

mputl(f1,’fun1.c’)

//creating the shared library (a gateway, a Makefile and a loader are

//generated.

ilib_for_link(’ext1c’,’fun1.o’,[],"c")

// load the shared library

exec loader.sce

//using the new primitive

a=[1,2,3];b=[4,5,6];n=3;
c=call(’ext1c’,n,1,’i’,a,2,’d’,b,3,’d’,’out’,[1,3],4,’d’);
if norm(c-(a+b)) > %eps then pause,end

S EE A LSO : addinter 265, link 303, ilib_compile 300, ilib_gen_Make 302, ilib_gen_gateway
302, ?? ilib gen loader, ilib for link

Scilab Group May 2000 301

intersci Scilab Tool

1.8.12 ilib gen Make utility for ilib build: produces a makefile for building
shared libraries

CALLING SEQUENCE :

Makename=ilib_gen_Make(name,files,libs,makename [,with_gateway])

PARAMETERS :

lib name : a character string, the generic name of the library without path and extension.
files : a vector of character string. The names of the C or Fortran files without the extension and the
path part.
libs : a vector of character string. additionnal libraries paths or [].
makename : character string. The path of the Makefile file.
with gateway : a boolean. If true a file with name <lib name> gateway is added.
Makename : character string. The path of the really generated Makefile file.

DESCRIPTION :
Utility function used by ilib build This function generates a makefile adapted to the Operating System
for building shared libraries to be loaded in Scilab. Proper options and paths are set.
Shared libraries can then be used with the link and addinter scilab function for incremental linking.
The shared library is build from a set of C or Fortran routines stored in a directory and if required from a
set of external libraries.
Files are not required to exist, when makefile is generated, but of course are required for executing the
makefile.
S EE A LSO : addinter 265, link 303, ilib_build 299, ilib_compile 300, ilib_gen_gateway
302, ?? ilib gen loader, ilib for link

1.8.13 ilib gen gateway utility for ilib build, generates a gateway file.

CALLING SEQUENCE :

ilib_gen_gateway(name,table)

PARAMETERS :

name : a character string, the generic name of the library without path and extension.
table : 2 column string matrix giving the table of pairs ’scilab-name’ ’interface name’

DESCRIPTION :
Utility function used by ilib build This function generates a gateway file used by addinter.
S EE A LSO : addinter 265, link 303, ilib_build 299, ilib_compile 300, ilib_gen_Make
302, ?? ilib gen loader, ilib for link

1.8.14 ilib gen loader utility for ilib build: generates a loader file

CALLING SEQUENCE :

ilib_gen_loader(name,table)

PARAMETERS :

Scilab Group April 1993 302

link Scilab Function

name : a character string, the generic name of the library without path and extension.
table : 2 column string matrix giving the table of pairs ’scilab-name’ ’interface name’

DESCRIPTION :
Utility function used by ilib build This function generates a loader file.
S EE A LSO : addinter 265, link 303, ilib_build 299, ilib_compile 300, ilib_gen_Make
302, ?? ilib gen loader, ilib for link

1.8.15 intersci scilab tool to interface C of Fortran functions with scilab

DESCRIPTION :
All scilab primitive functions are defined in a set of interface routines. For each function the interfacing
code checks first number of rhs and lhs arguments. Then it get pointers on input arguments in the Scilab data
base and checks their types. After that it calls procedure associated with Scilab functions, checks returned
errors flags and set the results in the data base.
intersci is a program which permits to interface automatically FORTRAN subroutines or C functions
to Scilab
With intersci, a user can group all his FORTRAN or C code into a same set, called an interface, and
use them in Scilab as Scilab functions. The interfacing is made by creating a FORTRAN subroutine which
has to be linked to Scilab together with the user code. This complex FORTRAN subroutine is automatically
generated by intersci from a description file of the interface.
Refer to intersci documentation for more details.
S EE A LSO : fort 43, external 38, addinter 265

1.8.16 link dynamic link

CALLING SEQUENCE :

link(files, sub-name)
link(files, sub-name, flag)
lst=link(’show’)
// Link extensions for machines using ‘‘dlopen’’
// (sun-solaris/linux-elf/alpha/hppa)
x=link(files [, sub-names,flag]);
link(x , sub-names [, flag]);
ulink(x)

PARAMETERS :

files : a character string or a vector of character strings. ld files used to define the new entry point
(compiled routines, user libraries, system libraries,..)
sub-name : a character string. Name of the entry point in files to be linked.
sub-names : a character string or a vector of character strings . Name of the entry points in files to
be linked.
x : an integer which gives the id of a shared library linked into Scilab with a previous call to link.
flag : character string ’f’ or ’c’ for Fortran (default) or C code.
names : a vector of character string. Names of dynamically linked entry points.

DESCRIPTION :
link is a dynamic link facility: this command allows to add new compiled Fortran or C routines to Scilab
executable code. Linked routines can be called interactively by the function fort. Linked routines can

Scilab Group April 1993 303

link Scilab Function

also be used as ”external” for e.g. non linear problem solvers (ode, optim, intg, dassl...). Here are
some examples:
The command link(’foo.o’,’foo’,’f’) links the Fortran object file foo.o with the entry point
foo.
The command link(’foo.o’,’foo’,’c’) links the C object file foo.o with the entry point foo.
The command link(’SCIDIR/libs/calelm.a’,’dcopy’) links the Fortran routine dcopy in
the library calelm.a.
A routine can be linked several times and can be unlinked with ulink. Note that, on some architectures
(the ones on which ulink exists) when a routine is linked several times, all the version are kept inside
Scilab.
Used with no arguments, link() returns the current linked routines.
If Scilab is compiled with static link (this is the default for SystemV machines) you may have to include
the system libraries in the ”link” command.
For example, if foo.o defines the object code of a routine named foo, you will use link in one the
following way:
link(’foo.o’,’foo’).
link(’foo.o -lm -lc’,’foo’,’c’).
link(’foo.o -lfor -lm -lc’,’foo’).
link(’foo.o -lftn -lm -lc’,’foo’).
link(’foo.o -L/opt/SUNWspro/SC3.0/lib/lib77 -lm -lc’,’foo’)
If Scilab compiled with the ”shared” option, the first example can be used even if a warning for unre-
solved references is issued.
(Experienced) users may also link a new Scilab interface routine to add a set of new functions. See
Intersci documentation for interface generation and addinter function.
REMARKS :

IBM: For IBM-RS6000 only one program can be dynamically linked.

Demo: When running a demo, you may have some trouble with the link due to slight differences between
systems. In this case, you modify the demo by adding the needed libraries in the link command.
dlopen: For machines using dlopen functionality extended command can be used. a call to link re-
turns an integer which gives the id of the shared library which is loaded into Scilab. This number can
then be used as the first argument of the link function in order to link additional function from the
linked shared library. The shared library is removed with the ulink command.
for example to link functions f and g form binary file test.o the two following command can
be used :

link(’test.o’,[’f’,’g’])

or

x=link(’test.o’,’f’);
link(x,’g’);

But

link(’test.o’,’f’);
link(’test.o’,’g’);

will also work but f and g will be loaded from two different shared libraries and won’t be able to
share data.
show: The command lst=link(’show’) will report information about linked shared libraries and
linked functions. The return value of the function lst is 1 or 0. If the return value is 1 then the ex-
tended calling sequence described as Link extensions for machines using ‘‘dlopen’’
are accepted.

Scilab Group April 1993 304

man Scilab Format

unlink : (dlopen version) If the function f is changed and one wants to link the new version, it is
necessary to use unlink to get rid of previous loaded versions of the function f

x=link(’test.o’,’f’);
// if I need to reload a new definition of f a call to unlink
// is necessary.
ulink(x);
link(’test.o’,’f’);
scilab symbols: In order to load a symbol from the Scilab code on can use

link("Scilab",[’Scilab-entry-point’])

This does not work on all architectures. On some machines, on can link a Scilab internal function
after a first call to link ( with a default binary file )

link("test.o",[’Scilab-entry-point’])

Note that with dld (Linux machine aout) you can use an empty string

link(" ",[’Scilab-entry-point’])

S EE A LSO : fort 43, c_link 297, addinter 265

1.8.17 man on line help source file description format

DESCRIPTION :
The on line help source files are written in a subset of the old text formatting language groff. The
advantage of this language is to allow the most useful formatting, being quite simple. It also allows easy
translation in other formatting language like HTML or LaTeX.
Source files (with extension .man) can be found in the <SCIDIR>/man/* directories. The file name is
associated to the keyword (usually a function name) it describes.
Most groff commands begin by a dot as first character of a line. The first line of each man file must
be:
.TH <keyword> 1 "date" "Author" "Category"

The help is then split into a sequence of ”sections”. Each section begins with the groff command
.SH <section name>.
To give a uniform aspect to the scilab on-line help Scilab uses the following sections names:
NAME : This section gives the keyword(s) documented in this file, on keyword per line followed by a
minus sign and a short description of the keyword. Below is the example of the NAME section
extracted from the mfscanf.man file.

--------------------------------------------
mscanf - interface to the C scanf function
mfscanf - interface to the C fscanf function
msscanf - interface to the C sscanf function
--------------------------------------------
CALLING SEQUENCE : Here one gives the Scilab syntaxe(s) which can be used. Below is an example
extracted out of the mfscanf.man file:

Scilab Group April 1993 305

man Scilab Format

---------------------------------
.nf
[n,v_1,...v_n]=mfscanf(fd,format)
L=mfscanf(fd,format)

[n,v_1,...v_n]=mscanf(format)
L=mscanf(format)

[n,v_1,...v_m]=msscanf(format,str)
L=msscanf(format)
.fi
---------------------------------

The .nf, .fi pair of commands is used to specify an unformatted region.

PARAMETERS : Here is given an indented itemized sequence of the parameters description first item is
defined using the .TP n command, where n is a number of characters. The following items begin
with the command .TP as shown on the following example extracted out of the file.man file:

--------------------------------------------
.TP 10
file-name
: string, file name of the file to be opened
.TP
status
: string, The status of the file to be opened
.RS
.TP 5
"new"
: file must not exist new file (default)
.TP
"old"
: file must already exists.
.RE
.TP
access
: string, The type of access to the file
--------------------------------------------

The .RS .RE pair of commands are used to nest an itemized sequence in an other.
DESCRIPTION : Here one describes the keyword
EXAMPLE : This section gives some examples of the use of the keyword. This must be a sequence of
Scilab instruction enclosed in a .nf, .fi pair of commands.
SEE ALSO : Here are given a one line sequence of related keywords separed by a comma followed by a
blank as in the example below.

---------------------------------------------------------------------
mclose, meof, mfprintf, fprintfMat, mfscanf, fscanfMat, mget, mgetstr
---------------------------------------------------------------------

AUTHOR : Here one gives informations on the author and references.

The fonts changes are specified in the formatted text by groff commands like

\fV for verbatim

\fR for Roman

Scilab Group April 1993 306

abs Scilab Function

Below is an example extracted out of the mfscanf.man file, the keywords are required to be in verba-
tim font.

---------------------------------------------------------------------
The \fVmfscanf\fR function reads characters from the stream \fVfd\fR.
.LP
The \fVmscanf\fR function reads characters from Scilab window.
.LP
The \fVmsscanf\fR function reads characters from the string \fVstr\fR.
---------------------------------------------------------------------

The .LP command is used to define a line break.

Some time it is useful to define tables. An example of such table formatting may be found in the file
overloading.man:
-------------------
.TS
tab(@);
l l.
string@c
polynomial@p
function@m
constant@s
list@l
tlist@<tlist_type>
boolean@b
sparse@sp
boolean sparse@spb
.TE
-------------------
These commands define a two column, left aligned( l l.), table. The column separator (@) is specified
here by the tab(@); command.

FORMATTING MAN FILES :

These source files may then be used to generate pure ASCII or LaTeX or HTML formatted files using the
Scilab function formatman.
S EE A LSO : formatman 660, help 298

1.8.18 sci2exp converts variable to expression

CALLING SEQUENCE :

t=sci2exp(a [,nam] [,lmax])

PARAMETERS :

a : a scilab variable, may be

- constant,
- polynomial
- string matrix
- list
- boolean matrix
nam : character string

Scilab Group April 1993 307

scilab Scilab Function

t : vector of string, contains the expression or instruction definition

lmax : integer, contains the maximum line length. default value is 90, lmax=0 indicate no line length
control a single string is returned

DESCRIPTION :
sci2exp converts variable to an instruction if nam is given or to an expression .
EXAMPLE :

a=[1 2;3 4]
sci2exp(a,’aa’)
sci2exp(a,’aa’,0)
sci2exp(ssrand(2,2,2))
sci2exp(poly([1 0 3 4],’s’),’fi’)

1.8.19 sci2map Scilab to Maple variable conversion

CALLING SEQUENCE :

txt=sci2map(a,Map-name)

PARAMETERS :

a : Scilab object (matrix, polynomial, list, string)

Map-name : string (name of the Maple variable)
txt : vector of strings containing the corresponding Maple code

DESCRIPTION :
Makes Maple code necessary to send the Scilab variable a to Maple : the name of the variable in Maple
is Map-name. A Maple procedure maple2scilab can be found in SCIDIR/maple directory.
EXAMPLE :

txt=[sci2map([1 2;3 4],’a’);

sci2map(%sˆ2+3*%s+4,’p’)]

1.8.20 scilab Major unix script to execute Scilab and miscellaneous tools

CALLING SEQUENCE :

scilab [-ns -nw -display display -f file -args arguments]

scilab -help [ <key> ]
scilab -k <key>
scilab -xk <key>
scilab -link <objects>

DESCRIPTION :

scilab [-ns -nw -display display -f path -args arguments] : run scilab.
-ns :if this option is present the startup file SCI/scilab.star is not executed.
-nw :if this option is present then scilab is not run in an X window.
-f file : if this option is present then Scilab script file is executed first into Scilab.
-args arguments : if this option is present arguments are passed to Scilab. They can then be got by
sciargs function. For multi arguments passing use a quoted, blank separated sequence of words like:
scilab -args ’foo1 foo2’

Scilab Group May 1994 308

unix Scilab Function

scilab -help <key> : write on-line documentation about <key> (usually automatically called by
scilab command ”help <key>”). Example:

scilab -help plot3d

scilab -k <key> : gives the list of Scilab commands containing the keyword <key> in their de-
scription (same as UNIX command man -k)
scilab -xk <key> : gives the list of Scilab commands containing the keyword <key> in their de-
scription in a X window.
scilab -link <objects> : Is used to produce a local scilex (executable code of Scilab) linked
with the additional files given by the user in <objects>.
If, in the list of object files, some names are known from SCIDIR/routines/default, then the
scilex default files are omitted and replaced with the given ones .
This command also produces an xscilab script, which when called will ran the new generated
scilex file.

For example:

scilab -link C/interf.o C/evol.o C/bib.a

will create a new scilex file in which the default interf.o file will be replaced by C/interf.o.

1.8.21 scilink Unix script to relink Scilab

CALLING SEQUENCE :

scilink <object-files>

DESCRIPTION :
This script is used to produce a local scilex (executable code of Scilab) linked with the additional files
given by the user in <object-files>.
If in the list of object files some names are known scilex names (from SCIDIR/routines/default
) then the scilex default files are omitted and replaced with the given ones .
This script also produces an xscilab script, which when called will ran the new generated scilex file.
For example the command

scilink C/interf.o C/evol.o C/bib.a

will create a new scilex file in which the default interf.o file will be replaced by C/interf.o.

S EE A LSO : link 303, addinter 265

1.8.22 ulink unlink a dynamically linked shared object

CALLING SEQUENCE :

ulink(x)

DESCRIPTION :
see link
S EE A LSO : link 303

Scilab Group April 1993 309

unix s Scilab Function

1.8.23 unix shell (sh) command execution

CALLING SEQUENCE :

stat=unix(command-name)

PARAMETERS :

command-name : A character string containing Unix sh instruction

stat : An integer flag

DESCRIPTION :
Sends a string command-name to Unix for execution by the sh shell. Standard output and standard errors
of the shell command are written in the calling shell. stat gives -1 if unix can’t be called (Not enough
system memory available) or the sh return code.
EXAMPLE :

unix("ls $SCI/demos");
deff(’wd=dir()’,’if MSDOS then unix(’’cd>’’+TMPDIR+’’\path’’);..
else unix(’’pwd>’’+TMPDIR+’’/path’’);end..
wd=read(TMPDIR+’’/path’’,1,1,’’(a)’’)’)
wd=dir()

S EE A LSO : edit 267, manedit 239, unix_g 310, unix_s 311, unix_w 311, unix_x
312, host 48

1.8.24 unix g shell (sh) command execution, output redirected to a variable

CALLING SEQUENCE :

rep=unix_g(cmd)

PARAMETERS :

cmd : a character string

rep : a column vector of character strings

DESCRIPTION :
Sends a string cmd to Unix for execution by the sh shell. The standard output is redirected to scilab
variable rep. Unix execution errors are trapped; *NOTE* that only the last shell command error is reported
when a list of command separated by ”;” is sent: this is not recommended.
EXAMPLE :

if MSDOS then unix_g(’dir ’+WSCI+’\demos’);

else unix_g("ls $SCI/demos"); end
deff(’wd=pwd()’,’if MSDOS then wd=unix_g(’’cd’’);..
else wd=unix_g(’’pwd’’); end’)
wd=pwd()

S EE A LSO : edit 267, manedit 239, unix_s 311, unix_w 311, unix_x 312, unix
310

Scilab Group April 1993 310

unix x Scilab Function

1.8.25 unix s shell (sh) command execution, no output

CALLING SEQUENCE :

unix_s(cmd)

PARAMETERS :

cmd : a character string

DESCRIPTION :
Sends a string cmd to Unix for execution by the sh shell. The standard output is redirected to /dev/null.
Unix execution errors are trapped; *NOTE* that only the last shell command error is reported when a list
of command separated by ”;” is sent: this is not recommended.
EXAMPLE :

if MSDOS then
unix_s("del foo");
else
unix_s("rm -f foo");
end

S EE A LSO : edit 267, manedit 239, unix_g 310, unix_w 311, unix_x 312, unix
310

1.8.26 unix w shell (sh) command execution, output redirected to scilab window

CALLING SEQUENCE :

rep=unix_w(cmd)

PARAMETERS :

cmd : a character string

rep : a column vector of character strings

DESCRIPTION :
Sends a string cmd to Unix for execution by the sh shell. The standard output is redirected to scilab
window. Unix execution errors are trapped; *NOTE* that only the last shell command error is reported
when a list of command separated by ”;” is sent: this is not recommended.
EXAMPLE :

if MSDOS then unix_w("dir "+WSCI+"\demos");

else unix_w("ls $SCI/demos"); end

S EE A LSO : edit 267, manedit 239, unix_g 310, unix_s 311, unix_x 312, unix
310

Scilab Group April 1993 311

unix x Scilab Function

1.8.27 unix x shell (sh) command execution, output redirected to a window

CALLING SEQUENCE :

unix_x(cmd)

PARAMETERS :

cmd : a character string

DESCRIPTION :
Sends a string cmd to Unix for execution by the sh shell. The standard output is redirected to a xless
window. Unix execution errors are trapped; *NOTE* that only the last shell command error is reported
when a list of command separated by ”;” is sent: this is not recommended.
EXAMPLE :

if MSDOS then unix_x("dir "+WSCI+"\demos");

else unix_x("ls $SCI/demos"); end

S EE A LSO : edit 267, manedit 239, unix_g 310, unix_s 311, unix_w 311, unix
310

Scilab Group April 1993 312

unix x Scilab Function

1.9 Time and date

Scilab Group April 1993 313

timer Scilab Function

1.9.1 date Current date as date string

CALLING SEQUENCE :
dt=date()
PARAMETERS :

dt : a string
DESCRIPTION :
dt=date() returns a string containing the date in dd-mmm-yyyy format.
EXAMPLES :
date()

S EE A LSO : getdate 314, timer 315

1.9.2 getdate get date and time information

CALLING SEQUENCE :
dt=getdate()
x=getdate(’s’)
dt=getdate(x)
PARAMETERS :
dt : an integer vector with 8 entries (see below)
x : an integer containing a date coded in second from 1 Jan 1970
DESCRIPTION :

dt =getdate() returns the current date in format given below:

dt(1) : The year as a number (with the century) between 0000 and 9999.
dt(2) : The month of the year as a number between 01 and 12.
dt(3) : The ISO 8601 week number as a number between 01 and 53.
dt(4) : The Julian day of the year as a number between 001 and 366.
dt(5) : Specifies the weekday as a decimal number [1,7], with 1 representing Sunday.
dt(6) : The day of the month as a number between 01 and 31.
dt(7) : The hour of the day as a number between 00 and 23.
dt(8) : The minute as a number between 00 and 59.
dt(9) : The second is output as a number between 00 and 61.
x =getdate(’s’), returns a scalar with the number of seconds since Jan 1,
1970, 00:00 UTC (unix time convention)
dt =getdate(x) ,format the date given by x (number of seconds since Jan 1, 1970, 00:00 UTC) in format
given above:
EXAMPLES :
w=getdate()
mprintf("Year:%d,Month:%d,Day:%d",w(1),w(2),w(6));

x=getdate(’s’)
getdate(x)

S EE A LSO : date 314, timer 315

Scilab Group April 1993 314

timer Scilab Function

1.9.3 timer cpu time

CALLING SEQUENCE :

timer()

DESCRIPTION :
Returns the CPU time from the preceding call to timer().
EXAMPLE :

timer();A=rand(100,100);timer()

S EE A LSO : unix_g 310

Scilab Group April 1993 315

timer Scilab Function

Scilab Group April 1993 316

Chapter 2

Specialized Toolboxes

2.1 General System and Control macros

317
abinv Scilab Function

2.1.1 abcd state-space matrices

CALLING SEQUENCE :

[A,B,C,D]=abcd(sl)

PARAMETERS :

sl : linear system (syslin list) in state-space or transfer form

A,B,C,D : real matrices of appropriate dimensions

DESCRIPTION :
returns the A,B,C,D matrices from a linear system Sl.
Utility function. For transfer matrices Sl is converted into state-space form by tf2ss.
The matrices A,B,C,D are the elements 2 to 5 of the syslin list Sl, i.e. [A,B,C,D] = Sl(2:5)
.
EXAMPLE :

A=diag([1,2,3]);B=[1;1;1];C=[2,2,2];
sys=syslin(’c’,A,B,C);
sys("A")
sys("C")
[A1,B1,C1,D1]=abcd(sys);
A1
systf=ss2tf(sys);
[a,b,c,d]=abcd(systf)
spec(a)
c*b-C*B
c*a*b-C*A*B

S EE A LSO : syslin 224, ssrand 220

2.1.2 abinv AB invariant subspace

CALLING SEQUENCE :

[X,dims,F,U,k,Z]=abinv(Sys,alfa,beta,flag)

PARAMETERS :

Sys : syslin list containing the matrices [A,B,C,D].

alfa : (optional) real number or vector (possibly complex, location of closed loop poles)
beta : (optional) real number or vector (possibly complex, location of closed loop poles)
flag : (optional) character string ’ge’ (default) or ’st’ or ’pp’
X : orthogonal matrix of size nx (dim of state space).
dims : integer row vector dims=[dimR,dimVg,dimV,noc,nos] with dimR<=dimVg<=dimV<=noc<=nos.
If flag=’st’, (resp. ’pp’), dims has 4 (resp. 3) components.
F : real matrix (state feedback)
k : integer (normal rank of Sys)
Z : non-singular linear system (syslin list)

Scilab Group April 1993 318

abinv Scilab Function

DESCRIPTION :
Output nulling subspace (maximal unobservable subspace) for Sys = linear system defined by a syslin
list containing the matrices [A,B,C,D] of Sys. The vector dims=[dimR,dimVg,dimV,noc,nos]
gives the dimensions of subspaces defined as columns of X according to partition given below. The dimV
first columns of X i.e V=X(:,1:dimV), span the AB-invariant subspace of Sys i.e the unobservable
subspace of (A+B*F,C+D*F). (dimV=nx iff Cˆ(-1)(D)=X).
The dimR first columns of X i.e. R=X(:,1:dimR) spans the controllable part of Sys in V, (dimR<=dimV).
(dimR=0 for a left invertible system). R is the maximal controllability subspace of Sys in kernel(C).
The dimVg first columns of X spans Vg=maximal AB-stabilizable subspace of Sys. (dimR<=dimVg<=dimV).
F is a decoupling feedback: for X=[V,X2] (X2=X(:,dimV+1:nx)) one has X2’*(A+B*F)*V=0
and (C+D*F)*V=0.
The zeros od Sys are given by : X0=X(:,dimR+1:dimV); spec(X0’*(A+B*F)*X0) i.e. there
are dimV-dimR closed-loop fixed modes.
If the optional parameter alfa is given as input, the dimR controllable modes of (A+BF) in V are set
to alfa (or to [alfa(1), alfa(2), ...]. (alfa can be a vector (real or complex pairs) or a
(real) number). Default value alfa=-1.
If the optional real parameter beta is given as input, the noc-dimV controllable modes of (A+BF)
”outside” V are set to beta (or [beta(1),beta(2),...]). Default value beta=-1.
In the X,U bases, the matrices [X’*(A+B*F)*X,X’*B*U;(C+D*F)*X,D*U] are displayed as fol-
lows:

[A11,*,*,*,*,*] [B11 * ]
[0,A22,*,*,*,*] [0 * ]
[0,0,A33,*,*,*] [0 * ]
[0,0,0,A44,*,*] [0 B42]
[0,0,0,0,A55,*] [0 0 ]
[0,0,0,0,0,A66] [0 0 ]

[0,0,0,*,*,*] [0 D2]

where the X-partitioning is defined by dims and the U-partitioning is defined by k.

A11 is (dimR x dimR) and has its eigenvalues set to alfa(i)’s. The pair (A11,B11) is control-
lable and B11 has nu-k columns. A22 is a stable (dimVg-dimR x dimVg-dimR) matrix. A33
is an unstable (dimV-dimVg x dimV-dimVg) matrix (see st ility).
A44 is (noc-dimV x noc-dimV) and has its eigenvalues set to beta(i)’s. The pair (A44,B42)
is controllable. A55 is a stable (nos-noc x nos-noc) matrix. A66 is an unstable (nx-nos x
nx-nos) matrix (see st ility).
Z is a column compression of Sys and k is the normal rank of Sys i.e Sys*Z is a column-compressed
linear system. k is the column dimensions of B42,B52,B62 and D2. [B42;B52;B62;D2] is full
column rank and has rank k.
If flag=’st’ is given, a five blocks partition of the matrices is returned and dims has four components. If
flag=’pp’ is given a four blocks partition is returned. In case flag=’ge’ one has dims=[dimR,dimVg,dimV,dimV+nc
where nc2 (resp. ns2) is the dimension of the controllable (resp. stabilizable) pair (A44,B42) (resp.
([A44,*;0,A55],[B42;0])). In case flag=’st’ one has dims=[dimR,dimVg,dimVg+nc,dimVg+ns]
and in case flag=’pp’ one has dims=[dimR,dimR+nc,dimR+ns]. nc (resp. ns) is here the di-
mension of the controllable (resp. stabilizable) subspace of the blocks 3 to 6 (resp. 2 to 6).
This function can be used for the (exact) disturbance decoupling problem.

DDPS:
Find u=Fx+Rd=[F,R]*[x;d] which rejects Q*d and stabilizes the plant:

xdot = Ax+Bu+Qd
y = Cx+Du+Td

DDPS has a solution if Im(Q) is included in Vg + Im(B) and stabilizability

Scilab Group April 1993 319

abinv Scilab Function

assumption is satisfied.
Let G=(X(:,dimVg+1:$))’= left annihilator of Vg i.e. G*Vg=0;
B2=G*B; Q2=G*Q; DDPS solvable iff [B2;D]*R + [Q2;T] =0 has a solution.
The pair F,R is the solution (with F=output of abinv).
Im(Q2) is in Im(B2) means row-compression of B2=>row-compression of Q2
Then C*[(sI-A-B*F)ˆ(-1)+D]*(Q+B*R) =0 (<=>G*(Q+B*R)=0)
EXAMPLE :

nu=3;ny=4;nx=7;
nrt=2;ngt=3;ng0=3;nvt=5;rk=2;
flag=list(’on’,nrt,ngt,ng0,nvt,rk);
Sys=ssrand(ny,nu,nx,flag);alfa=-1;beta=-2;
[X,dims,F,U,k,Z]=abinv(Sys,alfa,beta);
[A,B,C,D]=abcd(Sys);dimV=dims(3);dimR=dims(1);
V=X(:,1:dimV);X2=X(:,dimV+1:nx);
X2’*(A+B*F)*V
(C+D*F)*V
X0=X(:,dimR+1:dimV); spec(X0’*(A+B*F)*X0)
trzeros(Sys)
spec(A+B*F) //nr=2 evals at -1 and noc-dimV=2 evals at -2.
clean(ss2tf(Sys*Z))
// 2nd Example
nx=6;ny=3;nu=2;
A=diag(1:6);A(2,2)=-7;A(5,5)=-9;B=[1,2;0,3;0,4;0,5;0,0;0,0];
C=[zeros(ny,ny),eye(ny,ny)];D=[0,1;0,2;0,3];
sl=syslin(’c’,A,B,C,D);//sl=ss2ss(sl,rand(6,6))*rand(2,2);
[A,B,C,D]=abcd(sl); //The matrices of sl.
alfa=-1;beta=-2;
[X,dims,F,U,k,Z]=abinv(sl,alfa,beta);dimVg=dims(2);
clean(X’*(A+B*F)*X)
clean(X’*B*U)
clean((C+D*F)*X)
clean(D*U)
G=(X(:,dimVg+1:$))’;
B2=G*B;nd=3;
R=rand(nu,nd);Q2T=-[B2;D]*R;
p=size(G,1);Q2=Q2T(1:p,:);T=Q2T(p+1:$,:);
Q=G\Q2; //a valid [Q;T] since
[G*B;D]*R + [G*Q;T] // is zero
closed=syslin(’c’,A+B*F,Q+B*R,C+D*F,T+D*R); // closed loop: d-->y
ss2tf(closed) // Closed loop is zero
spec(closed(’A’)) //The plant is not stabilizable!
[ns,nc,W,sl1]=st_ility(sl);
[A,B,C,D]=abcd(sl1);A=A(1:ns,1:ns);B=B(1:ns,:);C=C(:,1:ns);
slnew=syslin(’c’,A,B,C,D); //Now stabilizable
//Fnew=stabil(slnew(’A’),slnew(’B’),-11);
//slnew(’A’)=slnew(’A’)+slnew(’B’)*Fnew;
//slnew(’C’)=slnew(’C’)+slnew(’D’)*Fnew;
[X,dims,F,U,k,Z]=abinv(slnew,alfa,beta);dimVg=dims(2);
[A,B,C,D]=abcd(slnew);
G=(X(:,dimVg+1:$))’;
B2=G*B;nd=3;
R=rand(nu,nd);Q2T=-[B2;D]*R;
p=size(G,1);Q2=Q2T(1:p,:);T=Q2T(p+1:$,:);
Q=G\Q2; //a valid [Q;T] since

Scilab Group April 1993 320

ARL2 Scilab Function

[G*B;D]*R + [G*Q;T] // is zero

closed=syslin(’c’,A+B*F,Q+B*R,C+D*F,T+D*R); // closed loop: d-->y
ss2tf(closed) // Closed loop is zero
spec(closed(’A’))

AUTHOR : F.D.
S EE A LSO : cainv 323, st_ility 364, ssrand 220, ss2ss 362, ddp 331

2.1.3 arhnk Hankel norm approximant

CALLING SEQUENCE :

[slm]=arhnk(sl,ord,[tol])

PARAMETERS :

sl : linear system (syslin list)

ord : integer, order of the approximant
tol : threshold for rank determination in equil1

DESCRIPTION :
computes slm, the optimal Hankel norm approximant of the stable continuous-time linear system sl with
matrices [A,B,C,D].
EXAMPLE :

A=diag([-1,-2,-3,-4,-5]);B=rand(5,1);C=rand(1,5);
sl=syslin(’c’,A,B,C);
slapprox=arhnk(sl,2);
[nk,W]=hankelsv(sl);nk
[nkred,Wred]=hankelsv(slapprox);nkred

S EE A LSO : equil 334, equil1 335, hankelsv 383

2.1.4 arl2 SISO model realization by L2 transfer approximation

CALLING SEQUENCE :

h=arl2(y,den0,n [,imp])
h=arl2(y,den0,n [,imp],’all’)
[den,num,err]=arl2(y,den0,n [,imp])
[den,num,err]=arl2(y,den0,n [,imp],’all’)

PARAMETERS :

y : real vector or polynomial in zˆ-1, it contains the coefficients of the Fourier’s series of the rational
system to approximate (the impulse response)
den0 : a polynomial which gives an initial guess of the solution, it may be poly(1,’z’,’c’)
n : integer, the degree of approximating transfer function (degree of den)
imp : integer in (0,1,2) (verbose mode)
h : transfer function num/den or transfer matrix (column vector) when flag ’all’ is given.
den : polynomial or vector of polynomials, contains the denominator(s) of the solution(s)
num : polynomial or vector of polynomials, contains the numerator(s) of the solution(s)
err : real constant or vector , the l2-error achieved for each solutions

Scilab Group April 1993 321

bilin Scilab Function

DESCRIPTION :
[den,num,err]=arl2(y,den0,n [,imp]) finds a pair of polynomials num and den such that
the transfer function num/den is stable and its impulse response approximates (with a minimal l2 norm)
the vector y assumed to be completed by an infinite number of zeros.
If :
1 1 2 1 n
y (z ) = y (1)( ) + y (2)( ) + : : : + y (ny )( ) y
z z z
then l2-norm of num/den - y(z) is err.
n is the degree of the polynomial den.
The num/den transfer function is a L2 approximant of the Fourier’s series of the rational system.
Various intermediate results are printed according to imp.
[den,num,err]=arl2(y,den0,n [,imp],’all’) returns in the vectors of polynomials num
and den a set of local optimums for the problem. The solutions are sorted with increasing errors err. In
this case den0 is already assumed to be poly(1,’z’,’c’)
EXAMPLE :
v=ones(1,20);
xbasc();
plot2d1(’enn’,0,[v’;zeros(80,1)],2,’051’,’ ’,[1,-0.5,100,1.5])

[d,n,e]=arl2(v,poly(1,’z’,’c’),1)
plot2d1(’enn’,0,ldiv(n,d,100),2,’000’)
[d,n,e]=arl2(v,d,3)
plot2d1(’enn’,0,ldiv(n,d,100),3,’000’)
[d,n,e]=arl2(v,d,8)
plot2d1(’enn’,0,ldiv(n,d,100),5,’000’)

[d,n,e]=arl2(v,poly(1,’z’,’c’),4,’all’)
plot2d1(’enn’,0,ldiv(n(1),d(1),100),10,’000’)
S EE A LSO : ldiv 493, imrep2ss 341, time_id 367, armax 395, frep2tf 338

2.1.5 balreal balanced realization

CALLING SEQUENCE :
[slb [,U] ] = balreal(sl)
PARAMETERS :
sl,slb : linear systems (syslin lists)
DESCRIPTION :
Balanced realization of linear system sl=[A,B,C,D]. sl can be a continuous-time or discrete-time
state-space system. sl is assumed stable.
slb=[inv(U)*A*U ,inv(U)*B , C*U , D]
is the balanced realization.
slb is returned as a syslin list.
EXAMPLE :
A=diag([-1,-2,-3,-4,-5]);B=rand(5,2);C=rand(1,5);
sl=syslin(’c’,A,B,C);
[slb,U]=balreal(sl);
Wc=clean(ctr_gram(slb))
W0=clean(obs_gram(slb))
S EE A LSO : ctr_gram 330, obs_gram 349, hankelsv 383, equil 334, equil1 335

Scilab Group April 1993 322

cainv Scilab Function

2.1.6 bilin general bilinear transform

CALLING SEQUENCE :

[sl1]=bilin(sl,v)

PARAMETERS :

sl,sl1 : linear systems (syslin lists)

v : real vector with 4 entries (v=[a,b,c,d])

DESCRIPTION :
Given a linear system in state space form, sl=syslin(dom,A,B,C,D) (syslin list), sl1=bilin(sl,v)
returns in sl1 a linear system with matrices [A1,B1,C1,D1] such that the transfer function H1(s)=C1*inv(s*eye()-A1)
is obtained from H(z)=C*inv(z*eye()-A)*B+D by replacing z by z=(a*s+b)/(c*s+d). One
has w=bilin(bilin(w,[a,b,c,d]),[d,-b,-c,a])
EXAMPLE :

s=poly(0,’s’);z=poly(0,’z’);
w=ssrand(1,1,3);
wtf=ss2tf(w);v=[2,3,-1,4];a=v(1);b=v(2);c=v(3);d=v(4);
[horner(wtf,(a*z+b)/(c*z+d)),ss2tf(bilin(w,[a,b,c,d]))]
clean(ss2tf(bilin(bilin(w,[a,b,c,d]),[d,-b,-c,a]))-wtf)

S EE A LSO : horner 490, cls2dls 326

2.1.7 cainv Dual of abinv

CALLING SEQUENCE :

[X,dims,J,Y,k,Z]=cainv(Sl,alfa,beta,flag)

PARAMETERS :

Sl : syslin list containing the matrices [A,B,C,D].

alfa : real number or vector (possibly complex, location of closed loop poles)
beta : real number or vector (possibly complex, location of closed loop poles)
flag : (optional) character string ’ge’ (default) or ’st’ or ’pp’
X : orthogonal matrix of size nx (dim of state space).
dims : integer row vector dims=[nd1,nu1,dimS,dimSg,dimN] (5 entries, nondecreasing order).If
flag=’st’, (resp. ’pp’), dims has 4 (resp. 3) components.
J : real matrix (output injection)
Y : orthogonal matrix of size ny (dim of output space).
k : integer (normal rank of Sl)
Z : non-singular linear system (syslin list)

DESCRIPTION :
cainv finds a bases (X,Y) (of state space and output space resp.) and output injection matrix J such
that the matrices of Sl in bases (X,Y) are displayed as:

[A11,*,*,*,*,*] [*]
[0,A22,*,*,*,*] [*]
X’*(A+J*C)*X = [0,0,A33,*,*,*] X’*(B+J*D) = [*]
[0,0,0,A44,*,*] [0]

Scilab Group April 1993 323

calfrq Scilab Function

[0,0,0,0,A55,*] [0]
[0,0,0,0,0,A66] [0]

Y*C*X = [0,0,C13,*,*,*] Y*D = [*]

[0,0,0,0,0,C26] [0]

The partition of X is defined by the vector dims=[nd1,nu1,dimS,dimSg,dimN] and the partition

of Y is determined by k.
Eigenvalues of A11 (nd1 x nd1) are unstable. Eigenvalues of A22 (nu1-nd1 x nu1-nd1) are
stable.
The pair (A33, C13) (dimS-nu1 x dimS-nu1, k x dimS-nu1) is observable, and eigenval-
ues of A33 are set to alfa.
Matrix A44 (dimSg-dimS x dimSg-dimS) is unstable. Matrix A55 (dimN-dimSg,dimN-dimSg)
is stable
The pair (A66,C26) (nx-dimN x nx-dimN) is observable, and eigenvalues of A66 set to beta.
The dimS first columns of X span S= smallest (C,A) invariant subspace which contains Im(B), dimSg
first columns of X span Sg the maximal ”complementary detectability subspace” of Sl
The dimN first columns of X span the maximal ”complementary observability subspace” of Sl. (dimS=0
if B(ker(D))=0).
If flag=’st’ is given, a five blocks partition of the matrices is returned and dims has four components.
If flag=’pp’ is given a four blocks partition is returned (see abinv).
This function can be used to calculate an unknown input observer:

// DDEP: dot(x)=A x + Bu + Gd
// y= Cx (observation)
// z= Hx (z=variable to be estimated, d=disturbance)
// Find: dot(w) = Fw + Ey + Ru such that
// zhat = Mw + Ny
// z-Hx goes to zero at infinity
// Solution exists iff Ker H contains Sg(A,C,G) inter KerC (assuming detectability)
//i.e. H is such that:
// For any W which makes a column compression of [Xp(1:dimSg,:);C]
// with Xp=X’ and [X,dims,J,Y,k,Z]=cainv(syslin(’c’,A,G,C));
// [Xp(1:dimSg,:);C]*W = [0 | *] one has
// H*W = [0 | *] (with at least as many aero columns as above).

S EE A LSO : abinv 318, dt_ility 334, ui_observer 369

2.1.8 calfrq frequency response discretization

CALLING SEQUENCE :

[frq,split]=calfrq(h,[fmin,fmax])

PARAMETERS :

h : SISO linear system (syslin list)

fmin,fmax : real scalars (min and max frequencies)
frq : row vector (discretization of interval)
split : vector of frq splitting points indexes

Scilab Group April 1993 324

canon Scilab Function

DESCRIPTION :
frequency response discretization ; frq is the discretization of [fmin,fmax] such that the peaks in
the frequency response are well represented.
Default values for fmin and fmax are 1.d-3, 1.d+3 if h is continuous-time or 1.d-3, 1/(2*h(’dt’))
if h is discrete-time.
Singularities are located between frq(split(k)) and frq(split(k)+1) for k>1.
EXAMPLE :

s=poly(0,’s’)
h=syslin(’c’,(sˆ2+2*0.9*10*s+100)/(sˆ2+2*0.3*10.1*s+102.01))
h1=h*syslin(’c’,(sˆ2+2*0.1*15.1*s+228.01)/(sˆ2+2*0.9*15*s+225))
[f1,spl]=calfrq(h1,0.01,1000);
rf=repfreq(h1,f1);
plot2d(real(rf)’,imag(rf)’)

S EE A LSO : bode 86, black 85, nyquist 115, freq 339, repfreq 355, logspace
197

2.1.9 canon canonical controllable form

CALLING SEQUENCE :

[Ac,Bc,U,ind]=canon(A,B)

PARAMETERS :

Ac,Bc : canonical form

U : current basis (square nonsingular matrix)
ind : vector of integers, controllability indices

DESCRIPTION :
gives the canonical controllable form of the pair (A,B).
Ac=inv(U)*A*U, Bc=inv(U)*B
The vector ind is made of the epsilon i’s indices of the pencil [sI - A , B] (decreasing order).
For example with ind=[3,2], Ac and Bc are as follows:

[*,*,*,*,*] [*]
[1,0,0,0,0] [0]
Ac= [0,1,0,0,0] Bc=[0]
[*,*,*,*,*] [*]
[0,0,0,1,0] [0]

If (A,B) is controllable, by an appropriate choice of F the * entries of Ac+Bc*F can be arbitrarily

set to desired values (pole placement).
EXAMPLE :

A=[1,2,3,4,5;
1,0,0,0,0;
0,1,0,0,0;
6,7,8,9,0;
0,0,0,1,0];
B=[1,2;
0,0;
0,0;
2,1;

Scilab Group April 1993 325

colregul Scilab Function

0,0];
X=rand(5,5);A=X*A*inv(X);B=X*B; //Controllable pair
[Ac,Bc,U,ind]=canon(A,B); //Two indices --> ind=[3.2];
index=1;for k=1:size(ind,’*’)-1,index=[index,1+sum(ind(1:k))];end
Acstar=Ac(index,:);Bcstar=Bc(index,:);
s=poly(0,’s’);
p1=sˆ3+2*sˆ2-5*s+3;p2=(s-5)*(s-3);
//p1 and p2 are desired closed-loop polynomials with degrees 3,2
c1=coeff(p1);c1=c1($-1:-1:1);c2=coeff(p2);c2=c2($-1:-1:1);
Acstardesired=[-c1,0,0;0,0,0,-c2];
//Acstardesired(index,:) is companion matrix with char. pol=p1*p2
F=Bcstar\\(Acstardesired-Acstar); //Feedbak gain
Ac+Bc*F // Companion form
spec(A+B*F/U) // F/U is the gain matrix in original basis.

S EE A LSO : obsv_mat 351, cont_mat 327, ctr_gram 330, contrss 328, ppol 354,
contr 328, stabil 364
AUTHOR : F.D.

2.1.10 cls2dls bilinear transform

CALLING SEQUENCE :

[sl1]=cls2dls(sl,T [,fp])

PARAMETERS :

sl,sl1 : linear systems (syslin lists)

T : real number, the sampling period
fp : prevarping frequency in hertz

DESCRIPTION :
given sl=[A,B,C,D] (syslin list),a continuous time system cls2dls returns the sampled system
obtained by the bilinear transform s=(2/T)*(z-1)/(z+1).
EXAMPLE :

s=poly(0,’s’);z=poly(0,’z’);
sl=syslin(’c’,(s+1)/(sˆ2-5*s+2)); //Continuous-time system in transfer form
slss=tf2ss(sl); //Now in state-space form
sl1=cls2dls(slss,0.2); //sl1= output of cls2dls
sl1t=ss2tf(sl1) // Converts in transfer form
sl2=horner(sl,(2/0.2)*(z-1)/(z+1)) //Compare sl2 and sl1

S EE A LSO : horner 490

2.1.11 colregul removing poles and zeros at infinity

CALLING SEQUENCE :

[Stmp,Ws]=colregul(Sl,alfa,beta)

PARAMETERS :

Sl,Stmp : syslin lists

Scilab Group April 1993 326

CONTR Scilab Function

alfa,beta : reals (new pole and zero positions)

DESCRIPTION :
computes a prefilter Ws such that Stmp=Sl*Ws is proper and with full rank D matrix.
Poles at infinity of Sl are moved to alfa;
Zeros at infinity of Sl are moved to beta;
Sl is a assumed to be a left invertible linear system (syslin list) in state-space representation with
possibly a polynomial D matrix.
S EE A LSO : invsyslin 342, inv 516, rowregul 357, rowshuff 532
AUTHOR : F. D. , R. N.

2.1.12 cont frm transfer to controllable state-space

CALLING SEQUENCE :

[sl]=cont_frm(NUM,den)

PARAMETERS :

NUM : polynomial matrix

den : polynomial
sl : syslin list, sl=[A,B,C,D].

DESCRIPTION :
controllable state-space form of the transfer NUM/den.
EXAMPLE :

s=poly(0,’s’);NUM=[1+s,s];den=sˆ2-5*s+1;
sl=cont_frm(NUM,den);
slss=ss2tf(sl); //Compare with NUM/den

S EE A LSO : tf2ss 367, canon 325, contr 328

2.1.13 cont mat controllability matrix

CALLING SEQUENCE :

Cc=cont_mat(A,B)
Cc=cont_mat(sl)

PARAMETERS :

a,b : two real matrices of appropriate dimensions

sl : linear system (syslin list)

DESCRIPTION :
cont mat returns the controllability matrix of the pair A,B (resp. of the system sl=[A,B,C,D]).

Cc=[B, AB, Aˆ2 B,..., Aˆ(n-1) B]

S EE A LSO : ctr_gram 330, contr 328, canon 325, st_ility 364

Scilab Group April 1993 327

csim Scilab Function

2.1.14 contr controllability, controllable subspace

CALLING SEQUENCE :

[n [,U]]=contr(A,B [,tol])
[A1,B1,U,ind]=contr(A,B [,tol])

PARAMETERS :

A, B : real matrices
tol : may be the constant rtol or the 2 vector [rtol atol]
rtol :tolerance used when evaluating ranks (QR factorizations).
atol :absolute tolerance (the B matrix is assumed to be 0 if norm(B)<atol)
n : dimension of controllable subspace.
U : orthogonal change of basis which puts (A,B) in canonical form.
A1 : block Hessenberg matrix
B1 : is U’*B.
ind : vector associated with controllability indices (dimensions of subspaces B, B+A*B,...=ind(1),ind(1)+ind(2),.

DESCRIPTION :
[n,[U]]=contr(A,B,[tol]) gives the controllable form of an (A,B) pair.(dx/dt = A x +
B u or x(n+1) = A x(n) +b u(n)). The n first columns of U make a basis for the controllable
subspace.
If V=U(:,1:n), then V’*A*V and V’*B give the controllable part of the (A,B) pair.
[A1,B1,U,ind]=contr(A,B) returns the Hessenberg controllable form of (A,B).
EXAMPLE :

W=ssrand(2,3,5,list(’co’,3)); //cont. subspace has dim 3.

A=W("A");B=W("B");
[n,U]=contr(A,B);n
A1=U’*A*U;
spec(A1(n+1:$,n+1:$)) //uncontrollable modes
spec(A+B*rand(3,5))

S EE A LSO : canon 325, cont_mat 327, unobs 370, stabil 364

2.1.15 contrss controllable part

CALLING SEQUENCE :

[slc]=contrss(sl [,tol])

PARAMETERS :

sl : linear system (syslin list)

tol : is a threshold for controllability (see contr). default value is sqrt(%eps).

DESCRIPTION :
returns the controllable part of the linear system sl = (A,B,C,D) in state-space form.
EXAMPLE :

A=[1,1;0,2];B=[1;0];C=[1,1];sl=syslin(’c’,A,B,C); //Non minimal

slc=contrss(sl);
sl1=ss2tf(sl);sl2=ss2tf(slc); //Compare sl1 and sl2

S EE A LSO : cont_mat 327, ctr_gram 330, cont_frm 327, contr 328

Scilab Group April 1993 328

ctr gram Scilab Function

2.1.16 csim simulation (time response) of linear system

CALLING SEQUENCE :

[y [,x]]=csim(u,t,sl,[x0 [,tol]])

PARAMETERS :

u : function, list or string (control)

t : real vector specifying times with, t(1) is the initial time (x0=x(t(1))).
sl : list (syslin)
y : a matrix such that y=[y(t(i)], i=1,..,n
x : a matrix such that x=[x(t(i)], i=1,..,n
tol : a 2 vector [atol rtol] defining absolute and relative tolerances for ode solver (see ode)

DESCRIPTION :
simulation of the controlled linear system sl. sl is assumed to be a continuous-time system represented
by a syslin list.
u is the control and x0 the initial state.
y is the output and x the state.
The control can be:
1. a function : [inputs]=u(t)
2. a list : list(ut,parameter1,....,parametern) such that: inputs=ut(t,parameter1,....,parametern
(ut is a function)
3. the string "impuls" for impulse response calculation (here sl is assumed SISO without direct feed
through and x0=0)
4. the string "step" for step response calculation (here sl is assumed SISO without direct feed-through
and x0=0)
5. a vector giving the values of u correponding to each t value.
EXAMPLE :

s=poly(0,’s’);rand(’seed’,0);w=ssrand(1,1,3);w(’A’)=w(’A’)-2*eye();
t=0:0.05:5;
//impulse(w) = step (s * w)
xbasc(0);xset("window",0);xselect();
plot2d([t’,t’],[(csim(’step’,t,tf2ss(s)*w))’,0*t’])
xbasc(1);xset("window",1);xselect();
plot2d([t’,t’],[(csim(’impulse’,t,w))’,0*t’])
//step(w) = impulse (sˆ-1 * w)
xbasc(3);xset("window",3);xselect();
plot2d([t’,t’],[(csim(’step’,t,w))’,0*t’])
xbasc(4);xset("window",4);xselect();
plot2d([t’,t’],[(csim(’impulse’,t,tf2ss(1/s)*w))’,0*t’])

//input defined by a time function

deff(’u=input(t)’,’u=abs(sin(t))’)
xbasc();plot2d([t’,t’],[(csim(input,t,w))’,0*t’])

S EE A LSO : syslin 224, dsimul 333, flts 336, ltitr 347, rtitr 358, ode 431,
impl 421

Scilab Group April 1993 329

ddp Scilab Function

2.1.17 ctr gram controllability gramian

CALLING SEQUENCE :

[Gc]=ctr_gram(A,B [,dom])
[Gc]=ctr_gram(sl)

PARAMETERS :

A,B : two real matrices of appropriate dimensions

dom : character string (’c’ (default value) or ’d’)
sl : linear system, syslin list

DESCRIPTION :
Controllability gramian of (A,B) or sl (a syslin linear system).
dom character string giving the time domain : "d" for a discrete time system and "c" for continuous
time (default case).
Z 1 1
X
e BB 0 eA t dt
At
Ak BB 0 A0 k
0
Gc = Gc =
0 0

EXAMPLE :

A=diag([-1,-2,-3]);B=rand(3,2);
Wc=ctr_gram(A,B)
U=rand(3,3);A1=U*A/U;B1=U*B;
Wc1=ctr_gram(A1,B1) //Not invariant!

S EE A LSO : equil1 335, obs_gram 349, contr 328, cont_mat 327, cont_frm 327,
contrss 328
AUTHOR : S. Steer INRIA 1988

2.1.18 dbphi frequency response to phase and magnitude representation

CALLING SEQUENCE :

[db,phi] =dbphi(repf)

PARAMETERS :

db,phi : vector of gains (db) and phases (degrees)

repf : vector of complex frequency response

DESCRIPTION :

db(k) is the magnitude of repf(k) expressed in dB i.e. db(k)=20*log(abs(repf(k)))/log(10)

and phi(k) is the phase of repf(k) expressed in degrees.
S EE A LSO : repfreq 355, bode 86

Scilab Group April 1993 330

ddp Scilab Function

2.1.19 ddp disturbance decoupling

CALLING SEQUENCE :

[Closed,F,G]=ddp(Sys,zeroed,B1,D1)
[Closed,F,G]=ddp(Sys,zeroed,B1,D1,flag,alfa,beta)

PARAMETERS :

Sys : syslin list containing the matrices (A,B2,C,D2).

zeroed : integer vector, indices of outputs of Sys which are zeroed.
B1 : real matrix
D1 : real matrix. B1 and D1 have the same number of columns.
flag : string ’ge’ or ’st’ (default) or ’pp’.
alfa : real or complex vector (loc. of closed loop poles)
beta : real or complex vector (loc. of closed loop poles)

DESCRIPTION :
Exact disturbance decoupling (output nulling algorithm). Given a linear system, and a subset of outputs,
z, which are to be zeroed, characterize the inputs w of Sys such that the transfer function from w to z is
zero. Sys is a linear system fA,B2,C,D2g with one input and two outputs ( i.e. Sys: u–>(z,y) ), part the
following system defined from Sys and B1,D1:
xdot = A x + B1 w + B2 u
z = C1 x + D11 w + D12 u
y = C2 x + D21 w + D22 u
outputs of Sys are partitioned into (z,y) where z is to be zeroed, i.e. the matrices C and D2 are:
C=[C1;C2] D2=[D12;D22]
C1=C(zeroed,:) D12=D2(zeroed,:)
The matrix D1 is partitioned similarly as D1=[D11;D21] with D11=D1(zeroed,:). The control
is u=Fx+Gw and one looks for matriced F,G such that the closed loop system: w–>z given by
xdot= (A+B2*F) x + (B1 + B2*G) w
z = (C1+D12F) x + (D11+D12*G) w
has zero transfer transfer function.
flag=’ge’ : no stability constraints. flag=’st’ : look for stable closed loop system (A+B2*F
stable). flag=’pp’ : eigenvalues of A+B2*F are assigned to alfa and beta.
Closed is a realization of the w-->y closed loop system
xdot= (A+B2*F) x + (B1 + B2*G) w
y = (C2+D22*F) x + (D21+D22*G) w
Stability (resp. pole placement) requires stabilizability (resp. controllability) of (A,B2).
EXAMPLE :

rand(’seed’,0);nx=6;nz=3;nu=2;ny=1;
A=diag(1:6);A(2,2)=-7;A(5,5)=-9;B2=[1,2;0,3;0,4;0,5;0,0;0,0];
C1=[zeros(nz,nz),eye(nz,nz)];D12=[0,1;0,2;0,3];
Sys12=syslin(’c’,A,B2,C1,D12);
C=[C1;rand(ny,nx)];D2=[D12;rand(ny,size(D12,2))];
Sys=syslin(’c’,A,B2,C,D2);
[A,B2,C1,D12]=abcd(Sys12); //The matrices of Sys12.
alfa=-1;beta=-2;flag=’ge’;
[X,dims,F,U,k,Z]=abinv(Sys12,alfa,beta,flag);

Scilab Group April 1993 331

dscr Scilab Function

clean(X’*(A+B2*F)*X)
clean(X’*B2*U)
clean((C1+D12*F)*X)
clean(D12*U);
//Calculating an ad-hoc B1,D1
G1=rand(size(B2,2),3);
B1=-B2*G1;
D11=-D12*G1;
D1=[D11;rand(ny,size(B1,2))];

[Closed,F,G]=ddp(Sys,1:nz,B1,D1,’st’,alfa,beta);
closed=syslin(’c’,A+B2*F,B1+B2*G,C1+D12*F,D11+D12*G);
ss2tf(closed)

AUTHOR : F.D.
S EE A LSO : abinv 318, ui_observer 369

2.1.20 des2tf descriptor to transfer function conversion

CALLING SEQUENCE :

[S]=des2tf(sl)
[Bfs,Bis,chis]=des2tf(sl)

PARAMETERS :

sl : list (linear system in descriptor form)

Bfs, Bis : two polynomial matrices
chis : polynomial
S : rational matrix

DESCRIPTION :
Given the linear system in descriptor form i.e. Sl=list(’des’,A,B,C,D,E), des2tf converts sl
into its transfer function representation:

S=C*(s*E-A)ˆ(-1)*B+D

Called with 3 outputs arguments des2tf returns Bfs and Bis two polynomial matrices, and chis
polynomial such that:

S=Bfs/chis - Bis

chis is the determinant of (s*E-A) (up to a xcative constant);

EXAMPLE :

s=poly(0,’s’);
G=[1/(s+1),s;1+sˆ2,3*sˆ3];
Descrip=tf2des(G);Tf1=des2tf(Descrip)
Descrip2=tf2des(G,"withD");Tf2=des2tf(Descrip2)
[A,B,C,D,E]=Descrip2(2:6);Tf3=C*inv(s*E-A)*B+D

S EE A LSO : glever 512, pol2des 494, tf2des 390, ss2tf 363, des2ss 376, rowshuff
532
AUTHOR : F. D.

Scilab Group April 1993 332

dt ility Scilab Function

2.1.21 dscr discretization of linear system

CALLING SEQUENCE :

[sld [,r]]=dscr(sl,dt [,m])

PARAMETERS :

sl : syslin list containing [A,B,C,D].

dt : real number, sampling period
m : covariance of the input noise (continuous time)(default value=0)
r : covariance of the output noise (discrete time) given if m is given as input
sld : sampled (discrete-time) linear system, syslin list

DESCRIPTION :
Discretization of linear system. sl is a continuous-time system:
dx/dt=A*x+B*u (+ noise).
sld is the discrete-time system obtained by sampling sl with the sampling period dt.
EXAMPLE :

s=poly(0,’s’);
Sys=syslin(’c’,[1,1/(s+1);2*s/(sˆ2+2),1/s])
ss2tf(dscr(tf2ss(Sys),0.1))

S EE A LSO : syslin 224, flts 336, dsimul 333

2.1.22 dsimul state space discrete time simulation

CALLING SEQUENCE :

y=dsimul(sl,u)

PARAMETERS :

sl : syslin list describing a discrete time linear system

u : real matrix of appropriate dimension
y : output of sl

DESCRIPTION :
Utility function. If [A,B,C,D]=abcd(sl) and x0=sl(’X0’), dsimul returns y=C*ltitr(A,B,u,x0)+D*u
i.e. the time response of sl to the input u. sl is assumed to be in state space form (syslin list).
EXAMPLE :

z=poly(0,’z’);
h=(1-2*z)/(zˆ2-0.2*z+1);
sl=tf2ss(h);
u=zeros(1,20);u(1)=1;
x1=dsimul(sl,u) //Impulse response
u=ones(1,20);
x2=dsimul(sl,u); //Step response

S EE A LSO : syslin 224, flts 336, ltitr 347

Scilab Group April 1993 333

equil Scilab Function

2.1.23 dt ility detectability test

CALLING SEQUENCE :

[k, [n [,U [,Sld ] ] ]]=dt_ility(Sl [,tol])

PARAMETERS :

Sl : linear system (syslin list)

n : dimension of unobservable subspace
k : dimension of unstable, unobservable subspace ( k<=n ).
U : orthogonal matrix
Sld : linear system (syslin list)
tol : threshold for controllability test.

DESCRIPTION :
Detectability test for sl, a linear system in state-space representation. U is a basis whose k first columns
span the unstable, unobservable subspace of Sl (intersection of unobservable subspace of (A,C) and
unstable subspace of A). Detectability means k=0.
Sld = (U’*A*U,U’*B,C*U,D) displays the ”detectable part” of Sl=(A,B,C,D), i.e.
[*,*,*]
U’*A*U = [0,*,*]
[0,0,*]

C*U = [0,0,*]
with (A33,C3) observable (dimension nx-n), A22 stable (dimension n-k) and A11 unstable (di-
mension k).
EXAMPLE :

A=[2,1,1;0,-2,1;0,0,3];
C=[0,0,1];
X=rand(3,3);A=inv(X)*A*X;C=C*X;
W=syslin(’c’,A,[],C);
[k,n,U,W1]=dt_ility(W);
W1("A")
W1("C")

S EE A LSO : contr 328, st_ility 364, unobs 370, stabil 364

2.1.24 equil balancing of pair of symmetric matrices

CALLING SEQUENCE :

T=equil(P,Q)

PARAMETERS :

P, Q : two positive definite symmetric matrices

T : nonsingular matrix

DESCRIPTION :
equil returns t such that:
T*P*T’ and inv(T)’*Q*inv(T) are both equal to a same diagonal and positive matrix.
EXAMPLE :

Scilab Group April 1993 334

abcd Scilab Function

P=rand(4,4);P=P*P’;
Q=rand(4,4);Q=Q*Q’;
T=equil(P,Q)
clean(T*P*T’)
clean(inv(T)’*Q*inv(T))

S EE A LSO : equil1 335, balanc 502, ctr_gram 330

2.1.25 equil1 balancing (nonnegative) pair of matrices

CALLING SEQUENCE :

[T [,siz]]=equil1(P,Q [,tol])

PARAMETERS :

P, Q : two non-negative symmetric matrices

T : nonsingular matrix
siz : vector of three integers
tol : threshold

DESCRIPTION :
equil1 computes t such that:
P1=T*P*T’ and Q1=inv(T)’*Q*inv(T) are as follows:
P1 = diag(S1,S2,0,0) and Q1 = diag(S1,0,S3,0) with S1,S2,S3 positive and diagonal
matrices with respective dimensions siz=[n1,n2,n3]
tol is a threshold for rank determination in SVD
EXAMPLE :

S1=rand(2,2);S1=S1*S1’;
S2=rand(2,2);S2=S2*S2’;
S3=rand(2,2);S3=S3*S3’;
P=sysdiag(S1,S2,zeros(4,4));
Q=sysdiag(S1,zeros(2,2),S3,zeros(2,2));
X=rand(8,8);
P=X*P*X’;Q=inv(X)’*Q*inv(X);
[T,siz]=equil1(P,Q);
P1=clean(T*P*T’)
Q1=clean(inv(T)’*Q*inv(T))

S EE A LSO : balreal 322, minreal 348, equil 334, hankelsv 383

AUTHOR : S. Steer 1987

2.1.26 feedback feedback operation

CALLING SEQUENCE :

Sl=Sl1/.Sl2

PARAMETERS :

Sl1,Sl2 : linear systems (syslin list) in state-space or transfer form, or ordinary gain matrices.
Sl : linear system (syslin list) in state-space or transfer form

Scilab Group April 1993 335

flts Scilab Function

DESCRIPTION :
The feedback operation is denoted by /. (slashdot). This command returns Sl=Sl1*(I+Sl2*Sl1)ˆ-1,
i.e the (negative) feedback of Sl1 and Sl2. Sl is the transfer v -> y for y = Sl1 u , u = v -
Sl2 y.
The result is the same as Sl=LFT([0,I;I,-Sl2],Sl1).
Caution: do not use with decimal point (e.g. 1/.1 is ambiguous!)
EXAMPLE :

S1=ssrand(2,2,3);S2=ssrand(2,2,2);
W=S1/.S2;
ss2tf(S1/.S2)
//Same operation by LFT:
ss2tf(lft([zeros(2,2),eye(2,2);eye(2,2),-S2],S1))
//Other approach: with constant feedback
BigS=sysdiag(S1,S2); F=[zeros(2,2),eye(2,2);-eye(2,2),zeros(2,2)];
Bigclosed=BigS/.F;
W1=Bigclosed(1:2,1:2); //W1=W (in state-space).
ss2tf(W1)
//Inverting
ss2tf(S1*inv(eye()+S2*S1))

S EE A LSO : lft 384, sysdiag 224, augment 373, obscont 349

2.1.27 flts time response (discrete time, sampled system)

CALLING SEQUENCE :

[y [,x]]=flts(u,sl [,x0])
[y]=flts(u,sl [,past])

PARAMETERS :

u : matrix (input vector)

sl : list (linear system syslin)
x0 : vector (initial state ; default value=0)
past : matrix (of the past ; default value=0)
x,y : matrices (state and output)

DESCRIPTION :

State-space form:
sl is a syslin list containing the matrices of the following linear system
sl=syslin(’d’,A,B,C,D) (see syslin):

x[t+1] = A x[t] + B u[t]

y[t] = C x[t] + D u[t]

or, more generally, if D is a polynomial matrix (p = degree(D(z))) :

D(z ) = D0 + zD1 + z 2 D2 + :: + z p Dp
yt = Cxt + D0 ut + D1 ut+1 + :: + Dp ut+p
u = [u0 ; u1 ; :::un ](input)
y = [y0 ; y1 ; :::yn p ](output)

Scilab Group April 1993 336

flts Scilab Function

x = xn p+1

(final state, used as x0 at next call to flts)

Transfer form:
y=flts(u,sl[,past]). Here sl is a linear system in transfer matrix representation i.e
sl=syslin(’d’,transfer matrix) (see syslin).
 
u nd ::: u
past = 1
y nd ::: u 1

is the matrix of past values of u and y.

nd is the maximum of degrees of lcm’s of each row of the denominator matrix of sl.

u=[u0 u1 ... un] (input)

y=[y0 y1 ... yn] (output)

p is the difference between maximum degree of numerator and maximum degree of denominator
EXAMPLE :

sl=syslin(’d’,1,1,1);u=1:10;
y=flts(u,sl);
plot2d2("onn",(1:size(u,’c’))’,y’)
[y1,x1]=flts(u(1:5),sl);y2=flts(u(6:10),sl,x1);
y-[y1,y2]

//With polynomial D:
z=poly(0,’z’);
D=1+z+zˆ2; p =degree(D);
sl=syslin(’d’,1,1,1,D);
y=flts(u,sl);[y1,x1]=flts(u(1:5),sl);
y2=flts(u(5-p+1:10),sl,x1); // (update)
y-[y1,y2]

//Delay (transfer form): flts(u,1/z)

// Usual responses
z=poly(0,’z’);
h=(1-2*z)/(zˆ2+0.3*z+1)
u=zeros(1,20);u(1)=1;
imprep=flts(u,tf2ss(h)); //Impulse response
plot2d2("onn",(1:size(u,’c’))’,imprep’)
u=ones(1,20);
stprep=flts(u,tf2ss(h)); //Step response
plot2d2("onn",(1:size(u,’c’))’,stprep’)
//
// Other examples
A=[1 2 3;0 2 4;0 0 1];B=[1 0;0 0;0 1];C=eye(3,3);Sys=syslin(’d’,A,B,C);
H=ss2tf(Sys); u=[1;-1]*(1:10);
//
yh=flts(u,H); ys=flts(u,Sys);
norm(yh-ys,1)
//hot restart
[ys1,x]=flts(u(:,1:4),Sys);ys2=flts(u(:,5:10),Sys,x);
norm([ys1,ys2]-ys,1)
//
yh1=flts(u(:,1:4),H);yh2=flts(u(:,5:10),H,[u(:,2:4);yh(:,2:4)]);
norm([yh1,yh2]-yh,1)
//with D<>0

Scilab Group April 1993 337

frep2tf Scilab Function

D=[-3 8;4 -0.5;2.2 0.9];

Sys=syslin(’d’,A,B,C,D);
H=ss2tf(Sys); u=[1;-1]*(1:10);
rh=flts(u,H); rs=flts(u,Sys);
norm(rh-rs,1)
//hot restart
[ys1,x]=flts(u(:,1:4),Sys);ys2=flts(u(:,5:10),Sys,x);
norm([ys1,ys2]-rs,1)
//With H:
yh1=flts(u(:,1:4),H);yh2=flts(u(:,5:10),H,[u(:,2:4); yh1(:,2:4)]);
norm([yh1,yh2]-rh)

S EE A LSO : ltitr 347, dsimul 333, rtitr 358

2.1.28 frep2tf transfer function realization from frequency response

CALLING SEQUENCE :

[h [,err]]=frep2tf(frq,repf,dg [,dom,tols,weight])

PARAMETERS :

frq : vector of frequencies in Hz.

repf : vector of frequency response
dg : degree of linear system
dom : time domain (’c’ or ’d’ or dt)
tols : a vector of size 3 giving the relative and absolute tolerance and the maximum number of iterations
(default values are rtol=1.e-2; atol=1.e-4, N=10).
weight : vector of weights on frequencies
h : SISO transfer function
err : error (for example if dom=’c’ sum(abs(h(2i*pi*frq) - rep)ˆ2)/size(frq,*))

DESCRIPTION :
Frequency response to transfer function conversion. The order of h is a priori given in dg which must be
provided. The following linear system is solved in the least square sense.

weight(k)*(n( phi_k) - d(phi_k)*rep_k)=0, k=1,..,n

where phi k= 2*%i*%pi*frq when dom=’c’ and phi k=exp(2*%i*%pi*dom*frq if not.

If the weight vector is not given a default penalization is used (when dom=’c’).
A stable and minimum phase system can be obtained by using function factors.
EXAMPLE :

s=poly(0,’s’);
h=syslin(’c’,(s-1)/(sˆ3+5*s+20))
frq=0:0.05:3;repf=repfreq(h,frq);
clean(frep2tf(frq,repf,3))

Sys=ssrand(1,1,10);
frq=logspace(-3,2,200);
[frq,rep]=repfreq(Sys,frq); //Frequency response of Sys
[Sys2,err]=frep2tf(frq,rep,10);Sys2=clean(Sys2)//Sys2 obtained from freq.
resp of Sys
[frq,rep2]=repfreq(Sys2,frq); //Frequency response of Sys2
xbasc();bode(frq,[rep;rep2]) //Responses of Sys and Sys2

Scilab Group April 1993 338

freson Scilab Function

[sort(trzeros(Sys)),sort(roots(Sys2(’num’)))] //zeros
[sort(spec(Sys(’A’))),sort(roots(Sys2(’den’)))] //poles

dom=1/1000; // Sampling time

z=poly(0,’z’);
h=syslin(dom,(zˆ2+0.5)/(zˆ3+0.1*zˆ2-0.5*z+0.08))
frq=(0:0.01:0.5)/dom;repf=repfreq(h,frq);
[Sys2,err]=frep2tf(frq,repf,3,dom);
[frq,rep2]=repfreq(Sys2,frq); //Frequency response of Sys2
xbasc();plot2d1("onn",frq’,abs([repf;rep2])’);

S EE A LSO : imrep2ss 341, arl2 321, time_id 367, armax 395, frfit 459

2.1.29 freq frequency response

CALLING SEQUENCE :

[x]=freq(A,B,C [,D],f)
[x]=freq(NUM,DEN,f)

PARAMETERS :

A, B, C, D : real matrices of respective dimensions nxn, nxp, mxn, mxp.

NUM,DEN : polynomial matrices of dimension mxp
x : real or complex matrix

DESCRIPTION :
x=freq(A,B,C [,D],f) returns a real or complex mxp*t matrix such that:
x(:,k*p:(k+1)*p)= C*inv(f(k)*eye()-A)*B + D.
Thus, for f taking values along the imaginary axis or on the unit circle x is the continuous or discrete
time frequency response of (A,B,C,D).
x=freq(NUM,DEN,f) returns a real or complex matrix x such that columns k*(p-1)+1 to k*p of
x contain the matrix NUM(f(k))./DEN(f(k))
EXAMPLE :

s=poly(0,’s’);
sys=(s+1)/(sˆ3-5*s+4)
rep=freq(sys("num"),sys("den"),[0,0.9,1.1,2,3,10,20])
[horner(sys,0),horner(sys,20)]
//
Sys=tf2ss(sys);
[A,B,C,D]=abcd(Sys);
freq(A,B,C,[0,0.9,1.1,2,3,10,20])

S EE A LSO : repfreq 355, horner 490

2.1.30 freson peak frequencies

CALLING SEQUENCE :

fr=freson(h)

Scilab Group April 1993 339

gfrancis Scilab Function

PARAMETERS :

h : syslin list
fr : vector of peak frequencies in Hz

DESCRIPTION :
returns the vector of peak frequencies in Hz for the SISO plant h
EXAMPLE :

h=syslin(’c’,-1+%s,(3+2*%s+%sˆ2)*(50+0.1*%s+%sˆ2))
fr=freson(h)
bode(h)
g=20*log(abs(repfreq(h,fr)))/log(10)

S EE A LSO : frep2tf 338, zgrid 160, h_norm 382

2.1.31 g margin gain margin

CALLING SEQUENCE :

[gm [,fr]]=g_margin(h)

PARAMETERS :

h : syslin list representing a linear system in state-space or transfer form

DESCRIPTION :
returns gm, the gain margin in dB of h (SISO plant) and fr, the achieved corresponding frequency in hz.
The gain margin is values of the system gain at points where the nyquist plot crosses the negative real axis.
EXAMPLE :

h=syslin(’c’,-1+%s,3+2*%s+%sˆ2)
[g,fr]=g_margin(h)
[g,fr]=g_margin(h-10)
nyquist(h-10)

S EE A LSO : p_margin 352, black 85, chart 88, nyquist 115

2.1.32 gfrancis Francis equations for tracking

CALLING SEQUENCE :

[L,M,T]=gfrancis(Plant,Model)

PARAMETERS :

Plant : syslin list

Model : syslin list
L,M,T : real matrices

DESCRIPTION :
Given the the linear plant:
x’= F*x + G*u
y = H*x + J*u

Scilab Group April 1993 340

imrep2ss Scilab Function

and the linear model

xm’= A*xm + B*um
ym = C*xm + D*um
the goal is for the plant to track the model i.e. e = y - ym ---> 0 while keeping stable the state
x(t) of the plant. u is given by feedforward and feedback
u = L*xm + M*um + K*(x-T*xm) = [K , L-K*T] *(x,xm) + M*um
The matrices T,L,M satisfy generalized Francis equations
F*T + G*L = T*A
H*T + J*L = C
G*M = T*B
J*M = D
The matrix K must be chosen as stabilizing the pair (F,G) See example of use in directory demos/tracking.

EXAMPLE :

Plant=ssrand(1,3,5);
[F,G,H,J]=abcd(Plant);
nw=4;nuu=2;A=rand(nw,nw);
st=maxi(real(spec(A)));A=A-st*eye(A);
B=rand(nw,nuu);C=2*rand(1,nw);D=0*rand(C*B);
Model=syslin(’c’,A,B,C,D);
[L,M,T]=gfrancis(Plant,Model);
norm(F*T+G*L-T*A,1)
norm(H*T+J*L-C,1)
norm(G*M-T*B,1)
norm(J*M-D,1)

S EE A LSO : lqg 344, ppol 354

2.1.33 imrep2ss state-space realization of an impulse response

CALLING SEQUENCE :

[sl]=imrep2ss(v [,deg])

PARAMETERS :

v : vector coefficients of impulse response, v(:,k) is the kth sample

deg : integer (order required)
sl : syslin list

DESCRIPTION :
Impulse response to linear system conversion (one input). v must have an even number of columns.
EXAMPLE :

s=poly(0,’s’);
H=[1/(s+0.5);2/(s-0.4)] //strictly proper
np=20;w=ldiv(H(’num’),H(’den’),np);
rep=[w(1:np)’;w(np+1:2*np)’]; //The impulse response
H1=ss2tf(imrep2ss(rep))
z=poly(0,’z’);

Scilab Group April 1993 341

krac2 Scilab Function

H=(2*zˆ2-3.4*z+1.5)/(zˆ2-1.6*z+0.8) //Proper transfer function

u=zeros(1,20);u(1)=1;
rep=rtitr(H(’num’),H(’den’),u); //Impulse rep.
// <=> rep=ldiv(H(’num’),H(’den’),20)
w=z*imrep2ss(rep) //Realization with shifted impulse response
// i.e strictly proper to proper
H2=ss2tf(w);

S EE A LSO : frep2tf 338, arl2 321, time_id 367, armax 395, markp2ss 347, ldiv
493

2.1.34 invsyslin system inversion

CALLING SEQUENCE :

[sl2]=invsyslin(sl1)

PARAMETERS :

sl1,sl2 : syslin lists (linear systems in state space representation)

DESCRIPTION :
Utility function. Computes the state form of the inverse sl2 of the linear system sl1 (which is also
given in state form).
The D-matrix is supposed to be full rank. Old stuff used by inv(S) when S is a syslin list.
S EE A LSO : rowregul 357, inv 516

2.1.35 kpure continuous SISO system limit feedback gain

CALLING SEQUENCE :

g=kpure(sys)

PARAMETERS :

sys : SISO linear system (syslin)

g : constant

DESCRIPTION :
kpure(sys) computes the gains g such that the system sys fedback by g (sys/.g) has
poles on imaginary axis.
EXAMPLE :

s=poly(0,’s’);
h=syslin(’c’,(s-1)/(1+5*s+sˆ2+sˆ3))
xbasc();evans(h)
g=kpure(h)
hf=h/.g(1)
roots(denom(hf))

S EE A LSO : evans 98, krac2 343

Scilab Group April 1993 342

lqe Scilab Function

2.1.36 krac2 continuous SISO system limit feedback gain

CALLING SEQUENCE :
g=krac2(sys)
PARAMETERS :
sys : SISO linear system (syslin)
g : constant
DESCRIPTION :
krac2(sys) computes the gains g such that the system sys fedback by g (sys/.g) has
2 real equal poles.
EXAMPLE :
h=syslin(’c’,352*poly(-5,’s’)/poly([0,0,2000,200,25,1],’s’,’c’));
xbasc();evans(h,100)
g=krac2(h)
hf1=h/.g(1);roots(denom(hf1))
hf2=h/.g(2);roots(denom(hf2))
S EE A LSO : evans 98, kpure 342

2.1.37 lin linearization

CALLING SEQUENCE :
[A,B,C,D]=lin(sim,x0,u0)
[sl]=lin(sim,x0,u0)
PARAMETERS :
sim : function
x0, u0 : vectors of compatible dimensions
A,B,C,D : real matrices
sl : syslin list
DESCRIPTION :
linearization of the non-linear system [y,xdot]=sim(x,u) around x0,u0.
sim is a function which computes y and xdot.
The output is a linear system (syslin list) sl or the four matrices (A,B,C,D) For example, if ftz
is the function passed to ode e.g.
[zd]=ftz(t,z,u)
and if we assume that y=x
[z]=ode(x0,t0,tf,list(ftz,u) compute x(tf).
If simula is the following function:
deff(’[y,xd]=simula(x,u)’,’xd=ftz(tf,x,u); y=x;’);
the tangent linear system sl can be obtained by:
[A,B,C,D]=lin(simula,z,u)
sl = syslin(’c’,A,B,C,D,x0)
EXAMPLE :
deff(’[y,xdot]=sim(x,u)’,’xdot=[u*sin(x);-u*xˆ2];y=xdot(1)+xdot(2)’)
sl=lin(sim,1,2);
S EE A LSO : external 38, derivat 487

Scilab Group April 1993 343

lqg2stan Scilab Function

2.1.38 lqe linear quadratic estimator (Kalman Filter)

CALLING SEQUENCE :
[K,X]=lqe(P21)
PARAMETERS :
P21 : syslin list
K, X : real matrices
DESCRIPTION :
lqe returns the Kalman gain for the filtering problem in continuous or discrete time.
P21 is a syslin list representing the system P21=[A,B1,C2,D21]
The input to P21 is a white noise with variance:
[B1 ] [Q S]
BigV=[ ] [ B1’ D21’] = [ ]
[D21] [S’ R]
X is the solution of the stabilizing Riccati equation and A+K*C2 is stable.
In continuous time:
(A-S*inv(R)*C2)*X+X*(A-S*inv(R)*C2)’-X*C2’*inv(R)*C2*X+Q-S*inv(R)*S’=0
K=-(X*C2’+S)*inv(R)
In discrete time:
X=A*X*A’-(A*X*C2’+B1*D21’)*pinv(C2*X*C2’+D21*D21’)*(C2*X*A’+D21*B1’)+B1*B1’
K=-(A*X*C2’+B1*D21’)*pinv(C2*X*C2’+D21*D21’)
xhat(t+1)= E(x(t+1)j y(0),...,y(t)) (one-step predicted x) satisfies the recursion:
xhat(t+1)=(A+K*C2)*xhat(t) - K*y(t).
S EE A LSO : lqr 345
AUTHOR : F. D.

2.1.39 lqg LQG compensator

CALLING SEQUENCE :
[K]=lqg(P,r)
PARAMETERS :
P : syslin list (augmented plant) in state-space form
r : 1x2 row vector = (number of measurements, number of inputs) (dimension of the 2,2 part of P)
K : syslin list (controller)
DESCRIPTION :
lqg computes the linear optimal LQG (H2) controller for the ”augmented” plant P=syslin(’c’,A,B,C,D)
(continuous time) or P=syslin(’d’,A,B,C,D) (discrete time).
The function lqg2stan returns P and r given the nominal plant, weighting terms and variances of
noises.
K is given by the following ABCD matrices: [A+B*Kc+Kf*C+Kf*D*Kc,-Kf,Kc,0] where Kc=lqr(P12)
is the controller gain and Kf=lqe(P21) is the filter gain. See example in lqg2stan.
S EE A LSO : lqg2stan 345, lqr 345, lqe 344, h_inf 381, obscont 349
AUTHOR : F.D.

Scilab Group April 1993 344

lqr Scilab Function

2.1.40 lqg2stan LQG to standard problem

CALLING SEQUENCE :

[P,r]=lqg2stan(P22,bigQ,bigR)

PARAMETERS :

P22 : syslin list (nominal plant) in state-space form

bigQ : [Q,S;S’,N] (symmetric) weighting matrix
bigR : [R,T;T’,V] (symmetric) covariance matrix
r : 1x2 row vector = (number of measurements, number of inputs) (dimension of the 2,2 part of P)
P : syslin list (augmented plant)

DESCRIPTION :
lqg2stan returns the augmented plant for linear LQG (H2) controller design.
P22=syslin(dom,A,B2,C2) is the nominal plant; it can be in continuous time (dom=’c’) or dis-
crete time (dom=’d’).
.
x = Ax + w1 + B2u
y = C2x + w2
for continuous time plant.
x[n+1]= Ax[n] + w1 + B2u
y = C2x + w2
for discrete time plant.
The (instantaneous) cost function is [x’ u’] bigQ [x;u].
The covariance of [w1;w2] is E[w1;w2] [w1’,w2’] = bigR
If [B1;D21] is a factor of bigQ, [C1,D12] is a factor of bigR and [A,B2,C2,D22] is a realiza-
tion of P22, then P is a realization of [A,[B1,B2],[C1,-C2],[0,D12;D21,D22]. The (negative)
feedback computed by lqg stabilizes P22, i.e. the poles of cl=P22/.K are stable.
EXAMPLE :

ny=2;nu=3;nx=4;
P22=ssrand(ny,nu,nx);
bigQ=rand(nx+nu,nx+nu);bigQ=bigQ*bigQ’;
bigR=rand(nx+ny,nx+ny);bigR=bigR*bigR’;
[P,r]=lqg2stan(P22,bigQ,bigR);K=lqg(P,r); //K=LQG-controller
spec(h_cl(P,r,K)) //Closed loop should be stable
//Same as Cl=P22/.K; spec(Cl(’A’))
s=poly(0,’s’)
lqg2stan(1/(s+2),eye(2,2),eye(2,2))

S EE A LSO : lqg 344, lqr 345, lqe 344, obscont 349, h_inf 381, augment 373,
fstabst 378, feedback 335
AUTHOR : F.D.

2.1.41 lqr LQ compensator (full state)

CALLING SEQUENCE :

[K,X]=lqr(P12)

Scilab Group April 1993 345

ltitr Scilab Function

PARAMETERS :

P12 : syslin list (state-space linear system)

K,X : two real matrices

DESCRIPTION :
lqr computes the linear optimal LQ full-state gain for the plant P12=[A,B2,C1,D12] in continuous
or discrete time.
P12 is a syslin list (e.g. P12=syslin(’c’,A,B2,C1,D12)).
The cost function is l2-norm of z’*z with z=C1 x + D12 u i.e. [x,u]’ * BigQ * [x;u]
where
[C1’ ] [Q S]
BigQ= [ ] * [C1 D12] = [ ]
[D12’] [S’ R]
The gain K is such that A + B2*K is stable.
X is the stabilizing solution of the Riccati equation.
For a continuous plant:
(A-B2*inv(R)*S’)’*X+X*(A-B2*inv(R)*S’)-X*B2*inv(R)*B2’*X+Q-S*inv(R)*S’=0

K=-inv(R)*(B2’*X+S)

For a discrete plant:

X=A’*X*A-(A’*X*B2+C1’*D12)*pinv(B2’*X*B2+D12’*D12)*(B2’*X*A+D12’*C1)+C1’*C1;

K=-pinv(B2’*X*B2+D12’*D12)*(B2’*X*A+D12’*C1)

An equivalent form for X is

X=Abar’*inv(inv(X)+B2*inv(r)*B2’)*Abar+Qbar
with Abar=A-B2*inv(R)*S’ and Qbar=Q-S*inv(R)*S’
The 3-blocks matrix pencils associated with these Riccati equations are:
discrete continuous
|I 0 0| | A 0 B2| |I 0 0| | A 0 B2|
z|0 A’ 0| - |-Q I -S| s|0 I 0| - |-Q -A’ -S|
|0 B2’ 0| | S’ 0 R| |0 0 0| | S’ -B2’ R|
Caution: It is assumed that matrix R is non singular. In particular, the plant must be tall (number of
outputs >= number of inputs).
EXAMPLE :

A=rand(2,2);B=rand(2,1); //two states, one input

Q=diag([2,5]);R=2; //Usual notations x’Qx + u’Ru
Big=sysdiag(Q,R); //Now we calculate C1 and D12
[w,wp]=fullrf(Big);C1=w(:,1:2);D12=w(:,3); //[C1,D12]’*[C1,D12]=Big
P=syslin(’c’,A,B,C1,D12); //The plant (continuous-time)
[K,X]=lqr(P)
spec(A+B*K) //check stability
norm(A’*X+X*A-X*B*inv(R)*B’*X+Q,1) //Riccati check
P=syslin(’d’,A,B,C1,D12); // Discrete time plant
[K,X]=lqr(P)
spec(A+B*K) //check stability
norm(A’*X*A-(A’*X*B)*pinv(B’*X*B+R)*(B’*X*A)+Q-X,1) //Riccati check

S EE A LSO : lqe 344, gcare 379, leqr 383

AUTHOR : F.D.

Scilab Group April 1993 346

markp2ss Scilab Function

2.1.42 ltitr discrete time response (state space)

CALLING SEQUENCE :

[X]=ltitr(A,B,U,[x0])
[xf,X]=ltitr(A,B,U,[x0])

PARAMETERS :

A,B : real matrices of appropriate dimensions

U,X : real matrices
x0,xf : real vectors (default value=0 for x0))

DESCRIPTION :
calculates the time response of the discrete time system

x[t+1] = Ax[t] + Bu[t].

The inputs ui’s are the columns of the U matrix

U=[u0,u1,...,un];

x0 is the vector of initial state (default value : 0) ;

X is the matrix of outputs (same number of columns as U).

X=[x0,x1,x2,...,xn]

xf is the vector of final state xf=X[n+1]

EXAMPLE :

A=eye(2,2);B=[1;1];
x0=[-1;-2];
u=[1,2,3,4,5];
x=ltitr(A,B,u,x0)
x1=A*x0+B*u(1)
x2=A*x1+B*u(2)
x3=A*x2+B*u(3) //....

S EE A LSO : rtitr 358, flts 336

2.1.43 markp2ss Markov parameters to state-space

CALLING SEQUENCE :

[sl]=markp2ss(markpar,n,nout,nin)

PARAMETERS :

markpar : matrix
n,nout,nin : integers
Sl : syslin list

DESCRIPTION :
given a set of n Markov parameters stacked in the (row)-matrix markpar of size noutX(n*nin)
markp2ss returns a state-space linear system sl (syslin list) such that with [A,B,C,D]=abcd(sl):

Scilab Group April 1993 347

minss Scilab Function

C*B = markpar(1:nout,1:nin),
C*A*B =markpar(1:nout,nin+1:2*nin),....

EXAMPLE :

W=ssrand(2,3,4); //random system with 2 outputs and 3 inputs

[a,b,c,d]=abcd(W);
markpar=[c*b,c*a*b,c*aˆ2*b,c*aˆ3*b,c*aˆ4*b];
S=markp2ss(markpar,5,2,3);
[A,B,C,D]=abcd(S);
Markpar=[C*B,C*A*B,C*Aˆ2*B,C*Aˆ3*B,C*Aˆ4*B];
norm(markpar-Markpar,1)
//Caution... c*aˆ5*b is not C*Aˆ5*B !

S EE A LSO : frep2tf 338, tf2ss 367, imrep2ss 341

2.1.44 minreal minimal balanced realization

CALLING SEQUENCE :

slb=minreal(sl [,tol])

PARAMETERS :

sl,slb : syslin lists

tol : real (threshold)

DESCRIPTION :
[ae,be,ce]=minreal(a,b,c,domain [,tol]) returns the balanced realization of linear sys-
tem sl (syslin list).
sl is assumed stable.
tol threshold used in equil1.
EXAMPLE :

A=[-eye(2,2),rand(2,2);zeros(2,2),-2*eye(2,2)];
B=[rand(2,2);zeros(2,2)];C=rand(2,4);
sl=syslin(’c’,A,B,C);
slb=minreal(sl);
ss2tf(sl)
ss2tf(slb)
ctr_gram(sl)
clean(ctr_gram(slb))
clean(obs_gram(slb))

S EE A LSO : minss 348, balreal 322, arhnk 321, equil 334, equil1 335
AUTHOR : S. Steer INRIA 1987

2.1.45 minss minimal realization

CALLING SEQUENCE :

[slc]=minss( sl [,tol])

PARAMETERS :

Scilab Group April 1993 348

obscont Scilab Function

sl,slc : syslin lists (linear systems in state-space form)

tol : real (threshold for rank determination (see contr))

DESCRIPTION :
minss returns in slc a minimal realization of sl.
EXAMPLE :

sl=syslin(’c’,[1 0;0 2],[1;0],[2 1]);

ssprint(sl);
ssprint(minss(sl))

S EE A LSO : contr 328, minreal 348, arhnk 321, contrss 328, obsvss 352, balreal
322

2.1.46 obs gram observability gramian

CALLING SEQUENCE :

Go=obs_gram(A,C [,dom])
Go=obs_gram(sl)

PARAMETERS :

A,C : real matrices (of appropriate dimensions)

dom : string ("d’ or "c" (default value))
sl : syslin list

DESCRIPTION :
Observability gramian of the pair (A,C) or linear system sl (syslin list). dom is the domain which
can be
"c" : continuous system (default)
"d" : discrete system
Z 1 1
X
eA t C 0 CeAt dt A0 k C 0 CAk
0
Go = Go =
0 0

EXAMPLE :

A=-diag(1:3);C=rand(2,3);
Go=obs_gram(A,C,’c’); // <=> w=syslin(’c’,A,[],C); Go=obs_gram(w);
norm(Go*A+A’*Go+C’*C,1)
norm(lyap(A,-C’*C,’c’)-Go,1)
A=A/4; Go=obs_gram(A,C,’d’); //discrete time case
norm(lyap(A,-C’*C,’d’)-Go,1)

S EE A LSO : ctr_gram 330, obsvss 352, obsv_mat 351, lyap 522

2.1.47 obscont observer based controller

CALLING SEQUENCE :

[K]=obscont(P,Kc,Kf)
[J,r]=obscont(P,Kc,Kf)

Scilab Group April 1993 349

onserver Scilab Function

PARAMETERS :

P : syslin list (nominal plant) in state-space form, continuous or discrete time

Kc : real matrix, (full state) controller gain
Kf : real matrix, filter gain
K : syslin list (controller)
J : syslin list (extended controller)
r : 1x2 row vector

DESCRIPTION :
obscont returns the observer-based controller associated with a nominal plant P with matrices [A,B,C,D]
(syslin list).
The full-state control gain is Kc and the filter gain is Kf. These gains can be computed, for example, by
pole placement.
A+B*Kc and A+Kf*C are (usually) assumed stable.
K is a state-space representation of the compensator K: y->u in:
xdot = A x + B u, y=C x + D u, zdot= (A + Kf C)z -Kf y +B u, u=Kc z
K is a linear system (syslin list) with matrices given by: K=[A+B*Kc+Kf*C+Kf*D*Kc,Kf,-Kc].
The closed loop feedback system Cl: v ->y with (negative) feedback K (i.e. y = P u, u = v
- K y, or xdot = A x + B u, y = C x + D u, zdot = (A + Kf C) z - Kf y + B
u, u = v -F z) is given by Cl = P/.(-K)
The poles of Cl ( spec(cl(’A’)) ) are located at the eigenvalues of A+B*Kc and A+Kf*C.
Invoked with two output arguments obscont returns a (square) linear system K which parametrizes all
the stabilizing feedbacks via a LFT.
Let Q an arbitrary stable linear system of dimension r(2)xr(1) i.e. number of inputs x number of
outputs in P. Then any stabilizing controller K for P can be expressed as K=lft(J,r,Q). The controller
which corresponds to Q=0 is K=J(1:nu,1:ny) (this K is returned by K=obscont(P,Kc,Kf)). r
is size(P) i.e the vector [number of outputs, number of inputs];
EXAMPLE :

ny=2;nu=3;nx=4;P=ssrand(ny,nu,nx);[A,B,C,D]=abcd(P);
Kc=-ppol(A,B,[-1,-1,-1,-1]); //Controller gain
Kf=-ppol(A’,C’,[-2,-2,-2,-2]);Kf=Kf’; //Observer gain
cl=P/.(-obscont(P,Kc,Kf));spec(cl(’A’)) //closed loop system
[J,r]=obscont(P,Kc,Kf);
Q=ssrand(nu,ny,3);Q(’A’)=Q(’A’)-(maxi(real(spec(Q(’A’))))+0.5)*eye(Q(’A’))
//Q is a stable parameter
K=lft(J,r,Q);
spec(h_cl(P,K)) // closed-loop A matrix (should be stable);

S EE A LSO : ppol 354, lqg 344, lqr 345, lqe 344, h_inf 381, lft 384, syslin
224, feedback 335, observer 350
AUTHOR : F.D.

2.1.48 observer observer design

CALLING SEQUENCE :

Obs=observer(Sys,J)
[Obs,U,m]=observer(Sys [,flag,alfa])

PARAMETERS :

Sys : syslin list (linear system)

J : nx x ny constant matrix (output injection matrix)

Scilab Group April 1993 350

obsvss Scilab Function

flag : character strings (’pp’ or ’st’ (default))

alfa : location of closed-loop poles (optional parameter, default=-1)
Obs : linear system (syslin list), the observer
U : orthogonal matrix (see dt ility)
m : integer (dimension of unstable unobservable (st) or unobservable (pp) subspace)

DESCRIPTION :
Obs=observer(Sys,J) returns the observer Obs=syslin(td,A+J*C,[B+J*D,-J],eye(A))
obtained from Sys by a J output injection. (td is the time domain of Sys). More generally, observer
returns in Obs an observer for the observable part of linear system Sys: dotx=A x + Bu, y=Cx +
Du represented by a syslin list. Sys has nx state variables, nu inputs and ny outputs. Obs is a
linear system with matrices [Ao,Bo,Identity], where Ao is no x no, Bo is no x (nu+ny), Co
is no x no and no=nx-m.
Input to Obs is [u,y] and output of Obs is:
xhat=estimate of x modulo unobservable subsp. (case flag=’pp’) or
xhat=estimate of x modulo unstable unobservable subsp. (case flag=’st’)
case flag=’st’: z=H*x can be estimated with stable observer iff H*U(:,1:m)=0 and assignable poles
of the observer are set to alfa(1),alfa(2),...
case flag=’pp’: z=H*x can be estimated with given error spectrum iff H*U(:,1:m)=0 all poles of
the observer are assigned and set to alfa(1),alfa(2),...
If H satifies the constraint: H*U(:,1:m)=0 (ker(H) contains unobs-subsp. of Sys) one has H*U=[0,H2]
and the observer for z=H*x is H2*Obs with H2=H*U(:,m+1:nx) i.e. Co, the C-matrix of the observer for
H*x, is Co=H2.
In the particular case where the pair (A,C) of Sys is observable, one has m=0 and the linear system
U*Obs (resp. H*U*Obs) is an observer for x (resp. Hx). The error spectrum is alpha(1),alpha(2),...,alpha(nx).

EXAMPLE :

nx=5;nu=1;ny=1;un=3;us=2;Sys=ssrand(ny,nu,nx,list(’dt’,us,us,un));
//nx=5 states, nu=1 input, ny=1 output,
//un=3 unobservable states, us=2 of them unstable.
[Obs,U,m]=observer(Sys); //Stable observer (default)
W=U’;H=W(m+1:nx,:);[A,B,C,D]=abcd(Sys); //H*U=[0,eye(no,no)];
Sys2=ss2tf(syslin(’c’,A,B,H)) //Transfer u-->z
Idu=eye(nu,nu);Sys3=ss2tf(H*U(:,m+1:$)*Obs*[Idu;Sys])
//Transfer u-->[u;y=Sys*u]-->Obs-->xhat-->HUxhat=zhat i.e. u-->output of
Obs
//this transfer must equal Sys2, the u-->z transfer (H2=eye).

S EE A LSO : dt_ility 334, unobs 370, stabil 364

AUTHOR : F.D.

2.1.49 obsv mat observability matrix

CALLING SEQUENCE :

[O]=obsv_mat(A,C)
[O]=obsv_mat(sl)

PARAMETERS :

A,C,O : real matrices

sl : syslin list

Scilab Group April 1993 351

pfss Scilab Function

DESCRIPTION :
obsv mat returns the observability matrix:

O=[C; CA; CAˆ2;...; CAˆ(n-1) ]

S EE A LSO : contrss 328, obsvss 352, obs_gram 349

2.1.50 obsvss observable part

CALLING SEQUENCE :

[Ao,Bo,Co]=obsvss(A,B,C [,tol])
[slo]=obsvss(sl [,tol])

PARAMETERS :

A,B,C,Ao,Bo,Co : real matrices

sl,slo : syslin lists
tol : real (threshold) (default value 100*%eps)

DESCRIPTION :
slo=(Ao,Bo,Co) is the observable part of linear system sl=(A,B,C) (syslin list)
tol threshold to test controllability (see contr); default value = 100*%eps
S EE A LSO : contr 328, contrss 328, obsv_mat 351, obs_gram 349

2.1.51 p margin phase margin

CALLING SEQUENCE :

[phm,fr]=p_margin(h)
phm=p_margin(h)

PARAMETERS :

h : SISO linear system (syslin list).

phm : phase margin (in degree)
fr : corresponding frequency (hz)

DESCRIPTION :
The phase margin is the values of the phase at points where the nyquist plot of h crosses the unit circle.
EXAMPLE :

h=syslin(’c’,-1+%s,3+2*%s+%sˆ2)
[p,fr]=p_margin(h)
[p,fr]=p_margin(h+0.7)
nyquist(h+0.7)
t=(0:0.1:2*%pi)’;plot2d(sin(t),cos(t),-3,’000’)

S EE A LSO : chart 88, black 85, g_margin 340, nyquist 115

AUTHOR : S. S.

Scilab Group April 1993 352

phasemag Scilab Function

2.1.52 pfss partial fraction decomposition

CALLING SEQUENCE :

elts=pfss(Sl)
elts=pfss(Sl,rmax)
elts=pfss(Sl,’cord’)
elts=pfss(Sl,rmax,’cord’)

PARAMETERS :
Sl : syslin list (state-space or transfer linear system) rmax : real number controlling the conditioning
of block diagoanalization cord : character string ’c’ or ’d’.
DESCRIPTION :
Partial fraction decomposition of the linear system Sl (in state-space form, transfer matrices are automat-
ically converted to state-space form by tf2ss):
elts is the list of linear systems which add up to Sl i.e. elts=list(S1,S2,S3,...,Sn) with:
Sl = S1 + S2 +... +Sn.
Each Si contains some poles of S according to the block-diagonalization of the A matrix of S.
For non proper systems the polynomial part of Sl is put in the last entry of elts.
If Sl is given in transfer form, it is first converted into state-space and each subsystem Si is then con-
verted in transfer form.
The A matrix is of the state-space is put into block diagonal form by function bdiag. The optional param-
eter rmax is sent to bdiag. If rmax should be set to a large number to enforce block-diagonalization.
If the optional flag cord=’c’ is given the elements in elts are sorted according to the real part (resp.
magnitude if cord=’d’) of the eigenvalues of A matrices.
EXAMPLE :

W=ssrand(1,1,6);
elts=pfss(W);
W1=0;for k=1:size(elts), W1=W1+ss2tf(elts(k));end
clean(ss2tf(W)-W1)

S EE A LSO : pbig 523, bdiag 502, coffg 485, dtsi 377

AUTHOR : F.D.

2.1.53 phasemag phase and magnitude computation

CALLING SEQUENCE :

[phi,db]=phasemag(z [,mod])

PARAMETERS :

z : matrix or row vector of complex numbers.

mod : character string
mod=’c’ : ”continuous” representation between -infinity and +360 degrees (default)
mod=’m’ : representation between -360 and 0 degrees
phi : phases (in degree) of z.
db : magnitude (in Db)

Scilab Group April 1993 353

projsl Scilab Function

DESCRIPTION :
phasemag computes the phases and magnitudes of the entries of a complex matrix. For mod=’c’
phasemag computes phi(:,i+1) to minimize the distance with phi(:,i), i.e. it tries to obtain a
”continuous representation” of the phase.
To obtain the phase between -%pi and %pi use phi=atan(imag(z),real(z))
EXAMPLE :

s=poly(0,’s’);
h=syslin(’c’,1/((s+5)*(s+10)*(100+6*s+s*s)*(s+.3)));
[frq,rf]=repfreq(h,0.1,20,0.005);
xbasc(0);
plot2d(frq’,phasemag(rf,’c’)’);
xbasc(1);
plot2d(frq’,phasemag(rf,’m’)’);

S EE A LSO : repfreq 355, gainplot 104, atan 167, bode 86

2.1.54 ppol pole placement

CALLING SEQUENCE :

[K]=ppol(A,B,poles)

PARAMETERS :

A,B : real matrices of dimensions nxn and nxm.

poles : real or complex vector of dimension n.
K : real matrix (negative feedback gain)

DESCRIPTION :
K=ppol(A,B,poles) returns a mxn gain matrix K such that the eigenvalues of A-B*K are poles.
The pair (A,B) must be controllable. Complex number in poles must appear in conjugate pairs.
An output-injection gain F for (A,C) is obtained as follows:
Ft=ppol(A’,C’,poles); F=Ft’
The algorithm is by P.H. Petkov.
EXAMPLE :

A=rand(3,3);B=rand(3,2);
F=ppol(A,B,[-1,-2,-3]);
spec(A-B*F)

S EE A LSO : canon 325, stabil 364

2.1.55 projsl linear system projection

CALLING SEQUENCE :

[slp]=projsl(sl,Q,M)

PARAMETERS :

sl,slp : syslin lists

Q,M : matrices (projection factorization)

Scilab Group April 1993 354

repfreq Scilab Function

DESCRIPTION :
slp= projected model of sl where Q*M is the full rank factorization of the projection.
If (A,B,C,D) is the representation of sl, the projected model is given by (M*A*Q,M*B,C*Q,D).
Usually, the projection Q*M is obtained as the spectral projection of an appropriate auxiliary matrix W e.g.
W = product of (weighted) gramians or product of Riccati equations.
EXAMPLE :

rand(’seed’,0);sl=ssrand(2,2,5);[A,B,C,D]=abcd(sl);poles=spec(A)
[Q,M]=pbig(A,0,’c’); //keeping unstable poles
slred=projsl(sl,Q,M);spec(slred(’A’))
sl(’D’)=rand(2,2); //making proper system
trzeros(sl) //zeros of sl
wi=inv(sl); //wi=inverse in state-space
[q,m]=psmall(wi(’A’),2,’d’); //keeping small zeros (poles of wi) i.e. abs(z)<2
slred2=projsl(sl,q,m);
trzeros(slred2) //zeros of slred2 = small zeros of sl
// Example keeping second order modes
A=diag([-1,-2,-3]);
sl=syslin(’c’,A,rand(3,2),rand(2,3));[nk2,W]=hankelsv(sl)
[Q,M]=pbig(W,nk2(2)-%eps,’c’); //keeping 2 eigenvalues of W
slr=projsl(sl,Q,M); //reduced model
hankelsv(slr)

S EE A LSO : pbig 523

AUTHOR : F. D.

2.1.56 repfreq frequency response

CALLING SEQUENCE :

[ [frq,] repf]=repfreq(sys,fmin,fmax [,step])

[ [frq,] repf]=repfreq(sys [,frq])
[ frq,repf,splitf]=repfreq(sys,fmin,fmax [,step])
[ frq,repf,splitf]=repfreq(sys [,frq])

PARAMETERS :

sys : syslin list : SIMO linear system

fmin,fmax : two real numbers (lower and upper frequency bounds)
frq : real vector of frequencies (Hz)
step : logarithmic discretization step
splitf : vector of indexes of critical frequencies.
repf : vector of the complex frequency response

DESCRIPTION :
repfreq returns the frequency response calculation of a linear system. If sys(s) is the transfer func-
tion of Sys, repf(k) equals sys(s) evaluated at s= %i*frq(k)*2*%pi for continuous time sys-
tems and at exp(2*%i*%pi*dt*frq(k)) for discrete time systems (dt is the sampling period).
db(k) is the magnitude of repf(k) expressed in dB i.e. db(k)=20*log10(abs(repf(k)))
and phi(k) is the phase of repf(k) expressed in degrees.
If fmin,fmax,step are input parameters, the response is calculated for the vector of frequencies frq
given by: frq=[10.ˆ((log10(fmin)):step:(log10(fmax))) fmax];
If step is not given, the output parameter frq is calculated by frq=calfrq(sys,fmin,fmax).

Scilab Group April 1993 355

RICC Scilab Function

Vector frq is splitted into regular parts with the split vector. frq(splitf(k):splitf(k+1)-1)
has no critical frequency. sys has a pole in the range [frq(splitf(k)),frq(splitf(k)+1)]
and no poles outside.
EXAMPLE :

A=diag([-1,-2]);B=[1;1];C=[1,1];
Sys=syslin(’c’,A,B,C);
frq=0:0.02:5;w=frq*2*%pi; //frq=frequencies in Hz ;w=frequencies in rad/sec;
[frq1,rep] =repfreq(Sys,frq);
[db,phi]=dbphi(rep);
Systf=ss2tf(Sys) //Transfer function of Sys
x=horner(Systf,w(2)*sqrt(-1)) // x is Systf(s) evaluated at s = i w(2)
rep=20*log(abs(x))/log(10) //magnitude of x in dB
db(2) // same as rep
ang=atan(imag(x),real(x)); //in rad.
ang=ang*180/%pi //in degrees
phi(2)
repf=repfreq(Sys,frq);
repf(2)-x

S EE A LSO : bode 86, freq 339, calfrq 324, horner 490, nyquist 115, dbphi 330

AUTHOR : S. S.

2.1.57 ricc Riccati equation

CALLING SEQUENCE :

[X]=ricc(A,B,C,"cont")
[X]=ricc(F,G,H,"disc")

PARAMETERS :

A,B,C : real matrices of appropriate dimensions

F,G,H : real matrices of appropriate dimensions
X : real matrix
"cont","disc"’ : imposed string (flag for continuous or discrete)

DESCRIPTION :
Riccati solver.
Continuous time:

X=ricc(A,B,C,’cont’)

gives a solution to the continuous time ARE

A’*X+X*A-X*B*X+C=0 .

B and C are assumed to be nonnegative definite. (A,G) is assumed to be stabilizable with G*G’ a
full rank factorization of B.
(A,H) is assumed to be detectable with H*H’ a full rank factorization of C.
Discrete time:

X=ricc(F,G,H,’disc’)

gives a solution to the discrete time ARE

Scilab Group April 1993 356

rowregul Scilab Function

X=F’*X*F-F’*X*G1*((G2+G1’*X*G1)ˆ-1)*G1’*X*F+H
F is assumed invertible and G = G1*inv(G2)*G1’.
One assumes (F,G1) stabilizable and (C,F) detectable with C’*C full rank factorization of H. Use
preferably ric desc.
EXAMPLE :

//Standard formulas to compute Riccati solutions

A=rand(3,3);B=rand(3,2);C=rand(3,3);C=C*C’;R=rand(2,2);R=R*R’+eye();
B=B*inv(R)*B’;
X=ricc(A,B,C,’cont’);
norm(A’*X+X*A-X*B*X+C,1)
H=[A -B;-C -A’];
[T,d]=gschur(eye(H),H,’cont’);T=T(:,1:d);
X1=T(4:6,:)/T(1:3,:);
norm(X1-X,1)
[T,d]=schur(H,’cont’);T=T(:,1:d);
X2=T(4:6,:)/T(1:3,:);
norm(X2-X,1)
// Discrete time case
F=A;B=rand(3,2);G1=B;G2=R;G=G1/G2*G1’;H=C;
X=ricc(F,G,H,’disc’);
norm(F’*X*F-(F’*X*G1/(G2+G1’*X*G1))*(G1’*X*F)+H-X)
H1=[eye(3,3) G;zeros(3,3) F’];
H2=[F zeros(3,3);-H eye(3,3)];
[T,d]=gschur(H2,H1,’disc’);T=T(:,1:d);X1=T(4:6,:)/T(1:3,:);
norm(X1-X,1)
Fi=inv(F);
Hami=[Fi Fi*G;H*Fi F’+H*Fi*G];
[T,d]=schur(Hami,’d’);T=T(:,1:d);
Fit=inv(F’);
Ham=[F+G*Fit*H -G*Fit;-Fit*H Fit];
[T,d]=schur(Ham,’d’);T=T(:,1:d);X2=T(4:6,:)/T(1:3,:);
norm(X2-X,1)

S EE A LSO : riccati 389, ric_desc 388, schur 533, gschur 513

2.1.58 rowregul removing poles and zeros at infinity

CALLING SEQUENCE :

[Stmp,Ws]=rowregul(Sl,alfa,beta)
PARAMETERS :

Sl,Stmp : syslin lists

alfa,beta : real numbers (new pole and zero positions)
DESCRIPTION :
computes a postfilter Ws such that Stmp=Ws*Sl is proper and with full rank D matrix.
Poles at infinity of Sl are moved to alfa;
Zeros at infinity of Sl are moved to beta;
Sl is a assumed to be a right invertible linear system (syslin list) in state-space representation with
possibly a polynomial D matrix.
This function is the dual of colregul (see function code).
EXAMPLE :

Scilab Group April 1993 357

rtitr Scilab Function

s=%s;
w=[1/s,0;s/(sˆ3+2),2/s];
Sl=tf2ss(w);
[Stmp,Ws]=rowregul(Sl,-1,-2);
Stmp(’D’) // D matrix of Stmp
clean(ss2tf(Stmp))

S EE A LSO : invsyslin 342, colregul 326

AUTHOR : F. D. , R. N.

2.1.59 rtitr discrete time response (transfer matrix)

CALLING SEQUENCE :

[y]=rtitr(Num,Den,u [,up,yp])

PARAMETERS :

Num,Den : polynomial matrices (resp. dimensions : nxm and nxn)

u : real matrix (dimension mx(t+1)
up,yp : real matrices (up dimension mx (maxi(degree(Den))) (default values=0) , yp dimen-
sion nx (maxi(degree(Den))))
y : real matrix

DESCRIPTION :
y=rtitr(Num,Den,u [,up,yp]) returns the time response of the discrete time linear system with
transfer matrix Denˆ-1 Num for the input u, i.e y and u are such that Den y = Num u at t=0,1,...
If d1=maxi(degree(Den)), and d2=maxi(degree(Num)) the polynomial matrices Den(z) and
Num(z) may be written respectively as:

D(z)= D_0 + D_1 z + ... + D_d1 zˆd1

N(z)= N_0 + N_1 z + ... + N_d2 zˆd2

and Den y = Num u is interpreted as the recursion:

D(0)y(t)+D(1)y(t+1)+...+ D(d1)y(t+d1)= N(0) u(t) +....+ N(d2) u(t+d2)

It is assumed that D(d1) is non singular.

The columns of u are the inputs of the system at t=0,1,...,T:

u=[u(0) , u(1),...,u(T)]

The outputs at t=0,1,...,T+d1-d2 are the columns of the matrix y:

y=[y(0), y(1), .... y(T+d1-d2)]

up and yp define the initial conditions for t < 0 i.e

up=[u(-d1), ..., u(-1) ]

yp=[y(-d1), ... y(-1) ]

Depending on the relative values of d1 and d2, some of the leftmost components of up, yp are
ignored. The default values of up and yp are zero: up = 0*ones(m,d1), yp=0*ones(n,d1)
EXAMPLE :

Scilab Group April 1993 358

rtitr Scilab Function

z=poly(0,’z’);
Num=1+z;Den=1+z;u=[1,2,3,4,5];
rtitr(Num,Den,u)-u
//Other examples
//siso
//causal
n1=1;d1=poly([1 1],’z’,’coeff’); // y(j)=-y(j-1)+u(j-1)
r1=[0 1 0 1 0 1 0 1 0 1 0];
r=rtitr(n1,d1,ones(1,10));norm(r1-r,1)
//hot restart
r=rtitr(n1,d1,ones(1,9),1,0);norm(r1(2:11)-r)
//non causal
n2=poly([1 1 1],’z’,’coeff’);d2=d1; // y(j)=-y(j-1)+u(j-1)+u(j)+u(j+1)
r2=[2 1 2 1 2 1 2 1 2];
r=rtitr(n2,d2,ones(1,10));norm(r-r2,1)
//hot restart
r=rtitr(n2,d2,ones(1,9),1,2);norm(r2(2:9)-r,1)
//
//MIMO example
//causal
d1=d1*diag([1 0.5]);n1=[1 3 1;2 4 1];r1=[5;14]*r1;
r=rtitr(n1,d1,ones(3,10));norm(r1-r,1)
//
r=rtitr(n1,d1,ones(3,9),[1;1;1],[0;0]);
norm(r1(:,2:11)-r,1)
//polynomial n1 (same ex.)
n1(1,1)=poly(1,’z’,’c’);r=rtitr(n1,d1,ones(3,10));norm(r1-r,1)
//
r=rtitr(n1,d1,ones(3,9),[1;1;1],[0;0]);
norm(r1(:,2:11)-r,1)
//non causal
d2=d1;n2=n2*n1;r2=[5;14]*r2;
r=rtitr(n2,d2,ones(3,10));norm(r2-r)
//
r=rtitr(n2,d2,ones(3,9),[1;1;1],[10;28]);
norm(r2(:,2:9)-r,1)
//
// State-space or transfer
a = [0.21 , 0.63 , 0.56 , 0.23 , 0.31
0.76 , 0.85 , 0.66 , 0.23 , 0.93
0 , 0.69 , 0.73 , 0.22 , 0.21
0.33 , 0.88 , 0.2 , 0.88 , 0.31
0.67 , 0.07 , 0.54 , 0.65 , 0.36];
b = [0.29 , 0.5 , 0.92
0.57 , 0.44 , 0.04
0.48 , 0.27 , 0.48
0.33 , 0.63 , 0.26
0.59 , 0.41 , 0.41];
c = [0.28 , 0.78 , 0.11 , 0.15 , 0.84
0.13 , 0.21 , 0.69 , 0.7 , 0.41];
d = [0.41 , 0.11 , 0.56
0.88 , 0.2 , 0.59];
s=syslin(’d’,a,b,c,d);
h=ss2tf(s);num=h(’num’);den=h(’den’);den=den(1,1)*eye(2,2);
u=1;u(3,10)=0;r3=flts(u,s);

Scilab Group April 1993 359

specfact Scilab Function

r=rtitr(num,den,u);norm(r3-r,1)

S EE A LSO : ltitr 347, exp 508, flts 336

2.1.60 sm2des system matrix to descriptor

CALLING SEQUENCE :

[Des]=sm2des(Sm);

PARAMETERS :

Sm : polynomial matrix (pencil system matrix)

Des : descriptor system (list(’des’,A,B,C,D,E))

DESCRIPTION :
Utility function: converts the system matrix:

Sm = [-sE + A B;
[ C D]

to descriptor system Des=list(’des’,A,B,C,D,E)).

S EE A LSO : ss2des 361, sm2ss 360

2.1.61 sm2ss system matrix to state-space

CALLING SEQUENCE :

[Sl]=sm2ss(Sm);

PARAMETERS :

Sm : polynomial matrix (pencil system matrix)

Sl : linear system (syslin list)

DESCRIPTION :
Utility function: converts the system matrix:

Sm = [-sI + A B;
[ C D]

to linear system in state-space representation (syslin) list.

S EE A LSO : ss2des 361

2.1.62 specfact spectral factor

CALLING SEQUENCE :

[W0,L]=specfact(A,B,C,D)

DESCRIPTION :
Given a spectral density matrix phi(s):

Scilab Group April 1993 360

ss2ss Scilab Function

-1 -1
R + C*(s*I-A) * B + B’*(-s*I-A’) * C’ with R=D+D’ > 0

specfact computes W0 and L such that W(s)=W0+L*(s*I-A)ˆ-1*B is a spectral factor of of

PHI(s), i.e.
phi(s)=W’(-s)*W(s)
EXAMPLE :

A=diag([-1,-2]);B=[1;1];C=[1,1];D=1;s=poly(0,’s’);
W1=syslin(’c’,A,B,C,D);
phi=gtild(W1,’c’)+W1;
phis=clean(ss2tf(phi))
clean(phis-horner(phis,-s)’); //check this is 0...
[A,B,C,D]=abcd(W1);
[W0,L]=specfact(A,B,C,D);
W=syslin(’c’,A,B,L,W0)
Ws=ss2tf(W);
horner(Ws,-s)*Ws

S EE A LSO : gtild 380, sfact 497, fspecg 377

AUTHOR : F. D.

2.1.63 ss2des (polynomial) state-space to descriptor form

CALLING SEQUENCE :

S=ss2des(Sl)
S=ss2des(Sl,flag)

PARAMETERS :

Sl : syslin list: proper or improper linear system.

flag : character string "withD"
S : list

DESCRIPTION :
Given the linear system in state-space representation Sl (syslin list), with a D matrix which is either
polynomial or constant, but not zero ss2des returns a descriptor system as list(’des’,A,B,C,0,E)
such that:

Sl=C*(s*E-A)ˆ(-1)*B

If the flag "withD" is given, S=list(’des’,A,B,C,D,E) with a D matrix of maximal rank.

EXAMPLE :

s=poly(0,’s’);
G=[1/(s+1),s;1+sˆ2,3*sˆ3];Sl=tf2ss(G);
S=ss2des(Sl)
S1=ss2des(Sl,"withD")
Des=des2ss(S);Des(5)=clean(Des(5))
Des1=des2ss(S1)

S EE A LSO : pol2des 494, tf2des 390, des2ss 376

AUTHOR : F. D.

Scilab Group April 1993 361

ss2ss Scilab Function

2.1.64 ss2ss state-space to state-space conversion, feedback, injection

CALLING SEQUENCE :

[Sl1,right,left]=ss2ss(Sl,T, [F, [G , [flag]]])

PARAMETERS :

Sl : linear system (syslin list) in state-space form

T : square (non-singular) matrix
Sl1, right, left : linear systems (syslin lists) in state-space form
F : real matrix (state feedback gain)
G : real matrix (output injection gain)

DESCRIPTION :
Returns the linear system Sl1=[A1,B1,C1,D1] where A1=inv(T)*A*T, B1=inv(T)*B, C1=C*T,
D1=D.
Optional parameters F and G are state feedback and output injection respectively.
For example, Sl1=ss2ss(Sl,T,F) returns  Sl1 with: 
T 1
(A + BF )T T 1
(B )
Sl1 =
(C + DF )T D
and right is a non singular linear system such that Sl1=Sl*right.
Sl1*inv(right) is a factorization of Sl.
Sl1=ss2ss(Sl,T,0*F,G) returns Sl1 with:
 
T 1
(A + GC )T T 1
(B + GD )
Sl1 =
CT D
and left is a non singular linear system such that Sl1=left*Sl (right=Id if F=0).
When both F and G are given, Sl1=left*Sl*right.
- When flag is used and flag=1 an output injection as follows is used
 
T 1
(A + GC )T T 1
(B + GD; G)
Sl1 =
CT (D; 0)

and then a feedback is performed, F must be of size (m+p,n) ( x is in R n , y in Rp , u in Rm ).

right and left have the following property:

Sl1 = left*sysdiag(sys,eye(p,p))*right
- When flag is used and flag=2 a feedback (F must be of size (m,n)) is performed and then the
above output injection is applied. right and left have the following property:

Sl1 = left*sysdiag(sys*right,eye(p,p)))

EXAMPLE :

Sl=ssrand(2,2,5); trzeros(Sl) // zeros are invariant:

Sl1=ss2ss(Sl,rand(5,5),rand(2,5),rand(5,2));
trzeros(Sl1), trzeros(rand(2,2)*Sl1*rand(2,2))
// output injection [ A + GC, (B+GD,-G)]
// [ C , (D , 0)]
p=1,m=2,n=2; sys=ssrand(p,m,n);

// feedback (m,n) first and then output injection.

Scilab Group April 1993 362

st ility Scilab Function

F1=rand(m,n);
G=rand(n,p);
[sys1,right,left]=ss2ss(sys,rand(n,n),F1,G,2);

// Sl1 equiv left*sysdiag(sys*right,eye(p,p)))

res=clean(ss2tf(sys1) - ss2tf(left*sysdiag(sys*right,eye(p,p))))

// output injection then feedback (m+p,n)

F2=rand(p,n); F=[F1;F2];
[sys2,right,left]=ss2ss(sys,rand(n,n),F,G,1);

// Sl1 equiv left*sysdiag(sys,eye(p,p))*right

res=clean(ss2tf(sys2)-ss2tf(left*sysdiag(sys,eye(p,p))*right))

// when F2= 0; sys1 and sys2 are the same

F2=0*rand(p,n);F=[F1;F2];
[sys2,right,left]=ss2ss(sys,rand(n,n),F,G,1);

res=clean(ss2tf(sys2)-ss2tf(sys1))

S EE A LSO : projsl 354, feedback 335

2.1.65 ss2tf conversion from state-space to transfer function

CALLING SEQUENCE :

[h]=ss2tf(sl)
[Ds,NUM,chi]=ss2tf(sl)

PARAMETERS :

sl : linear system (syslin list)

h : transfer matrix

DESCRIPTION :
Called with three outputs [Ds,NUM,chi]=ss2tf(sl) returns the numerator polynomial matrix NUM,
the characteristic polynomial chi and the polynomial part Ds separately i.e.:

h=NUM/chi + Ds

Method:
One uses the characteristic polynomial and det(A+Eij)=det(A)+C(i,j) where C is the adju-
gate matrix of A.
EXAMPLE :

s=poly(0,’s’);
h=[1,1/s;1/(sˆ2+1),s/(sˆ2-2)]
sl=tf2ss(h);
h=clean(ss2tf(sl))
[Ds,NUM,chi]=ss2tf(sl)

S EE A LSO : tf2ss 367, syslin 224, nlev 522, glever 512

Scilab Group April 1993 363

stabil Scilab Function

2.1.66 st ility stabilizability test

CALLING SEQUENCE :

[ns, [nc, [,U [,Slo] ]]]=st_ility(Sl [,tol])

PARAMETERS :

Sl : syslin list (linear system)

ns : integer (dimension of stabilizable subspace)
nc : integer (dimension of controllable subspace nc <= ns)
U : basis such that its ns (resp. nc) first components span the stabilizable (resp. controllable) subspace
Slo : a linear system (syslin list)
tol : threshold for controllability detection (see contr)

DESCRIPTION :
Slo=( U’*A*U, U’*B, C*U, D, U’*x0 ) (syslin list) displays the stabilizable form of Sl.
Stabilizability means ns=nx (dim. of A matrix).

[*,*,*] [*]
U’*A*U = [0,*,*] U’*B = [0]
[0,0,*] [0]

where (A11,B1) (dim(A11)= nc) is controllable and A22 (dim(A22)=ns-nc) is stable. ”Stable”
means real part of eigenvalues negative for a continuous linear system, and magnitude of eigenvalues lower
than one for a discrete-time system (as defined by syslin).
EXAMPLE :

A=diag([0.9,-2,3]);B=[0;0;1];Sl=syslin(’c’,A,B,[]);
[ns,nc,U]=st_ility(Sl);
U’*A*U
U’*B
[ns,nc,U]=st_ility(syslin(’d’,A,B,[]));
U’*A*U
U’*B

S EE A LSO : dt_ility 334, contr 328, stabil 364, ssrand 220

AUTHOR : S. Steer INRIA 1988

2.1.67 stabil stabilization

CALLING SEQUENCE :

F=stabil(A,B,alfa)
K=stabil(Sys,alfa,beta)

PARAMETERS :

A : square real matrix (nx x nx)

B : real matrix (nx x nu)
alfa, beta : real or complex vector (in conjugate pairs) or real number.
F : real matrix (nx x nu)
Sys : linear system (syslin list) (m inputs, p outputs).
K : linear system (p inputs, m outputs)

Scilab Group April 1993 364

svplot Scilab Function

DESCRIPTION :
F=stabil(A,B,alfa) returns a gain matrix F such that A+B*F is stable if pair (A,B) is stabiliz-
able. Assignable poles are set to alfa(1),alfa(2),.... If (A,B) is not stabilizable a warning is
given and assignable poles are set to alfa(1),alfa(2),.... If alfa is a number all eigenvalues are
set to this alfa (default value is alfa=-1).
K=stabil(Sys,alfa,beta) returns K, a compensator for Sys such that (A,B)-controllable eigen-
values are set to alfa and (C,A)-observable eigenvalues are set to beta.
All assignable closed loop poles (which are given by the eigenvalues of Aclosed=h cl(Sys,K) are
set to alfa(i)’s and beta(j)’s.
EXAMPLE :

// Gain:
Sys=ssrand(0,2,5,list(’st’,2,3,3));
A=Sys(’A’);B=Sys(’B’);F=stabil(A,B);
spec(A) //2 controllable modes 2 unstable uncontrollable modes
//and one stable uncontrollable mode
spec(A+B*F) //the two controllable modes are set to -1.
// Compensator:
Sys=ssrand(3,2,5,list(’st’,2,3,3)); //3 outputs, 2 inputs, 5 states
//2 controllables modes, 3 controllable or stabilizable modes.
K=stabil(Sys,-2,-3); //Compensator for Sys.
spec(Sys(’A’))
spec(h_cl(Sys,K)) //K Stabilizes what can be stabilized.

S EE A LSO : st_ility 364, contr 328, ppol 354

2.1.68 svplot singular-value sigma-plot

CALLING SEQUENCE :

[SVM]=svplot(sl,[w])

PARAMETERS :

sl : syslin list (continuous, discrete or sampled system)

w : real vector (optional parameter)

DESCRIPTION :
computes for the system sl=(A,B,C,D) the singular values of its transfer function matrix:
G(jw) = C(jw*I-A)Bˆ-1+D
or
G(exp(jw)) = C(exp(jw)*I-A)Bˆ-1+D
or
G(exp(jwT)) = C(exp(jw*T)*I-A)Bˆ-1+D
evaluated over the frequency range specified by w. (T is the sampling period, T=sl(’dt’) for sam-
pled systems).
sl is a syslin list representing the system [A,B,C,D] in state-space form. sl can be continous or
discrete time or sampled system.
The i-th column of the output matrix SVM contains the singular values of G for the i-th frequency value
w(i).
SVM = svplot(sl)
is equivalent to

Scilab Group April 1993 365

abcd Scilab Function

SVM = svplot(sl,logspace(-3,3)) (continuous)

SVM = svplot(sl,logspace(-3,%pi)) (discrete)

EXAMPLE :

x=logspace(-3,3);
y=svplot(ssrand(2,2,4));
xbasc();plot2d1("oln",x’,20*log(y’)/log(10));
xgrid(12)
xtitle("Singular values plot","(Rd/sec)", "Db");

AUTHOR : F.D

2.1.69 sysfact- factorization

CALLING SEQUENCE :

[S,Series]=sysfact(Sys,Gain,flag)

PARAMETERS :

Sys : syslin list containing the matrices [A,B,C,D].

Gain : real matrix
flag : string ’post’ or ’pre’
S : syslin list
Series : syslin list

DESCRIPTION :
If flag equals ’post’, sysfact returns in S the linear system with ABCD matrices (A+B*Gain,
B , Gain, I), and Series, a minimal realization of the series system Sys*S. If flag equals ’pre’,
sysfact returns the linear system (A+Gain*C, Gain , C, I) and Series, a minimal realiza-
tion of the series system S*Sys.
AUTHOR : F.D.
EXAMPLE :

//Kalman filter
Sys=ssrand(3,2,4);Sys(’D’)=rand(3,2);
S=sysfact(Sys,lqr(Sys),’post’);
ww=minss(Sys*S);
ss2tf(gtild(ww)*ww),Sys(’D’)’*Sys(’D’)
//Kernel
Sys=ssrand(2,3,4);
[X,d,F,U,k,Z]=abinv(Sys);
ss2tf(Sys*Z)
ss2tf(Sys*sysfact(Sys,F,’post’)*U)

S EE A LSO : lqr 345, lqe 344

Scilab Group April 1993 366

time id Scilab Function

2.1.70 syssize size of state-space system

CALLING SEQUENCE :

[r,nx]=syssize(Sl)

PARAMETERS :

Sl : linear system (syslin list) in state-space

r : 1 x 2 real vector
nx : integer

DESCRIPTION :
returns in r the vector [number of outputs, number of inputs] of the linear system Sl. nx is the number
of states of Sl.
S EE A LSO : size 211

2.1.71 tf2ss transfer to state-space

CALLING SEQUENCE :

sl=tf2ss(h [,tol])

PARAMETERS :

h : rational matrix
tol : may be the constant rtol or the 2 vector [rtol atol]
rtol :tolerance used when evaluating observability.
atol :absolute tolerance used when evaluating observability.
sl : linear system (syslin list sl=[A,B,C,D(s)])

DESCRIPTION :
transfer to state-space conversion:
h=C*(s*eye()-A)ˆ-1*B+D(s)
EXAMPLE :

s=poly(0,’s’);
H=[2/s,(s+1)/(sˆ2-5)];
Sys=tf2ss(H)
clean(ss2tf(Sys))

S EE A LSO : ss2tf 363, tf2des 390, des2tf 332

2.1.72 time id SISO least square identification

CALLING SEQUENCE :

[H [,err]]=time_id(n,u,y)

PARAMETERS :

n : order of transfer
u : one of the following

Scilab Group April 1993 367

trzeros Scilab Function

u1 : a vector of inputs to the system

"impuls" : if y is an impulse response
"step" : if y is a step response.
y : vector of response.
H : rational function with degree n denominator and degree n-1 numerator if y(1)==0 or rational function
with degree n denominator and numerator if y(1)<>0.
err : jjy - impuls(H,npt)jjˆ2, where impuls(H,npt) are the npt first coefficients of im-
pulse response of H

DESCRIPTION :
Identification of discrete time response. If y is strictly proper (y(1)=0) then time id computes the
least square solution of the linear equation: Den*y-Num*u=0 with the constraint coeff(Den,n):=1.
if y(1)˜=0 then the algorithm first computes the proper part solution and then add y(1) to the solution
EXAMPLE :

z=poly(0,’z’);
h=(1-2*z)/(zˆ2-0.5*z+5)
rep=[0;ldiv(h(’num’),h(’den’),20)]; //impulse response
H=time_id(2,’impuls’,rep)
// Same example with flts and u
u=zeros(1,20);u(1)=1;
rep=flts(u,tf2ss(h)); //impulse response
H=time_id(2,u,rep)
// step response
u=ones(1,20);
rep=flts(u,tf2ss(h)); //step response.
H=time_id(2,’step’,rep)
H=time_id(3,u,rep) //with u as input and too high order required

AUTHOR : Serge Steer INRIA

S EE A LSO : imrep2ss 341, arl2 321, armax 395, frep2tf 338

2.1.73 trzeros transmission zeros and normal rank

CALLING SEQUENCE :

[tr]=trzeros(Sl)
[nt,dt,rk]=trzeros(Sl)

PARAMETERS :

Sl : linear system (syslin list)

nt : complex vectors
dt : real vector
rk : integer (normal rank of Sl)

DESCRIPTION :
Called with one output argument, trzeros(Sl) returns the transmission zeros of the linear system Sl.
Sl may have a polynomial (but square) D matrix.
Called with 2 output arguments, trzeros returns the transmission zeros of the linear system Sl as
tr=nt./dt;
(Note that some components of dt may be zeros)
Called with 3 output arguments, rk is the normal rank of Sl
Transfer matrices are converted to state-space.

Scilab Group April 1993 368

ddp Scilab Function

If Sl is a (square) polynomial matrix trzeros returns the roots of its determinant.

For usual state-space system trzeros uses the state-space algorithm of Emami-Naeni & Van Dooren.
If D is invertible the transmission zeros are the eigenvalues of the ”A matrix” of the inverse system : A -
B*inv(D)*C;
If C*B is invertible the transmission zeros are the eigenvalues of N*A*M where M*N is a full rank factor-
ization of eye(A)-B*inv(C*B)*C;
For systems with a polynomial D matrix zeros are calculated as the roots of the determinant of the system
matrix.
Caution: the computed zeros are not always reliable, in particular in case of repeated zeros.
EXAMPLE :

W1=ssrand(2,2,5);trzeros(W1) //call trzeros

roots(det(systmat(W1))) //roots of det(system matrix)
s=poly(0,’s’);W=[1/(s+1);1/(s-2)];W2=(s-3)*W*W’;[nt,dt,rk]=trzeros(W2);
St=systmat(tf2ss(W2));[Q,Z,Qd,Zd,numbeps,numbeta]=kroneck(St);
St1=Q*St*Z;rowf=(Qd(1)+Qd(2)+1):(Qd(1)+Qd(2)+Qd(3));
colf=(Zd(1)+Zd(2)+1):(Zd(1)+Zd(2)+Zd(3));
roots(St1(rowf,colf)), nt./dt //By Kronecker form

S EE A LSO : gspec 514, kroneck 517

2.1.74 ui observer unknown input observer

CALLING SEQUENCE :

[UIobs,J,N]=ui_observer(Sys,reject,C1,D1)
[UIobs,J,N]=ui_observer(Sys,reject,C1,D1,flag,alfa,beta)

PARAMETERS :

Sys : syslin list containing the matrices (A,B,C2,D2).

reject : integer vector, indices of inputs of Sys which are unknown.
C1 : real matrix
D1 : real matrix. C1 and D1 have the same number of rows.
flag : string ’ge’ or ’st’ (default) or ’pp’.
alfa : real or complex vector (loc. of closed loop poles)
beta : real or complex vector (loc. of closed loop poles)

DESCRIPTION :
Unknown input observer.
Sys: (w,u) --> y is a (A,B,C2,D2) syslin linear system with two inputs w and u, w be-
ing the unknown input. The matrices B and D2 of Sys are (implicitly) partitioned as: B=[B1,B2] and
D2=[D21,D22] with B1=B(:,reject) and D21=D2(:,reject) where reject = indices of un-
known inputs. The matrices C1 and D1 define z = C1 x + D1 (w,u), the to-be-estimated output.
The matrix D1 is (implicitly) partitioned as D1=[D11,D12] with D11=D(:,reject)
The data (Sys, reject,C1, D1) define a 2-input 2-output system:

xdot = A x + B1 w + B2 u
z = C1 x + D11 w + D12 u
y = C2 x + D21 w + D22 u

An observer (u,y) --> zhat is looked for the output z.

flag=’ge’ no stability constraints flag=’st’ stable observer (default) flag=’pp’ observer with
pole placement alfa,beta = desired location of closed loop poles (default -1, -2) J=y-output to x-state injec-
tion. N=y-output to z-estimated output injection.

Scilab Group April 1993 369

zeropen Scilab Function

UIobs = linear system (u,y) –> zhat such that: The transfer function: (w,u) –> z equals the composed
transfer function: [0,I; UIobs Sys] (w,u) —–> (u,y) —–> zhat i.e. transfer function of system fA,B,C1,D1g
equals transfer function UIobs*[0,I; Sys]
Stability (resp. pole placement) requires detectability (resp. observability) of (A,C2).
EXAMPLE :
A=diag([3,-3,7,4,-4,8]);
B=[eye(3,3);zeros(3,3)];
C=[0,0,1,2,3,4;0,0,0,0,0,1];
D=[1,2,3;0,0,0];
rand(’seed’,0);w=ss2ss(syslin(’c’,A,B,C,D),rand(6,6));
[A,B,C,D]=abcd(w);
B=[B,matrix(1:18,6,3)];D=[D,matrix(-(1:6),2,3)];
reject=1:3;
Sys=syslin(’c’,A,B,C,D);
N1=[-2,-3];C1=-N1*C;D1=-N1*D;
nw=length(reject);nu=size(Sys(’B’),2)-nw;
ny=size(Sys(’C’),1);nz=size(C1,1);
[UIobs,J,N]=ui_observer(Sys,reject,C1,D1);

W=[zeros(nu,nw),eye(nu,nu);Sys];UIobsW=UIobs*W;
//(w,u) --> z=UIobs*[0,I;Sys](w,u)
clean(ss2tf(UIobsW));
wu_to_z=syslin(’c’,A,B,C1,D1);clean(ss2tf(wu_to_z));
clean(ss2tf(wu_to_z)-ss2tf(UIobsW),1.d-7)
/////2nd example//////
nx=2;ny=3;nwu=2;Sys=ssrand(ny,nwu,nx);
C1=rand(1,nx);D1=[0,1];
UIobs=ui_observer(Sys,1,C1,D1);
AUTHOR : F.D.
S EE A LSO : cainv 323, ddp 331, abinv 318

2.1.75 unobs unobservable subspace

CALLING SEQUENCE :
[n,[U]]=unobs(A,C,[tol])
PARAMETERS :
A, C : real matrices
tol : tolerance used when evaluating ranks (QR factorizations).
n : dimension of unobservable subspace.
U : orthogonal change of basis which puts (A,B) in canonical form.
DESCRIPTION :
[n,[U]]=unobs(A,C,[tol]) gives the unobservable form of an (A,C) pair. The n first columns
of U make a basis for the unobservable subspace.
The (2,1) block (made of last nx-n rows and n first columns) of U’*A*U is zero and and the n first
columns of C*U are zero.
EXAMPLE :
A=diag([1,2,3]);C=[1,0,0];
unobs(A,C)
S EE A LSO : contr 328, contrss 328, canon 325, cont_mat 327, spantwo 535,
dt_ility 334

Scilab Group April 1993 370

zeropen Scilab Function

2.1.76 zeropen zero pencil

CALLING SEQUENCE :

[Z,U]=zeropen(Sl)

PARAMETERS :

Sl : a linear system (syslin list in state-space form [A,B,C,D])

Z : matrix pencil Z=s*E-A
U : square orthogonal matrix

DESCRIPTION :
Z = sE - F is the zero pencil of the linear system Sl with matrices [A,B,C,D]. Utility function.
With U row compression of [B;D] i.e, U*[B;D]=[0;*]; one has:
U*[-sI+A |B; [ Z |0;
C |D] = [ * |*]
The zeros of Z are the zeros of Sl.
S EE A LSO : systmat 499, kroneck 517

Scilab Group April 1993 371

zeropen Scilab Function

2.2 Robust control toolbox

Scilab Group April 1993 372

augment Scilab Function

2.2.1 augment augmented plant

CALLING SEQUENCE :

[P,r]=augment(G)
[P,r]=augment(G,flag1)
[P,r]=augment(G,flag1,flag2)

PARAMETERS :

G : linear system (syslin list), the nominal plant

flag1 : one of the following (upper case) character string: ’S’ , ’R’ , ’T’ ’SR’ , ’ST’ , ’RT’
’SRT’
flag2 : one of the following character string: ’o’ (stands for ’output’, this is the default value) or ’i’
(stands for ’input’).
P : linear system (syslin list), the “augmented” plant
r : 1x2 row vector, dimension of P22 = G

DESCRIPTION :
If flag1=’SRT’ (default value), returns the ”full” augmented plant

[ I | -G] -->’S’
[ 0 | I] -->’R’
P = [ 0 | G] -->’T’
[-------]
[ I | -G]
’S’ , ’R’ , ’T’ refer to the first three (block) rows of P respectively.
If one of these letters is absent in flag1, the corresponding row in P is missing.
If G is given in state-space form, the returned P is minimal. P is calculated by: [I,0,0;0,I,0;-I,0,I;I,0,0]*[I,-G;0
The augmented plant associated with input sensitivity functions, namely

[ I | -I] -->’S’ (input sensitivity)

[ G | -G] -->’R’ (G*input sensitivity)
P = [ 0 | I] -->’T’ (K*G*input sensitivity)
[-------]
[ G | -G]

is obtained by the command [P,r]=augment(G,flag,’i’). For state-space G, this P is calcu-

lated by: [I,-I;0,0;0,I;0,0]+[0;I;0;I]*G*[I,-I] and is thus generically minimal.
Note that weighting functions can be introduced by left-multiplying P by a diagonal system of appropriate
dimension, e.g., P = sysdiag(W1,W2,W3,eye(G))*P.
Sensitivity functions can be calculated by lft. One has:
For output sensitivity functions [P,r]=augment(P,’SRT’): lft(P,r,K)=[inv(eye()+G*K);K*inv(eye()+G*K);G*K*inv(eye()+G*K)];
For input sensitivity functions [P,r]=augment(P,’SRT’,’i’): lft(P,r,K)=[inv(eye()+K*G);G*inv(eye()+K*G);K*G*inv(eye()+G*K)];

EXAMPLE :

G=ssrand(2,3,2); //Plant
K=ssrand(3,2,2); //Compensator
[P,r]=augment(G,’T’);
T=lft(P,r,K); //Complementary sensitivity function
Ktf=ss2tf(K);Gtf=ss2tf(G);
Ttf=ss2tf(T);T11=Ttf(1,1);
Oloop=Gtf*Ktf;
Tn=Oloop*inv(eye(Oloop)+Oloop);

Scilab Group April 1993 373

colinout Scilab Function

clean(T11-Tn(1,1));
//
[Pi,r]=augment(G,’T’,’i’);
T1=lft(Pi,r,K);T1tf=ss2tf(T1); //Input Complementary sensitivity function
Oloop=Ktf*Gtf;
T1n=Oloop*inv(eye(Oloop)+Oloop);
clean(T1tf(1,1)-T1n(1,1))

S EE A LSO : lft 384, sensi 390

2.2.2 bstap hankel approximant

CALLING SEQUENCE :

[Q]=bstap(Sl)

PARAMETERS :

sl : linear system (syslin list) assumed continuous-time and anti-stable.

Q : best stable approximation of Sl (syslin list).

DESCRIPTION :
Computes the best approximant Q of the linear system Sl

kSl Qk1 = kT k
where is the H-infinity norm of the Hankel operator associated with Sl.
S EE A LSO : syslin 224

2.2.3 ccontrg central H-infinity controller

CALLING SEQUENCE :

[K]=ccontrg(P,r,gamma);

PARAMETERS :

P : syslin list (linear system in state-space representation)

r : 1x2 row vector, dimension of the 2,2 part of P
gamma : real number

DESCRIPTION :
returns a realization K of the central controller for the general standard problem in state-space form.
Note that gamma must be > gopt (ouput of gamitg)
P contains the parameters of plant realization (A,B,C,D) (syslin list) with

B = ( B1 , B2 ) , C= ( C1 ) , D = ( D11 D12)
( C2 ) ( D21 D22)

r(1) and r(2) are the dimensions of D22 (rows x columns)

S EE A LSO : gamitg 378, h_inf 381
AUTHOR : P. Gahinet (INRIA)

Scilab Group April 1993 374

dcf Scilab Function

2.2.4 colinout inner-outer factorization

CALLING SEQUENCE :

[Inn,X,Gbar]=colinout(G)

PARAMETERS :

G : linear system (syslin list) [A,B,C,D]

Inn : inner factor (syslin list)
Gbar : outer factor (syslin list)
X : row-compressor of G (syslin list)

DESCRIPTION :
Inner-outer factorization (and column compression) of (lxp) G =[A,B,C,D] with l<=p.
G is assumed to be fat (l<=p) without zero on the imaginary axis and with a D matrix which is full row
rank.
G must also be stable for having Gbar stable.
Dual of rowinout.
S EE A LSO : syslin 224, rowinout 389

2.2.5 copfac right coprime factorization

CALLING SEQUENCE :

[N,M,XT,YT]=copfac(G [,polf,polc,tol])

PARAMETERS :

G : syslin list (continuous-time linear system )

polf, polc : respectively the poles of XT and YT and the poles of n and M (default values =-1).
tol : real threshold for detecting stable poles (default value 100*%eps)
N,M,XT,YT : linear systems represented by syslin lists

DESCRIPTION :
[N,M,XT,YT]=copfac(G,[polf,polc,[tol]]) returns a right coprime factorization of G.
G = N*Mˆ-1 where N and M are stable, proper and right coprime. (i.e. [N M] left-invertible with
stability)
XT and YT satisfy:
[XT -YT].[M N]’ = eye (Bezout identity)
G is assumed stabilizable and detectable.
S EE A LSO : syslin 224, lcf 383

2.2.6 dcf double coprime factorization

CALLING SEQUENCE :

[N,M,X,Y,NT,MT,XT,YT]=dcf(G,[polf,polc,[tol]])

PARAMETERS :

G : syslin list (continuous-time linear system)

polf, polc : respectively the poles of XT and YT and the poles of N and M (default values =-1).

Scilab Group April 1993 375

dtsi Scilab Function

tol : real threshold for detecting stable poles (default value 100*%eps).
N,M,XT,YT,NT,MT,X,Y : linear systems represented by syslin lists
DESCRIPTION :
returns eight stable systems (N,M,X,Y,NT,MT,XT,YT) for the doubly coprime factorization
   
XT YT M Y
NT MT
 M X
= eye
G must be stabilizable and detectable.
S EE A LSO : copfac 375

2.2.7 des2ss descriptor to state-space

CALLING SEQUENCE :
[Sl]=des2ss(A,B,C,D,E [,tol])
[Sl]=des2ss(Des)
PARAMETERS :
A,B,C,D,E : real matrices of appropriate dimensions
Des : list
Sl : syslin list
tol : real parameter (threshold) (default value 100*%eps).
DESCRIPTION :
Descriptor to state-space transform.
Sl=des2ss(A,B,C,D,E) returns a linear system Sl equivalent to the descriptor system (E,A,B,C,D).
For index one (E,A) pencil, explicit formula is used and for higher index pencils rowshuff is used.
Sl=des2ss(Des) with Des=list(’des’,A,B,C,D,E) returns a linear system Sl in state-space
form with possibly a polynomial D matrix.
A generalized Leverrier algorithm is used.
EXAMPLE :
s=poly(0,’s’);G=[1/(s-1),s;1,2/sˆ3];
S1=tf2des(G);S2=tf2des(G,"withD");
W1=des2ss(S1);W2=des2ss(S2);
clean(ss2tf(W1))
clean(ss2tf(W2))
S EE A LSO : des2tf 332, glever 512, rowshuff 532

2.2.8 dhnorm discrete H-infinity norm

CALLING SEQUENCE :
hinfnorm=dhnorm(sl,[tol],[normax])
PARAMETERS :
sl : the state space system (syslin list) (discrete-time)
tol : tolerance in bisection step, default value 0.01
normax : upper bound for the norm , default value is 1000
hinfnorm : the discrete infinity norm of Sl
DESCRIPTION :
produces the discrete-time infinity norm of a state-space system (the maximum over all frequencies on the
unit circle of the maximum singular value).
S EE A LSO : h_norm 382, linfn 385

Scilab Group April 1993 376

fstabst Scilab Function

2.2.9 dtsi stable anti-stable decomposition

CALLING SEQUENCE :
[Ga,Gs,Gi]=dtsi(G,[tol])
PARAMETERS :
G : linear system (syslin list)
Ga : linear system (syslin list) antistable and strictly proper
Gs : linear system (syslin list) stable and strictly proper
Gi : real matrix (or polynomial matrix for improper systems)
tol : optional parameter for detecting stables poles. Default value: 100*%eps
DESCRIPTION :
returns the stable-antistable decomposition of G:
G = Ga + Gs + Gi, (Gi = G(oo))
G can be given in state-space form or in transfer form.
S EE A LSO : syslin 224, pbig 523, psmall 527, pfss 353

2.2.10 fourplan augmented plant to four plants

CALLING SEQUENCE :
[P11,P12,P21,P22]=fourplan(P,r)
PARAMETERS :
P : syslin list (linear system)
r : 1x2 row vector, dimension of P22
P11,P12,P21,P22 : syslin lists.
DESCRIPTION :
Utility function.
P being partitioned as follows:
P=[ P11 P12;
P21 P22]
with size(P22)=r this function returns the four linear systems P11,P12,P21,P22.
S EE A LSO : lqg 344, lqg2stan 345, lqr 345, lqe 344, lft 384

2.2.11 fspecg stable factorization

CALLING SEQUENCE :
[gm]=fspecg(g).
PARAMETERS :
g,gm : syslin lists (linear systems in state-space representation)
DESCRIPTION :
returns gm with gm and gmˆ-1 stable such that:
gtild(g)*g = gtild(gm)*gm
g and gm are continuous-time linear systems in state-space form.
Imaginary-axis poles are forbidden.

Scilab Group April 1993 377

gamitg Scilab Function

2.2.12 fstabst Youla’s parametrization

CALLING SEQUENCE :

[J]=fstabst(P,r)

PARAMETERS :

P : syslin list (linear system)

r : 1x2 row vector, dimension of P22
J : syslin list (linear system in state-space representation)

DESCRIPTION :
Parameterization of all stabilizing feedbacks.
P is partitioned as follows:
P=[ P11 P12;
P21 P22]
(in state-space or transfer form: automatic conversion in state-space is done for the computations)
r = size of P22 subsystem, (2,2) block of P
J =[ J11 J12;
J21 J22]
K is a stabilizing controller for P (i.e. P22) iff K=lft(J,r,Q) with Q stable.
The central part of J , J11 is the lqg regulator for P
This J is such that defining T as the 2-port lft of P and J : [T,rt]=lft(P,r,J,r) one has that
T12 is inner and T21 is co-inner.
EXAMPLE :

ny=2;nu=3;nx=4;
P22=ssrand(ny,nu,nx);
bigQ=rand(nx+nu,nx+nu);bigQ=bigQ*bigQ’;
bigR=rand(nx+ny,nx+ny);bigR=bigR*bigR’;
[P,r]=lqg2stan(P22,bigQ,bigR);
J=fstabst(P,r);
Q=ssrand(nu,ny,1);Q(’A’)=-1; //Stable Q
K=lft(J,r,Q);
A=h_cl(P,r,K); spec(A)

S EE A LSO : obscont 349, lft 384, lqg 344, lqg2stan 345

2.2.13 gamitg H-infinity gamma iterations

CALLING SEQUENCE :

[gopt]=gamitg(G,r,prec [,options]);

PARAMETERS :

G : syslin list (plant realization )

r : 1x2 row vector (dimension of G22)
prec : desired relative accuracy on the norm
option : string ’t’
gopt : real scalar, optimal H-infinity gain

Scilab Group April 1993 378

gtild Scilab Function

DESCRIPTION :
gopt=gamitg(G,r,prec [,options]) returns the H-infinity optimal gain gopt.
G contains the state-space matrices [A,B,C,D] of the plant with the usual partitions:
B = ( B1 , B2 ) , C = ( C1 ) , D = ( D11 D12)
( C2 ) ( D21 D22)
These partitions are implicitly given in r: r(1) and r(2) are the dimensions of D22 (rows x
columns)
With option=’t’, gamitg traces each bisection step, i.e., displays the lower and upper bounds and the
current test point.
S EE A LSO : ccontrg 374, h_inf 381
AUTHOR : P. Gahinet

2.2.14 gcare control Riccati equation

CALLING SEQUENCE :

[X,F]=gcare(Sl)
PARAMETERS :

Sl : linear system (syslin list)

X : symmetric matrix
F : real matrix
DESCRIPTION :
Generalized Control Algebraic Riccati Equation (GCARE). X = solution , F = gain.
The GCARE for Sl=[A,B,C,D] is:
(A-B*Si*D’*C)’*X+X*(A-B*Si*D’*C)-X*B*Si*B’*X+C’*Ri*C=0
where S=(eye()+D’*D), Si=inv(S), R=(eye()+D*D’), Ri=inv(R) and F=-Si*(D’*C+B’*X)
is such that A+B*F is stable.
S EE A LSO : gfare 379

2.2.15 gfare filter Riccati equation

CALLING SEQUENCE :

[Z,H]=gfare(Sl)
PARAMETERS :

Sl : linear system (syslin list)

Z : symmetric matrix
H : real matrix
DESCRIPTION :
Generalized Filter Algebraic Riccati Equation (GFARE). Z = solution, H = gain.
The GFARE for Sl=[A,B,C,D] is:
(A-B*D’*Ri*C)*Z+Z*(A-B*D’*Ri*C)’-Z*C’*Ri*C*Z+B*Si*B’=0
where S=(eye()+D’*D), Si=inv(S), R=(eye()+D*D’), Ri=inv(R) and H=-(B*D’+Z*C’)*Ri
is such that A+H*C is stable.
S EE A LSO : gcare 379

Scilab Group April 1993 379

h2norm Scilab Function

2.2.16 gtild tilde operation

CALLING SEQUENCE :

Gt=gtild(G)
Gt=gtild(G,flag)

PARAMETERS :

G : either a polynomial or a linear system (syslin list) or a rational matrix

Gt : same as G
flag : character string: either ’c’ or ’d’ (optional parameter).

DESCRIPTION :
If G is a polynomial matrix (or a polynomial), Gt=gtild(G,’c’) returns the polynomial matrix
Gt(s)=G(-s)’.
If G is a polynomial matrix (or a polynomial), Gt=gtild(G,’d’) returns the polynomial matrix Gt=G(1/z)*zˆn
where n is the maximum degree of G.
For continuous-time systems represented in state-space by a syslin list, Gt = gtild(G,’c’) re-
turns a state-space representation of G(-s)’ i.e the ABCD matrices of Gt are A’,-C’, B’, D’. If G
is improper ( D= D(s)) the D matrix of Gt is D(-s)’.
For discrete-time systems represented in state-space by a syslin list, Gt = gtild(G,’d’) returns a
state-space representation of G(-1/z)’ i.e the (possibly improper) state-space representation of -z*C*inv(z*A-B)*C
+ D(1/z) .
For rational matrices, Gt = gtild(G,’c’) returns the rational matrix Gt(s)=G(-s) and Gt =
gtild(G,’d’) returns the rational matrix Gt(z)= G(1/z)’.
The parameter flag is necessary when gtild is called with a polynomial argument.
EXAMPLE :

//Continuous time
s=poly(0,’s’);G=[s,sˆ3;2+sˆ3,sˆ2-5]
Gt=gtild(G,’c’)
Gt-horner(G,-s)’ //continuous-time interpretation
Gt=gtild(G,’d’);
Gt-horner(G,1/s)’*sˆ3 //discrete-time interpretation
G=ssrand(2,2,3);Gt=gtild(G); //State-space (G is cont. time by default)
clean((horner(ss2tf(G),-s))’-ss2tf(Gt)) //Check
// Discrete-time
z=poly(0,’z’);
Gss=ssrand(2,2,3);Gss(’dt’)=’d’; //discrete-time
Gss(5)=[1,2;0,1]; //With a constant D matrix
G=ss2tf(Gss);Gt1=horner(G,1/z)’;
Gt=gtild(Gss);
Gt2=clean(ss2tf(Gt)); clean(Gt1-Gt2) //Check
//Improper systems
z=poly(0,’z’);
Gss=ssrand(2,2,3);Gss(7)=’d’; //discrete-time
Gss(5)=[z,zˆ2;1+z,3]; //D(z) is polynomial
G=ss2tf(Gss);Gt1=horner(G,1/z)’; //Calculation in transfer form
Gt=gtild(Gss); //..in state-space
Gt2=clean(ss2tf(Gt));clean(Gt1-Gt2) //Check

S EE A LSO : syslin 224, horner 490, factors 488

Scilab Group April 1993 380

H inf Scilab Function

2.2.17 h2norm H2 norm

CALLING SEQUENCE :

[n]=h2norm(Sl [,tol])

PARAMETERS :

Sl : linear system (syslin list)

n : real scalar

DESCRIPTION :
produces the H2 norm of a linear continuous time system Sl.
(For Sl in state-space form h2norm uses the observability gramian and for Sl in transfer form h2norm
uses a residue method)

2.2.18 h cl closed loop matrix

CALLING SEQUENCE :

[Acl]=h_cl(P,r,K)
[Acl]=h_cl(P22,K)

PARAMETERS :

P, P22 : linear system (syslin list), augmented plant or nominal plant respectively
r : 1x2 row vector, dimensions of 2,2 part of P (r=[rows,cols]=size(P22))
K : linear system (syslin list), controller
Acl : real square matrix

DESCRIPTION :
Given the standard plant P (with r=size(P22)) and the controller K, this function returns the closed
loop matrix Acl.
The poles of Acl must be stable for the internal stability of the closed loop system.
Acl is the A-matrix of the linear system [I -P22;-K I]ˆ-1 i.e. the A-matrix of lft(P,r,K)
S EE A LSO : lft 384
AUTHOR : F. D.

2.2.19 h inf H-infinity (central) controller

CALLING SEQUENCE :

[Sk,ro]=h_inf(P,r,romin,romax,nmax)
[Sk,rk,ro]=h_inf(P,r,romin,romax,nmax)

PARAMETERS :

P : syslin list : continuous-time linear system (“augmented” plant given in state-space form or in
transfer form)
r : size of the P22 plant i.e. 2-vector [#outputs,#inputs]
romin,romax : a priori bounds on ro with ro=1/gamaˆ2; (romin=0 usually)
nmax : integer, maximum number of iterations in the gama-iteration.

Scilab Group April 1993 381

hankelsv Scilab Function

DESCRIPTION :
h inf computes H-infinity optimal controller for the continuous-time plant P.
The partition of P into four sub-plants is given through the 2-vector r which is the size of the 22 part of
P.
P is given in state-space e.g. P=syslin(’c’,A,B,C,D) with A,B,C,D = constant matrices or
P=syslin(’c’,H) with H a transfer matrix.
[Sk,ro]=H_inf(P,r,romin,romax,nmax) returns ro in [romin,romax] and the cen-
tral controller Sk in the same representation as P.
(All calculations are made in state-space, i.e conversion to state-space is done by the function, if necessary).
Invoked with three LHS parameters, [Sk,rk,ro]=H_inf(P,r,romin,romax,nmax) re-
turns ro and the Parameterization of all stabilizing controllers:
a stabilizing controller K is obtained by K=lft(Sk,r,PHI) where PHI is a linear system with dimen-
sions r’ and satisfy:
H norm(PHI) < gamma. rk (=r) is the size of the Sk22 block and ro = 1/gamaˆ2 after
nmax iterations.
Algorithm is adapted from Safonov-Limebeer. Note that P is assumed to be a continuous-time plant.
S EE A LSO : gamitg 378, ccontrg 374, leqr 383
AUTHOR : F.D. (1990)

2.2.20 h inf st static H infinity problem

CALLING SEQUENCE :
[Kopt,gamaopt]=h_inf_stat(D,r)
PARAMETERS :
D : real matrix
r : 1x2 vector
Kopt : matrix
DESCRIPTION :
computes a matrix Kopt such that largest singular value of:
lft(D,r,K)=D11+D12* K*inv(I-D22*K)* D21 is minimal (Static H-infinity four blocks prob-
lem).
D is partionned as D=[D11 D12; D21 D22] where size(D22)=r=[r1 r2]
AUTHOR : F.D.

2.2.21 h norm H-infinity norm

CALLING SEQUENCE :
[hinfnorm [,frequency]]=h_norm(sl [,rerr])
PARAMETERS :
sl : the state space system (syslin list)
rerr : max. relative error, default value 1e-8
hinfnorm : the infinity norm of Sl
frequency : frequency at which maximum is achieved
DESCRIPTION :
produces the infinity norm of a state-space system (the maximum over all frequencies of the maximum
singular value).
S EE A LSO : linfn 385, linf 385, svplot 365

Scilab Group April 1993 382

lqr Scilab Function

2.2.22 hankelsv Hankel singular values

CALLING SEQUENCE :

[nk2,W]=hankelsv(sl [,tol])
[nk2]=hankelsv(sl [,tol])

PARAMETERS :

sl : syslin list representing the linear system (state-space).

tol : tolerance parameter for detecting imaginary axis modes (default value is 1000*%eps).

DESCRIPTION :
returns nk2, the squared Hankel singular values of sl and W = P*Q = controllability gramian times
observability gramian.
nk2 is the vector of eigenvalues of W.
EXAMPLE :

A=diag([-1,-2,-3]);
sl=syslin(’c’,A,rand(3,2),rand(2,3));[nk2,W]=hankelsv(sl)
[Q,M]=pbig(W,nk2(2)-%eps,’c’);
slr=projsl(sl,Q,M);hankelsv(slr)

S EE A LSO : balreal 322, equil 334, equil1 335

2.2.23 lcf normalized coprime factorization

CALLING SEQUENCE :

[N,M]=lcf(sl)

PARAMETERS :

sl : linear system given in state space or transfer function (syslin list)

N,M : two linear systems (syslin list)

DESCRIPTION :
Computes normalized coprime factorization of the linear dynamic system sl.
sl = Mˆ-1 N
AUTHOR : F. D.

2.2.24 leqr H-infinity LQ gain (full state)

CALLING SEQUENCE :

[K,X,err]=leqr(P12,Vx)

PARAMETERS :

P12 : syslin list

Vx : symmetric nonnegative matrix (should be small enough)
K,X : two real matrices
err : a real number (l1 norm of LHS of Riccati equation)

Scilab Group April 1993 383

lft Scilab Function

DESCRIPTION :
leqr computes the linear suboptimal H-infinity LQ full-state gain for the plant P12=[A,B2,C1,D12]
in continuous or discrete time.
P12 is a syslin list (e.g. P12=syslin(’c’,A,B2,C1,D12)).

[C1’ ] [Q S]
[ ] * [C1 D12] = [ ]
[D12’] [S’ R]

Vx is related to the variance matrix of the noise w perturbing x; (usually Vx=gamaˆ-2*B1*B1’).

The gain K is such that A + B2*K is stable.
X is the stabilizing solution of the Riccati equation.
For a continuous plant:

(A-B2*inv(R)*S’)’*X+X*(A-B2*inv(R)*S’)-X*(B2*inv(R)*B2’-Vx)*X+Q-S*inv(R)*S’=0

K=-inv(R)*(B2’*X+S)

For a discrete time plant:

X-(Abar’*inv((inv(X)+B2*inv(R)*B2’-Vx))*Abar+Qbar=0

K=-inv(R)*(B2’*inv(inv(X)+B2*inv(R)*B2’-Vx)*Abar+S’)

with Abar=A-B2*inv(R)*S’ and Qbar=Q-S*inv(R)*S’

The 3-blocks matrix pencils associated with these Riccati equations are:

discrete continuous
|I -Vx 0| | A 0 B2| |I 0 0| | A Vx B2|
z|0 A’ 0| - |-Q I -S| s|0 I 0| - |-Q -A’ -S |
|0 B2’ 0| | S’ 0 R| |0 0 0| | S’ -B2’ R|

S EE A LSO : lqr 345

AUTHOR : F.D.

2.2.25 lft linear fractional transformation

CALLING SEQUENCE :

[P1]=LFT(P,K)
[P1]=LFT(P,r,K)
[P1,r1]=LFT(P,r,P#,r#)

PARAMETERS :

P : linear system (syslin list), the “augmented” plant, implicitly partitioned into four blocks (two input
ports and two output ports).
K : linear system (syslin list), the controller (possibly an ordinary gain).
r : 1x2 row vector, dimension of P22
P# : linear system (syslin list), implicitly partitioned into four blocks (two input ports and two output
ports).
r# : 1x2 row vector, dimension of P#22

Scilab Group April 1993 384

linfn Scilab Function

DESCRIPTION :
Linear fractional transform between two standard plants P and P# in state space form or in transfer form
(syslin lists).
r= size(P22) r#=size(P22#)
LFT(P,r, K) is the linear fractional transform between P and a controller K (K may be a gain or a
controller in state space form or in transfer form);
LFT(P,K) is LFT(P,r,K) with r=size of K transpose;
P1= P11+P12*K* (I-P22*K)ˆ-1 *P21
[P1,r1]=LFT(P,r,P#,r#) returns the generalized (2 ports) lft of P and P#.
P1 is the pair two-port interconnected plant and the partition of P1 into 4 blocks in given by r1 which
is the dimension of the 22 block of P1.
P and R can be PSSDs i.e. may admit a polynomial D matrix.
EXAMPLE :

s=poly(0,’s’);
P=[1/s, 1/(s+1); 1/(s+2),2/s]; K= 1/(s-1);
lft(P,K)
lft(P,[1,1],K)
P(1,1)+P(1,2)*K*inv(1-P(2,2)*K)*P(2,1) //Numerically dangerous!
ss2tf(lft(tf2ss(P),tf2ss(K)))
lft(P,-1)
f=[0,0;0,1];w=P/.f; w(1,1)
//Improper plant (PID control)
W=[1,1;1,1/(sˆ2+0.1*s)];K=1+1/s+s
lft(W,[1,1],K); ss2tf(lft(tf2ss(W),[1,1],tf2ss(K)))

S EE A LSO : sensi 390, augment 373, feedback 335, sysdiag 224

2.2.26 linf infinity norm

CALLING SEQUENCE :

linf(g [,eps],[tol])

PARAMETERS :

g : is a syslin linear system.

eps : is error tolerance on n.
tol : threshold for imaginary axis poles.

DESCRIPTION :
returns the L infinity norm of g.
n=sup [sigmax(g(jw)]
w
(sigmax largest singular value).
S EE A LSO : h_norm 382, linfn 385

2.2.27 linfn infinity norm

CALLING SEQUENCE :

[x,freq]=linfn(G,PREC,RELTOL,options);

Scilab Group April 1993 385

lqgltr Scilab Function

PARAMETERS :
G : is a syslin list
PREC : desired relative accuracy on the norm
RELTOL : relative threshold to decide when an eigenvalue can be considered on the imaginary axis.
options : available options are ’trace’ or ’cond’
x is the computed norm.
freq : vector
DESCRIPTION :
Computes the Linf (or Hinf) norm of G This norm is well-defined as soon as the realization G=(A,B,C,D)
has no imaginary eigenvalue which is both controllable and observable.
freq is a list of the frequencies for which jjGjj is attained,i.e., such that jjG (j om)jj = jjGjj.
If -1 is in the list, the norm is attained at infinity.
If -2 is in the list, G is all-pass in some direction so that jjG (j omega)jj = jjGjj for all frequencies
omega.
The algorithm follows the paper by G. Robel (AC-34 pp. 882-884, 1989). The case D=0 is not treated
separately due to superior accuracy of the general method when (A,B,C) is nearly non minimal.
The ’trace’ option traces each bisection step, i.e., displays the lower and upper bounds and the current
test point.
The ’cond’ option estimates a confidence index on the computed value and issues a warning if compu-
tations are ill-conditioned
In the general case (A neither stable nor anti-stable), no upper bound is prespecified.
If by contrast A is stable or anti stable, lower and upper bounds are computed using the associated Lya-
punov solutions.
S EE A LSO : h_norm 382
AUTHOR : P. Gahinet

2.2.28 lqg ltr LQG with loop transform recovery

CALLING SEQUENCE :
[kf,kc]=lqg_ltr(sl,mu,ro)
PARAMETERS :
sl : linear system in state-space form (syslin list)
mu,ro : real positive numbers chosen “small enough”
kf,kc : controller and observer Kalman gains.
DESCRIPTION :
returns the Kalman gains for:
x = a*x + b*u + l*w1
(sl)
y = c*x + mu*I*w2

z = h*x
Cost function: Z 1
Jlqg = E( [z (t)
0  z (t) + ro2  u(t)0  u(t)]dt)
0
The lqg/ltr approach looks for L,mu,H,ro such that: J(lqg) = J(freq) where
Z 1
Jf req = tr[SW W ? S ? ] + tr[T T ? ]dw
0

and

Scilab Group April 1993 386

ric desc Scilab Function

S = (I + G*K)ˆ(-1)
T = G*K*(I+G*K)ˆ(-1)

S EE A LSO : syslin 224

2.2.29 macglov Mac Farlane Glover problem

CALLING SEQUENCE :

[P,r]=macglov(Sl)

PARAMETERS :

Sl : linear system (syslin list)

P : linear system (syslin list), “augmented” plant
r : 1x2 vector, dimension of P22

DESCRIPTION :
[P,r]=macglov(Sl) returns the standard plant P for the Glover-McFarlane problem.
For this problem ro optimal = 1-hankel norm([N,M]) with [N,M]=lcf(sl) (Normalized coprime fac-
torization) i.e.
gama optimal = 1/sqrt(ro optimal)
AUTHOR : F. D.

2.2.30 nehari Nehari approximant

CALLING SEQUENCE :

[x]=nehari(R [,tol])

PARAMETERS :

R : linear system (syslin list)

x : linear system (syslin list)
tol : optional threshold

DESCRIPTION :
[x]=nehari(R [,tol]) returns the Nehari approximant of R.
R = linear system in state-space representation (syslin list).
R is strictly proper and - R˜ is stable (i.e. R is anti stable).
|| R - X ||oo = min || R - Y ||oo
Y in Hoo

2.2.31 parrot Parrot’s problem

CALLING SEQUENCE :

K=parrot(D,r)

PARAMETERS :

D,K : matrices

Scilab Group April 1993 387

riccati Scilab Function

r : 1X2 vector (dimension of the 2,2 part of D)

DESCRIPTION :
Given a matrix D partionned as [D11 D12; D21 D22] where size(D22)=r=[r1,r2] compute
a matrix K such that largest singular value of [D11 D12; D21 D22+K] is minimal (Parrot’s problem)

S EE A LSO : h_inf_st 382

2.2.32 ric desc Riccati equation

CALLING SEQUENCE :

X=ric_desc(H [,E))
[X1,X2,zero]=ric_desc(H [,E])

PARAMETERS :

H,E : real square matrices

X1,X2 : real square matrices
zero : real number

DESCRIPTION :
Riccati solver with hamiltonian matrices as inputs.
In the continuous time case calling sequence is (one input): ric_descr(H)
Riccati equation is:

(Ec) A’*X + X*A + X*R*X -Q = 0.

Defining the hamiltonian matrix H by:

H = [A R;
Q -A’]

with the calling sequence [X1,X2,zero]=ric descr(H), the solution X is given by X=X1/X2.
zero = L1 norm of rhs of (Ec)
The solution X is also given by X=riccati(A,Q,R,’c’))
In the discrete-time case calling sequence is (two inputs): ric_descr(H,E)
The Riccati equation is:

(Ed) A’*X*A-(A’*X*B*(R+B’*X*B)ˆ-1)*(B’*X*A)+C-X = 0.

Defining G=B/R*B’ and the hamiltonian pencil (E,H) by:

E=[eye(n,n),G; H=[A, 0*ones(n,n);

0*ones(n,n),A’] -C, eye(n,n)];

with the calling sequence [X1,X2,err]=ric descr(H,E), the solution X is given by X=X1/X2.
zero= L1 norm of rhs of (Ed)
The solution X is also given by X=riccati(A,G,C,’d’) with G=B/R*B’
S EE A LSO : riccati 389

Scilab Group April 1993 388

sensi Scilab Function

2.2.33 riccati Riccati equation

CALLING SEQUENCE :

X=riccati(A,B,C,dom,[typ])
[X1,X2]=riccati(A,B,C,dom,[typ])

PARAMETERS :

A,B,C : real matrices nxn, B and C symetric.

dom : ’c’ or ’d’ for the time domain (continuous or discrete)
typ : string : ’eigen’ for block diagonalization or schur’ for Schur method.
X1,X2,X : square real matrices (X2 invertible), X symmetric

DESCRIPTION :
X=riccati(A,B,C,dom,[typ]) solves the Riccati equation:
A’*X+X*A-X*B*X+C=0
in continuous time case, or:
A’*X*A-(A’*X*B1/(B2+B1’*X*B1))*(B1’*X*A)+C-X
with B=B1/B2*B1’ in the discrete time case. If called with two output arguments, riccati returns
X1,X2 such that X=X1/X2.
S EE A LSO : ric_desc 388

2.2.34 rowinout inner-outer factorization

CALLING SEQUENCE :

[Inn,X,Gbar]=rowinout(G)

PARAMETERS :

G : linear system (syslin list) [A,B,C,D]

Inn : inner factor (syslin list)
Gbar : outer factor (syslin list)
X : row-compressor of G (syslin list)

DESCRIPTION :
Inner-outer factorization (and row compression) of (lxp) G =[A,B,C,D] with l>=p.
G is assumed to be tall (l>=p) without zero on the imaginary axis and with a D matrix which is full
column rank.
G must also be stable for having Gbar stable.
G admits the following inner-outer factorization:
G = [ Inn ] | Gbar |
| 0 |
where Inn is square and inner (all pass and stable) and Gbar square and outer i.e: Gbar is square
bi-proper and bi-stable (Gbar inverse is also proper and stable);
Note that:
[ Gbar ]
X*G = [ - ]
[ 0 ]

Scilab Group April 1993 389

tf2des Scilab Function

is a row compression of G where X = Inn inverse is all-pass i.e:

T
X (-s) X(s) = Identity
(for the continous time case).
S EE A LSO : syslin 224, colinout 375

2.2.35 sensi sensitivity functions

CALLING SEQUENCE :

[Se,Re,Te]=sensi(G,K)
[Si,Ri,Ti]=sensi(G,K,flag)

PARAMETERS :

G : standard plant (syslin list)

K : compensator (syslin list)
flag : character string ’o’ (default value) or ’i’
Se : output sensitivity function (I+G*K)ˆ-1
Re : K*Se
Te : G*K*Se (output complementary sensitivity function)

DESCRIPTION :
sensi computes sensitivity functions. If G and K are given in state-space form, the systems returned
are generically minimal. Calculation is made by lft, e.g., Se can be given by the commands P =
augment(G,’S’), Se=lft(P,K). If flag = ’i’, [Si,Ri,Ti]=sensi(G,K,’i’) returns the
input sensitivity functions.
[Se;Re;Te]= [inv(eye()+G*K);K*inv(eye()+G*K);G*K*inv(eye()+G*K)];
[Si;Ri;Ti]= [inv(eye()+K*G);G*inv(eye()+K*G);K*G*inv(eye()+K*G)];

EXAMPLE :

G=ssrand(1,1,3);K=ssrand(1,1,3);
[Se,Re,Te]=sensi(G,K);
Se1=inv(eye()+G*K); //Other way to compute
ss2tf(Se) //Se seen in transfer form
ss2tf(Se1)
ss2tf(Te)
ss2tf(G*K*Se1)
[Si,Ri,Ti]=sensi(G,K,’i’);
w1=[ss2tf(Si);ss2tf(Ri);ss2tf(Ti)]
w2=[ss2tf(inv(eye()+K*G));ss2tf(G*inv(eye()+K*G));ss2tf(K*G*inv(eye()+K*G))];
clean(w1-w2)

S EE A LSO : augment 373, lft 384, h_cl 381

2.2.36 tf2des transfer function to descriptor

CALLING SEQUENCE :

S=tf2des(G)
S=tf2des(G,flag)

Scilab Group April 1993 390

tf2des Scilab Function

PARAMETERS :

G : linear system (syslin list) with possibly polynomial D matrix

flag : character string "withD"
S : list

DESCRIPTION :
Transfer function to descriptor form: S=list(’d’,A,B,C,D,E)
E*xdot = A*x+B*u
y = C*x + D*u
Note that D=0 if the optional parameter flag="withD" is not given. Otherwise a maximal rank D
matrix is returned in the fifth entry of the list S
EXAMPLE :

s=poly(0,’s’);
G=[1/(s-1),s;1,2/sˆ3];
S1=tf2des(G);des2tf(S1)
S2=tf2des(G,"withD");des2tf(S2)

S EE A LSO : pol2des 494, tf2ss 367, ss2des 361, des2tf 332

Scilab Group April 1993 391

tf2des Scilab Function

2.3 Tools for dynamical systems

Scilab Group April 1993 392

arma2p Scilab Function

2.3.1 arma Scilab arma library

DESCRIPTION :
Armax processes can be coded with Scilab tlist of type ’ar’. armac is used to build Armax scilab
object. An ’ar’ tlist contains the fields [’a’,’b’,’d’,’ny’,’nu’,’sig’].

armac : this function creates a Scilab tlist which code an Armax process A(zˆ-1)y= B(zˆ-1)u + D(zˆ-
1)sig*e(t)

-->ar=armac([1,2],[3,4],1,1,1,sig);

-->ar(’a’)
ans =

! 1. 2. !
-->ar(’sig’)
ans =

1.

armap(ar [,out]) : Display the armax equation associated with ar

armap p(ar [,out]) : Display the armax equation associated with ar using polynomial matrix dis-
play.
[A,B,D]=armap2p(ar) : extract polynomial matrices from ar representation
armax : is used to identify the coefficients of a n-dimensional ARX process A(zˆ-1)y= B(zˆ-1)u +
sig*e(t)
armax1 : armax1 is used to identify the coefficients of a 1-dimensional ARX process A(zˆ-1)y= B(zˆ-1)u
+ D(zˆ-1)sig*e(t)
arsimul : armax trajectory simulation.
arspec : Spectral power estimation of armax processes. Test of mese and arsimul
exar1 : An Example of ARMAX identification ( K.J. Astrom) The armax process is described by : a=[1,-
2.851,2.717,-0.865] b=[0,1,1,1] d=[1,0.7,0.2]
exar2 : ARMAX example ( K.J. Astrom). A simulation of a bi dimensional version of the example of
exar1.
exar3 : Spectral power estimation of arma processes from Sawaragi et all where a value of m=18 is
used. Test of mese and arsimul
gbruit : noise generation
narsimul : armax simulation ( using rtitr)
odedi : Simple tests of ode and arsimul. Tests the option ’discret’ of ode
prbs a : pseudo random binary sequences generation
reglin : Linear regression

AUTHOR : J.P.C

2.3.2 arma2p extract polynomial matrices from ar representation

CALLING SEQUENCE :

[A,B,D]=arma2p(ar)

PARAMETERS :

A,B,D : three polynomial matrices

Scilab Group April 1993 393

armax Scilab Function

ar : Scilab ’ar’ tlist for arma storage (see armac).

DESCRIPTION :
this function extract polynomial matrices (A,B,D) from an armax description.

A(z 1
)y = B (z 1
)u + D (z
1
)sig  e(t)

EXAMPLE :

a=[1,-2.851,2.717,-0.865].*.eye(2,2)
b=[0,1,1,1].*.[1;1];
d=[1,0.7,0.2].*.eye(2,2);
sig=eye(2,2);
ar=armac(a,b,d,2,1,sig)
// extract polynomial matrices from ar representation
[A,B,D]=arma2p(ar);

S EE A LSO : arma 393, armax 395, armax1 396, arsimul 396, armac 394

2.3.3 armac Scilab description of an armax process

CALLING SEQUENCE :

[ar]=armac(a,b,d,ny,nu,sig)

PARAMETERS :

a=[Id,a1,..,a r] : is a matrix of size (ny,r*ny)

b=[b0,.....,b s] : is a matrix of size (ny,(s+1)*nu)
d=[Id,d1,..,d p] : is a matrix of size (ny,p*ny);
ny : dimension of the output y
nu : dimension of the output u
sig : a matrix of size (ny,ny)

DESCRIPTION :
This function creates a description as a tlist of an ARMAX process

A(z 1
)y = B (z 1
)u + D (z
1
)sig  e(t)
ar is defined by
ar=tlist([’ar’,’a’,’b’,’d’,’ny’,’nu’,’sig’],a,b,d,ny,nu,sig);
and thus the coefficients of ar can be retrieved by e.g. ar(’a’) .
EXAMPLE :

a=[1,-2.851,2.717,-0.865].*.eye(2,2)
b=[0,1,1,1].*.[1;1];
d=[1,0.7,0.2].*.eye(2,2);
sig=eye(2,2);
ar=armac(a,b,d,2,1,sig)
// extract polynomial matrices from ar representation
[A,B,D]=arma2p(ar);

S EE A LSO : arma 393, armax 395, armax1 396, arsimul 396, arma2p 393, tlist.
??

Scilab Group April 1993 394

armax Scilab Function

2.3.4 armax armax identification

CALLING SEQUENCE :

[arc,la,lb,sig,resid]=armax(r,s,y,u,[b0f,prf])

PARAMETERS :

y : output process y(ny,n); ( ny: dimension of y , n : sample size)

u : input process u(nu,n); ( nu: dimension of u , n : sample size)
r and s : auto-regression orders r >=0 et s >=-1
b0f : optional parameter. Its default value is 0 and it means that the coefficient b0 must be identified. if
bof=1 the b0 is supposed to be zero and is not identified
prf : optional parameter for display control. If prf =1, the default value, a display of the identified Arma
is given.
arc : a Scilab arma object (see armac)
la : is the list(a,a+eta,a-eta) ( la = a in dimension 1) ; where eta is the estimated standard deviation. ,
a=[Id,a1,a2,...,ar] where each ai is a matrix of size (ny,ny)
lb : is the list(b,b+etb,b-etb) (lb =b in dimension 1) ; where etb is the estimated standard deviation.
b=[b0,.....,b s] where each bi is a matrix of size (nu,nu)
sig : is the estimated standard deviation of the noise and resid=[ sig*e(t0),....] (

DESCRIPTION :
armax is used to identify the coefficients of a n-dimensional ARX process

A(zˆ-1)y= B(zˆ-1)u + sig*e(t)

where e(t) is a n-dimensional white noise with variance I. sig an nxn matrix and A(z) and B(z):

A(z) = 1+a1*z+...+a_r*zˆr; ( r=0 => A(z)=1)

B(z) = b0+b1*z+...+b_s zˆs ( s=-1 => B(z)=0)

for the method see Eykhoff in trends and progress in system identification, page 96. with z(t)=[y(t-
1),..,y(t-r),u(t),...,u(t-s)] and coef= [-a1,..,-ar,b0,...,b s] we can write y(t)= coef* z(t) + sig*e(t) and the algo-
rithm minimises sum ft=1gˆN ( [y(t)- coef’z(t)]ˆ2) where t0=maxi(maxi(r,s)+1,1))).
EXAMPLE :

//-Ex1- Arma model : y(t) = 0.2*u(t-1)+0.01*e(t-1)

ny=1,nu=1,sig=0.01;
Arma=armac(1,[0,0.2],[0,1],ny,nu,sig) //defining the above arma model
u=rand(1,1000,’normal’); //a random input sequence u
y=arsimul(Arma,u); //simulation of a y output sequence associated with u.
Armaest=armax(0,1,y,u); //Identified model given u and y.
Acoeff=Armaest(’a’); //Coefficients of the polynomial A(x)
Bcoeff=Armaest(’b’) //Coefficients of the polynomial B(x)
Dcoeff=Armaest(’d’); //Coefficients of the polynomial D(x)
[Ax,Bx,Dx]=arma2p(Armaest) //Results in polynomial form.

//-Ex2- Arma1: y_t -0.8*y_{t-1} + 0.2*y_{t-2} = sig*e(t)

ny=1,nu=1;sig=0.001;
// First step: simulation the Arma1 model, for that we define
// Arma2: y_t -0.8*y_{t-1} + 0.2*y_{t-2} = sig*u(t)
// with normal deviates for u(t).
Arma2=armac([1,-0.8,0.2],sig,0,ny,nu,0);
//Definition of the Arma2 arma model (a model with B=sig and without noise!)
u=rand(1,10000,’normal’); // An input sequence for Arma2

Scilab Group April 1993 395

arsimul Scilab Function

y=arsimul(Arma2,u); // y = output of Arma2 with input u

// can be seen as output of Arma1.
// Second step: identification. We look for an Arma model
// y(t) + a1*y(t-1) + a2 *y(t-2) = sig*e(t)
Arma1est=armax(2,-1,y,[]);
[A,B,D]=arma2p(Arma1est)

AUTHOR : J-Ph. Chancelier.

S EE A LSO : imrep2ss 341, time_id 367, arl2 321, armax 395, frep2tf 338

2.3.5 armax1 armax identification

CALLING SEQUENCE :

[a,b,d,sig,resid]=armax1(r,s,q,y,u,[b0f])

PARAMETERS :

y : output signal
u : input signal
r,s,q : auto regression orders with r >=0, s >=-1.
b0f : optional parameter. Its default value is 0 and it means that the coefficient b0 must be identified. if
bof=1 the b0 is supposed to be zero and is not identified
a : is the vector [1,a1,...,a r]
b : is the vector [b0,......,b s]
d : is the vector [1,d1,....,d q]
sig : resid=[ sig*echap(1),....,];

DESCRIPTION :
armax1 is used to identify the coefficients of a 1-dimensional ARX process:
A(zˆ-1)y= B(zˆ-1)u + D(zˆ-1)sig*e(t)
e(t) is a 1-dimensional white noise with variance 1.
A(z)= 1+a1*z+...+a_r*zˆr; ( r=0 => A(z)=1)
B(z)= b0+b1*z+...+b_s zˆs ( s=-1 => B(z)=0)
D(z)= 1+d1*z+...+d_q*zˆq ( q=0 => D(z)=1)
for the method, see Eykhoff in trends and progress in system identification) page 96. with z(t)=[y(t-
1),..,y(t-r),u(t),..., u(t-s),e(t-1),...,e(t-q)] and coef= [-a1,..,-ar,b0,...,b s,d1,...,d q]’ y(t)= coef’* z(t) + sig*e(t).
a sequential version of the AR estimation where e(t-i) is replaced by an estimated value is used (RLLS).
With q=0 this method is exactly a sequential version of armax
AUTHOR : J.-Ph.C

2.3.6 arsimul armax simulation

CALLING SEQUENCE :

[z]=arsimul(a,b,d,sig,u,[up,yp,ep])
[z]=arsimul(ar,u,[up,yp,ep])

PARAMETERS :

ar : an armax process. See armac.

a : is the matrix[Id,a1,...,a r] of dimension (n,(r+1)*n)

Scilab Group April 1993 396

prbs a Scilab Function

b : is the matrix[b0,......,b s] of dimension (n,(s+1)*m)

d : is the matrix[Id,d 1,......,d t] of dimension (n,(t+1)*n)
u : is a matrix (m,N), which gives the entry u(:,j)=u j
sig : is a (n,n) matrix e fkg is an n-dimensional Gaussian process with variance I
up, yp : optional parameter which describe the past. up=[ u 0,u f-1g,...,u fs-1g]; yp=[ y 0,y f-1g,...,y fr-
1g]; ep=[ e 0,e f-1g,...,e fr-1g]; if they are omitted, the past value are supposed to be zero
z : z=[ y(1),....,y(N)]
DESCRIPTION :
simulation of an n-dimensional armax process A(zˆ-1) z(k)= B(zˆ-1)u(k) + D(zˆ-1)*sig*e(k)
A(z)= Id+a1*z+...+a r*zˆr; ( r=0 => A(z)=Id) B(z)= b0+b1*z+...+b s zˆs; ( s=-1 => B(z)=[]) D(z)=
Id+d1*z+...+d t zˆt; ( t=0 => D(z)=Id)
z et e are in Rˆn et u in Rˆm
METHOD :
a state-space representation is constructed and ode with the option ”discr” is used to compute z
AUTHOR : J-Ph.C.

2.3.7 narsimul armax simulation ( using rtitr)

CALLING SEQUENCE :

[z]=narsimul(a,b,d,sig,u,[up,yp,ep])
[z]=narsimul(ar,u,[up,yp,ep])
DESCRIPTION :
ARMAX simulation. Same as arsimul but the method is different the simulation is made with rtitr
AUTHOR : J-Ph. Chancelier ENPC Cergrene

2.3.8 noisegen noise generation

CALLING SEQUENCE :
[]=noisegen(pas,Tmax,sig)
DESCRIPTION :
generates a Scilab function [b]=Noise(t) where Noise(t) is a piecewise constant function ( con-
stant on [k*pas,(k+1)*pas] ). The value on each constant interval are random values from i.i.d
Gaussian variables of standard deviation sig. The function is constant for t<=0 and t>=Tmax.
EXAMPLE :

noisegen(0.5,30,1.0);
x=-5:0.01:35;
y=feval(x,Noise);
plot(x,y);

2.3.9 odedi test of ode

CALLING SEQUENCE :
[]=odedi()
DESCRIPTION :
Simple tests of ode and arsimul. Tests the option ’discret’ of ode

Scilab Group April 1993 397

reglin Scilab Function

2.3.10 prbs a pseudo random binary sequences generation

CALLING SEQUENCE :

[u]=prbs_a(n,nc,[ids])

DESCRIPTION :
generation of pseudo random binary sequences u=[u0,u1,...,u (n-1)]; u takes values in f-1,1g
and changes at most nc times its sign. ids can be used to fix the date at which u must change its sign ids is
then an integer vector with values in [1:n].
EXAMPLE :

u=prbs_a(50,10);
plot2d2("onn",(1:50)’,u’,1,"151",’ ’,[0,-1.5,50,1.5]);

2.3.11 reglin Linear regression

CALLING SEQUENCE :

[a,b,sig]=reglin(x,y)

DESCRIPTION :
solve the regression problem y=a*x+ b in the least square sense. sig is the standard deviation
of the residual. x and y are two matrices of size x(p,n) and y(q,n), where n is the num-
ber of samples.
The estimator a is a matrix of size (q,p) and b is a vector of size (q,1)
// simulation of data for a(3,5) and b(3,1)
x=rand(5,100);
aa=testmatrix(’magi’,5);aa=aa(1:3,:);
bb=[9;10;11]
y=aa*x +bb*ones(1,100)+ 0.1*rand(3,100);
// identification
[a,b,sig]=reglin(x,y);
maxi(abs(aa-a))
maxi(abs(bb-b))
// an other example : fitting a polynom
f=1:100; x=[f.*f; f];
y= [ 2,3]*x+ 10*ones(f) + 0.1*rand(f);
[a,b]=reglin(x,y)

S EE A LSO : pinv 525, leastsq 427, qr 528

Scilab Group April 1993 398

reglin Scilab Function

2.4 Examples

Scilab Group April 1993 399

boucle Scilab Function

2.4.1 artest arnold dynamical system

CALLING SEQUENCE :

artest(f_l,[odem,xdim,npts])
arnold(t,x)
iarf([a])
PARAMETERS :

fl : can be "arnold" or arnold. It is the name of the external for the

arnold system. If f l is set to ”arnold” a Fortran coded version of the arnold system
where a(1:6)=1 will be used and if f l is set to arnold a Scilab coded version will be used . arnold
is a Scilab macro coding the Arnold system. This macro is loaded when calling artest.
iarf : is used to fix the values of a in the Scilab coded case. a is a vector of size 6.
odem,xdim,npts : are optional arguments. Their meaning and syntax can be found in the portr3d
help

DESCRIPTION :
A call to the function artest() will interactively display a phase portrait of a the follow-
ing dynamical system :
ydot(1)=a(1)*cos(y(2)) +a(2)*sin(y(3))
ydot(2)=a(3)*cos(y(3)) +a(4)*sin(y(1))
ydot(3)=a(5)*cos(y(1)) +a(6)*sin(y(2))

S EE A LSO : portr3d 405, ode 431, chaintest 401, lotest 403

2.4.2 bifish shows a bifurcation diagram in a fish population discrete time model

CALLING SEQUENCE :

bifish([f_ch])
PARAMETERS :

f ch : can be one of fish, fishr and fishr2. This option selects the population model.
DESCRIPTION :
The dynamical system fish is the following :
y=b*exp(-0.1*(x(k)_1+x(k)_2));
x(k+1)=[ y 2*y ; s 0.0]*x(k);
and the parameters s evolves to show the bifurcation diagram. fishr and fishr2 are constructed
as above but with added white noises.
fishr
y=b*exp(-0.1*(xk(1)+xk(2)))
xkp1=[ y 2*y ; s*(1+0.1*(rand()-0.5)) 0.0]*xk

fishr2
z=exp(-0.1*(xk(1)+xk(2)))
xkp1=[ b*z**(1+0.1*(rand()-0.5)) 2*b*z**(1+0.1*(rand()-0.5)) ; s 0.0]*xk
The three macros fish, fishr, fishr2 are loaded in Scilab when calling bifish.
S EE A LSO : ode 431

Scilab Group April 1993 400

gpeche Scilab Function

2.4.3 boucle phase portrait of a dynamical system with observer

CALLING SEQUENCE :

[]=boucle(fch,[abruit,xdim,npts,farrow])

PARAMETERS :

fch : Scilab macro. fch is supposed to be an observed-controlled system with noisy output of state
dimension 4 ( [x;xchap] is of dimension 4). fch can be created with the macro obscont1 or can
be set to one of the two following string which gives pre computed examples
"bcomp" : for a non-linear competition model.
"lcomp" : for a linear example.
abruit : give the noise variance.
xdim,npts,farrow : See portrait

DESCRIPTION :
Phase portrait of dynamical systems.
S EE A LSO : portrait 406, ode 431, obscont1 405

2.4.4 chaintest a three-species food chain model

CALLING SEQUENCE :

chaintest([f_l,b1,odem,xdim,npts])
[xdot]=chain(t,x)
[z1]=ch_f1(u)
[z2]=ch_f2(u)

PARAMETERS :

f l : the name of the macro which code the three-species food chain model (default value chain).
odem,xdim,npts : are optional arguments. Their meaning and syntax can be found in the portr3d
help

DESCRIPTION :
A call to the function chaintest() will interactively display a phase portrait of a three-species food
chain model given by:

ff1= f1(x(1))
ff2= f2(x(2))

xdot1= x(1)*(1-x(1)) - ff1*x(2)

xdot2= ff1*x(2) - ff2*x(3) - 0.4*x(2)
xdot3= ff2*x(3) - 0.01*x(3)

and

f1(u)=5*u/(1+b1*u)
f2(u)z2=0.1*u/(1+2*u)

The default value for b1 is 3.0.

The Scilab macros chain(t,x),f1(u),f2(u) code the dynamical system
S EE A LSO : portr3d 405, ode 431

Scilab Group April 1993 401

fusee Scilab Function

2.4.5 gpeche a fishing program

CALLING SEQUENCE :

[xk,ukp1]=gpeche(uk,pasg)
[ut]=peche(t)
[pdot]=pechep(t,p)

DESCRIPTION :
gpeche Iterates a gradient method on a fishing problem Computes the trajectory associated to the com-
mand law uk prints the cost value and computes a new control.

2.4.6 fusee a set of Scilab macro for a landing rocket problem

FUSEE :

[xdot]=fusee(t,x)
Dynamical motion equation for the rocket
FINIT :

finit()
Initialises the following parameters for rocket landing.
k : The acceleration of the rocket engines
gamma : The moon gravity acceleration.
umax : the gaz ejection flow out.
mcap : the mass of the space capsule.
cpen : penalisation in the cost function of the final state.

FUSEEGRAD :

[ukp1]=fuseegrad(niter,ukp1,pasg)

niter : number of gradient iteration steps.

ukp1 : initial control value ( vector of sie 135 )
pasg : the gradient step value.

DESCRIPTION :
Iterate a gradient method and returns the computed control.
FUSEEP :

[pdot]=fuseep(t,p)

DESCRIPTION :
adjoint equation for the landing rocket problem.
POUSSE :

[ut]=pousse(t)
return the value of a piece wise constant control build on the discrete control uk
UBANG :

[uk]=ubang(tf,tcom)

Scilab Group April 1993 402

mine Scilab Function

returns a bang-bang control, 0 form time 0 to tcom and 1 form tcom to tf.
FCOUT :

[c,xk,pk,ukp1]=fcout(tf,uk,pasg)

DESCRITION :
optimise the following cost function by gradient iterations.
c = -m(tf) + C*( h(tf)**2 + v(tf)**2)

SFUSEE :

[]=sfusee(tau,h0,v0,m0,Tf)

DESCRIPTION :
computes the rocket trajectory when a bang-bang control is used tau is the commutation time.
h0 : The initial position (high)
v0 : The initial speed ( negative if the rocket is landing )
m0 : The total initial mass ( capsule and fuel).
Tf : Time horizon.

EQUAD :

DESCRIPTION :

[xk,pk]=equad(tf,uk)
Computes the state and adjoint state of the rocket system for a given control ur.
TRAJ :

[xt]=traj(t)
returns a piece wise value of the mass evolution.

2.4.7 lotest demo of the Lorenz attractor

CALLING SEQUENCE :

[]=lotest([f_l,odem,xdim,npts,pinit])
[y]=lorenz(t,x)
[]=ilo(sig,ro,beta)
[]=ilof(sig,ro,beta)

PARAMETERS :

fl : can be "loren" or lorenz. it is the name of the external for the Lorenz system. "loren"
will use a Fortran coded version of the lorenz system and arnold will and loren will use a Scilab
coded version.lorentz is the Scilab macro which code the lorenz system. This macro is loaded
when calling lotest.
ilof, ilo :are used to fix the parameters of the Fortran and Scilab code version of the Lorenz system.
odem,xdim,npts : are optional arguments. Their meaning and syntax can be found in the portr3d
help

DESCRIPTION :
A call to the function lotest() will interactively display a phase portrait of a the following dynamical
system

Scilab Group April 1993 403

obscont1 Scilab Function

y(1)=sig*(x(2)-x(1));
y(2)=ro*x(1) -x(2)-x(1)*x(3);
y(3)=-beta*x(3)+x(1)*x(2);

S EE A LSO : portr3d 405, ode 431, chaintest 401, lotest 403

2.4.8 mine a mining problem

CALLING SEQUENCE :

[cout,feed]=mine(n1,n2,uvect)

PARAMETERS :

n1 : Number of discrete point for the state.

n2 : Number of time step
uvect : a row vector which gives the possible control value ( integer values ). for example u=[-1,0,1]
means that at each step we come down one step or stay at the same level or rise one step ).
cout(n1,n2) : The Bellman values.
feed(n1,n2) : The feedback Law.

DESCRIPTION :
Dynamic programming applied to an optimal extraction of ore in an opencast mine. The extraction is done
as follows : the steam shovel move forward for (k=1,2,...,n2) at each step it takes the ore, then move up
or down (or stay at the same level) according to the control value to reach another level at next step. The
extraction process must maximise the following cost :

-- n2-1
\\
/ f(x(k),k) + V_F(x,n2)
-- k=1

with x(k+1)=x(k) + u. x(k) is the trajectory depth at step k (x=1 is the ground level).
The instantaneous cost f(i,k) stands for the benefit of digging at depth i at po-
sition k. It must be given as a Scilab macro ff o

[y]=ff_o(x,k)

and for efficiency ff o must accept and return column vectors for x and y.
V F(i,n2) is a final cost which is set so as to impose the steam shovel to be at ground level at position
n2
FF O :

SHOWCOST :

CALLING SEQUENCE :

[]=showcost(n1,n2,teta,alpha)

DESCRIPTION :
Shows a 3D representation of the instantaneous cost.

Scilab Group April 1993 404

portrait Scilab Function

2.4.9 obscont1 a controlled-observed system

CALLING SEQUENCE :

[macr]=obscont1(sysn)

PARAMETERS :

sysn : A Scilab string which gives the name of the controlled system.
gaincom,gainobs : column vectors giving the requested gains
macr : a new Scilab function which simulates the controlled observed system.

[x1dot]=macr(t,x1,abruit,pas,n)
x1=[x;xchap],

DESCRIPTION :
This macros return a new function which computes the controlled observed version of a linearised system
around the (xe,ue) point.
before calling this function, a noise vector br should be created. the equilibrium point (xe,ue)
should be given as a global Scilab. the linearised system $f,g,h$ and the two gain matrices l,k are returned
as global Scilab data.

2.4.10 portr3d 3 dimensional phase portrait.

CALLING SEQUENCE :

[]=portr3d(f,[odem,xdim,npts,pinit])

PARAMETERS :

f : a Scilab external which gives the field of the dynamical system. Hence it can be a macro name which
computes the field at time t and point x [y]=f(t,x,[u]) or a list list(f1,u1) where f1 is a macro of type
[y]=f1(t,x,u) or a character string
rest : The other parameters are optional. If omitted they will be asked interactively
odem : gives the integration method to use. The value ”default” can be used, otherwise see ode for a
complete set of possibilities
npts : a vector of size (2,10) [number-of-points,step] gives the step for integration and the number of re-
quested points. The solution will be calculated and drawn for time=0:step:(step*[number-of-points])
xdim : [xmin,xmax,ymin,ymax,zmin,zmax] the boundaries of the graphic frame.
pinit : initial values for integration. A set of initial points can be given in a matrix

pinit = [x0(1), x1(1),...., xn(1)

x0(2), x1(2),...., xn(2)
x0(3), x1(3),...., xn(3)].

DESCRIPTION :
Interactive integration and display of a 3 dimensional phase portrait of a dynamical system dx/dt=f(t,x,[u])
(where u is an optional parameter )
S EE A LSO : ode 431

Scilab Group April 1993 405

systems Scilab Function

2.4.11 portrait 2 dimensional phase portrait.

CALLING SEQUENCE :

[]=portrait(f,[odem,xdim,npts,pinit])

PARAMETERS :

f : a Scilab external which gives the field of the dynamical system. Hence it can be a macro name which
computes the field at time t and point x [y]=f(t,x,[u]) or a list list(f1,u1) where f1 is a macro of type
[y]=f1(t,x,u) or a character string. The macro can be used to simulate a continuous or discrete system
and in case of discrete system the second parameter must be set to ’discrete’
rest : The other parameters are optional. If omitted they will be asked interactively
odem : gives the integration method to use. The value ”default” can be used, otherwise see ode for a
complete set of possibilities
npts : a vector of size (2,10) [number-of-points,step] gives the step for integration and the number of re-
quested points. The solution will be calculated and drawn for time=0:step:(step*[number-of-points])
xdim : [xmin,xmax,ymin,ymax,zmin,zmax] the boundaries of the graphic frame.
pinit : initial values for integration. A set of initial points can be given in a matrix

pinit = [x0(1), x1(1),...., xn(1)

x0(2), x1(2),...., xn(2)
x0(3), x1(3),...., xn(3)].

DESCRIPTION :
Interactive integration and display of a 2 dimensional phase portrait of a dynamical system dx/dt=f(t,x,[u])
(where u is an optional parameter )
EXAMPLE :

a=rand(2,2)
deff(’[ydot]=l_s(t,y)’,’ydot=a*y’)
portrait(l_s)

S EE A LSO : ode 431

2.4.12 recur a bilinear recurrent equation

CALLING SEQUENCE :

[y]=recur(x0,var,k,n)
[integr]=logr(k,var)

DESCRIPTION :
computes solutions of a bilinear recurrent equation

x(i+1)=-x(i)*(k + sqrt(var)*br(i))

with initial value x0 and driven by a white noise of variance var.

Trajectories are drawn and the empirical Lyapunov exponent is returned ( x(i) is not to much different
from exp(y*i) )
A theoretical computation of the Lyapunov exponent is given by

[integr]=logr(k,var)

Scilab Group April 1993 406

systems Scilab Function

2.4.13 systems a collection of dynamical system

CALLING SEQUENCE :

[]=systems()

DESCRIPTION :
A call to this function will load into Scilab a set of macros which describes dynamical systems. Their
parameters can be initiated by calling the routine tdinit().
BIOREACT :

[ydot]=biorecat(t,x)
a bioreactor model,
x(1) is the biomass concentration
x(2) is the sugar concentration

xdot(1)=mu_td(x(2))*x(1)- debit*x(1);
xdot(2)=-k*mu_td(x(2))*x(1)-debit*x(2)+debit*x2in;

where mu td is given by

mu_td(x)=x/(1+x);

COMPET :

[xdot]=compet(t,x [,u])
a competition model. x(1),x(2) stands for two populations which grows on a same resource. 1/u
is the level of that resource ( 1 is the default value).
xdot=0*ones(2,1);
xdot(1) = ppr*x(1)*(1-x(1)/ppk) - u*ppa*x(1)*x(2) ,
xdot(2) = pps*x(2)*(1-x(2)/ppl) - u*ppb*x(1)*x(2) ,

The macro [xe]=equilcom(ue) computes an equilibrium point of the competition model and a fixed
level of the resource ue ( default value is 1)
The macro [f,g,h,linsy]=lincomp([ue]) gives the linearisation of the competition model ( with
output y=x) around the equilibrium point xe=equilcom(ue). This macro returns [f,g,h] the three
matrices of the linearised system. and linsy which is a Scilab macro [ydot]=linsy(t,x) which computes
the dynamics of the linearised system

CYCLLIM :

[xdot]=cycllim(t,x)
a model with a limit cycle
xdot=a*x+qeps(1-||x||**2)x

LINEAR :

[xdot]=linear(t,x)
a linear system
BLINPER :

[xdot]=linper(t,x)

Scilab Group April 1993 407

tdinit Scilab Function

a linear system with quadratic perturbations.

POP :

[xdot]=pop(t,x)

a fish population model

xdot= 10*x*(1-x/K)- peche(t)*x

PROIE :
a Predator prey model with external insecticide.

[xdot]=p_p(t,x,[u]

x(1) The prey ( that we want to kill )

x(2) the predator ( that we want to preserve )
u mortality rate due to insecticide which destroys both prey and predator ( default value u=0)

xdot(1) = ppr*x(1)*(1-x(1)/ppk) - ppa*x(1)*x(2) - u*x(1);

xdot(2) = -ppm*x(2) + ppb*x(1)*x(2) - u*x(2);

The macro [xe]=equilpp([ue]) computes the equilibrium point of the p p system for the
value ue of the command. The default value for ue is 0.

xe(1) = (ppm+ue)/ppb;
xe(2) = (ppr*(1-xe(1)/ppk)-ue)/ppa;

LINCOM :

[xdot]=lincom(t,x,k)

linear system with a feedback

xdot= a*x +b*(-k*x)

S EE A LSO : tdinit 409

2.4.14 tangent linearization of a dynamical system at an equilibrium point

CALLING SEQUENCE :

[f,g,newm]=tangent(ff,xe,[ue])

PARAMETERS :

ff : a string which gives the name of the Scilab macro which codes the system
xe : column vector which gives the equilibrium point for the value ue of the parameter
ue : real value.
f, g : two matrices for the linearised system dxdot=f.dx + g.du
newm : A new macro of type [y]=newm(t,x,u) which computes the field of the linearised system (newm(t,xe,ue)=0)

DESCRIPTION :
linearises around the equilibrium point (xe,ue) the vector field of the dynamical system given by a
Scilab macro ff, xdot=ff(t,x,[u]). The dynamical system is supposed to be autonomous.

Scilab Group April 1993 408

tdinit Scilab Function

2.4.15 tdinit interactive initialisation of the tdcs dynamical systems

CALLING SEQUENCE :

tdinit()

DESCRIPTION :
This macro can be used to interactively define the parameters needed by the dynamical systems described
in systems

bioreactor model
competition model
system with limit cycle
linear system
quadratic model
linear system with a feedback

S EE A LSO : portrait 406, systems 407

Scilab Group April 1993 409

tdinit Scilab Function

2.5 Non-linear tools (optimization and simulation)

Scilab Group April 1993 410

 bvode Scilab Function

2.5.1 bvode boundary value problems for ODE

prey predatory model

CALLING SEQUENCE :

[z]=bvode(points,ncomp,m,aleft,aright,zeta,ipar,ltol,tol,fixpnt,...
fsub1,dfsub1,gsub1,dgsub1,guess1)

PARAMETERS :

z The solution of the ode evaluated on the mesh given by points

points an array which gives the points for which we want the solution
ncomp number of differential equations (ncomp <= 20)
m a vector of size ncomp. m(j) gives the order of the j-th differential equation
ncomp
X
mstar = m(i)  40
i=1

aleft left end of interval

aright right end of interval
zeta zeta(j) gives j-th side condition point (boundary point). must have zeta(j )  zeta(j + 1).
all side condition points must be mesh points in all meshes used, see description of ipar(11) and
fixpnt below.
ipar an integer array dimensioned at least 11. a list of the parameters in ipar and their meaning follows
some parameters are renamed in bvode; these new names are given in parentheses.
ipar(1) ( = nonlin )
= 0 if the problem is linear

= 1 if the problem is nonlinear ipar(2) = number of collocation points per subinterval (= k

) where max m(i)  k  7. if ipar(2)=0 then bvode sets k = max(max m(i) + 1; 5 max m(i))
ipar(3) = number of subintervals in the initial mesh ( = n ). if ipar(3) = 0 then bvode arbitrarily
sets n = 5.
ipar(4) = number of solution and derivative tolerances. ( = ntol ) we require 0 < ntol < mstar:
ipar(5) = dimension of fspace ( = ndimf ) a real work array. its size provides a constraint on nmax.
choose ipar(5) according to the formula

ipar(5)  nmaxns where ns = 4 + 3mstar + (5 + kd )kd m + (2mstar nrec)2mstar

ipar(6) = dimension of ispace ( = ndimi )an integer work array. its size provides a constraint on nmax,
the maximum number of subintervals. choose ipar(6) according to the formula

ipar(6)  nmaxni whereni = 3 + kd m kd m = kd + mstar kd = k ncomp

ipar(7) output control ( = iprint )
= -1 for full diagnostic printout
= 0 for selected printout
= 1 for no printout
ipar(8) ( = iread )
= 0 causes bvode to generate a uniform initial mesh.
= xx Other values are not implemented yet in Scilab
= 1 if the initial mesh is provided by the user. it is defined in fspace as follows: the mesh

aleft = x(1) < x(2) < : : : < x(n) < x(n + 1) = aright

will occupy fspace(1), ..., fspace(n+1). the user needs to supply only the interior mesh
points fspace(j) = x(j), j = 2, ..., n.

Scilab Group June 1993 411

bvode Scilab Function

= 2 if the initial mesh is supplied by the user as with ipar(8)=1, and in addi-
tion no adaptive mesh selection is to be done.
ipar(9) ( = iguess )
= 0 if no initial guess for the solution is provided.
= 1 if an initial guess is provided by the user in subroutine guess.
= 2 if an initial mesh and approximate solution coefficients are provided by the user in fspace. (the
former and new mesh are the same).
= 3 if a former mesh and approximate solution coefficients are provided by the user in fspace, and the
new mesh is to be taken twice as coarse; i.e.,every second point from the former mesh.
= 4 if in addition to a former initial mesh and approximate solution coefficients, a new mesh is provided
in fspace as well. (see description of output for further details on iguess = 2, 3, and 4.)

= 0 if the problem is regular

ipar(10)
= 1 if the first relax factor is =rstart, and the nonlinear iteration does not rely on past covergence (use for
an extra sensitive nonlinear problem only).
= 2 if we are to return immediately upon (a) two successive nonconvergences, or (b) after obtaining error
estimate for the first time.
ipar(11) = number of fixed points in the mesh other than aleft and aright. ( = nfxpnt , the dimen-
sion of fixpnt) the code requires that all side condition points other than aleft and aright
(see description of zeta ) be included as fixed points in fixpnt.
ltol an array of dimension ipar(4). ltol(j) = l specifies that the j-th tolerance in tol controls
the error in the l-th component of z(u). also require that
1  ltol(1) < ltol(2) < ::: < ltol(ntol)  mstar
tol an array of dimension ipar(4). tol(j) is the error tolerance on the ltol(j) -th component
of z(u). thus, the code attempts to satisfy for j=1,...,ntol on each subinterval
jz (v) z (u)jltol(j )  tol(j )  jz (u)jltol(j ) + tol(j )
if v(x) is the approximate solution vector.
fixpnt an array of dimension ipar(11). it contains the points, other than aleft and aright,
which are to be included in every mesh.
externals The function fsub,dfsub,gsub,dgsub,guess are Scilab externals i.e. functions
(see syntax below) or the name of a Fortran subroutine (character string) with specified calling se-
quence or a list. An external as a character string refers to the name of a Fortran subroutine. The
Fortran coded function interface to bvode are specified in the file fcol.f.
fsub name of subroutine for evaluating
f (x; z (u(x))) = (f1 ; : : : ; fncomp )t
at a point x in (aleft,aright). it should have the heading [f]=fsub(x,z) where f is the
vector containing the value of fi(x,z(u)) in the i-th component and
z (u(x)) = (z1 ; : : : ; zmstar )t
is defined as above under purpose .
dfsub name of subroutine for evaluating the Jacobian of f(x,z(u)) at a point x. it should have the
heading [df]=dfsub (x , z ) where z(u(x)) is defined as for fsub and the (ncomp)
by (mstar) array df should be filled by the partial derivatives of f, viz, for a particular call one
calculates
df (i; j ) = dfi =dzj ; i = 1; : : : ; ncomp j = 1; : : : ; mstar:
gsub name of subroutine for evaluating the i-th component of
g (x; z (u(x))) = gi (zeta(i); z (u(zeta(i))))
at a point x = zeta(i) where 1  i  mstar: it should have the heading[g]=gsub (i ,
z) where z(u) is as for fsub, and i and g=gi are as above. note that in contrast to f in fsub , here
only one value per call is returned in g.

Scilab Group June 1993 412

bvode Scilab Function

dgsub name of subroutine for evaluating the i-th row of the Jacobian of g(x,u(x)). it should have the
heading [dg]=dgsub (i , z ) where z(u) is as for fsub, i as for gsub and the mstar-vector
dg should be filled with the partial derivatives of g, viz, for a particular call one calculates

dg (i; j ) = dgi =dzj ; j = 1; : : : ; mstar:

guess name of subroutine to evaluate the initial approximation for z(u(x)) and for dmval(u(x))=
vector of the mj-th derivatives of u(x). it should have the heading [z,dmval]= guess (x )
note that this subroutine is used only if ipar(9) = 1, and then all mstar components of z and
ncomp components of dmval should be specified for any x, aleft  x  aright:

DESCRIPTION :
this package solves a multi-point boundary value problem for a mixed order system of ode-s given by

u(i m(i)) = f (x; z (u(x))) i = 1; : : : ; ncomp aleft < x < aright

ncomp
X
gj (zeta(j ); z (u(zeta(j )))) = 0 j = 1; : : : ; mstar mstar = m(i)
i=1
(m(i))
where u = (u1 ; u2 ; : : : ; uncomp )t is the exact solution vector u i is the mi=m(i) th derivative of
ui .
(m1 (mncomp 1)
z (u(x)) = (u1 (x); u(1)
1 (x); : : : ; u1
1)
(x); : : : ; uncomp (x))

fi (x; z (u)) is a (generally) nonlinear function of z (u) = z (u(x)). g j (zeta(j ); z (u)) is a (generally)
nonlinear function used to represent a boundary condition. the boundary points satisfy

aleft  zeta(1)  : : :  zeta(mstar)  aright

the orders mi of the differential equations satisfy 1  m(i)  4.

EXAMPLE :

deff(’df=dfsub(x,z)’,’df=[0,0,-6/x**2,-6/x]’)
deff(’f=fsub(x,z)’,’f=(1 -6*x**2*z(4)-6*x*z(3))/x**3’)
deff(’g=gsub(i,z)’,’g=[z(1),z(3),z(1),z(3)];g=g(i)’)
deff(’dg=dgsub(i,z)’,[’dg=[1,0,0,0;0,0,1,0;1,0,0,0;0,0,1,0]’;
’dg=dg(i,:)’])
deff(’[z,mpar]=guess(x)’,’z=0;mpar=0’)// unused here

deff(’u=trusol(x)’,[ //for testing purposes

’u=0*ones(4,1)’;
’u(1) = 0.25*(10*log(2)-3)*(1-x) + 0.5 *( 1/x + (3+x)*log(x) - x)’
’u(2) = -0.25*(10*log(2)-3) + 0.5 *(-1/xˆ2 + (3+x)/x + log(x)
- 1)’
’u(3) = 0.5*( 2/xˆ3 + 1/x - 3/xˆ2)’
’u(4) = 0.5*(-6/xˆ4 - 1/x/x + 6/xˆ3)’])

fixpnt=0;m=4;
ncomp=1;aleft=1;aright=2;
zeta=[1,1,2,2];
ipar=zeros(1,11);
ipar(3)=1;ipar(4)=2;ipar(5)=2000;ipar(6)=200;ipar(7)=1;
ltol=[1,3];tol=[1.e-11,1.e-11];
res=aleft:0.1:aright;
z=bvode(res,ncomp,m,aleft,aright,zeta,ipar,ltol,tol,fixpnt,...
fsub,dfsub,gsub,dgsub,guess)

Scilab Group June 1993 413

dasrt Scilab Function

z1=[];for x=res,z1=[z1,trusol(x)]; end;

z-z1

AUTHOR : u. ascher, department of computer science, university of british columbia, vancouver, b. c.,
canada v6t 1w5
g. bader, institut f. angewandte mathematik university of heidelberg im neuenheimer feld 294d-6900
heidelberg 1
Fotran subroutine colnew.f
S EE A LSO : fort 43, link 303, external 38, ode 431, dassl 416

2.5.2 colnew boundary value problems for ODE

CALLING SEQUENCE :
This function has been renamed bvode.

2.5.3 dasrt DAE solver with zero crossing

CALLING SEQUENCE :

[r,nn,[,hd]]=dasrt(x0,t0,t [,atol,[rtol]],res [,jac],ng, surf [,info] [,hd])

PARAMETERS :

x0 : is either y0 (ydot0 is estimated by dassl with zero as first estimate) or the matrix [y0
ydot0]. g(t,y0,ydot0) must be equal to zero. If you only know an estimate of ydot0 set
info(7)=1
y0 : real column vector of initial conditions.
ydot0 : real column vector of the time derivative of y at t0 (may be an estimate).
t0 : real number is the initial instant.
t : real scalar or vector. Gives instants for which you want the solution. Note that you can get solution at
each dassl’s step point by setting info(2)=1.
nn : a vector with two entries [times num] times is the value of the time at which the surface is
crossed, num is the number of the crossed surface
atol,rtol : real scalars or column vectors of same size as y. atol,rtol give respectively absolute
and relative error tolerances of solution. If vectors the tolerances are specified for each component of
y.
res : external (function or list or string). Computes the value of g(t,y,ydot).
function : Its calling sequence must be [r,ires]=res(t,y,ydot) and res must return the
residue r=g(t,y,ydot) and error flag ires. ires = 0 if res succeeds to compute r, =-1
if residue is locally not defined for (t,y,ydot), =-2 if parameters are out of admissible range.
list : it must be as follows:

list(res,x1,x2,...)

where the calling sequence of the function res is now

r=res(t,y,ydot,x1,x2,...)

res still returns r=g(t,y,ydot) as a function of (t,y,ydot,x1,x2,...).

string : it must refer to the name of a fortran subroutine (see source code of fresd.f).
jac : external (function or list or string). Computes the value of dg/dy+cj*dg/dydot for a given
value of parameter cj

Scilab Group June 1993 414

dasrt Scilab Function

function : Its calling sequence must be r=jac(t,y,ydot,cj) and the jac function must return
r=dg(t,y,ydot)/dy+cj*dg(t,y,ydot)/dydot where cj is a real scalar
list : it must be as follows

list(jac,x1,x2,...)

where the calling sequence of the function jac is now

r=jac(t,y,ydot,x1,x2,...)

jac still returns dg/dy+cj*dg/dydot as a function of (t,y,ydot,cj,x1,x2,...).

character string : it must refer to the name of a fortran subroutine (see source code of jacdd.f).
surf : external (function or list or string). Computes the value of the column vector surf(t,y) with
ng components. Each component defines a surface.
function : Its calling sequence must be surf(t,y)
list : it must be as follows

list(surf,x1,x2,...)

where the calling sequence of the function surf is now

r=surf(t,y,x1,x2,...)
character string : it must refer to the name of a fortran subroutine (see source code of fsurfd.f)
in directory SCDIR/default
info : list which contains 7 elements, default value is list([],0,[],[],[],0,0)
info(1) : real scalar which gives the maximum time for which g is allowed to be evaluated or an empty
matrix [] if no limits imposed for time.
info(2) : flag which indicates if dassl returns its intermediate computed values (flag=1) or only
the user specified time point values (flag=0).
info(3) : 2 components vector which give the definition [ml,mu] of band matrix computed by jac;
r(i - j + ml + mu + 1,j) = "dg(i)/dy(j)+cj*dg(i)/dydot(j)". If jac re-
turns a full matrix set info(3)=[].
info(4) : real scalar which gives the maximum step size. Set info(4)=[] if no limitation.
info(5) : real scalar which gives the initial step size. Set info(4)=[] if not specified.
info(6) : set info(6)=1 if the solution is known to be non negative, else set info(6)=0.
info(7) : set info(7)=1 if ydot0 is just an estimation, info(7)=0 if g(t0,y0,ydot0)=0.
hd : real vector which allows to store the dassl context and to resume integration
r : real matrix . Each column is the vector [t;x(t);xdot(t)] where t is time index for which the solution had
been computed

DESCRIPTION :
Solution of the implicit differential equation
g(t,y,ydot)=0
y(t0)=y0 and ydot(t0)=ydot0
Returns the surface crossing instants and the number of the surface reached in nn.
Detailed examples can be found in SCIDIR/tests/dassldasrt.tst
EXAMPLE :

//dy/dt = ((2*log(y)+8)/t -5)*y, y(1) = 1, 1<=t<=6

//g1 = ((2*log(y)+8)/t - 5)*y
//g2 = log(y) - 2.2491
y0=1;t=2:6;t0=1;y0d=3;
atol=1.d-6;rtol=0;ng=2;

Scilab Group June 1993 415

dassl Scilab Function

deff(’[delta,ires]=res1(t,y,ydot)’,’ires=0;delta=ydot-((2*log(y)+8)/t-5)*y’)
deff(’[rts]=gr1(t,y)’,’rts=[((2*log(y)+8)/t-5)*y;log(y)-2.2491]’)

[yy,nn]=dasrt([y0,y0d],t0,t,atol,rtol,res1,ng,gr1);
//(Should return nn=[2.4698972 2])

S EE A LSO : ode 431, dassl 416, impl 421, fort 43, link 303, external 38

2.5.4 dassl differential algebraic equation

CALLING SEQUENCE :

[r [,hd]]=dassl(x0,t0,t [,atol,[rtol]],res [,jac] [,info] [,hd])

PARAMETERS :

x0 : is either y0 (ydot0 is estimated by dassl with zero as first estimate) or the matrix [y0
ydot0]. g(t,y0,ydot0) must be equal to zero. If you only know an estimate of ydot0 set
info(7)=1
y0 : real column vector of initial conditions.
ydot0 : real column vector of the time derivative of y at t0 (may be an estimate).
t0 : real number is the initial instant.
t : real scalar or vector. Gives instants for which you want the solution. Note that you can get solution at
each dassl’s step point by setting info(2)=1.
atol,rtol : real scalars or column vectors of same size as y. atol,rtol give respectively absolute
and relative error tolerances of solution. If vectors the tolerances are specified for each component of
y.
res : external (function or list or string). Computes the value of g(t,y,ydot).
function : Its calling sequence must be [r,ires]=res(t,y,ydot) and res must return the
residue r=g(t,y,ydot) and error flag ires. ires = 0 if res succeeds to compute r, =-1
if residue is locally not defined for (t,y,ydot), =-2 if parameters are out of admissible range.
list : it must be as follows:

list(res,x1,x2,...)

where the calling sequence of the function res is now

r=res(t,y,ydot,x1,x2,...)

res still returns r=g(t,y,ydot) as a function of (t,y,ydot,x1,x2,...).

string : it must refer to the name of a fortran subroutine (see source code of of Ex-dassl.f in
routines/defaut/).
jac : external (function or list or string). Computes the value of dg/dy+cj*dg/dydot for a given
value of parameter cj
function : Its calling sequence must be r=jac(t,y,ydot,cj) and the jac function must return
r=dg(t,y,ydot)/dy+cj*dg(t,y,ydot)/dydot where cj is a real scalar
list : it must be as follows

list(jac,x1,x2,...)

where the calling sequence of the function jac is now

r=jac(t,y,ydot,x1,x2,...)

jac still returns dg/dy+cj*dg/dydot as a function of (t,y,ydot,cj,x1,x2,...).

Scilab Group June 1993 416

datafit Scilab Function

character string : it must refer to the name of a fortran subroutine (see source code of Ex-dassl.f
in routines/defaut/).
info : list which contains 7 elements, default value is list([],0,[],[],[],0,0);
info(1) : real scalar which gives the maximum time for which g is allowed to be evaluated or an empty
matrix [] if no limits imposed for time.
info(2) : flag which indicates if dassl returns its intermediate computed values (flag=1) or only
the user specified time point values (flag=0).
info(3) : 2 components vector which give the definition [ml,mu] of band matrix computed by jac;
r(i - j + ml + mu + 1,j) = "dg(i)/dy(j)+cj*dg(i)/dydot(j)". If jac re-
turns a full matrix set info(3)=[].
info(4) : real scalar which gives the maximum step size. Set info(4)=[] if no limitation.
info(5) : real scalar which gives the initial step size. Set info(4)=[] if not specified.
info(6) : set info(6)=1 if the solution is known to be non negative, else set info(6)=0.
info(7) : set info(7)=1 if ydot0 is just an estimation, info(7)=0 if g(t0,y0,ydot0)=0.
hd : real vector which allows to store the dassl context and to resume integration
r : real matrix . Each column is the vector [t;x(t);xdot(t)] where t is time index for which the solution had
been computed

DESCRIPTION :
Solution of the implicit differential equation

g(t,y,ydot)=0
y(t0)=y0 and ydot(t0)=ydot0

Detailed examples are given in SCIDIR/tests/dassldasrt.tst

EXAMPLES :

deff(’[r,ires]=chemres(t,y,yd)’,[
’r(1)=-0.04*y(1)+1d4*y(2)*y(3)-yd(1);’;
’r(2)=0.04*y(1)-1d4*y(2)*y(3)-3d7*y(2)*y(2)-yd(2);’
’r(3)=y(1)+y(2)+y(3)-1;’
’ires=0’]);
deff(’[pd]=chemjac(x,y,yd,cj)’,[
’pd=[-0.04-cj , 1d4*y(3) , 1d4*y(2);’;
’0.04 ,-1d4*y(3)-2*3d7*y(2)-cj ,-1d4*y(2);’;
’1 , 1 , 1 ]’])

y0=[1;0;0];
yd0=[-0.04;0.04;0];
t=[1.d-5:0.02:.4,0.41:.1:4,40,400,4000,40000,4d5,4d6,4d7,4d8,4d9,4d10];

y=dassl([y0,yd0],0,t,chemres);

info=list([],0,[],[],[],0,0);
info(2)=1;
y=dassl([y0,yd0],0,4d10,chemres,info);
y=dassl([y0,yd0],0,4d10,chemres,chemjac,info);

S EE A LSO : ode 431, dasrt 414, impl 421, fort 43, link 303, external 38

2.5.5 datafit Parameter identification based on measured data

CALLING SEQUENCE :

Scilab Group Feb 1999 417

datafit Scilab Function

[p,err]=datafit([imp,] G [,DG],Z [,W],[contr],p0,[algo],[df0,[mem]],

[work],[stop],[’in’])

PARAMETERS :

imp : scalar argument used to set the trace mode. imp=0 nothing (execpt errors) is reported, imp=1
initial and final reports, imp=2 adds a report per iteration, imp>2 add reports on linear search.
Warning, most of these reports are written on the Scilab standard output.
G : function descriptor (e=G(p,z), e: ne x 1, p: np x 1, z: nz x 1)
DG : partial of G wrt p function descriptor (optional; S=DG(p,z), S: ne x np)
Z : matrix [z 1,z 2,...z n] where z i (nz x 1) is the ith measurement
W : weighting matrix of size ne x ne (optional; defaut no ponderation)
contr : ’b’,binf,bsup with binf and bsup real vectors with same dimension as p0. binf
and bsup are lower and upper bounds on p.
p0 : initial guess (size np x 1)
algo : ’qn’ or ’gc’ or ’nd’ . This string stands for quasi-Newton (default), conjugate gradient or
non-differentiable respectively. Note that ’nd’ does not accept bounds on x ).
df0 : real scalar. Guessed decreasing of f at first iteration. (df0=1 is the default value).
mem : integer, number of variables used to approximate the Hessian, (algo=’gc’ or ’nd’). Default
value is around 6.
stop : sequence of optional parameters controlling the convergence of the algorithm. stop= ’ar’,nap,
[iter [,epsg [,epsf [,epsx]]]]
"ar" : reserved keyword for stopping rule selection defined as follows:
nap : maximum number of calls to fun allowed.
iter : maximum number of iterations allowed.
epsg : threshold on gradient norm.
epsf : threshold controlling decreasing of f
epsx : threshold controlling variation of x. This vector (possibly matrix) of same size as x0 can be
used to scale x.
"in" : reserved keyword for initialization of parameters used when fun in given as a Fortran routine
(see below).
p : Column vector, optimal solution found
err : scalar, least square error.

DESCRIPTION :
datafit is used for fitting data to a model. For a given function G(p,z), this function finds the best vec-
tor of parameters p for approximating G(p,z i)=0 for a set of measurement vectors z i. Vector p is
found by minimizing G(p,z 1)’WG(p,z 1)+G(p,z 2)’WG(p,z 2)+...+G(p,z n)’WG(p,z n)
datafit is an improved version of fit dat.
EXAMPLE :

deff(’y=FF(x)’,’y=a*(x-b)+c*x.*x’)
X=[];Y=[];
a=34;b=12;c=14;for x=0:.1:3, Y=[Y,FF(x)+100*(rand()-.5)];X=[X,x];end
Z=[Y;X];
deff(’e=G(p,z)’,’a=p(1),b=p(2),c=p(3),y=z(1),x=z(2),e=y-FF(x)’)
[p,err]=datafit(G,Z,[3;5;10])

xset(’window’,0)
xbasc();
plot2d(X’,Y’,-1)
plot2d(X’,FF(X)’,5,’002’)
a=p(1),b=p(2),c=p(3);plot2d(X’,FF(X)’,12,’002’)
//same probleme with a known
deff(’e=G(p,z,a)’,’b=p(1),c=p(2),y=z(1),x=z(2),e=y-FF(x)’)
[p,err]=datafit(list(G,a),Z,[5;10])

Scilab Group Feb 1999 418

fit dat Scilab Function

a=34;b=12;c=14;
deff(’s=DG(p,z)’,’y=z(1),x=z(2),s=-[x-p(2),-p(1),x*x]’)
[p,err]=datafit(G,DG,Z,[3;5;10])
xset(’window’,1)
xbasc();
plot2d(X’,Y’,-1)
plot2d(X’,FF(X)’,5,’002’)
a=p(1),b=p(2),c=p(3);plot2d(X’,FF(X)’,12,’002’)

S EE A LSO : optim 438, leastsq 427

2.5.6 derivative- derivative

CALLING SEQUENCE :

J=derivative(f,x0,h)
[J,J2]=derivative(f,x0,h)

PARAMETERS :

f : Scilab function f: Rˆn --> Rˆp

x0 : real column vector (of dimension n)
h : (small) positive real number (default is 1.d-7)
J : real p x n Jacobian matrix
J2 : real p x (p*n) matrix

DESCRIPTION :
Approximate derivatives of a function f: Rˆn --> Rˆp.
f(x) = f(x0) + D1f(x0) *dx + 1/2* D2f(x0) *(dx.*.dx) +...
J = D1f(x0) ; J2=D2f(x0)
Derivatives are evaluated by finite difference:f i(x+h)-f i(x))/h. Caution: h should be carefully chosen...

EXAMPLE :

deff(’y=f(x)’,’y=[sin(x(1))*cos(x(2));x(1)ˆ2*x(2)ˆ2;1+x(1)*x(2)ˆ2]’)
x0=[1;2];eps=0.001;h=eps*[2;5];
[J,J2]=derivative(f,x0);
[f(x0+h)-f(x0)-J*h ,0.5*J2*(h.*.h)]

S EE A LSO : mtlb_diff ??, derivat 487

2.5.7 fit dat Parameter identification based on measured data

CALLING SEQUENCE :

[p,err]=fit_dat(G,p0,Z [,W] [,pmin,pmax] [,DG])

PARAMETERS :

G : Scilab function (e=G(p,z), e: nex1, p: npx1, z: nzx1)

p0 : initial guess (size npx1)
Z : matrix [z 1,z 2,...z n] where z i (nzx1) is the ith measurement

Scilab Group Feb 1998 419

fsolve Scilab Function

W : weighting matrix of size nexne (optional; default 1)

pmin : lower bound on p (optional; size npx1)
pmax : upper bound on p (optional; size npx1)
DG : partial of G wrt p (optional; S=DG(p,z), S: nexnp)

DESCRIPTION :
fit dat is used for fitting data to a model. For a given function G(p,z), this function finds the best vector
of parameters p for approximating G(p,z i)=0 for a set of measurement vectors z i. Vector p is found by
minimizing G(p,z 1)’WG(p,z 1)+G(p,z 2)’WG(p,z 2)+...+G(p,z n)’WG(p,z n)
EXAMPLE :

deff(’y=FF(x)’,’y=a*(x-b)+c*x.*x’)
X=[];Y=[];
a=34;b=12;c=14;for x=0:.1:3, Y=[Y,FF(x)+100*(rand()-.5)];X=[X,x];end
Z=[Y;X];
deff(’e=G(p,z)’,’a=p(1),b=p(2),c=p(3),y=z(1),x=z(2),e=y-FF(x)’)
[p,err]=fit_dat(G,[3;5;10],Z)
xset(’window’,0)
xbasc();
plot2d(X’,Y’,-1)
plot2d(X’,FF(X)’,5,’002’)
a=p(1),b=p(2),c=p(3);plot2d(X’,FF(X)’,12,’002’)

a=34;b=12;c=14;
deff(’s=DG(p,z)’,’y=z(1),x=z(2),s=-[x-p(2),-p(1),x*x]’)
[p,err]=fit_dat(G,[3;5;10],Z,DG)
xset(’window’,1)
xbasc();
plot2d(X’,Y’,-1)
plot2d(X’,FF(X)’,5,’002’)
a=p(1),b=p(2),c=p(3);plot2d(X’,FF(X)’,12,’002’)

S EE A LSO : optim 438, datafit 417

2.5.8 fsolve find a zero of a system of n nonlinear functions

CALLING SEQUENCE :

[x [,v [,info]]]=fsolve(x0,fct [,fjac] [,tol])

PARAMETERS :

x0 : real vector (initial value of function argument).

fct : external (i.e function or list or string).
fjac : external (i.e function or list or string).
tol : real scalar. precision tolerance: termination occurs when the algorithm estimates that the relative
error between x and the solution is at most tol. (tol=1.d-10 is the default value).
x : real vector (final value of function argument, estimated zero).
v : real vector (value of function at x).
info : termination indicator
0 : improper input parameters.
1 : algorithm estimates that the relative error between x and the solution is at most tol.
2 : number of calls to fcn reached
3 : tol is too small. No further improvement in the approximate solution x is possible.

Scilab Group August 1993 420

impl Scilab Function

4 : iteration is not making good progress.

DESCRIPTION :
find a zero of a system of n nonlinear functions in n variables by a modification of the powell hybrid
method. Jacobian may be provided.
0 = fct(x) w.r.t x.
fct is an ”external”. This external returns v=fct(x) given x.
The simplest calling sequence for fct is:
[v]=fct(x).
If fct is a character string, it refers to a C or Fortran routine which must be linked to Scilab. Fortran
calling sequence must be
fct(n,x,v,iflag)
integer n,iflag
double precision x(n),v(n)
and C Calling sequence must be
fct(int *n, double x[],double v[],int *iflag)
Incremental link is possible (help link).
jac is an ”external”. This external returns v=d(fct)/dx (x) given x.
The simplest calling sequence for jac is:
[v]=jac(x).
If jac is a character string, it refers to a to a C or Fortran routine which must be linked to Scilab calling
sequences are the same as those for fct. Note however that v must be a nxn array.
EXAMPLES :

// A simple example with fsolve

a=[1,7;2,8];b=[10;11];
deff(’[y]=fsol1(x)’,’y=a*x+b’);
deff(’[y]=fsolj1(x)’,’y=a’);
[xres]=fsolve([100;100],fsol1);
a*xres+b
[xres]=fsolve([100;100],fsol1,fsolj1);
a*xres+b
// See routines/default/Ex-fsolve.f
[xres]=fsolve([100;100],’fsol1’,’fsolj1’,1.e-7);
a*xres+b

S EE A LSO : external 38, quapro 440, linpro 429, optim 438

2.5.9 impl differential algebraic equation

DESCRIPTION :

y=impl([type],y0,ydot0,t0,t [,atol, [rtol]],res,adda [,jac])

PARAMETERS :

y0,ydot0 : real vectors or matrix (initial conditions).

t0 : real scalar (initial time).

Scilab Group February 1998 421

int2d Scilab Function

t : real vector (times at which the solution is computed).

res,adda : externals (function or character string or list).
type : string ’adams’ or ’stiff’
atol,rtol : real scalar or real vector of the same size as as y.
jac : external (function or character string or list).

DESCRIPTION :
Solution of the linear implicit differential equation
A(t,y) dy/dt=g(t,y), y(t0)=y0
t0 is the initial instant, y0 is the vector of initial conditions Vector ydot0 of the time derivative of y
at t0 must also be given. r The input res is an external i.e. a function with specified syntax, or the name
a Fortran subroutine or a C function (character string) with specified calling sequence or a list.
If res is a function, its syntax must be as follows:
r = res(t,y,ydot)
where t is a real scalar (time) and y and ydot are real vector (state and derivative of the state). This
function must return r=g(t,y)-A(t,y)*ydot.
If res is a character string, it refers to the name of a Fortran subroutine or a C function. See SCIDIR/routines/default/
for an example to do that.
res can also be a list: see the help of ode.
The input adda is also an external.
If adda is a function, its syntax must be as follows:
r = adda(t,y,p)
and it must return r=A(t,y)+p where p is a matrix to be added to A(t,y).
If adda is a character string, it refers to the name of a Fortran subroutine or a C function. See
SCIDIR/routines/default/Ex-impl.f for an example to do that.
adda can also be a list: see the help of ode.
The input jac is also an external.
If adda is a function, its syntax must be as follows:
j = jac(t,y,ydot)
and it must return the Jacobian of r=g(t,y)-A(t,y)*ydot with respect to y.
If jac is a character string, it refers to the name of a Fortran subroutine or a C function. See SCIDIR/routines/default/
for an example to do that.
jac can also be a list: see the help of ode.
EXAMPLES :

y=impl([1;0;0],[-0.04;0.04;0],0,0.4,’resid’,’aplusp’);
// Using hot restart
//[x1,w,iw]=impl([1;0;0],[-0.04;0.04;0],0,0.2,’resid’,’aplusp’);
// hot start from previous call
//[x1]=impl([1;0;0],[-0.04;0.04;0],0.2,0.4,’resid’,’aplusp’,w,iw);
//maxi(abs(x1-x))

S EE A LSO : dassl 416, ode 431, external 38

2.5.10 int2d definite 2D integral by quadrature and cubature method

CALLING SEQUENCE :

[I,err]=int2d(X,Y,f [,params])

PARAMETERS :

Scilab Group April 1993 422

int3d Scilab Function

X : a 3 by N array containing the abscissae of the vertices of the N triangles.

Y : a 3 by N array containing the ordinates of the vertices of the N triangles.
f : external (function or list or string) defining the integrand f(u,v);
params : real vector [tol, iclose, maxtri, mevals, iflag]. default value is [1.d-10,
1, 50, 4000, 1].
tol :the desired bound on the error. If iflag=0, tol is interpreted as a bound on the relative error; if
iflag=1, the bound is on the absolute error.
iclose :an integer parameter that determines the selection of LQM0 or LQM1 methods. If iclose=1
then LQM1 is used. Any other value of iclose causes LQM0 to be used. LQM0 uses function
values only at interior points of the triangle. LQM1 is usually more accurate than LQM0 but involves
evaluating the integrand at more points including some on the boundary of the triangle. It will usually
be better to use LQM1 unless the integrand has singularities on the boundary of the triangle.
maxtri :the maximum number of triangles in the final triangulation of the region
mevals : the maximum number of function evaluations to be allowed. This number will be effective in
limiting the computation only if it is less than 94*maxtri when LQM1 is specified or 56*maxtri
when LQM0 is specified.
iflag :
I : the integral value
err : the estimated error

DESCRIPTION :
int2d computes the two-dimensional integral of a function f over a region consisting of n triangles.
A total error estimate is obtained and compared with a tolerance - tol - that is provided as input to the
subroutine. The error tolerance is treated as either relative or absolute depending on the input value of
iflag. A ’Local Quadrature Module’ is applied to each input triangle and estimates of the total integral
and the total error are computed. The local quadrature module is either subroutine LQM0 or subroutine
LQM1 and the choice between them is determined by the value of the input variable iclose.
If the total error estimate exceeds the tolerance, the triangle with the largest absolute error is divided
into two triangles by a median to its longest side. The local quadrature module is then applied to each of the
subtriangles to obtain new estimates of the integral and the error. This process is repeated until either (1)
the error tolerance is satisfied, (2) the number of triangles generated exceeds the input parameter maxtri,
(3) the number of integrand evaluations exceeds the input parameter mevals, or (4) the function senses
that roundoff error is beginning to contaminate the result.
EXAMPLES :

X=[0,0;1,1;1,0];
Y=[0,0;0,1;1,1];
deff(’z=f(x,y)’,’z=cos(x+y)’)
[I,e]=int2d(X,Y,f)
// computes the integrand over the square [0 1]x[0 1]

S EE A LSO : intc 425, intl 426, int3d 423, intg 425, mesh2d 569
REFERENCES :
Fortran routine twodq,Authors: Kahaner,D.K.,N.B.S., Rechard,O.W.,N.B.S., Barnhill,Robert,Univ. of
UTAH

2.5.11 int3d definite 3D integral by quadrature and cubature method

CALLING SEQUENCE :

[result,err]=int3d(X,Y,Z,f [,nf[,params]])

PARAMETERS :

X : a 4 by NUMTET array containing the abscissae of the vertices of the NUMTET tetrahedrons.

Scilab Group April 1993 423

int3d Scilab Function

Y : a 4 by NUMTET array containing the ordinates of the vertices of the NUMTET tetrahedrons.
Z : a 4 by NUMTET array containing the third coordinates of the vertices of the NUMTET tetrahedrons.
f : external (function or list or string) defining the integrand f(xyz,nf), where xyz is the vector of a
point coordinates and nf the number functions
nf : the number of function to integate (default is 1)
params : real vector [minpts, maxpts, epsabs, epsrel]. default value is [0, 1000, 0.0,
1.d-5].
epsabs : Desired bound on the absolute error.
epsrel : Desired bound on the relative error.
minpts : Minimum number of function evaluations.
maxpts : Maximum number of function evaluations. The number of function evaluations over each
subregion is 43
result : the integral value,or vector of the integral values.
err : Estimates of absolute errors.

DESCRIPTION :

The function calculates an approximation to a given vector of definite integrals

I I I (F ,F ,...,F ) dx(3)dx(2)dx(1),
1 2 numfun

where the region of integration is a collection of NUMTET tetrahedrons and where

F = F (X(1),X(2),X(3)), J = 1,2,...,NUMFUN.
J J

A globally adaptive strategy is applied in order to compute approximations result(k) hopefully sat-
isfying, for each component of I, the following claim for accuracy: ABS(I(K)-RESULT(K))<=MAX(EPSABS,EPSREL*ABS(
int3d repeatedly subdivides the tetrahedrons with greatest estimated errors and estimates the integrals
and the errors over the new subtetrahedrons until the error request is met or MAXPTS function evaluations
have been used.
A 43 point integration rule with all evaluation points inside the tetrahedron is applied. The rule has
polynomial degree 8.
If the values of the input parameters EPSABS or EPSREL are selected great enough, an integration
rule is applied over each tetrahedron and the results are added up to give the approximations RESULT(K).
No further subdivision of the tetrahedrons will then be applied.
When int3d computes estimates to a vector of integrals, all components of the vector are given the
same treatment. That is, I(Fj) and I(Fk) for
j not equal to k, are estimated with the same subdivision of the region of integration. For integrals
with enough similarity, we may save time by applying int3d to all integrands in one call. For integrals
that varies continuously as functions of some parameter, the estimates produced by int3d will also vary
continuously when the same subdivision is applied to all components. This will generally not be the case
when the different components are given separate treatment.
On the other hand this feature should be used with caution when the different components of the inte-
grals require clearly different subdivisions.
EXAMPLES :

X=[0;1;0;0];
Y=[0;0;1;0];
Z=[0;0;0;1];
deff(’v=f(xyz,numfun)’,’v=exp(xyz’’*xyz)’)
[RESULT,ERROR]=int3d(X,Y,Z,’int3dex’)
// computes the integrand exp(x*x+y*y+z*z) over the
//tetrahedron (0.,0.,0.),(1.,0.,0.),(0.,1.,0.),(0.,0.,1.)

Scilab Group April 1993 424

intg Scilab Function

S EE A LSO : intc 425, intl 426, int3d 423

REFERENCES :
Fortran routine dqtet.f
Authors:
Jarle Berntsen, The Computing Centre,
University of Bergen, Thormohlens gt. 55,
N-5008 Bergen, Norway
Phone.. 47-5-544055
Email.. jarle@eik.ii.uib.no

Ronald Cools, Dept. of Computer Science,

Katholieke Universiteit Leuven, Celestijnenlaan 200A,
B-3030 Heverlee, Belgium
Phone.. 32-16-201015 (3562)
Email.. ronald@cs.kuleuven.ac.be

Terje O. Espelid, Department of Informatics,

University of Bergen, Thormohlens gt. 55,
N-5008 Bergen, Norway
Phone.. 47-5-544180
Email.. terje@eik.ii.uib.no

2.5.12 intc Cauchy integral

CALING SEQUENCE :

[y]=intc(a,b,f)

PARAMETERS :

a,b : two complex numbers

f : ”external” function

DESCRIPTION :
If f is a complex-valued function, intc(a,b,f) computes the integral from a to b of f(z)dz
along the straight line a b of the complex plane.
S EE A LSO : intg 425, intl 426
AUTHOR : F. D.

2.5.13 intg definite integral

CALLING SEQUENCE :

[v,err]=intg(a,b,f [,ea [,er])

PARAMETERS :

a,b : real numbers

f : external (function or list or string)
ea, er : real numbers
ea : absolute error required on the result. Default value: 0
er : relative error required on the result. Default value: 1.d-8

Scilab Group April 1993 425

karmarkar Scilab Function

err : estimated absolute error on the result.

DESCRIPTION :
intg(a,b,f) evaluates the definite integral from a to b of f(t)dt. The evaluation hopefully satis-
fies following claim for accuracy: abs(I-v)<= max(ea,er*abs(I)) where I stands for the exact
value of the integral.
f is an external :
If f is function its definition must be as follows y = f(t)
If f is a list the list must be as follows: list(f,x1,x2,...) where f is a function with calling
sequence f(t,x1,x2,...).
If f is a string it refers to a the name of a Fortran subroutine (see source code of fintg.f)
EXAMPLE :

deff(’[y]=f(x)’,’y=x*sin(30*x)/sqrt(1-((x/(2*%pi))ˆ2))’)
exact=-2.5432596188;
abs(exact-intg(0,2*%pi,f))
// See file routines/default/Ex-intg.f
abs(exact-intg(0,2*%pi,’intgex’))

S EE A LSO : intc 425, intl 426, inttrap 192, intsplin 191, ode 431

2.5.14 intl Cauchy integral

CALLING SEQUENCE :

[y]=intl(a,b,z0,r,f)

PARAMETERS :

z0 : complex number
a,b : two real numbers
r : positive real number
f : ”external” function

DESCRIPTION :
If f is a complex-valued function, intl(a,b,z0,r,f) computes the integral of f(z)dz along the
curve in the complex plane defined by z0 + r.exp(%i*t) for a<=t<=b .(part of the circle with
center z0 and radius r with phase between a and b)
S EE A LSO : intc 425
AUTHOR : F. D.

2.5.15 karmarkar karmarkar algorithm

CALLING SEQUENCE :

[x1]=karmarkar(a,b,c,x0)

PARAMETERS :

a : matrix (n,p)
b : n - vector
c : p - vector
x0 : initial vector

Scilab Group April 1993 426

leastsq Scilab Function

eps : threshold (default value : 1.d-5)

gamma : descent step 0<gamma<1 , default value : 1/4
x1 : solution
crit : value of c’*x1

DESCRIPTION :
Computes x which minimizes

c’*x

under constraints:

a*x = b
x>=0

EXAMPLE :

// n=10;p=20;
// a=rand(n,p);c=rand(p,1);x0=abs(rand(p,1));b=a*x0;x1=karmarkar(a,b,c,x0);

2.5.16 leastsq Solves non-linear least squares problems

CALLING SEQUENCE :

[f,xopt]=leastsq([imp,] fun [,Dfun],x0)

[f,[xopt,[gradopt]]]=leastsq(fun [,Dfun],[contr],x0,[’algo’],[df0,[mem]],
,[stop],[’in’])

PARAMETERS :

imp : scalar argument used to set the trace mode. imp=0 nothing (execpt errors) is reported, imp=1
initial and final reports, imp=2 adds a report per iteration, imp>2 add reports on linear search.
Warning, most of these reports are written on the Scilab standard output.
fun : external, i.e Scilab function or string (fun is the function defining the least square probleme: see
below.
x0 : real vector (initial value of variable to be minimized).
f : value of optimal least square value.
xopt : best value of x found.
contr : ’b’,binf,bsup with binf and bsup real vectors with same dimension as x0. binf
and bsup are lower and upper bounds on x.
algo : A string with possible values :’qn’ or ’gc’ or ’nd’ . This string stands for quasi-Newton
(default), conjugate gradient or non-differentiable respectively. Note that ’nd’ does not accept
bounds on x ).
df0 : real scalar. Guessed decreasing of f at first iteration. (df0=1 is the default value).
mem : integer, number of variables used to approximate the Hessian, (algo=’gc’ or ’nd’). Default
value is around 6.
stop : sequence of optional parameters controlling the convergence of the algorithm. stop= ’ar’,nap,
[iter [,epsg [,epsf [,epsx]]]]
"ar" : reserved keyword for stopping rule selection defined as follows:
nap : maximum number of calls to fun allowed.
iter : maximum number of iterations allowed.
epsg : threshold on gradient norm.
epsf : threshold controlling decreasing of f
epsx : threshold controlling variation of x. This vector (possibly matrix) of same size as x0 can be
used to scale x.

Scilab Group April 1999 427

linpro Scilab Function

"in" : reserved keyword for initialization of parameters used when fun in given as a Fortran routine
(see below).
gradopt : gradient of fun at xopt

DESCRIPTION :
Non-linear optimization routine for programs without constraints or with bound constraints:

min sum(f(x).ˆ2 w.r.t x.

fun is an ”external” i.e function, or list or Fortran routine (see ”external”). This external must return
(f(x)) for a given x.

If fun is a function, the calling sequence for fun must be:

[f]=fun(x, [optional parameters]).

Here, fun is a function from Rˆn to Rˆm which returns f(x), a real vector ( value of function at x)
If fun is defined by a Fortran or C routine first argument must be a list: ist(fun name,m,...) If fun name
is a character string, it refers to the name of the routine which must be linked to Scilab.
Here, the generic calling sequence for the Fortran subroutine is: subroutine fun(m,n,x,td,f)
n is the dimension of x, x is an n vector, td are working arrays which may also be used to pass param-
eters
If fun is given as a Fortran routine, it is possible to initialize parameters or to send Scilab variables to
this routine using sequence of arguments ’td’ , valtd. Then, the Fortran function fun(m,n , x,
f, td) is evaluated with td=valtd. Thus, the Scilab variables valtd are sent to the Fortran function
fun.

Dfun is an ”external”.This external must return a matrix g such as (g(i,j)=dfi/dxj) for a given x.

If Dfun is a function, the calling sequence for fun must be:

[g]=Dfun(x, [optional parameters]).

If Dfun is defined by a Fortran or C routine first argument must be a list: ist(fun name,m,...) If fun name
is a character string, it refers to the name of the routine which must be linked to Scilab.
Here, the generic calling sequence for the Fortran subroutine is: subroutine dfun(m,n,x,td,g)
EXAMPLES :

a=rand(3,2);b=[1;1;1];x0=[1;-1];
deff(’f=fun(x,a,b)’,’f=a*x-b’);
deff(’g=dfun(x,a,b)’,’g=a’);

[f,xopt]=leastsq(fun,x0) //Simplest call

xopt-a\b //compare with linear algebra solution

[f,xopt]=leastsq(fun,dfun,x0) //specify gradient

[f,xopt]=leastsq(list(fun,[1 2;3 4],[1;2]),x0)

deff(’f=fun(x,a,b)’,’f=exp(a*x)-b’);
deff(’g=dfun(x,a,b)’,’g=a.*(exp(a*x)*ones(1,size(a,2)))’);

[f,xopt]=leastsq(list(fun,[1 2;3 4],[1;2]),x0)

S EE A LSO : external 38, quapro 440, linpro 429

Scilab Group April 1993 428

linpro Scilab Function

2.5.17 linpro linear programming solver

CALLING SEQUENCE :

[x,lagr,f]=linpro(p,C,b [,x0])
[x,lagr,f]=linpro(p,C,b,ci,cs [,x0])
[x,lagr,f]=linpro(p,C,b,ci,cs,me [,x0])
[x,lagr,f]=linpro(p,C,b,ci,cs,me,x0 [,imp])

PARAMETERS :

p : real column vector (dimension n)

C : real matrix (dimension (me + md) x n) (If no constraints are given, you can set C = [])
b : RHS column vector (dimension (me + md)) (If no constraints are given, you can set b = [])
ci : column vector of lower-bounds (dimension n). If there are no lower bound constraints, put ci =
[]. If some components of x are bounded from below, set the other (unconstrained) values of ci
to a very large negative number (e.g. ci(j) = -(% eps)ˆ(-1).
cs : column vector of upper-bounds. (Same remarks as above).
me : number of equality constraints (i.e. C(1:me,:)*x = b(1:me))
x0 : either an initial guess for x or one of the character strings ’v’ or ’g’. If x0=’v’ the calculated
initial feasible point is a vertex. If x0=’g’ the calculated initial feasible point is arbitrary.
imp : verbose option (optional parameter) (Try imp=7,8,...) warning the message are output in the
window where scilab has been started.
x : optimal solution found.
f : optimal value of the cost function (i.e. f=p’*x).
lagr : vector of Lagrange multipliers. If lower and upper-bounds ci,cs are provided, lagr has n
+ me + md components and lagr(1:n) is the Lagrange vector associated with the bound con-
straints and lagr (n+1 : n + me + md) is the Lagrange vector associated with the linear
constraints. (If an upper-bound (resp. lower-bound) constraint i is active lagr(i) is > 0 (resp.
<0). If no bounds are provided, lagr has only me + md components.
DESCRIPTION :
[x,lagr,f]=linpro(p,C,b [,x0])
Minimize p’*x under the constraints C*x <= b
[x,lagr,f]=linpro(p,C,b,ci,cs [,x0])
Minimize p’*x under the constraints C*x <= b , ci <= x <= cs
[x,lagr,f]=linpro(p,C,b,ci,cs,me [,x0])
Minimize p’*x under the constraints

C(j,:) x = b(j), j=1,...,me

C(j,:) x <= b(j), j=me+1,...,me+md
ci <= x <= cs

If no initial point is given the program computes a feasible initial point which is a vertex of the region of
feasible points if x0=’v’.
If x0=’g’, the program computes a feasible initial point which is not necessarily a vertex. This mode
is advisable when the quadratic form is positive definite and there are a few constraints in the problem
or when there are large bounds on the variables that are security bounds and very likely not active at the
optimal solution.
EXAMPLE :

//Find x in Rˆ6 such that:

//C1*x = b1 (3 equality constraints i.e me=3)
C1= [1,-1,1,0,3,1;
-1,0,-3,-4,5,6;

Scilab Group April 1993 429

lmisolver Scilab Function

2,5,3,0,1,0];
b1=[1;2;3];
//C2*x <= b2 (2 inequality constraints)
C2=[0,1,0,1,2,-1;
-1,0,2,1,1,0];
b2=[-1;2.5];
//with x between ci and cs:
ci=[-1000;-10000;0;-1000;-1000;-1000];cs=[10000;100;1.5;100;100;1000];
//and minimize p’*x with
p=[1;2;3;4;5;6]
//No initial point is given: x0=’v’;
C=[C1;C2]; b=[b1;b2] ; me=3; x0=’v’;
[x,lagr,f]=linpro(p,C,b,ci,cs,me,x0)
// Lower bound constraints 3 and 4 are active and upper bound
// constraint 5 is active --> lagr(3:4) < 0 and lagr(5) > 0.
// Linear (equality) constraints 1 to 3 are active --> lagr(7:9) <> 0

S EE A LSO : quapro 440

AUTHOR : E. Casas, C. Pola Mendez

2.5.18 lmisolver linear matrix inequation solver

CALLING SEQUENCE :

[XLISTF[,OPT]] = lmisolver(XLIST0,evalfunc [,options])

PARAMETERS :

XLIST0 : a list of containing initial guess (e.g. XLIST0=list(X1,X2,..,Xn))

evalfunc : a Scilab function (”external” function with specific syntax)
XLISTF : a list of matrices (e.g. XLIST0=list(X1,X2,..,Xn))
options : optional parameter. If given, options is a real row vector with 5 components [Mbound,abstol,nu,maxiters
The syntax the function evalfunc must be as follows:
[LME,LMI,OBJ]=evalfunct(X) where X is a list of matrices, LME, LMI are lists and OBJ a real
scalar.
DESCRIPTION :
lmisolver solves the following problem:
minimize f(X1,X2,...,Xn) a linear function of Xi’s
under the linear constraints: Gi(X1,X2,...,Xn)=0 for i=1,...,p and LMI (linear matrix inequalities)
constraints:
Hj(X1,X2,...,Xn) > 0 for j=1,...,q
The functions f, G, H are coded in the Scilab function evalfunc and the set of matrices Xi’s in the list
X (i.e. X=list(X1,...,Xn)).
The function evalfun must return in the list LME the matrices G1(X),...,Gp(X) (i.e. LME(i)=Gi(X1,...,Xn),
i=1,...,p). evalfun must return in the list LMI the matrices H1(X0),...,Hq(X) (i.e. LMI(j)=Hj(X1,...,Xn),
j=1,...,q). evalfun must return in OBJ the value of f(X) (i.e. OBJ=f(X1,...,Xn)).
lmisolver returns in XLISTF, a list of real matrices, i. e. XLIST=list(X1,X2,..,Xn) where
the Xi’s solve the LMI problem:
Defining Y,Z and cost by:
[Y,Z,cost]=evalfunc(XLIST), Y is a list of zero matrices, Y=list(Y1,...,Yp), Y1=0, Y2=0,
..., Yp=0.
Z is a list of square symmetric matrices, Z=list(Z1,...,Zq) , which are semi positive definite
Z1>0, Z2>0, ..., Zq>0 (i.e. spec(Z(j)) > 0),

Scilab Group April 1993 430

ode Scilab Function

cost is minimized.
lmisolver can also solve LMI problems in which the Xi’s are not matrices but lists of matrices. More
details are given in the documentation of LMITOOL.
EXAMPLE :

//Find diagonal matrix X (i.e. X=diag(diag(X), p=1) such that

//A1’*X+X*A1+Q1 < 0, A2’*X+X*A2+Q2 < 0 (q=2) and trace(X) is maximized
n=2;A1=rand(n,n);A2=rand(n,n);
Xs=diag(1:n);Q1=-(A1’*Xs+Xs*A1+0.1*eye());
Q2=-(A2’*Xs+Xs*A2+0.2*eye());
deff(’[LME,LMI,OBJ]=evalf(Xlist)’,’X=Xlist(1),LME=X-diag(diag(X));...
LMI=list(-(A1’’*X+X*A1+Q1),-(A2’’*X+X*A2+Q2)),OBJ= -sum(diag(X)) ’);
X=lmisolver(list(zeros(A1)),evalf);X=X(1)
[Y,Z,c]=evalf(X)

S EE A LSO : lmitool 431

2.5.19 lmitool tool for solving linear matrix inequations

CALLING SEQUENCE :

lmitool()

lmitool(filename)

txt=lmitool(probname,varlist,datalist)

PARAMETERS :

filename : a string referring to a .sci function

probname : a string containing the name of the problem
varlist : a string containing the names of the unknown matrices (separated by commas if there are more
than one)
datalist : a string containing the names of data matrices (separated by commas if there are more than
one)
txt : a string providing information on what the user should do next

DESCRIPTION :
lmitool() or lmitool(filename) is used to define interactively a LMI problem. In the non
interactive mode, txt=lmitool(probname,varlist,datalist) generates a file in the current
directory. The name of this file is obtained by adding .sci to the end of probname. This file is the
skeleton of a solver function and the corresponding evaluation function needed by lmisolver.
S EE A LSO : lmisolver 430

2.5.20 ode ordinary differential equation solver

CALLING SEQUENCE :

y=ode(y0,t0,t,f)
[y,w,iw]=ode([type],y0,t0,t [,rtol [,atol]],f [,jac] [,w,iw])
[y,rd,w,iw]=ode("root",y0,t0,t [,rtol [,atol]],f [,jac],ng,g [,w,iw])
y=ode("discrete",y0,k0,kvect,f)

Scilab Group February 1998 431

ode Scilab Function

PARAMETERS :

y0 : real vector or matrix (initial conditions).

t0 : real scalar (initial time).
t : real vector (times at which the solution is computed).
f : external (function or character string or list).
type : one of the following character string: "adams" "stiff" "rk" "rkf" "fix" "discrete"
"roots"
rtol,atol : real constants or real vectors of the same size as y.
jac : external (function or character string or list).
w,iw : real vectors.
ng : integer.
g : external (function or character string or list).
k0 : integer (initial time). kvect : integer vector.

DESCRIPTION :
ode is the standard function for solving explicit ODE systems defined by:
dy/dt=f(t,y) , y(t0)=y0.
It is an interface to various solvers, in particular to ODEPACK. The type of problem solved and the method
used depend on the value of the first optional argument type which can be one of the following strings:
<not given>: lsoda solver of package ODEPACK is called by default. It automatically se-
lects between nonstiff predictor-corrector Adams method and stiff Backward Differentiation Formula
(BDF) method. It uses nonstiff method initially and dynamically monitors data in order to decide
which method to use.
"adams": This is for nonstiff problems. lsode solver of package ODEPACK is called and it uses
the Adams method.
"stiff": This is for stiff problems. lsode solver of package ODEPACK is called and it uses the
BDF method.
"rk": Adaptive Runge-Kutta of order 4 (RK4) method.
"rkf": The Shampine and Watts program based on Fehlberg’s Runge-Kutta pair of order 4 and 5
(RKF45) method is used. This is for non-stiff and mildly stiff problems when derivative evaluations
are inexpensive. This method should generally not be used when the user is demanding high accuracy.
"fix": Same solver as ”rkf”, but the user interface is very simple, i.e. only rtol and atol param-
eters can be passed to the solver. This is the simplest method to try.
"root": ODE solver with rootfinding capabilities. The lsodar solver of package ODEPACK is
used. It is a variant of the lsoda solver where it finds the roots of a given vector function. See help
on ode root for more details.
"discrete": Discrete time simulation. See help on ode discrete for more details.
In this help we only describe the use of ode for standard explicit ODE systems.
The simplest call of ode is: y=ode(y0,t0,t,f) where y0 is the vector of initial conditions,
t0 is the initial time, t is the vector of times at which the solution y is computed and y is the
solution vector y=[y(t(1)),y(t(2)),...].
The input f to ode is an external i.e. a function with specified syntax, or the name of a Fortran
subroutine or a C function (character string) with specified calling sequence or a list.
If f is a function, its syntax must be as follows:
ydot = f(t,y)
where t is a real scalar (time) and y a real vector (state). This function is the RHS of the differential
equation dy/dt=f(t,y).
If f is a character string, it refers to the name of a Fortran subroutine or a C function, i.e. if ode(y0,t0,t,"fex")
is the command, then the subroutine fex is called. This routine must have the following calling sequence:
f(n,t,y,ydot). It can be dynamically linked to Scilab by the link function. Examples of such pro-
grams can be seen in the files SCIDIR/routines/default/README and SCIDIR/routines/default/Ex-ode.f.

Scilab Group February 1998 432

ode Scilab Function

The f argument can also be a list: if ode(y0,t0,t,lst) is the command, then lst must be a
list with the following structure:
lst=list(f,u1,u2,...un)
where f is a function with syntax:
ydot = f(t,y,u1,u2,...,un)
this allows to use parameters as the arguments of f.
The function f can return a p x q matrix instead of a vector. With this matrix notation, we solve the
n=p+q ODE’s system dY/dt=F(t,Y) where Y is a p x q matrix. Then initial conditions, Y0, must
also be a p x q matrix and the result of ode is the p x q(T+1) matrix [Y(t 0),Y(t 1),...,Y(t T)].
Optional parameters can be given for the error of the solution: rtol and atol are threshold for
relative and absolute estimated errors. The estimated error on y(i) is:
rtol(i)*abs(y(i))+atol(i)

and integration is carried out as far as this error is small for all components of the state. If rtol and/or
atol is a constant rtol(i) and/or atol(i) are set to this constant value. Default values for rtol
and atol are respectively rtol=1.d-5 and atol=1.d-7 for most solvers and rtol=1.d-3 and
atol=1.d-4 for "rfk" and "fix".
For stiff problems, it is better to give the Jacobian of the RHS function as the optional argument jac.
It is an external i.e. a function with specified syntax, or the name of a Fortran subroutine or a C function
(character string) with specified calling sequence or a list.
If jac is a function the syntax should be as follows:
J=jac(t,y)
where t is a real scalar (time) and y a real vector (state). The result matrix J must evaluate to df/dx
i.e. J(k,i) = dfk /dxi with fk = kth component of f.
If jac is a character string it refers to the name of a Fortran subroutine or a C function, with the following
calling sequence: jac(n,t,y,ml,mu,J,nrpd). In most cases you have not to refer ml, mu and
nrpd (see source code in SCIDIR/routines/default/Ex-ode.f for an example).
If jac is a list the same conventions as for f apply.
Optional arguments w and iw are vectors for storing information returned by the integration routine.
When these vectors are provided in RHS of ode the integration re-starts with the same parameters as in its
previous stop.
More options can be given to ODEPACK solvers by using %ODEOPTIONS variable. See odeoptions
help.
EXAMPLE :

// Simple one dimension ODE

// dy/dt=yˆ2-y sin(t)+cos(t), y(0)=0
deff("[ydot]=f(t,y)","ydot=yˆ2-y*sin(t)+cos(t)")
y0=0;t0=0;t=0:0.1:%pi;
y=ode(y0,t0,t,f)
plot(t,y)
// Simulation of dx/dt = A x(t) + B u(t) with u(t)=sin(omega*t),
// x0=[1;0]
// solution x(t) desired at t=0.1, 0.2, 0.5 ,1.
// A and u function are passed to RHS function in a list.
// B and omega are passed as global variables
deff("[xdot]=linear(t,x,A,u)","xdot=A*x+B*u(t)")
deff("[ut]=u(t)","ut=sin(omega*t)")
A=[1 1;0 2];B=[1;1];omega=5;
ode([1;0],0,[0.1,0.2,0.5,1],list(linear,A,u))
//

Scilab Group February 1998 433

ode root Scilab Function

// Matrix notation
// Integration of the Riccati differential equation
// Xdot=A’*X + X*A - X’*B*X + C , X(0)=Identity
// Solution at t=[1,2]
deff("[Xdot]=ric(t,X)","Xdot=A’’*X+X*A-X’’*B*X+C")
A=[1,1;0,2]; B=[1,0;0,1]; C=[1,0;0,1];
t0=0;t=0:0.1:%pi;
X=ode(eye(A),0,t,ric)
//
// Computation of exp(A)
A=[1,1;0,2];
deff("[xdot]=f(t,x)","xdot=A*x");
ode(eye(A),0,1,f)
ode("adams",eye(A),0,1,f)
// with stiff matrix, Jacobian given
A=[10,0;0,-1];
deff("[xdot]=f(t,x)","xdot=A*x");
deff("[J]=Jacobian(t,y)","J=A")
ode("stiff",[0;1],0,1,f,Jacobian)

S EE A LSO : ode_discrete 434, ode_root 435, dassl 416, impl 421, odedc 436,
odeoptions 437, csim 329, ltitr 347, rtitr 358

2.5.21 ode discrete ordinary differential equation solver, discrete time

simulation

CALLING SEQUENCE :

y=ode("discrete",y0,k0,kvect,f)

PARAMETERS :

y0 : real vector or matrix (initial conditions).

t0 : real scalar (initial time).
f : external i.e. function or character string or list.
k0 : integer (initial time).
kvect : integer vector.

DESCRIPTION :
With this syntax (first argument equal to "discrete") ode computes recursively y(k+1)=f(k,y(k))
from an initial state y(k0) and returns y(k) for k in kvect. kvect(1) must be greater than or
equal to k0.
Other arguments and other options are the same as for ode, see the ode help.
EXAMPLE :

y1=[1;2;3]; deff("yp=a_function(k,y)","yp=A*y+B*u(k)")
A=diag([0.2,0.5,0.9]); B=[1;1;1];u=1:10;n=5;
y=ode("discrete",y1,1,1:n,a_function);
y(:,2)-(A*y1+B*u(1))
// Now y evaluates at [y3,y5,y7,y9]
y=ode("discrete",y1,1,3:2:9,a_function)

S EE A LSO : ode 431

Scilab Group February 1998 434

odedc Scilab Function

2.5.22 ode root ordinary differential equation solver with root finding

CALLING SEQUENCE :

y,rd[,w,iw]=ode("root",y0,t0,t [,rtol [,atol]],f [,jac],ng,g [,w,iw])

PARAMETERS :

y0 : real vector or matrix (initial conditions).

t0 : real scalar (initial time).
t : real vector (times at which the solution is computed).
f : external i.e. function or character string or list.
rtol,atol : real constants or real vectors of the same size as y.
jac : external i.e. function or character string or list.
w,iw : real vectors.
ng : integer.
g : external i.e. function or character string or list.

DESCRIPTION :
With this syntax (first argument equal to "root") ode computes the solution of the differential equation
dy/dt=f(t,y) until the state y(t) crosses the surface g(t,y)=0.
g should give the equation of the surface. It is an external i.e. a function with specified syntax, or the
name of a Fortran subroutine or a C function (character string) with specified calling sequence or a list.
If g is a function the syntax should be as follows:

z=g(t,y)

where t is a real scalar (time) and y a real vector (state). It returns a vector of size ng which cor-
responds to the ng constraints. If g is a character string it refers to the name of a Fortran subroutine or
a C function, with the following calling sequence: g(n,t,y,ng,gout) where ng is the number of
constraints and gout is the value of g (output of the program). If g is a list the same conventions as for
f apply (see ode help).
Ouput rd is a 1 x k vector. The first entry contains the stopping time. Other entries indicate which
components of g have changed sign. k larger than 2 indicates that more than one surface ((k-1) sur-
faces) have been simultaneously traversed.
Other arguments and other options are the same as for ode, see the ode help.
EXAMPLE :

// Integration of the differential equation

// dy/dt=y , y(0)=1, and finds the minimum time t such that y(t)=2
deff("[ydot]=f(t,y)","ydot=y")
deff("[z]=g(t,y)","z=y-2")
y0=1;ng=1;
[y,rd]=ode("roots",y0,0,2,f,ng,g)

deff("[z]=g(t,y)","z=y-[2;2;33]")
[y,rd]=ode("roots",1,0,2,f,3,g)

S EE A LSO : dasrt 414, ode 431

Scilab Group April 1993 435

odedc Scilab Function

2.5.23 odedc discrete/continuous ode solver

CALLING SEQUENCE :

yt=odedc(y0,nd,stdel,t0,t,f)

PARAMETERS :

y0 : real column vector (initial conditions), y0=[y0c;y0d] where y0d has nd components.
nd : integer, dimension of y0d
stdel : real vector with one or two entries, stdel=[h, delta] (with delta=0 as default value).
t0 : real scalar (initial time).
t : real (row) vector, instants where yt is calculated .
f : external i.e. function or character string or list with calling sequence: yp=f(t,yc,yd,flag).

DESCRIPTION :

y=odedc([y0c;y0d],nd,[h,delta],t0,t,f) computes the solution of a mixed discrete/continuous

system. The discrete system state yd k is embedded into a piecewise constant yd(t) time function as
follows:
yd(t)=yd_k for t in
[t_k=delay+k*h,t_(k+1)=delay+(k+1)*h[ (with delay=h*delta).
The simulated equations are now:
dyc/dt=f(t,yc(t),yd(t),0), for t in [t_k,t_(k+1)[
yc(t0)=y0c
and at instants t k the discrete variable yd is updated by:
yd(t_k+)=f(yc(t_k-),yd(t_k-),1)
Note that, using the definition of yd(t) the last equation gives
yd_k = f (t_k,yc(t_k-),yd(t_(k-1)),1) (yc is time-continuous: yc(t_k-)=yc(tk))
The calling parameters of f are fixed: ycd=f(t,yc,yd,flag); this function must return either the
derivative of the vector yc if flag=0 or the update of yd if flag=1.
ycd=dot(yc) must be a vector with same dimension as yc if flag=0 and ycd=update(yd)
must be a vector with same dimension as yd if flag=1.
t is a vector of instants where the solution y is computed.
y is the vector y=[y(t(1)),y(t(2)),...]. This function can be called with the same optional
parameters as the ode function (provided nd and stdel are given in the calling sequence as second
and third parameters). In particular integration flags, tolerances can be set. Optional parameters can be set
by the odeoptions function.
An example for calling an external routine is given in directory SCIDIR/default/fydot2.f
External routines can be dynamically linked (see link).
EXAMPLE :

//Linear system with switching input

deff(’xdu=phis(t,x,u,flag)’,’if flag==0 then xdu=A*x+B*u; else xdu=1-u;end’);
x0=[1;1];A=[-1,2;-2,-1];B=[1;2];u=0;nu=1;stdel=[1,0];u0=0;t=0:0.05:10;
xu=odedc([x0;u0],nu,stdel,0,t,phis);x=xu(1:2,:);u=xu(3,:);
nx=2;
plot2d1(’onn’,t’,x’,[1:nx],’161’);
plot2d2(’onn’,t’,u’,[nx+1:nx+nu],’000’);
//Fortran external( see fydot2.f):

Scilab Group April 1993 436

odeoptions Scilab Function

norm(xu-odedc([x0;u0],nu,stdel,0,t,’phis’),1)

//Sampled feedback
//
// | xcdot=fc(t,xc,u)
// (system) |
// | y=hc(t,xc)
//
//
// | xd+=fd(xd,y)
// (feedback) |
// | u=hd(t,xd)
//
deff(’xcd=f(t,xc,xd,iflag)’,...
[’if iflag==0 then ’
’ xcd=fc(t,xc,e(t)-hd(t,xd));’
’else ’
’ xcd=fd(xd,hc(t,xc));’
’end’]);
A=[-10,2,3;4,-10,6;7,8,-10];B=[1;1;1];C=[1,1,1];
Ad=[1/2,1;0,1/20];Bd=[1;1];Cd=[1,1];
deff(’st=e(t)’,’st=sin(3*t)’)
deff(’xdot=fc(t,x,u)’,’xdot=A*x+B*u’)
deff(’y=hc(t,x)’,’y=C*x’)
deff(’xp=fd(x,y)’,’xp=Ad*x + Bd*y’)
deff(’u=hd(t,x)’,’u=Cd*x’)
h=0.1;t0=0;t=0:0.1:2;
x0c=[0;0;0];x0d=[0;0];nd=2;
xcd=odedc([x0c;x0d],nd,h,t0,t,f);
norm(xcd-odedc([x0c;x0d],nd,h,t0,t,’fcd1’)) // Fast calculation (see fydot2.f)
plot2d([t’,t’,t’],xcd(1:3,:)’);
xset("window",2);plot2d2("gnn",[t’,t’],xcd(4:5,:)’);
xset("window",0);

S EE A LSO : ode 431, odeoptions 437, csim 329, external 38

2.5.24 odeoptions set options for ode solvers

CALLING SEQUENCE :

odeoptions()

DESCRIPTION :
This function interactively displays a command which should be executed to set various options of ode
solvers. The global variable %ODEOPTIONS sets the options.
CAUTION: the ode function checks if this variable exists and in this case it uses it. For using default
values you should clear this variable. Note that odeoptions does not create this variable. To create it
you must execute the command line displayed by odeoptions.
The variable %ODEOPTIONS is a vector with the following elements:
[itask,tcrit,h0,hmax,hmin,jactyp,mxstep,maxordn,maxords,ixpr,ml,mu]
The default value is:
[1,0,0,%inf,0,2,500,12,5,0,-1,-1]

Scilab Group February 1998 437

optim Scilab Function

The meaning of the elements is described below.

itask 1 : normal computation at specified times 2 : computation at mesh points (given in first row
of output of ode) 3 : one step at one internal mesh point and return 4 : normal computation without
overshooting tcrit 5 : one step, without passing tcrit, and return
tcrit assumes itask equals 4 or 5, described above
h0 first step tried
hmax max step size
hmin min step size
jactype 0 : functional iterations, no jacobian used ("adams" or "stiff" only) 1 : user-supplied
full jacobian 2 : internally generated full jacobian 3 : internally generated diagonal jacobian ("adams"
or "stiff" only) 4 : user-supplied banded jacobian (see ml and mu below) 5 : internally generated
banded jacobian (see ml and mu below)
maxordn maximum non-stiff order allowed, at most 12
maxords maximum stiff order allowed, at most 5
ixpr print level, 0 or 1
ml,mu If jactype equals 4 or 5, ml and mu are the lower and upper half-bandwidths of the banded
jacobian: the band is the i,j’s with i-ml <= j <= ny-1. If jactype equals 4 the jacobian function must
return a matrix J which is ml+mu+1 x ny (where ny=dim of y in ydot=f(t,y)) such that column 1 of J is
made of mu zeros followed by df1/dy1, df2/dy1, df3/dy1, ... (1+ml possibly non-zero entries) column 2 is
made of mu-1 zeros followed by df1/dx2, df2/dx2, etc
S EE A LSO : ode 431

2.5.25 optim non-linear optimization routine

CALLING SEQUENCE :

[f,xopt]=optim(costf,x0)
[f,[xopt,[gradopt,[work]]]]=optim(costf,[contr],x0,[’algo’],[df0,[mem]],
[work],[stop],[’in’],[imp=iflag])

PARAMETERS :

costf : external, i.e Scilab function or string (costf is the cost function: see below its calling sequence
(Scilab or Fortran)).
x0 : real vector (initial value of variable to be minimized).
f : value of optimal cost (f=costf(xopt))
xopt : best value of x found.
contr : ’b’,binf,bsup with binf and bsup real vectors with same dimension as x0. binf
and bsup are lower and upper bounds on x.
"algo" : ’qn’ or ’gc’ or ’nd’ . This string stands for quasi-Newton (default), conjugate gradient
or non-differentiable respectively. Note that ’nd’ does not accept bounds on x ).
df0 : real scalar. Guessed decreasing of f at first iteration. (df0=1 is the default value).
mem : integer, number of variables used to approximate the Hessian, (algo=’gc’ or ’nd’). Default
value is around 6.
stop : sequence of optional parameters controlling the convergence of the algorithm. stop= ’ar’,nap,
[iter [,epsg [,epsf [,epsx]]]]
"ar" : reserved keyword for stopping rule selection defined as follows:
nap : maximum number of calls to costf allowed.
iter : maximum number of iterations allowed.
epsg : threshold on gradient norm.
epsf : threshold controlling decreasing of f
epsx : threshold controlling variation of x. This vector (possibly matrix) of same size as x0 can be
used to scale x.

Scilab Group April 1993 438

optim Scilab Function

"in" : reserved keyword for initialization of parameters used when costf in given as a Fortran routine
(see below).
"imp=iflag" : named argument used to set the trace mode. iflag=0 nothing (execpt errors) is
reported, iflag=1 initial and final reports, iflag=2 adds a report per iteration, iflag>2 add
reports on linear search. Warning, most of these reports are written on the Scilab standard output.
gradopt : gradient of costf at xopt
work : working array for hot restart for quasi-Newton method. This array is automatically initialized by
optim when optim is invoked. It can be used as input parameter to speed-up the calculations.

DESCRIPTION :
Non-linear optimization routine for programs without constraints or with bound constraints:
min costf(x) w.r.t x.
costf is an ”external” i.e function, or list or Fortran routine (see ”external”). This external must
return f (costf(x)) and g (gradient of costf) given x.
If costf is a function, the calling sequence for costf must be:
[f,g,ind]=costf(x,ind).
Here, costf is a function which returns f, value (real number) of cost function at x, and g, gradient
vector of cost function at x. The variable ind is used by optim and is described below.
If ind=2 (resp. 3, 4), costf must provide f (resp. g, f and g).
If ind=1 nothing is computed (used for display purposes only).
On output, ind<0 means that f cannot be evaluated at x and ind=0 interrupts the optimization.
If costf is a character string, it refers to the name of a Fortran routine which must be linked to Scilab
(see examples in the routines foptim.f and e.g. genros.f in the directory SCIDIR/default)
Dynamic link of Fortran routine is also possible (help link).
Here, the generic calling sequence for the Fortran subroutine is: function costf(ind,n,x,f,g,ti,tr,td)
ind has the same meaning as above if set to 0,1,2 but the values ind=10 and ind=11 are now
valid. These values are used for initializations (see below).
n is the dimension of x, x is an n vector, ti,tr,td are working arrays.
The Fortran function costf must return f and the vector g, given x, ind, n, ti, tr, td.
If costf is given as a Fortran routine, it is possible to initialize parameters or to send Scilab variables to
this routine.
This facility is managed by the parameter ’in.
If the string ’in’ is present, initialization is done by Fortran: optim makes two calls to the Fortran
function costf, once with ind=10 and once with ind=11. In this case, for ind=10, costf must set
the dimensions nti, ntr, ntd of ti, tr, td in the common/nird/nti, ntr, ntd and,
for ind=11, costf must initialize the vectors ti , tr, td (integer vector, real vector, double pre-
cision vector respectively).
In the calling sequence of optim, the string ’in’ can be replaced by ’ti’, valti ,’td’ , valtd.
Then, the Fortran function costf(ind, x, f, g, ti, tr, td) is evaluated with ti=valti
and td=valtd whatever the value of ind. Thus, the Scilab variables valti and valtd (integer vec-
tor and real vector) are sent to the Fortran function costf.
It is also possible to save the content of of the working arrays ti and td. This is possible by adding the
strings ’si’ and/or ’sd’ at the ned of the calling sequence of optim. Then, the output variables must be:
[f,[x,[g],[to]]],[ti],[td]].
EXAMPLES :

xref=[1;2;3];x0=[1;-1;1]
deff(’[f,g,ind]=cost(x,ind)’,’f=0.5*norm(x-xref)ˆ2,g=x-xref’);
[f,xopt]=optim(cost,x0) //Simplest call
[f,xopt,gopt]=optim(cost,x0,’gc’) // By conjugate gradient
[f,xopt,gopt]=optim(cost,x0,’nd’) //Seen as non differentiable
[f,xopt,gopt]=optim(cost,’b’,[-1;0;2],[0.5;1;4],x0) // Bounds on x
[f,xopt,gopt]=optim(cost,’b’,[-1;0;2],[0.5;1;4],x0,’gc’) // Bounds on x

Scilab Group April 1993 439

quapro Scilab Function

[f,xopt,gopt]=optim(cost,’b’,[-1;0;2],[0.5;1;4],x0,’gc’,’ar’,3)
// Here, 3 calls to cost are allowed.
// Now calling the Fortran subroutine "genros" in SCIDIR/default/Ex-optim.f
// See also the link function for dynamically linking an objective function
[f,xopt,gopt]=optim(’genros’,[1;2;3]) //Rosenbrock’s function

S EE A LSO : external 38, quapro 440, linpro 429, datafit 417, leastsq 427

2.5.26 quapro linear quadratic programming solver

CALLING SEQUENCE :

[x,lagr,f]=quapro(Q,p,C,b [,x0])
[x,lagr,f]=quapro(Q,p,C,b,ci,cs [,x0])
[x,lagr,f]=quapro(Q,p,C,b,ci,cs,me [,x0])
[x,lagr,f]=quapro(Q,p,C,b,ci,cs,me,x0 [,imp])

PARAMETERS :

Q :real symmetric matrix (dimension n x n).

p : real (column) vector (dimension n)
C : real matrix (dimension (me + md) x n) (If no constraints are given, you can set C = [])
b : RHS column vector (dimension (me + md)) (If no constraints are given, you can set b = [])
ci : column vector of lower-bounds (dimension n). If there are no lower bound constraints, put ci =
[]. If some components of x are bounded from below, set the other (unconstrained) values of ci
to a very large negative number (e.g. ci(j) = -(% eps)ˆ(-1).
cs : column vector of upper-bounds. (Same remarks as above).
me : number of equality constraints (i.e. C(1:me,:)*x = b(1:me))
x0 : either an initial guess for x or one of the character strings ’v’ or ’g’. If x0=’v’ the calculated
initial feasible point is a vertex. If x0=’g’ the calculated initial feasible point is arbitrary.
imp : verbose option (optional parameter) (Try imp=7,8,...). warning the message are output in the
window where scilab has been started.
x : optimal solution found.
f : optimal value of the cost function (i.e. f=0.5*x’*Q*x+p’).
lagr : vector of Lagrange multipliers. If lower and upper-bounds ci,cs are provided, lagr has n
+ me + md components and lagr(1:n) is the Lagrange vector associated with the bound con-
straints and lagr (n+1 : n + me + md) is the Lagrange vector associated with the linear
constraints. (If an upper-bound (resp. lower-bound) constraint i is active lagr(i) is > 0 (resp.
<0). If no bounds are provided, lagr has only me + md components.
DESCRIPTION :
[x,lagr,f]=quapro(Q,p,C,b [,x0])
Minimize 0.5*x’*Q*x + p’*x
under the constraint
C*x <= b
[x,lagr,f]=quapro(Q,p,C,b,ci,cs [,x0])
Minimize 0.5*x’*Q*x + p’*x
under the constraints
C*x <= b ci <= x <= cs
[x,lagr,f]=quapro(Q,p,C,b,ci,cs,me [,x0])
Minimize 0.5*x’*Q*x + p’*x
under the constraints

Scilab Group April 1993 440

semidef Scilab Function

C(j,:) x = b(j), j=1,...,me

C(j,:) x <= b(j), j=me+1,...,me+md
ci <= x <= cs

If no initial point is given the program computes a feasible initial point which is a vertex of the region of
feasible points if x0=’v’.
If x0=’g’, the program computes a feasible initial point which is not necessarily a vertex. This mode is
advisable when the quadratic form is positive definite and there are few constraints in the problem or when
there are large bounds on the variables that are just security bounds and very likely not active at the optimal
solution.
Note that Q is not necessarily non-negative, i.e. Q may have negative eigenvalues.
EXAMPLE :

//Find x in Rˆ6 such that:

//C1*x = b1 (3 equality constraints i.e me=3)
C1= [1,-1,1,0,3,1;
-1,0,-3,-4,5,6;
2,5,3,0,1,0];
b1=[1;2;3];
//C2*x <= b2 (2 inequality constraints)
C2=[0,1,0,1,2,-1;
-1,0,2,1,1,0];
b2=[-1;2.5];
//with x between ci and cs:
ci=[-1000;-10000;0;-1000;-1000;-1000];cs=[10000;100;1.5;100;100;1000];
//and minimize 0.5*x’*Q*x + p’*x with
p=[1;2;3;4;5;6]; Q=eye(6,6);
//No initial point is given;
C=[C1;C2] ; //
b=[b1;b2] ; //
me=3;
[x,lagr,f]=quapro(Q,p,C,b,ci,cs,me)
//Only linear constraints (1 to 4) are active (lagr(1:6)=0):
[x,lagr,f]=quapro(Q,p,C,b,[],[],me) //Same result as above

S EE A LSO : linpro 429, optim 438

AUTHOR : E. Casas, C. Pola Mendez

2.5.27 semidef semidefinite programming

CALLING SEQUENCE :

[x,Z,ul,info]=semidef(x0,Z0,F,blck_szs,c,options)

PARAMETERS :

x0 : m x 1 real column vector (must be strictly primal feasible, see below)

Z0 : L x 1 real vector (compressed form of a strictly feasible dual matrix, see below)
F : L x (m+1) real matrix
blck szs : p x 2 integer matrix (sizes of the blocks) defining the dimensions of the (square) diagonal
blocks size(Fi(j)=blck szs(j) j=1,...,m+1.
c : m x 1 real vector
options : row vector with five entries [nu,abstol,reltol,0,maxiters]
ul : row vector with two entries

Scilab Group April 1993 441

semidef Scilab Function

DESCRIPTION :
[x,Z,ul,info]=semidef(x0,Z0,F,blck szs,c,options) solves semidefinite program:

minimize c’*x
subject to F_0 + x_1*F_1 + ... + x_m*F_m >= 0

and its dual

maximize -Tr F_0 Z

subject to Tr F_i Z = c_i, i=1,...,m
Z >= 0

exploiting block structure in the matrices F i.

It interfaces L. Vandenberghe and S. Boyd sp.c program.
The Fi’s matrices are stored columnwise in F in compressed format: if F iˆj, i=0,..,m, j=1,...,L denote
the jth (symmetric) diagonal block of F i, then

[ pack(F_0ˆ1) pack(F_1ˆ1) ... pack(F_mˆ1) ]

[ pack(F_0ˆ2) pack(F_1ˆ2) ... pack(F_mˆ2) ]
F= [ ... ... ... ]
[ pack(F_0ˆL) pack(F_1ˆL) ... pack(F_mˆL) ]

where pack(M), for symmetric M, is the vector [M(1,1);M(1,2);...;M(1,n);M(2,2);M(2,3);...;M(2,n);..

(obtained by scanning columnwise the lower triangular part of M).
blck szs gives the size of block j, ie, size(F iˆj)=blck szs(j).
Z is a block diagonal matrix with L blocks Zˆ0, ..., ZˆfL-1g. Zˆj has size blck szs[j] times
blck szs[j]. Every block is stored using packed storage of the lower triangular part.
The 2 vector ul contains the primal objective value c’*x and the dual objective value -Tr F 0*Z.
The entries of options are respectively: nu = a real parameter which ntrols the rate of convergence.
abstol = absolute tolerance. reltol = relative tolerance (has a special meaning when negative). tv
target value, only referenced if reltol < 0. iters = on entry: maximum number of iterations >= 0,
on exit: the number of iterations taken.
info returns 1 if maxiters exceeded, 2 if absolute accuracy is reached, 3 if relative accuracy is reached, 4
if target value is reached, 5 if target value is not achievable; negative values indicate errors.
Convergence criterion:

(1) maxiters is exceeded

(2) duality gap is less than abstol
(3) primal and dual objective are both positive and
duality gap is less than (reltol * dual objective)
or primal and dual objective are both negative and
duality gap is less than (reltol * minus the primal objective)
(4) reltol is negative and
primal objective is less than tv or dual objective is greater
than tv

EXAMPLE :

F0=[2,1,0,0;
1,2,0,0;
0,0,3,1
0,0,1,3];
F1=[1,2,0,0;
2,1,0,0;
0,0,1,3;

Scilab Group April 1993 442

semidef Scilab Function

0,0,3,1]
F2=[2,2,0,0;
2,2,0,0;
0,0,3,4;
0,0,4,4];
blck_szs=[2,2];
F01=F0(1:2,1:2);F02=F0(3:4,3:4);
F11=F1(1:2,1:2);F12=F1(3:4,3:4);
F21=F2(1:2,1:2);F22=F2(3:4,3:4);
x0=[0;0]
Z0=2*F0;
Z01=Z0(1:2,1:2);Z02=Z0(3:4,3:4);
FF=[[F01(:);F02(:)],[F11(:);F12(:)],[F21(:);F22(:)]]
ZZ0=[[Z01(:);Z02(:)]];
c=[trace(F1*Z0);trace(F2*Z0)];
options=[10,1.d-10,1.d-10,0,50];
[x,Z,ul,info]=semidef(x0,pack(ZZ0),pack(FF),blck_szs,c,options)
w=vec2list(unpack(Z,blck_szs),[blck_szs;blck_szs]);Z=sysdiag(w(1),w(2))
c’*x+trace(F0*Z)
spec(F0+F1*x(1)+F2*x(2))
trace(F1*Z)-c(1)
trace(F2*Z)-c(2)

Scilab Group April 1993 443

semidef Scilab Function

2.6 Signal Processing toolbox

Scilab Group April 1993 444

%sn Scilab Function

2.6.1 %asn elliptic integral

CALLING SEQUENCE :
[y]=%asn(x,m)
PARAMETERS :
x : upper limit of integral (x>0) (can be a vector)
m : parameter of integral (0<m<1)
y : value of the integral
DESCRIPTION :
Calculates the elliptic integral Z x
dt
K=
0 [(1 t 2 )(1 mt2 )]1=2
If x is a vector, y is a vector of same dimension as x.
EXAMPLE :
m=0.8;z=%asn(1/sqrt(m),m);K=real(z);Ktilde=imag(z);
x2max=1/sqrt(m);
x1=0:0.05:1;x2=1:((x2max-1)/20):x2max;x3=x2max:0.05:10;
x=[x1,x2,x3];
y=%asn(x,m);
rect=[0,-Ktilde,1.1*K,2*Ktilde];
plot2d(real(y)’,imag(y)’,1,’011’,’ ’,rect)
//
deff(’y=f(t)’,’y=1/sqrt((1-tˆ2)*(1-m*tˆ2))’);
intg(0,0.9,f)-%asn(0.9,m) //Works for real case only!
AUTHOR : F. D.

2.6.2 %k Jacobi’s complete elliptic integral

CALLING SEQUENCE :
[K]=%k(m)
PARAMETERS :
m : parameter of the elliptic integral 0<m<1 (m can be a vector)
K : value of the elliptic integral from 0 to 1 on the real axis
DESCRIPTION :
Calculates Jacobi’s complete elliptic integral of the first kind :
Z 1
dt
K=
0 [(1 t2 )(1 mt2 )]1=2

EXAMPLE :
m=0.4;
%asn(1,m)
%k(m)
REFERENCES :
Abramowitz and Stegun page 598
S EE A LSO : %asn 445
AUTHOR : F.D.

Scilab Group April 1993 445

analpf Scilab Function

2.6.3 %sn Jacobi ’s elliptic function

CALLING SEQUENCE :

[y]=%sn(x,m)

PARAMETERS :

x : a point inside the fundamental rectangle defined by the elliptic integral; x is a vector of complex
numbers
m : parameter of the elliptic integral (0<m<1)
y : result

DESCRIPTION :
Jacobi ’s sn elliptic function with parameter m: the inverse of the elliptic integral for the parameter m.
The amplitude am is computed in fortran and the addition formulas for elliptic functions are applied
EXAMPLE :

m=0.36;
K=%k(m);
P=4*K; //Real period
real_val=0:(P/50):P;
plot(real_val,real(%sn(real_val,m)))
xbasc();
KK=%k(1-m);
Ip=2*KK;
ima_val1=0:(Ip/50):KK-0.001;
ima_val2=(KK+0.05):(Ip/25):(Ip+KK);
z1=%sn(%i*ima_val1,m);z2=%sn(%i*ima_val2,m);
plot2d([ima_val1’,ima_val2’],[imag(z1)’,imag(z2)’]);
xgrid(3)

S EE A LSO : %asn 445, %k 445

AUTHOR : F. D.

2.6.4 analpf create analog low-pass filter

CALLING SEQUENCE :

[hs,pols,zers,gain]=analpf(n,fdesign,rp,omega)

PARAMETERS :

n : positive integer : filter order

fdesign : string : filter design method : ’butt’ or ’cheb1’ or ’cheb2’ or ’ellip’
rp : 2-vector of error values for cheb1, cheb2 and ellip filters where only rp(1) is used for cheb1
case, only rp(2) is used for cheb2 case, and rp(1) and rp(2) are both used for ellip case.
0<rp(1),rp(2)<1
- for cheb1 filters 1-rp(1)<ripple<1 in passband
- for cheb2 filters 0<ripple<rp(2) in stopband
- for ellip filters 1-rp(1)<ripple<1 in passband 0<ripple<rp(2) in stopband
omega : cut-off frequency of low-pass filter in Hertz
hs : rational polynomial transfer function
pols : poles of transfer function

Scilab Group April 1993 446

casc Scilab Function

zers : zeros of transfer function

gain : gain of transfer function

DESCRIPTION :
Creates analog low-pass filter with cut-off frequency at omega.
hs=gain*poly(zers,’s’)/poly(pols,’s’)
EXAMPLE :

//Evaluate magnitude response of continuous-time system

hs=analpf(4,’cheb1’,[.1 0],5)
fr=0:.1:15;
hf=freq(hs(2),hs(3),%i*fr);
hm=abs(hf);
plot(fr,hm)

AUTHOR : C. B.

2.6.5 buttmag response of Butterworth filter

CALLING SEQUENCE :

[h]=buttmag(order,omegac,sample)

PARAMETERS :

order : integer : filter order

omegac : real : cut-off frequency in Hertz
sample : vector of frequency where buttmag is evaluated
h : Butterworth filter values at sample points

DESCRIPTION :
squared magnitude response of a Butterworth filter omegac = cutoff frequency ; sample = sample of
frequencies
EXAMPLE :

//squared magnitude response of Butterworth filter

h=buttmag(13,300,1:1000);
mag=20*log(h)’/log(10);
plot2d((1:1000)’,mag,[2],"011"," ",[0,-180,1000,20])

AUTHOR : F. D.

2.6.6 casc cascade realization of filter from coefficients

CALLING SEQUENCE :

[cels]=casc(x,z)

PARAMETERS :

x : (4xN)-matrix where each column is a cascade element, the first two column entries being the numerator
coefficients and the second two column entries being the denominator coefficients
z : string representing the cascade variable
cels : resulting cascade representation

Scilab Group April 1993 447

cheb2mag Scilab Function

DESCRIPTION :
Creates cascade realization of filter from a matrix of coefficients (utility function).
EXAMPLE :
x=[1,2,3;4,5,6;7,8,9;10,11,12]
cels=casc(x,’z’)

2.6.7 cepstrum cepstrum calculation

CALLING SEQUENCE :
fresp = cepstrum(w,mag)
PARAMETERS :
w : positive real vector of frequencies (rad/sec)
mag : real vector of magnitudes (same size as w)
fresp : complex vector
DESCRIPTION :
fresp = cepstrum(w,mag) returns a frequency response fresp(i) whose magnitude at fre-
quency w(i) equals mag(i) and such that the phase of freq corresponds to a stable and minimum
phase system. w needs not to be sorted, but minimal entry should not be close to zero and all the entries of
w should be different.
EXAMPLE :
w=0.1:0.1:5;mag=1+abs(sin(w));
fresp=cepstrum(w,mag);
plot2d([w’,w’],[mag(:),abs(fresp)])
S EE A LSO : frfit 459

2.6.8 cheb1mag response of Chebyshev type 1 filter

CALLING SEQUENCE :
[h2]=cheb1mag(n,omegac,epsilon,sample)
PARAMETERS :
n : integer : filter order
omegac : real : cut-off frequency
epsilon : real : ripple in pass band
sample : vector of frequencies where cheb1mag is evaluated
h2 : Chebyshev I filter values at sample points
DESCRIPTION :
Square magnitude response of a type 1 Chebyshev filter.
omegac=passband edge.
epsilon: such that 1/(1+epsilonˆ2)=passband ripple.
sample: vector of frequencies where the square magnitude is desired.
EXAMPLE :
//Chebyshev; ripple in the passband
n=13;epsilon=0.2;omegac=3;sample=0:0.05:10;
h=cheb1mag(n,omegac,epsilon,sample);
plot(sample,h,’frequencies’,’magnitude’)
S EE A LSO : buttmag 447

Scilab Group April 1993 448

convol Scilab Function

2.6.9 cheb2mag response of type 2 Chebyshev filter

CALLING SEQUENCE :

[h2]=cheb2mag(n,omegar,A,sample)

PARAMETERS :

n : integer ; filter order

omegar : real scalar : cut-off frequency
A : attenuation in stop band
sample : vector of frequencies where cheb2mag is evaluated
h2 : vector of Chebyshev II filter values at sample points

DESCRIPTION :
Square magnitude response of a type 2 Chebyshev filter.
omegar = stopband edge, sample = vector of frequencies where the square magnitude h2 is desired.
EXAMPLE :

//Chebyshev; ripple in the stopband

n=10;omegar=6;A=1/0.2;sample=0.0001:0.05:10;
h2=cheb2mag(n,omegar,A,sample);
plot(sample,log(h2)/log(10),’frequencies’,’magnitude in dB’)
//Plotting of frequency edges
minval=(-maxi(-log(h2)))/log(10);
plot2d([omegar;omegar],[minval;0],[2],"000");
//Computation of the attenuation in dB at the stopband edge
attenuation=-log(A*A)/log(10);
plot2d(sample’,attenuation*ones(sample)’,[5],"000")

S EE A LSO : cheb1mag 448

2.6.10 chepol Chebychev polynomial

CALLING SEQUENCE :

[Tn]=chepol(n,var)

PARAMETERS :

n : integer : polynomial order

var : string : polynomial variable
Tn : polynomial in the variable var

DESCRIPTION :
Recursive implementation of Chebychev polynomial. Tn=2*poly(0,var)*chepol(n-1,var)-chepol(n-2,var)
with T0=1 and T1=poly(0,var).
EXAMPLE :

chepol(4,’x’)

AUTHOR : F. D.

Scilab Group April 1993 449

corr Scilab Function

2.6.11 convol convolution

CALLING SEQUENCE :

[y]=convol(h,x)
[y,e1]=convol(h,x,e0)

PARAMETERS :

x,h :input sequences (h is a ”short” sequence, x a ”long” one)

e0 : old tail to overlap add (not used in first call)
y : output of convolution
e1 : new tail to overlap add (not used in last call)

DESCRIPTION :
calculates the convolution y= h*x of two discrete sequences by using the fft. Overlap add method can
be used.
USE OF OVERLAP ADD METHOD: For x=[x1,x2,...,xNm1,xN] First call is [y1,e1]=convol(h,x1); Subse-
quent calls : [yk,ek]=convol(h,xk,ekm1); Final call : [yN]=convol(h,xN,eNm1); Finally y=[y1,y2,...,yNm1,yN]

EXAMPLE :

x=1:3;
h1=[1,0,0,0,0];h2=[0,1,0,0,0];h3=[0,0,1,0,0];
x1=convol(h1,x),x2=convol(h2,x),x3=convol(h3,x),
convol(h1+h2+h3,x)
p1=poly(x,’x’,’coeff’)
p2=poly(h1+h2+h3,’x’,’coeff’)
p1*p2

S EE A LSO : corr 450, fft 457, pspect 472

AUTHOR : F. D , C. Bunks Date 3 Oct. 1988

2.6.12 corr correlation, covariance

CALLING SEQUENCE :

[cov,Mean]=corr(x,[y],nlags)
[cov,Mean]=corr(’fft’,xmacro,[ymacro],n,sect)

[w,xu]=corr(’updt’,x1,[y1],w0)
[w,xu]=corr(’updt’,x2,[y2],w,xu)
...
[wk]=corr(’updt’,xk,[yk],w,xu)

PARAMETERS :

x : a real vector
y : a real vector, default value x.
nlags : integer, number of correlation coefficients desired.
xmacro : a scilab external (see below).
ymacro : a scilab external (see below), default value xmacro
n : an integer, total size of the sequence (see below).
sect : size of sections of the sequence (see below).

Scilab Group April 1993 450

corr Scilab Function

xi : a real vector
yi : a real vector,default value xi.
cov : real vector, the correlation coefficients
Mean : real number or vector, the mean of x and if given y

DESCRIPTION :
Computes
n - m
====
\\ 1
cov(m) = > (x(k) - xmean) (y(m+k) - ymean) * ---
/ n
====
k = 1

nXm
cov (m) = 1=n (x(k ) E (x))(y (m + k ) E (y ))
1

for m=0,..,nlag-1 and two vectors x=[x(1),..,x(n)] y=[y(1),..,y(n)]

Note that if x and y sequences are differents corr(x,y,...) is different with corr(y,x,...)
Short sequences:
[cov,Mean]=corr(x,[y],nlags) returns the first nlags correlation coefficients and Mean =
mean(x) (mean of [x,y] if y is an argument). The sequence x (resp. y) is assumed real, and x
and y are of same dimension n.
Long sequences:
[cov,Mean]=corr(’fft’,xmacro,[ymacro],n,sect)
Here xmacro is either
- a function of type [xx]=xmacro(sect,istart) which returns a vector xx of dimension nsect
containing the part of the sequence with indices from istart to istart+sect-1.
- a fortran subroutine which performs the same calculation. (See the source code of dgetx for an ex-
ample). n = total size of the sequence. sect = size of sections of the sequence. sect must be a
power of 2. cov has dimension sect. Calculation is performed by FFT.
”Updating method”:
[w,xu]=corr(’updt’,x1,[y1],w0)
[w,xu]=corr(’updt’,x2,[y2],w,xu)
...
wk=corr(’updt’,xk,[yk],w,xu)
With this calling sequence the calculation is updated at each call to corr.
w0 = 0*ones(1,2*nlags);
nlags = power of 2.
x1,x2,... are parts of x such that x=[x1,x2,...] and sizes of xi a power of 2. To get
nlags coefficients a final fft must be performed c=fft(w,1)/n; cov=c(1nlags) (n is the size of
x (y)). Caution: this calling sequence assumes that xmean = ymean = 0.
EXAMPLE :

x=%pi/10:%pi/10:102.4*%pi;
rand(’seed’);rand(’normal’);
y=[.8*sin(x)+.8*sin(2*x)+rand(x);.8*sin(x)+.8*sin(1.99*x)+rand(x)];
c=[];
for j=1:2,for k=1:2,c=[c;corr(y(k,:),y(j,:),64)];end;end;
c=matrix(c,2,128);cov=[];

Scilab Group April 1993 451

cspect Scilab Function

for j=1:64,cov=[cov;c(:,(j-1)*2+1:2*j)];end;
rand(’unif’)
//
rand(’normal’);x=rand(1,256);y=-x;
deff(’[z]=xx(inc,is)’,’z=x(is:is+inc-1)’);
deff(’[z]=yy(inc,is)’,’z=y(is:is+inc-1)’);
[c,mxy]=corr(x,y,32);
x=x-mxy(1)*ones(x);y=y-mxy(2)*ones(y); //centring
c1=corr(x,y,32);c2=corr(x,32);
norm(c1+c2,1)
[c3,m3]=corr(’fft’,xx,yy,256,32);
norm(c1-c3,1)
[c4,m4]=corr(’fft’,xx,256,32);
norm(m3,1),norm(m4,1)
norm(c3-c1,1),norm(c4-c2,1)
x1=x(1:128);x2=x(129:256);
y1=y(1:128);y2=y(129:256);
w0=0*ones(1:64); //32 coeffs
[w1,xu]=corr(’u’,x1,y1,w0);w2=corr(’u’,x2,y2,w1,xu);
zz=real(fft(w2,1))/256;c5=zz(1:32);
norm(c5-c1,1)
[w1,xu]=corr(’u’,x1,w0);w2=corr(’u’,x2,w1,xu);
zz=real(fft(w2,1))/256;c6=zz(1:32);
norm(c6-c2,1)
rand(’unif’)
// test for Fortran or C external
//
deff(’[y]=xmacro(sec,ist)’,’y=sin(ist:(ist+sec-1))’);
x=xmacro(100,1);
[cc1,mm1]=corr(x,2ˆ3);
[cc,mm]=corr(’fft’,xmacro,100,2ˆ3);
[cc2,mm2]=corr(’fft’,’corexx’,100,2ˆ3);
[maxi(abs(cc-cc1)),maxi(abs(mm-mm1)),maxi(abs(cc-cc2)),maxi(abs(mm-mm2))]

deff(’[y]=ymacro(sec,ist)’,’y=cos(ist:(ist+sec-1))’);
y=ymacro(100,1);
[cc1,mm1]=corr(x,y,2ˆ3);
[cc,mm]=corr(’fft’,xmacro,ymacro,100,2ˆ3);
[cc2,mm2]=corr(’fft’,’corexx’,’corexy’,100,2ˆ3);
[maxi(abs(cc-cc1)),maxi(abs(mm-mm1)),maxi(abs(cc-cc2)),maxi(abs(mm-mm2))]

S EE A LSO : fft 457

2.6.13 cspect spectral estimation (correlation method)

CALLING SEQUENCE :

[sm,cwp]=cspect(nlags,ntp,wtype,x,y,wpar)

PARAMETERS :

x : data if vector, amount of input data if scalar

y : data if vector, amount of input data if scalar

Scilab Group April 1993 452

czt Scilab Function

nlags : number of correlation lags (positive integer)

ntp : number of transform points (positive integer)
wtype : string : ’re’,’tr’,’hm’,’hn’,’kr’,’ch’ (window type)
wpar : optional window parameters for wtype=’kr’, wpar>0 and for wtype=’ch’, 0 < wpar(1)
< .5, wpar(2) > 0
sm : power spectral estimate in the interval [0,1]
cwp : calculated value of unspecified Chebyshev window parameter

DESCRIPTION :
Spectral estimation using the correlation method. Cross-spectral estimate of x and y is calculated when
both x and y are given. Auto-spectral estimate of x is calculated if y is not given.
EXAMPLE :

rand(’normal’);rand(’seed’,0);
x=rand(1:1024-33+1);
//make low-pass filter with eqfir
nf=33;bedge=[0 .1;.125 .5];des=[1 0];wate=[1 1];
h=eqfir(nf,bedge,des,wate);
//filter white data to obtain colored data
h1=[h 0*ones(1:maxi(size(x))-1)];
x1=[x 0*ones(1:maxi(size(h))-1)];
hf=fft(h1,-1); xf=fft(x1,-1);yf=hf.*xf;y=real(fft(yf,1));
sm=cspect(100,200,’tr’,y);
smsize=maxi(size(sm));fr=(1:smsize)/smsize;
plot(fr,log(sm))

S EE A LSO : pspect 472

AUTHOR : C. Bunks
REFERENCE :
Digital Signal Processing by Oppenheim and Schafer

2.6.14 czt chirp z-transform algorithm

CALLING SEQUENCE :

[czx]=czt(x,m,w,phi,a,theta)

PARAMETERS :

x : input data sequence

m : czt is evaluated at m points in z-plane
w : magnitude multiplier
phi : phase increment
a : initial magnitude
theta : initial phase
czx : chirp z-transform output

DESCRIPTION :
chirp z-transform algorithm which calcultes the z-transform on a spiral in the z-plane at the points
[a*exp(j*theta)][wˆkexp(j*k*phi)] for k=0,1,...,m-1.
EXAMPLE :

Scilab Group April 1993 453

ell1mag Scilab Function

a=.7*exp(%i*%pi/6);
[ffr,bds]=xgetech(); //preserve current context
rect=[-1.2,-1.2*sqrt(2),1.2,1.2*sqrt(2)];
t=2*%pi*(0:179)/179;xsetech([0,0,0.5,1]);
plot2d(sin(t)’,cos(t)’,[2],"012",’ ’,rect)
plot2d([0 real(a)]’,[0 imag(a)]’,[3],"000")
xsegs([-1.0,0;1.0,0],[0,-1.0;0,1.0])
w0=.93*exp(-%i*%pi/15);w=exp(-(0:9)*log(w0));z=a*w;
zr=real(z);zi=imag(z);
plot2d(zr’,zi’,[5],"000")
xsetech([0.5,0,0.5,1]);
plot2d(sin(t)’,cos(t)’,[2],"012",’ ’,rect)
plot2d([0 real(a)]’,[0 imag(a)]’,[-1],"000")
xsegs([-1.0,0;1.0,0],[0,-1.0;0,1.0])
w0=w0/(.93*.93);w=exp(-(0:9)*log(w0));z=a*w;
zr=real(z);zi=imag(z);
plot2d(zr’,zi’,[5],"000")
xsetech(ffr,bds); //restore context

AUTHOR : C. Bunks

2.6.15 dft discrete Fourier transform

CALLING SEQUENCE :

[xf]=dft(x,flag);

PARAMETERS :

x : input vector
flag : indicates dft (flag=-1) or idft (flag=1)
xf : output vector

DESCRIPTION :
Function which computes dft of vector x.
EXAMPLE :

n=8;omega = exp(-2*%pi*%i/n);
j=0:n-1;F=omega.ˆ(j’*j); //Fourier matrix
x=1:8;x=x(:);
F*x
fft(x,-1)
dft(x,-1)
inv(F)*x
fft(x,1)
dft(x,1)

S EE A LSO : fft 457

AUTHOR : C. B.

Scilab Group April 1993 454

eqiir Scilab Function

2.6.16 ell1mag magnitude of elliptic filter

CALLING SEQUENCE :
[v]=ell1mag(eps,m1,z)
PARAMETERS :

eps : passband ripple=1/(1+epsˆ2)

m1 : stopband ripple=1/(1+(epsˆ2)/m1)
z : sample vector of values in the complex plane
v : elliptic filter values at sample points
DESCRIPTION :
Function used for squared magnitude of an elliptic filter. Usually m1=eps*eps/(a*a-1). Returns
v=real(ones(z)./(ones(z)+eps*eps*s.*s)) for s=%sn(z,m1).
EXAMPLE :

deff(’[alpha,beta]=alpha_beta(n,m,m1)’,...
’if 2*int(n/2)=n then, beta=K1; else, beta=0;end;...
alpha=%k(1-m1)/%k(1-m);’)
epsilon=0.1;A=10; //ripple parameters
m1=(epsilon*epsilon)/(A*A-1);n=5;omegac=6;
m=find_freq(epsilon,A,n);omegar = omegac/sqrt(m)
%k(1-m1)*%k(m)/(%k(m1)*%k(1-m))-n //Check...
[alpha,beta]=alpha_beta(n,m,m1)
alpha*%asn(1,m)-n*%k(m1) //Check
sample=0:0.01:20;
//Now we map the positive real axis into the contour...
z=alpha*%asn(sample/omegac,m)+beta*ones(sample);
plot(sample,ell1mag(epsilon,m1,z))

S EE A LSO : buttmag 447

2.6.17 eqfir minimax approximation of FIR filter

CALLING SEQUENCE :

[hn]=eqfir(nf,bedge,des,wate)
PARAMETERS :
nf : number of output filter points desired
bedge : Mx2 matrix giving a pair of edges for each band
des : M-vector giving desired magnitude for each band
wate : M-vector giving relative weight of error in each band
hn : output of linear-phase FIR filter coefficients
DESCRIPTION :
Minimax approximation of multi-band, linear phase, FIR filter
EXAMPLE :
hn=eqfir(33,[0 .2;.25 .35;.4 .5],[0 1 0],[1 1 1]);
[hm,fr]=frmag(hn,256);
plot(fr,hm),

AUTHOR : C. B.

Scilab Group April 1993 455

ffilt Scilab Function

2.6.18 eqiir Design of iir filters

CALLING SEQUENCE :

[cells,fact,zzeros,zpoles]=eqiir(ftype,approx,om,deltap,deltas)

PARAMETERS :

ftype : filter type (’lp’,’hp’,’sb’,’bp’)

approx : design approximation (’butt’,’cheb1’,’cheb2’,’ellip’)
om : 4-vector of cutoff frequencies (in radians) om=[om1,om2,om3,om4], 0 <= om1 <= om2 <=
om3 <= om4 <= pi. When ftype=’lp’ or ’hp’, om3 and om4 are not used and may be set to
0.
deltap : ripple in the passband. 0<= deltap <=1
deltas : ripple in the stopband. 0<= deltas <=1
cells : realization of the filter as second order cells
fact : normalization constant
zzeros : zeros in the z-domain
zpoles : poles in the z-domain

DESCRIPTION :
Design of iir filter interface with eqiir (syredi)
The filter obtained is h(z)=fact*product of the elements of cells.
That is hz=fact*prod(cells(2))./prod(cells(3))
EXAMPLE :

[cells,fact,zzeros,zpoles]=...
eqiir(’lp’,’ellip’,[2*%pi/10,4*%pi/10],0.02,0.001)
transfer=fact*poly(zzeros,’z’)/poly(zpoles,’z’)

S EE A LSO : eqfir 455, iir 463

2.6.19 faurre filter computation by simple Faurre algorithm

CALLING SEQUENCE :

[P,R,T]=faurre(n,H,F,G,R0)

PARAMETERS :

n : number of iterations.
H, F, G : estimated triple from the covariance sequence of y.
R0 : E(yk*yk’)
P : solution of the Riccati equation after n iterations.
R, T : gain matrix of the filter.

DESCRIPTION :
This function computes iteratively the minimal solution of the algebraic Riccati equation and gives the
matrices R and T of the filter model. The algorithm tries to compute the solution P as the growing limit of
a sequence of matrices Pn such that
-1
Pn+1=F*Pn*F’+(G-F*Pn*h’)*(R0-H*Pn*H’) *(G’-H*Pn*F’)
-1
P0=G*R0 *G’

Scilab Group April 1993 456

FFT Scilab Function

Note that this method may not converge,especially when F has poles near the unit circle. Use preferably
the srfaur function.
AUTHOR : G. Le V.
S EE A LSO : srfaur 476, linquist ??, phc 471

2.6.20 ffilt coefficients of FIR low-pass

CALLING SEQUENCE :

[x]=ffilt(ft,n,fl,fh)

PARAMETERS :

ft : filter type where ft can take the values

"lp" : for low-pass filter
"hp" : for high-pass filter
"bp" : for band-pass filter
"sb" : for stop-band filter
n : integer (number of filter samples desired)
fl : real (low frequency cut-off)
fh : real (high frequency cut-off)
x : vector of filter coefficients

DESCRIPTION :
Get n coefficients of a FIR low-pass, high-pass, band-pass, or stop-band filter. For low and high-pass
filters one cut-off frequency must be specified whose value is given in fl. For band-pass and stop-band
filters two cut-off frequencies must be specified for which the lower value is in fl and the higher value is
in fh
AUTHOR : C. B.

2.6.21 fft fast Fourier transform.

CALLING SEQUENCE :

[x]=fft(a,-1)
[x]=fft(a,1)
x=fft(a,-1,dim,incr)
x=fft(a,1,dim,incr)

PARAMETERS :

x : real or complex vector. Real or complex matrix (2-dim fft)

a : real or complex vector.
dim : integer
incr : integer

DESCRIPTION :
Short syntax (one or two dimensional fft):
x=fft(a,-1) gives a direct transform (the -1 refers to the sign of the exponent..., NOT to ”inverse”),
that is
n
X
x(k ) = a(m)exp( 2i (m 1)(k 1)=n)
m=1

Scilab Group April 1993 457

find freq Scilab Function

for k varying from 1 to n (n=size of vector a).

a=fft(x,1) performs the inverse transform normalized by 1/n.
(fft(fft(.,-1),1) is identity).
When the first argument given to fft is a matrix a two-dimensional FFT is performed.
Long syntax (multidimensional FFT): x=fft(a,-1,dim,incr) allows to perform an multidimen-
sional fft.
If a is a real or complex vector implicitly indexed by x1,x2,..,xp i.e. a(x1,x2,..,xp) where x1
lies in 1..dim1, x2 in 1.. dim2,... one gets a p-dimensional FFT p by calling p times fft
as follows
a1=fft(a ,-1,dim1,incr1)
a2=fft(a1,-1,dim2,incr2) ...
where dimi is the dimension of the current variable w.r.t which one is integrating and incri is the
increment which separates two successive xi elements in a.
In particular,if a is an nxm matrix, x=fft(a,-1) is equivalent to the two instructions:
a1=fft(a,-1,m,1) and x=fft(a1,-1,n,m).
if a is an hypermatrix (see hypermat) fft(a,flag) performs the N dimensional fft of a.
EXAMPLE :

a=[1;2;3];n=size(a,’*’);
norm(1/n*exp(2*%i*%pi*(0:n-1)’.*.(0:n-1)/n)*a -fft(a,1))
norm(exp(-2*%i*%pi*(0:n-1)’.*.(0:n-1)/n)*a -fft(a,-1))

S EE A LSO : corr 450

2.6.22 filter modelling filter

CALLING SEQUENCE :

[y,xt]=filter(n,F,H,Rt,T)

PARAMETERS :

n : number of computed points.

F, H : relevant matrices of the Markovian model.
Rt, T : gain matrices.
y : output of the filter.
xt : filter process.

DESCRIPTION :
This function computes the modelling filter
S EE A LSO : faurre 456
AUTHOR : G. Le V.

2.6.23 find freq parameter compatibility for elliptic filter design

CALLING SEQUENCE :

[m]=find_freq(epsilon,A,n)

PARAMETERS :

epsilon : passband ripple

Scilab Group April 1993 458

frmag Scilab Function

A : stopband attenuation
n : filter order
m : frequency needed for construction of elliptic filter
DESCRIPTION :
Search for m such that n=K(1-m1)K(m)/(K(m1)K(1-m)) with
m1=(epsilon*epsilon)/(A*A-1);
If m = omegarˆ2/omegacˆ2, the parameters epsilon,A,omegac,omegar and n are then com-
patible for defining a prototype elliptic filter. Here, K=%k(m) is the complete elliptic integral with param-
eter m.
S EE A LSO : %k 445
AUTHOR : F. D.

2.6.24 findm for elliptic filter design

CALLING SEQUENCE :
[m]=findm(chi)
DESCRIPTION :
Search for m such that chi = %k(1-m)/%k(m) (For use with find freq).
S EE A LSO : %k 445
AUTHOR : F. D.

2.6.25 frfit frequency response fit

CALLING SEQUENCE :
sys=frfit(w,fresp,order)
[num,den]=frfit(w,fresp,order)
sys=frfit(w,fresp,order,weight)
[num,den]=frfit(w,fresp,order,weight)
PARAMETERS :
w : positive real vector of frequencies (Hz)
fresp : complex vector of frequency responses (same size as w)
order : integer (required order, degree of den)
weight : positive real vector (default value ones(w)).
num,den : stable polynomials
DESCRIPTION :
sys=frfit(w,fresp,order,weight) returns a bi-stable transfer function G(s)=sys=num/den,
of of given order such that its frequency response G(w(i)) matches fresp(i), i.e. freq(num,den,%i*w)
should be close to fresp. weight(i) is the weight given to w(i).
EXAMPLE :
w=0.01:0.01:2;s=poly(0,’s’);
G=syslin(’c’,2*(sˆ2+0.1*s+2), (sˆ2+s+1)*(sˆ2+0.3*s+1));
fresp=repfreq(G,w);
Gid=frfit(w,fresp,4);
frespfit=repfreq(Gid,w);
bode(w,[fresp;frespfit])
S EE A LSO : frep2tf 338, factors 488, cepstrum 448, mrfit 470, freq 339, calfrq
324

Scilab Group April 1993 459

fsfirlin Scilab Function

2.6.26 frmag magnitude of FIR and IIR filters

CALLING SEQUENCE :

[xm,fr]=frmag(num[,den],npts)

PARAMETERS :

npts : integer (number of points in frequency response)

xm : mvector of magnitude of frequency response at the points fr
fr : points in the frequency domain where magnitude is evaluated
num : if den is omitted vector coefficients/polynomial/rational polynomial of filter
num : if den is given vector coefficients/polynomial of filter numerator
den : vector coefficients/polynomial of filter denominator

DESCRIPTION :
calculates the magnitude of the frequency responses of FIR and IIR filters. The filter description can be
one or two vectors of coefficients, one or two polynomials, or a rational polynomial.
AUTHOR : C. B.

2.6.27 fsfirlin design of FIR, linear phase filters, frequency sampling technique

CALLING SEQUENCE :

[hst]=fsfirlin(hd,flag)

PARAMETERS :

hd : vector of desired frequency response samples

flag : is equal to 1 or 2, according to the choice of type 1 or type 2 design
hst : vector giving the approximated continuous response on a dense grid of frequencies

DESCRIPTION :
function for the design of FIR, linear phase filters using the frequency sampling technique
AUTHOR : G. Le Vey
EXAMPLE :

//
//Example of how to use the fsfirlin macro for the design
//of an FIR filter by a frequency sampling technique.
//
//Two filters are designed : the first (response hst1) with
//abrupt transitions from 0 to 1 between passbands and stop
//bands; the second (response hst2) with one sample in each
//transition band (amplitude 0.5) for smoothing.
//
hd=[zeros(1,15) ones(1,10) zeros(1,39)];//desired samples
hst1=fsfirlin(hd,1);//filter with no sample in the transition
hd(15)=.5;hd(26)=.5;//samples in the transition bands
hst2=fsfirlin(hd,1);//corresponding filter
pas=1/prod(size(hst1))*.5;
fg=0:pas:.5;//normalized frequencies grid
plot2d([1 1].*.fg(1:257)’,[hst1’ hst2’]);
// 2nd example

Scilab Group April 1993 460

hank Scilab Function

hd=[0*ones(1,15) ones(1,10) 0*ones(1,39)];//desired samples

hst1=fsfirlin(hd,1);//filter with no sample in the transition
hd(15)=.5;hd(26)=.5;//samples in the transition bands
hst2=fsfirlin(hd,1);//corresponding filter
pas=1/prod(size(hst1))*.5;
fg=0:pas:.5;//normalized frequencies grid
n=prod(size(hst1))
plot(fg(1:n),hst1);
plot2d(fg(1:n)’,hst2’,[3],"000");

S EE A LSO : ffilt 457, wfir 479

2.6.28 group group delay for digital filter

CALLING SEQUENCE :

[tg,fr]=group(npts,a1i,a2i,b1i,b2i)

PARAMETERS :

npts : integer : number of points desired in calculation of group delay

a1i : in coefficient, polynomial, rational polynomial, or cascade polynomial form this variable is the
transfer function of the filter. In coefficient polynomial form this is a vector of coefficients (see
below).
a2i : in coeff poly form this is a vector of coeffs
b1i : in coeff poly form this is a vector of coeffs
b2i : in coeff poly form this is a vector of coeffs
tg : values of group delay evaluated on the grid fr
fr : grid of frequency values where group delay is evaluated

DESCRIPTION :
Calculate the group delay of a digital filter with transfer function h(z).
The filter specification can be in coefficient form, polynomial form, rational polynomial form, cascade
polynomial form, or in coefficient polynomial form.
In the coefficient polynomial form the transfer function is formulated by the following expression
h(z)=prod(a1i+a2i*z+z**2)/prod(b1i+b2i*z+zˆ2)
EXAMPLE :

z=poly(0,’z’);
h=z/(z-.5);
[tg,fr]=group(100,h);
plot(fr,tg)

AUTHOR : C. B.

2.6.29 hank covariance to hankel matrix

CALLING SEQUENCE :

[hk]=hank(m,n,cov)

PARAMETERS :

m : number of bloc-rows

Scilab Group April 1993 461

iir Scilab Function

n : number of bloc-columns
cov : sequence of covariances; it must be given as :[R0 R1 R2...Rk]
hk : computed hankel matrix
DESCRIPTION :
this function builds the hankel matrix of size (m*d,n*d) from the covariance sequence of a vector
process
AUTHOR : G. Le Vey
EXAMPLE :
//Example of how to use the hank macro for
//building a Hankel matrix from multidimensional
//data (covariance or Markov parameters e.g.)
//
//This is used e.g. in the solution of normal equations
//by classical identification methods (Instrumental Variables e.g.)
//
//1)let’s generate the multidimensional data under the form :
// C=[c_0 c_1 c_2 .... c_n]
//where each bloc c_k is a d-dimensional matrix (e.g. the k-th correlation
//of a d-dimensional stochastic process X(t) [c_k = E(X(t) X’(t+k)], ’
//being the transposition in scilab)
//
//we take here d=2 and n=64
//
c=rand(2,2*64)
//
//generate the hankel matrix H (with 4 bloc-rows and 5 bloc-columns)
//from the data in c
//
H=hank(4,5,c);
//

S EE A LSO : toeplitz 227

2.6.30 hilb Hilbert transform

CALLING SEQUENCE :
[xh]=hilb(n[,wtype][,par])
PARAMETERS :
n : odd integer : number of points in filter
wtype : string : window type (’re’,’tr’,’hn’,’hm’,’kr’,’ch’) (default =’re’)
par : window parameter for wtype=’kr’ or ’ch’ default par=[0 0] see the function window
for more help
xh : Hilbert transform
DESCRIPTION :
returns the first n points of the Hilbert transform centred around the origin.
That is, xh=(2/(n*pi))*(sin(n*pi/2))ˆ2.
EXAMPLE :
plot(hilb(51))

AUTHOR : C. B.

Scilab Group April 1993 462

iirlp Scilab Function

2.6.31 iir iir digital filter

CALLING SEQUENCE :

[hz]=iir(n,ftype,fdesign,frq,delta)

PARAMETERS :

n : filter order (pos. integer)

ftype : string specifying the filter type ’lp’,’hp’,’bp’,’sb’
fdesign : string specifying the analog filter design =’butt’,’cheb1’,’cheb2’,’ellip’
frq : 2-vector of discrete cut-off frequencies (i.e., 0<frq<.5). For lp and hp filters only frq(1)
is used. For bp and sb filters frq(1) is the lower cut-off frequency and frq(2) is the upper
cut-off frequency
delta : 2-vector of error values for cheb1, cheb2, and ellip filters where only delta(1) is
used for cheb1 case, only delta(2) is used for cheb2 case, and delta(1) and delta(2)
are both used for ellip case. 0<delta(1),delta(2)<1
- for cheb1 filters 1-delta(1)<ripple<1 in passband
- for cheb2 filters 0<ripple<delta(2) in stopband
- for ellip filters 1-delta(1)<ripple<1 in passband and 0<ripple<delta(2) in stop-
band

DESCRIPTION :
function which designs an iir digital filter using analog filter designs.
EXAMPLE :

hz=iir(3,’bp’,’ellip’,[.15 .25],[.08 .03]);

[hzm,fr]=frmag(hz,256);
plot2d(fr’,hzm’)
xtitle(’Discrete IIR filter band pass 0.15<fr<0.25 ’,’ ’,’ ’);
q=poly(0,’q’); //to express the result in terms of the ...
hzd=horner(hz,1/q) //delay operator q=zˆ-1

S EE A LSO : eqfir 455, eqiir 456

AUTHOR : C. B.

2.6.32 iirgroup group delay Lp IIR filter optimization

CALLING SEQUENCE :

[lt,grad]=iirgroup(p,r,theta,omega,wt,td)
[cout,grad,ind]=iirlp(x,ind,p,[flag],lambda,omega,ad,wa,td,wt)

PARAMETERS :

r : vector of the module of the poles and the zeros of the filters
theta : vector of the argument of the poles and the zeros of the filters
omega : frequencies where the filter specifications are given
wt : weighting function for and the group delay
td : desired group delay
lt, grad : criterium and gradient values

DESCRIPTION :
optimization of IIR filters for the Lp criterium for the the group delay. (Rabiner & Gold pp270-273).

Scilab Group April 1993 463

kalm Scilab Function

2.6.33 iirlp Lp IIR filter optimization

CALLING SEQUENCE :

[cost,grad,ind]=iirlp(x,ind,p,[flag],lambda,omega,ad,wa,td,wt)

PARAMETERS :

x : 1X2 vector of the module and argument of the poles and the zeros of the filters
flag : string : ’a’ for amplitude, ’gd’ for group delay; default case for amplitude and group delay.
omega : frequencies where the filter specifications are given
wa,wt : weighting functions for the amplitude and the group delay
lambda : weighting (with 1-lambda) of the costs (’a’ and ’gd’ for getting the global cost.
ad, td : desired amplitude and group delay
cost, grad : criterium and gradient values

DESCRIPTION :
optimization of IIR filters for the Lp criterium for the amplitude and/or the group delay. (Rabiner & Gold
pp270-273).

2.6.34 intdec Changes sampling rate of a signal

CALLING SEQUENCE :

[y]=intdec(x,lom)

PARAMETERS :

x : input sampled signal

lom : For a 1D signal this is a scalar which gives the rate change. For a 2D signal this is a 2-Vector of
sampling rate changes lom=(col rate change,row rate change)
y : Output sampled signal

DESCRIPTION :
Changes the sampling rate of a 1D or 2D signal by the rates in lom
AUTHOR : C. B.

2.6.35 jmat row or column block permutation

CALLING SEQUENCE :

[j]=jmat(n,m)

PARAMETERS :

n : number of block rows or block columns of the matrix

m : size of the (square) blocks

DESCRIPTION :
This function permutes block rows or block columns of a matrix

Scilab Group April 1993 464

lattp Scilab Function

2.6.36 kalm Kalman update

CALLING SEQUENCE :

[x1,p1,x,p]=kalm(y,x0,p0,f,g,h,q,r)

PARAMETERS :

f,g,h : current system matrices

q, r : covariance matrices of dynamics and observation noise
x0,p0 : state estimate and error variance at t=0 based on data up to t=-1
y : current observation Output from the function is:
x1,p1 : updated estimate and error covariance at t=1 based on data up to t=0
x : updated estimate and error covariance at t=0 based on data up to t=0

DESCRIPTION :
function which gives the Kalman update and error variance
AUTHOR : C. B.

2.6.37 lattn recursive solution of normal equations

CALLING SEQUENCE :

[la,lb]=lattn(n,p,cov)

PARAMETERS :

n : maximum order of the filter

p : fixed dimension of the MA part. If p= -1, the algorithm reduces to the classical Levinson recursions.
cov : matrix containing the Rk’s (d*d matrices for a d-dimensional process).It must be given the follow-
ing way
2 3
R0
6 R1 7
6 7
cov = 6 R26
7
7
4 .. 5
.
Rnlag
la : list-type variable, giving the successively calculated polynomials (degree 1 to degree n),with coeffi-
cients Ak

DESCRIPTION :
solves recursively on n (p being fixed) the following system (normal equations), i.e. identifies the AR
part (poles) of a vector ARMA(n,p) process
0
Rp+1 Rp+2 : : : Rp+n 1
B Rp Rp+1 : : : Rp+n 1 C
(I A1 A2 : : : An ) B
@ .. .. .. C=0
A
. . ::: .
Rp+1 n Rp+2 n ::: Rp
where fRk;k=1,nlagg is the sequence of empirical covariances
AUTHOR : G. Le V.

Scilab Group April 1993 465

levin Scilab Function

2.6.38 lattp lattp

CALLING SEQUENCE :

[la,lb]=lattp(n,p,cov)

DESCRIPTION :
see lattn
AUTHOR : G.Levey

2.6.39 lev Yule-Walker equations (Levinson’s algorithm)

CALLING SEQUENCE :

[ar,sigma2,rc]=lev(r)

PARAMETERS :

r : correlation coefficients
ar : auto-Regressive model parameters
sigma2 : scale constant
rc : reflection coefficients

DESCRIPTION :
resolve the Yule-Walker equations
0 10 1 0 1
R0 R1 : : : RN 1 ar1 2
B R1 R0 : : : RN CB ar2 C B 0 C
CB C B C
2
B
@ .. .. .. AB
@
.. C=B .
A @ ..
C
A
. . ::: . .
RN 1 RN 2 ::: R0 arN 1 0

where Ri = r (i 1). using Levinson’s algorithm.

AUTHOR : C. B.

2.6.40 levin Toeplitz system solver by Levinson algorithm (multidimensional)

CALLING SEQUENCE :

[la,sig]=levin(n,cov)

PARAMETERS :

n : maximum order of the filter

cov : matrix containing the R k (d x d matrices for a d-dimensional process). It must be given the following
way : 0 1
R0
B
B R1 C
C
B
B R2 C
C
B .. C
@ . A
Rnlag

Scilab Group April 1993 466

levin Scilab Function

la : list-type variable, giving the successively calculated Levinson polynomials (degree 1 to n), with
coefficients Ak
sig : list-type variable, giving the successive mean-square errors.

DESCRIPTION :
function which solves recursively on n the following Toeplitz system (normal equations)
0 1
R1 R2 : : : Rn
B
B R0 R1 : : : Rn 1 C
C

B R 1 R0 : : : Rn 2 C
I A1 : : : An B
B .. .. ..
C
C=0
B . . ::: . C
B C
@ R2 n R3 n ::: R1 A
R1 n R2 n ::: R0
where fRk;k=1,nlagg is the sequence of nlag empirical covariances
AUTHOR : G. Le Vey
EXAMPLE :

//We use the ’levin’ macro for solving the normal equations
//on two examples: a one-dimensional and a two-dimensional process.
//We need the covariance sequence of the stochastic process.
//This example may usefully be compared with the results from
//the ’phc’ macro (see the corresponding help and example in it)
//
//
//1) A one-dimensional process
// -------------------------
//
//We generate the process defined by two sinusoids (1Hz and 2 Hz)
//in additive Gaussian noise (this is the observed process);
//the simulated process is sampled at 10 Hz (step 0.1 in t, underafter).
//
t1=0:.1:100;rand(’normal’);
y1=sin(2*%pi*t1)+sin(2*%pi*2*t1);y1=y1+rand(y1);plot(t1,y1);
//
//covariance of y1
//
nlag=128;
c1=corr(y1,nlag);
c1=c1’;//c1 needs to be given columnwise (see the section PARAMETERS of this
help)
//
//compute the filter for a maximum order of n=10
//la is a list-type variable each element of which
//containing the filters of order ranging from 1 to n; (try varying n)
//in the d-dimensional case this is a matrix polynomial (square, d X d)
//sig gives, the same way, the mean-square error
//
n=15;
[la1,sig1]=levin(n,c1);
//
//verify that the roots of ’la’ contain the
//frequency spectrum of the observed process y
//(remember that y is sampled -in our example
//at 10Hz (T=0.1s) so that we need to retrieve

Scilab Group April 1993 467

lgfft Scilab Function

//the original frequencies (1Hz and 2 Hz) through

//the log and correct scaling by the frequency sampling)
//we verify this for each filter order
//
for i=1:n, s1=roots(la1(i));s1=log(s1)/2/%pi/.1;
//
//now we get the estimated poles (sorted, positive ones only !)
//
s1=sort(imag(s1));s1=s1(1:i/2);end;
//
//the last two frequencies are the ones really present in the observed
//process ---> the others are "artifacts" coming from the used model size.
//This is related to the rather difficult problem of order estimation.
//
//2) A 2-dimensional process
// -----------------------
//(4 frequencies 1, 2, 3, and 4 Hz, sampled at 0.1 Hz :
// |y_1| y_1=sin(2*Pi*t)+sin(2*Pi*2*t)+Gaussian noise
// y=| | with :
// |y_2| y_2=sin(2*Pi*3*t)+sin(2*Pi*4*t)+Gaussian noise
//
//
d=2;dt=0.1;
nlag=64;
t2=0:2*%pi*dt:100;
y2=[sin(t2)+sin(2*t2)+rand(t2);sin(3*t2)+sin(4*t2)+rand(t2)];
c2=[];
for j=1:2, for k=1:2, c2=[c2;corr(y2(k,:),y2(j,:),nlag)];end;end;
c2=matrix(c2,2,128);cov=[];
for j=1:64,cov=[cov;c2(:,(j-1)*d+1:j*d)];end;//covar. columnwise
c2=cov;
//
//in the multidimensional case, we have to compute the
//roots of the determinant of the matrix polynomial
//(easy in the 2-dimensional case but tricky if d>=3 !).
//We just do that here for the maximum desired
//filter order (n); mp is the matrix polynomial of degree n
//
[la2,sig2]=levin(n,c2);
mp=la2(n);determinant=mp(1,1)*mp(2,2)-mp(1,2)*mp(2,1);
s2=roots(determinant);s2=log(s2)/2/%pi/0.1;//same trick as above for 1D process
s2=sort(imag(s2));s2=s2(1:d*n/2);//just the positive ones !
//
//There the order estimation problem is seen to be much more difficult !
//many artifacts ! The 4 frequencies are in the estimated spectrum
//but beneath many non relevant others.
//

S EE A LSO : phc 471

2.6.41 lgfft utility for fft

CALLING SEQUENCE :

Scilab Group April 1993 468

mfft Scilab Function

[y]=lgfft(x)

PARAMETERS :

x : real or complex vector

DESCRIPTION :
returns the lowest power of 2 larger than size(x) (for FFT use).

2.6.42 lindquist Lindquist’s algorithm

CALLING SEQUENCE :

[P,R,T]=lindquist(n,H,F,G,R0)

PARAMETERS :

n : number of iterations.
H, F, G : estimated triple from the covariance sequence of y.
R0 : E(yk*yk’)
P : solution of the Riccati equation after n iterations.
R, T : gain matrices of the filter.

DESCRIPTION :
computes iteratively the minimal solution of the algebraic Riccati equation and gives the matrices R and
T of the filter model, by the Lindquist’s algorithm.
AUTHOR : G. Le V.
S EE A LSO : srfaur 476, faurre 456, phc 471

2.6.43 mese maximum entropy spectral estimation

CALLING SEQUENCE :

[sm,fr]=mese(x [,npts]);

PARAMETERS :

x : Input sampled data sequence

npts : Optional parameter giving number of points of fr and sm (default is 256)
sm : Samples of spectral estimate on the frequency grid fr
fr : npts equally spaced frequency samples in [0,.5)

DESCRIPTION :
Calculate the maximum entropy spectral estimate of x
AUTHOR : C. B.

Scilab Group April 1993 469

phc Scilab Function

2.6.44 mfft multi-dimensional fft

CALLING SEQUENCE :

[xk]=mfft(x,flag,dim)

PARAMETERS :

x : x(i,j,k,...) input signal in the form of a row vector whose values are arranged so that the i
index runs the quickest, followed by the j index, etc.
flag : (-1) FFT or (1) inverse FFT
dim : dimension vector which gives the number of values of x for each of its indices
xk : output of multidimensional fft in same format as for x

DESCRIPTION :
FFT for a multi-dimensional signal
For example for a three dimensional vector which has three points along its first dimension, two points
along its second dimension and three points along its third dimension the row vector is arranged as follows

x=[x(1,1,1),x(2,1,1),x(3,1,1),
x(1,2,1),x(2,2,1),x(3,2,1),
x(1,1,2),x(2,1,2),x(3,1,2),
x(1,2,2),x(2,2,2),x(3,2,2),
x(1,1,3),x(2,1,3),x(3,1,3),
x(1,2,3),x(2,2,3),x(3,2,3)]

and the dim vector is: dim=[3,2,3]

AUTHOR : C. B.

2.6.45 mrfit frequency response fit

CALLING SEQUENCE :

sys=mrfit(w,mag,order)
[num,den]=mrfit(w,mag,order)
sys=mrfit(w,mag,order,weight)
[num,den]=mrfit(w,mag,order,weight)

PARAMETERS :

w : positive real vector of frequencies (Hz)

mag : real vector of frequency responses magnitude (same size as w)
order : integer (required order, degree of den)
weight : positive real vector (default value ones(w)).
num,den : stable polynomials

DESCRIPTION :
sys=mrfit(w,mag,order,weight) returns a bi-stable transfer function G(s)=sys=num/den,
of of given order such that its frequency response magnitude abs(G(w(i))) matches mag(i) i.e.
abs(freq(num,den,%i*w)) should be close to mag. weight(i) is the weigth given to w(i).
EXAMPLE :

Scilab Group April 1993 470

phc Scilab Function

w=0.01:0.01:2;s=poly(0,’s’);
G=syslin(’c’,2*(sˆ2+0.1*s+2),(sˆ2+s+1)*(sˆ2+0.3*s+1)); // syslin(’c’,Num,Den);
fresp=repfreq(G,w);
mag=abs(fresp);
Gid=mrfit(w,mag,4);
frespfit=repfreq(Gid,w);
plot2d([w’,w’],[mag(:),abs(frespfit(:))])

S EE A LSO : cepstrum 448, frfit 459, freq 339, calfrq 324

2.6.46 phc Markovian representation

CALLING SEQUENCE :

[H,F,G]=phc(hk,d,r)

PARAMETERS :

hk : hankel matrix
d : dimension of the observation
r : desired dimension of the state vector for the approximated model
H, F, G : relevant matrices of the Markovian model

DESCRIPTION :
Function which computes the matrices H, F, G of a Markovian representation by the principal hankel
component approximation method, from the hankel matrix built from the covariance sequence of a stochas-
tic process.
EXAMPLE :

//
//This example may usefully be compared with the results from
//the ’levin’ macro (see the corresponding help and example)
//
//We consider the process defined by two sinusoids (1Hz and 2 Hz)
//in additive Gaussian noise (this is the observation);
//the simulated process is sampled at 10 Hz.
//
t=0:.1:100;rand(’normal’);
y=sin(2*%pi*t)+sin(2*%pi*2*t);y=y+rand(y);plot(t,y)
//
//covariance of y
//
nlag=128;
c=corr(y,nlag);
//
//hankel matrix from the covariance sequence
//(we can choose to take more information from covariance
//by taking greater n and m; try it to compare the results !
//
n=20;m=20;
h=hank(n,m,c);
//
//compute the Markov representation (mh,mf,mg)
//We just take here a state dimension equal to 4 :

Scilab Group April 1993 471

pspect Scilab Function

//this is the rather difficult problem of estimating the order !

//Try varying ns !
//(the observation dimension is here equal to one)
ns=4;
[mh,mf,mg]=phc(h,1,ns);
//
//verify that the spectrum of mf contains the
//frequency spectrum of the observed process y
//(remember that y is sampled -in our example
//at 10Hz (T=0.1s) so that we need
//to retrieve the original frequencies through the log
//and correct scaling by the frequency sampling)
//
s=spec(mf);s=log(s);
s=s/2/%pi/.1;
//
//now we get the estimated spectrum
imag(s),
//

S EE A LSO : levin 466

2.6.47 pspect cross-spectral estimate between 2 series

CALLING SEQUENCE :

[sm,cwp]=pspect(sec_step,sec_leng,wtype,x,y,wpar)

PARAMETERS :

x : data if vector, amount of input data if scalar

y : data if vector, amount of input data if scalar
sec step : offset of each data window
sec leng : length of each data window
wtype : window type (re,tr,hm,hn,kr,ch)
wpar : optional parameters for wtype=’kr’, wpar>0 for wtype=’ch’, 0<wpar(1)<.5, wpar(2)>0
sm : power spectral estimate in the interval [0,1]
cwp : unspecified Chebyshev window parameter

DESCRIPTION :
Cross-spectral estimate between x and y if both are given and auto-spectral estimate of x otherwise.
Spectral estimate obtained using the modified periodogram method.
EXAMPLE :

rand(’normal’);rand(’seed’,0);
x=rand(1:1024-33+1);
//make low-pass filter with eqfir
nf=33;bedge=[0 .1;.125 .5];des=[1 0];wate=[1 1];
h=eqfir(nf,bedge,des,wate);
//filter white data to obtain colored data
h1=[h 0*ones(1:maxi(size(x))-1)];
x1=[x 0*ones(1:maxi(size(h))-1)];
hf=fft(h1,-1); xf=fft(x1,-1);yf=hf.*xf;y=real(fft(yf,1));
//plot magnitude of filter

Scilab Group April 1993 472

remezb Scilab Function

//h2=[h 0*ones(1:968)];hf2=fft(h2,-1);hf2=real(hf2.*conj(hf2));
//hsize=maxi(size(hf2));fr=(1:hsize)/hsize;plot(fr,log(hf2));
//pspect example
sm=pspect(100,200,’tr’,y);smsize=maxi(size(sm));fr=(1:smsize)/smsize;
plot(fr,log(sm));
rand(’unif’);

S EE A LSO : cspect 452

AUTHOR : C. B.
REFERENCE :
Digital Signal Processing by Oppenheim and Schafer

2.6.48 remez Remez’s algorithm

CALLING SEQUENCE :

[an]=remez(nc,fg,ds,wt)

PARAMETERS :

nc : integer, number of cosine functions

fg,ds,wt : real vectors
fg : grid of frequency points in [0,.5)
ds : desired magnitude on grid fg
wt : weighting function on error on grid fg

DESCRIPTION :
minimax approximation of a frequency domain magnitude response. The approximation takes the form
h = sum[a(n)*cos(wn)]
for n=0,1,...,nc. An FIR, linear-phase filter can be obtained from the the output of remez by using the
following commands:
hn(1nc-1)=an(nc-12)/2;
hn(nc)=an(1);
hn(nc+12*nc-1)=an(2nc)/2;
where an = cosine filter coefficients
S EE A LSO : remezb 473

2.6.49 remezb Minimax approximation of magnitude response

CALLING SEQUENCE :

[an]=remezb(nc,fg,ds,wt)

PARAMETERS :

nc : Number of cosine functions

fg : Grid of frequency points in [0,.5)
ds : Desired magnitude on grid fg
wt : Weighting function on error on grid fg
an : Cosine filter coefficients

Scilab Group April 1993 473

rpem Scilab Function

DESCRIPTION :
Minimax approximation of a frequency domain magnitude response. The approximation takes the form
h = sum[a(n)*cos(wn)] for n=0,1,...,nc. An FIR, linear-phase filter can be obtained from the the
output of the function by using the following commands

hn(1:nc-1)=an(nc:-1:2)/2;
hn(nc)=an(1);
hn(nc+1:2*nc-1)=an(2:nc)/2;

EXAMPLE :

// Choose the number of cosine functions and create a dense grid

// in [0,.24) and [.26,.5)
nc=21;ngrid=nc*16;
fg=.24*(0:ngrid/2-1)/(ngrid/2-1);
fg(ngrid/2+1:ngrid)=fg(1:ngrid/2)+.26*ones(1:ngrid/2);
// Specify a low pass filter magnitude for the desired response
ds(1:ngrid/2)=ones(1:ngrid/2);
ds(ngrid/2+1:ngrid)=zeros(1:ngrid/2);
// Specify a uniform weighting function
wt=ones(fg);
// Run remezb
an=remezb(nc,fg,ds,wt)
// Make a linear phase FIR filter
hn(1:nc-1)=an(nc:-1:2)/2;
hn(nc)=an(1);
hn(nc+1:2*nc-1)=an(2:nc)/2;
// Plot the filter’s magnitude response
plot(.5*(0:255)/256,frmag(hn,256));
//////////////
// Choose the number of cosine functions and create a dense grid in [0,.5)
nc=21; ngrid=nc*16;
fg=.5*(0:(ngrid-1))/ngrid;
// Specify a triangular shaped magnitude for the desired response
ds(1:ngrid/2)=(0:ngrid/2-1)/(ngrid/2-1);
ds(ngrid/2+1:ngrid)=ds(ngrid/2:-1:1);
// Specify a uniform weighting function
wt=ones(fg);
// Run remezb
an=remezb(nc,fg,ds,wt)
// Make a linear phase FIR filter
hn(1:nc-1)=an(nc:-1:2)/2;
hn(nc)=an(1);
hn(nc+1:2*nc-1)=an(2:nc)/2;
// Plot the filter’s magnitude response
plot(.5*(0:255)/256,frmag(hn,256));

AUTHOR : C. B.
S EE A LSO : eqfir 455

2.6.50 rpem RPEM estimation

CALLING SEQUENCE :

Scilab Group April 1993 474

sinc Scilab Function

[w1,[v]]=rpem(w0,u0,y0,[lambda,[k,[c]]])

PARAMETERS :

a,b,c : a=[a(1),...,a(n)], b=[b(1),...,b(n)], c=[c(1),...,c(n)]

w0 : list(theta,p,phi,psi,l) where:
theta : [a,b,c] is a real vector of order 3*n
p : (3*n x 3*n) real matrix.
phi,psi,l : real vector of dimension 3*n
During the first call on can take:

theta=phi=psi=l=0*ones(1,3*n). p=eye(3*n,3*n)

u0 : real vector of inputs (arbitrary size) (if no input take u0=[ ]).
y0 : vector of outputs (same dimension as u0 if u0 is not empty). (y0(1) is not used by rpem).

If the time domain is (t0,t0+k-1) the u0 vector contains the inputs

u(t0),u(t0+1),..,u(t0+k-1) and y0 the outputs
y(t0),y(t0+1),..,y(t0+k-1)
DESCRIPTION :
Recursive estimation of parameters in an ARMAX model. Uses Ljung-Soderstrom recursive prediction
error method. Model considered is the following:

y(t)+a(1)*y(t-1)+...+a(n)*y(t-n)=
b(1)*u(t-1)+...+b(n)*u(t-n)+e(t)+c(1)*e(t-1)+...+c(n)*e(t-n)

The effect of this command is to update the estimation of unknown parameter theta=[a,b,c] with
a=[a(1),...,a(n)], b=[b(1),...,b(n)], c=[c(1),...,c(n)].
OPTIONAL PARAMETERS :

lambda : optional parameter (forgetting constant) choosed close to 1 as convergence occur:

lambda=[lambda0,alfa,beta] evolves according to :

lambda(t)=alfa*lambda(t-1)+beta

with lambda(0)=lambda0
k : contraction factor to be chosen close to 1 as convergence occurs.
k=[k0,mu,nu] evolves according to:

k(t)=mu*k(t-1)+nu

with k(0)=k0.
c : large parameter.(c=1000 is the default value).
OUTPUT PARAMETERS: :

w1: update for w0.

v: sum of squared prediction errors on u0, y0.(optional).
In particular w1(1) is the new estimate of theta. If a new sample u1, y1 is available the update is
obtained by:
[w2,[v]]=rpem(w1,u1,y1,[lambda,[k,[c]]]). Arbitrary large series can thus be treated.

Scilab Group April 1993 475

srfaur Scilab Function

2.6.51 sinc samples of sinc function

CALLING SEQUENCE :

[x]=sinc(n,fl)

PARAMETERS :

n : number of samples
fl : cut-off frequency of the associated low-pass filter in Hertz.
x : samples of the sinc function

DESCRIPTION :
Calculate n samples of the function sin(2*pi*fl*t)/(pi*t) for t=-(n-1)/2:(n-1)/2 (i.e.
centred around the origin).
EXAMPLE :

plot(sinc(100,0.1))

S EE A LSO : sincd 476

AUTHOR : C. B.

2.6.52 sincd digital sinc function or Direchlet kernel

CALLING SEQUENCE :

[s]=sincd(n,flag)

PARAMETERS :

n : integer
flag : if flag = 1 the function is centred around the origin; if flag = 2 the function is delayed by
%pi/(2*n)
s : vector of values of the function on a dense grid of frequencies

DESCRIPTION :
function which calculates the function Sin(N*x)/N*Sin(x)
EXAMPLE :

plot(sincd(10,1))

AUTHOR : G. Le V.

2.6.53 srfaur square-root algorithm

CALLING SEQUENCE :

[p,s,t,l,rt,tt]=srfaur(h,f,g,r0,n,p,s,t,l)

PARAMETERS :

h, f, g : convenient matrices of the state-space model.

r0 : E(yk*yk’).
n : number of iterations.

Scilab Group April 1993 476

sskf Scilab Function

p : estimate of the solution after n iterations.

s, t, l : intermediate matrices for successive iterations;
rt, tt : gain matrices of the filter model after n iterations.
p, s, t, l : may be given as input if more than one recursion is desired (evaluation of intermediate
values of p).

DESCRIPTION :
square-root algorithm for the algebraic Riccati equation.
EXAMPLE :

//GENERATE SIGNAL
x=%pi/10:%pi/10:102.4*%pi;
rand(’seed’,0);rand(’normal’);
y=[1;1]*sin(x)+[sin(2*x);sin(1.9*x)]+rand(2,1024);
//COMPUTE CORRELATIONS
c=[];for j=1:2,for k=1:2,c=[c;corr(y(k,:),y(j,:),64)];end;end
c=matrix(c,2,128);
//FINDING H,F,G with 6 states
hk=hank(20,20,c);
[H,F,G]=phc(hk,2,6);
//SOLVING RICCATI EQN
r0=c(1:2,1:2);
[P,s,t,l,Rt,Tt]=srfaur(H,F,G,r0,200);
//Make covariance matrix exactly symetric
Rt=(Rt+Rt’)/2

S EE A LSO : phc 471, faurre 456, lindquist 469

2.6.54 srkf square root Kalman filter

CALLING SEQUENCE :

[x1,p1]=srkf(y,x0,p0,f,h,q,r)

PARAMETERS :

f, h : current system matrices

q, r : covariance matrices of dynamics and observation noise
x0, p0 : state estimate and error variance at t=0 based on data up to t=-1
y : current observation Output from the function is
x1, p1 : updated estimate and error covariance at t=1 based on data up to t=0

DESCRIPTION :
square root Kalman filter algorithm
AUTHOR : C. B.

2.6.55 sskf steady-state Kalman filter

CALLING SEQUENCE :

[xe,pe]=sskf(y,f,h,q,r,x0)

PARAMETERS :

Scilab Group April 1993 477

wfir Scilab Function

y : data in form [y0,y1,...,yn], yk a column vector

f : system matrix dim(NxN)
h : observations matrix dim(MxN)
q : dynamics noise matrix dim(NxN)
r : observations noise matrix dim(MxM)
x0 : initial state estimate
xe : estimated state
pe : steady-state error covariance
DESCRIPTION :
steady-state Kalman filter
AUTHOR : C. B.

2.6.56 system observation update

CALLING SEQUENCE :
[x1,y]=system(x0,f,g,h,q,r)
PARAMETERS :
x0 : input state vector
f : system matrix
g : input matrix
h : Output matrix
q : input noise covariance matrix
r : output noise covariance matrix
x1 : output state vector
y : output observation
DESCRIPTION :
define system function which generates the next observation given the old state. System recursively calcu-
lated
x1=f*x0+g*u
y=h*x0+v
where u is distributed N(0,q) and v is distribute N(0,r).
AUTHOR : C. B.

2.6.57 trans low-pass to other filter transform

CALLING SEQUENCE :
hzt=trans(pd,zd,gd,tr_type,frq)
PARAMETERS :
hz : input polynomial
tr type : type of transformation
frq : frequency values
hzt : output polynomial
DESCRIPTION :
function for transforming standardized low-pass filter into one of the following filters: low-pass, high-pass,
band-pass, stop-band.
AUTHOR : C. Bunks

Scilab Group April 1993 478

wigner Scilab Function

2.6.58 wfir linear-phase FIR filters

CALLING SEQUENCE :

[wft,wfm,fr]=wfir(ftype,forder,cfreq,wtype,fpar)

PARAMETERS :

ftype : string : ’lp’,’hp’,’bp’,’sb’ (filter type)

forder : Filter order (pos integer)(odd for ftype=’hp’ or ’sb’)
cfreq : 2-vector of cutoff frequencies (0<cfreq(1),cfreq(2)<.5) only cfreq(1) is used when
ftype=’lp’ or ’hp’
wtype : Window type (’re’,’tr’,’hm’,’hn’,’kr’,’ch’)
fpar : 2-vector of window parameters. Kaiser window fpar(1)>0 fpar(2)=0. Chebyshev window
fpar(1)>0, fpar(2)<0 or fpar(1)<0, 0<fpar(2)<.5
wft : time domain filter coefficients
wfm : frequency domain filter response on the grid fr
fr : Frequency grid

DESCRIPTION :
Function which makes linear-phase, FIR low-pass, band-pass, high-pass, and stop-band filters using the
windowing technique. Works interactively if called with no arguments.
AUTHOR : C. Bunks

2.6.59 wiener Wiener estimate

CALLING SEQUENCE :

[xs,ps,xf,pf]=wiener(y,x0,p0,f,g,h,q,r)

PARAMETERS :

f, g, h : system matrices in the interval [t0,tf]

f =[f0,f1,...,ff], and fk is a nxn matrix
g =[g0,g1,...,gf], and gk is a nxn matrix
h =[h0,h1,...,hf], and hk is a mxn matrix
q, r : covariance matrices of dynamics and observation noise
q =[q0,q1,...,qf], and qk is a nxn matrix
r =[r0,r1,...,rf], and gk is a mxm matrix
x0, p0 : initial state estimate and error variance
y : observations in the interval [t0,tf]. y=[y0,y1,...,yf], and yk is a column m-vector
xs : Smoothed state estimate xs= [xs0,xs1,...,xsf], and xsk is a column n-vector
ps : Error covariance of smoothed estimate ps=[p0,p1,...,pf], and pk is a nxn matrix
xf : Filtered state estimate xf= [xf0,xf1,...,xff], and xfk is a column n-vector
pf : Error covariance of filtered estimate pf=[p0,p1,...,pf], and pk is a nxn matrix

DESCRIPTION :
function which gives the Wiener estimate using the forward-backward Kalman filter formulation
AUTHOR : C. B.

Scilab Group April 1993 479

yulewalk Scilab Function

2.6.60 wigner ’time-frequency’ wigner spectrum

CALLING SEQUENCE :

[tab]=wigner(x,h,deltat,zp)

PARAMETERS :

tab : wigner spectrum (lines correspond to the time variable)

x : analyzed signal
h : data window
deltat : analysis time increment (in samples)
zp : length of FFT’s. %pi/zp gives the frequency increment.

DESCRIPTION :
function which computes the ’time-frequency’ wigner spectrum of a signal.

2.6.61 window symmetric window

CALLING SEQUENCE :

[win_l,cwp]=window(wtype,n,par)

PARAMETERS :

wtype : window type (re,tr,hn,hm,kr,ch)

n : window length
par : parameter 2-vector (kaiser window: par(1)=beta>0) (Chebychev window par =[dp,df]),
dp =main lobe width (0<dp<.5), df=side lobe height (df>0)
win : window
cwp : unspecified Chebyshev window parameter

DESCRIPTION :
function which calculates symmetric window
AUTHOR : C. B.

2.6.62 yulewalk least-square filter design

CALLING SEQUENCE :

Hz = yulewalk(N,frq,mag)

PARAMETERS :

N : integer (order of desired filter)

frq : real row vector (non-decreasing order), frequencies.
mag : non negative real row vector (same size as frq), desired magnitudes.
Hz : filter B(z)/A(z)

DESCRIPTION :
Hz = yulewalk(N,frq,mag) finds the N-th order iir filter

Scilab Group April 1993 480

zpch2 Scilab Function

n-1 n-2
B(z) b(1)z + b(2)z + .... + b(n)
H(z)= ---- = ---------------------------------
n-1 n-2
A(z) z + a(2)z + .... + a(n)
which matches the magnitude frequency response given by vectors frq and mag. Vectors frq and mag
specify the frequency and magnitude of the desired frequency response. The frequencies in frq must be
between 0.0 and 1.0, with 1.0 corresponding to half the sample rate. They must be in increasing order and
start with 0.0 and end with 1.0.
EXAMPLE :
f=[0,0.4,0.4,0.6,0.6,1];H=[0,0,1,1,0,0];Hz=yulewalk(8,f,H);
fs=1000;fhz = f*fs/2;
xbasc(0);xset(’window’,0);plot2d(fhz’,H’);
xtitle(’Desired Frequency Response (Magnitude)’)
[frq,repf]=repfreq(Hz,0:0.001:0.5);
xbasc(1);xset(’window’,1);plot2d(fs*frq’,abs(repf’));
xtitle(’Obtained Frequency Response (Magnitude)’)

2.6.63 zpbutt Butterworth analog filter

CALLING SEQUENCE :
[pols,gain]=zpbutt(n,omegac)
PARAMETERS :
n : integer (filter order)
omegac : real (cut-off frequency in Hertz)
pols : resulting poles of filter
gain : resulting gain of filter
DESCRIPTION :
computes the poles of a Butterworth analog filter of order n and cutoff frequency omegac transfer function
H(s) is calculated by H(s) = gain/real(poly(pols,’s’))
AUTHOR : F.D.

2.6.64 zpch1 Chebyshev analog filter

CALLING SEQUENCE :
[poles,gain]=zpch1(n,epsilon,omegac)
PARAMETERS :
n : integer (filter order)
epsilon : real : ripple in the pass band (0<epsilon<1)
omegac : real : cut-off frequency in Hertz
poles : resulting filter poles
gain : resulting filter gain
DESCRIPTION :
Poles of a Type 1 Chebyshev analog filter. The transfer function is given by :
H(s)=gain/poly(poles,’s’)
AUTHOR : F.D.

Scilab Group April 1993 481

zpell Scilab Function

2.6.65 zpch2 Chebyshev analog filter

CALLING SEQUENCE :

[zeros,poles,gain]=zpch2(n,A,omegar)

PARAMETERS :

n : integer : filter order

A : real : attenuation in stop band (A>1)
omegar : real : cut-off frequency in Hertz
zeros : resulting filter zeros
poles : resulting filter poles
gain : Resulting filter gain

DESCRIPTION :
Poles and zeros of a type 2 Chebyshev analog filter gain is the gain of the filter
H(s)=gain*poly(zeros,’s’)/poly(poles,’s’)

AUTHOR : F.D.

2.6.66 zpell lowpass elliptic filter

CALLING SEQUENCE :

[zeros,poles,gain]=zpell(epsilon,A,omegac,omegar)

PARAMETERS :

epsilon : real : ripple of filter in pass band (0<epsilon<1)

A : real : attenuation of filter in stop band (A>1)
omegac : real : pass band cut-off frequency in Hertz
omegar : real : stop band cut-off frequency in Hertz
zeros : resulting zeros of filter
poles : resulting poles of filter
gain : resulting gain of filter

DESCRIPTION :
Poles and zeros of prototype lowpass elliptic filter. gain is the gain of the filter
S EE A LSO : ell1mag 455, eqiir 456
AUTHOR : F.D.

Scilab Group April 1993 482

zpell Scilab Function

2.7 Polynomial calculations

Scilab Group April 1993 483

cmndred Scilab Function

2.7.1 bezout Bezout equation for polynomials

CALLING SEQUENCE :

[thegcd,U]=bezout(p1,p2)

PARAMETERS :

p1, p2 : two real polynomials

DESCRIPTION :
[thegcd,U]=bezout(p1,p2) computes GCD thegcd of p1 and p2 and in addition a (2x2)
unimodular matrix U such that:
[p1,p2]*U = [thegcd,0]
The lcm of p1 and p2 is given by:
p1*U(1,2) (or -p2*U(2,2))
EXAMPLE :

x=poly(0,’x’);
p1=(x+1)*(x-3)ˆ5;p2=(x-2)*(x-3)ˆ3;
[thegcd,U]=bezout(p1,p2)
det(U)
clean([p1,p2]*U)
thelcm=p1*U(1,2)
lcm([p1,p2])

S EE A LSO : poly 65, roots 496, simp 497, clean 484, lcm 492

2.7.2 clean cleans matrices (round to zero small entries)

CALLING SEQUENCE :

[B]=clean(A [,epsa [,epsr]])

PARAMETERS :

A : a numerical matrix (scalar, polynomial, sparse...)

epsa,epsr : real numbers (default values resp. 1.d-10 and 1.d-10)

DESCRIPTION :
This function eliminates (i.e. set to zero) all the coefficients with absolute value < epsa and relative value
< epsr (relative means relative w.r.t. 1-norm of coefficients) in a polynomial (possibly matrix polynomial
or rational matrix).
Default values are epsa=1.d-10 and epsr=1.d-10;
For a constant (non polynomial) matrix clean(A,epsa) sets to zero all entries of A smaller than epsa.

EXAMPLE :

x=poly(0,’x’);
w=[x,1,2+x;3+x,2-x,xˆ2;1,2,3+x]/3;
w*inv(w)
clean(w*inv(w))

Scilab Group April 1993 484

colcompr Scilab Function

2.7.3 cmndred common denominator form

CALLING SEQUENCE :
[n,d]=cmndred(num,den)
PARAMETERS :
num, den : two polynomial matrices of same dimensions
DESCRIPTION :
[n,d]=cmndred(num,den) computes a polynomial matrix n and a common denominator poly-
nomial d such that:
n/d=num./den
The rational matrix defined by num./den is n/d
S EE A LSO : simp 497, clean 484

2.7.4 coeff coefficients of matrix polynomial

CALLING SEQUENCE :
[C]=coeff(Mp [,v])
PARAMETERS :
Mp : polynomial matrix
v : integer (row or column) vector of selected degrees
C : big matrix of the coefficients
DESCRIPTION :
C=coeff(Mp) returns in a big matrix C the coefficients of the polynomial matrix Mp . C is partitioned
as C=[C0,C1,...,Ck] where the Ci are arranged in increasing order k = maxi(degree(Mp))
C=coeff(Mp,v) returns the matrix of coefficients with degree in v . (v is a row or column vector).
S EE A LSO : poly 65, degree 486, inv_coeff 54

2.7.5 coffg inverse of polynomial matrix

CALLING SEQUENCE :
[Ns,d]=coffg(Fs)
PARAMETERS :
Fs : square polynomial matrix
DESCRIPTION :
coffg computes Fsˆ-1 where Fs is a polynomial matrix by co-factors method.
Fs inverse = Ns/d
d = common denominator; Ns = numerator (a polynomial matrix)
(For large matrices,be patient...results are generally reliable)
EXAMPLE :
s=poly(0,’s’)
a=[ s, sˆ2+1; s sˆ2-1];
[a1,d]=coffg(a);
(a1/d)-inv(a)
S EE A LSO : determ 487, detr 487, invr 491, penlaur 524, glever 512
AUTHOR : F. D.

Scilab Group April 1993 485

derivat Scilab Function

2.7.6 colcompr column compression of polynomial matrix

CALLING SEQUENCE :

[Y,rk,ac]=colcompr(A);

PARAMETERS :

A : polynomial matrix
Y : square polynomial matrix (right unimodular basis)
rk : normal rank of A
Ac : Ac=A*Y, polynomial matrix

DESCRIPTION :
column compression of polynomial matrix A (compression to the left)
EXAMPLE :

s=poly(0,’s’);
p=[s;s*(s+1)ˆ2;2*sˆ2+sˆ3];
[Y,rk,ac]=colcompr(p*p’);
p*p’*Y

S EE A LSO : rowcompr 496

2.7.7 degree degree of polynomial matrix

CALLING SEQUENCE :

[D]=degree(M)

PARAMETERS :

M : polynomial matrix
D : integer matrix

DESCRIPTION :
returns the matrix of highest degrees of M.
S EE A LSO : poly 65, coeff 485, clean 484

2.7.8 denom denominator

CALLING SEQUENCE :

den=denom(r)

PARAMETERS :

r : rational or polynomial or constant matrix.

den : polynomial matrix

DESCRIPTION :
den=denom(r) returns the denominator of a rational matrix.
Since rationals are internally represented as r=list([’r’,’num’,’den’,’dt’],num,den,[]),
denom(r) is the same as r(3) or r(’den’) .
S EE A LSO : numer 493

Scilab Group April 1993 486

diophant Scilab Function

2.7.9 derivat rational matrix derivative

CALLING SEQUENCE :
pd=derivat(p)
PARAMETERS :
p : polynomial or rational matrix
DESCRIPTION :
computes the derivative of the polynomial or rational function matrix w.r.t the dummy variable.
EXAMPLE :
s=poly(0,’s’);
derivat(1/s) // -1/sˆ2;

2.7.10 determ determinant of polynomial matrix

CALLING SEQUENCE :
res=determ(W [,k])
PARAMETERS :
W : real square polynomial matrix
k : integer (upper bound for the degree of the determinant of W)
DESCRIPTION :
res=determ(W [,k]) returns the determinant of a real polynomial matrix (computation made by
FFT).
k is an integer larger than the actual degree of the determinant of W.
The default value of k is the smallest power of 2 which is larger than n*maxi(degree(W)).
Method: evaluate the determinant of W for the Fourier frequencies and apply inverse FFT to the coefficients
of the determinant.
EXAMPLE :
s=poly(0,’s’);
w=s*rand(10,10);
determ(w)
det(coeff(w,1))*sˆ10
S EE A LSO : det 507, detr 487, coffg 485
AUTHOR : F.D.

2.7.11 detr polynomial determinant

CALLING SEQUENCE :
d=detr(h)
PARAMETERS :
h : polynomial or rational square matrix
DESCRIPTION :
d=detr(h) returns the determinant d of the polynomial or rational function matrix h. Based on
Leverrier’s algorithm.
S EE A LSO : det 507, determ 487

Scilab Group April 1993 487

factors Scilab Function

2.7.12 diophant diophantine (Bezout) equation

CALLING SEQUENCE :

[x,err]=diophant(p1p2,b)

PARAMETERS :

p1p2 : polynomial vector p1p2 = [p1 p2]

b : polynomial
x : polynomial vector [x1;x2]

DESCRIPTION :
diophant solves the bezout equation:
p1*x1+p2*x2=b with p1p2 a polynomial vector. If the equation is not solvable err = jjp1x1+p2x2
bjj=jjbjj else err=0
EXAMPLE :

s=poly(0,’s’);p1=(s+3)ˆ2;p2=(1+s);
x1=s;x2=(2+s);
[x,err]=diophant([p1,p2],p1*x1+p2*x2);
p1*x1+p2*x2-p1*x(1)-p2*x(2)

2.7.13 factors numeric real factorization

CALLING SEQUENCE :

[lnum,g]=factors(pol [,’flag’])
[lnum,lden,g]=factors(rat [,’flag’])
rat=factors(rat,’flag’)

PARAMETERS :

pol : real polynomial

rat : real rational polynomial (rat=pol1/pol2)
lnum : list of polynomials (of degrees 1 or 2)
lden : list of polynomials (of degrees 1 or 2)
g : real number
flag : character string ’c’ or ’d’

DESCRIPTION :
returns the factors of polynomial pol in the list lnum and the ”gain” g.
One has pol= g times product of entries of the list lnum (if flag is not given). If flag=’c’ is given,
then one has jpol(i omega)j = jg*prod(lnum j(i omega)j. If flag=’d’ is given, then one
has jpol(exp(i omega))j = jg*prod(lnum i(exp(i omega))j. If argument of factors is
a 1x1 rational rat=pol1/pol2, the factors of the numerator pol1 and the denominator pol2 are
returned in the lists lnum and lden respectively.
The ”gain” is returned as g,i.e. one has: rat= g times (product entries in lnum) / (product entries in lden).
If flag is ’c’ (resp. ’d’), the roots of pol are refected wrt the imaginary axis (resp. the unit circle),
i.e. the factors in lnum are stable polynomials.
Same thing if factors is invoked with a rational arguments: the entries in lnum and lden are sta-
ble polynomials if flag is given. R2=factors(R1,’c’) or R2=factors(R1,’d’) with R1 a
rational function or SISO syslin list then the output R2 is a transfer with stable numerator and denom-
inator and with same magnitude as R1 along the imaginary axis (’c’) or unit circle (’d’).
EXAMPLE :

Scilab Group April 1993 488

horner Scilab Function

n=poly([0.2,2,5],’z’);
d=poly([0.1,0.3,7],’z’);
R=syslin(’d’,n,d);
R1=factors(R,’d’)
roots(R1(’num’))
roots(R1(’den’))
w=exp(2*%i*%pi*[0:0.1:1]);
norm(abs(horner(R1,w))-abs(horner(R,w)))
S EE A LSO : simp 497

2.7.14 gcd gcd calculation

CALLING SEQUENCE :
[pgcd,U]=gcd(p)
PARAMETERS :
p : polynomial row vector p=[p1,..,pn]
DESCRIPTION :
[pgcd,u]=gcd(p) computes the gcd of components of p and a unimodular matrix (with polyno-
mial inverse) U, with minimal degree such that
p*U=[0 ... 0 pgcd]
EXAMPLE :
s=poly(0,’s’);
p=[s,s*(s+1)ˆ2,2*sˆ2+sˆ3];
[pgcd,u]=gcd(p);
p*u
S EE A LSO : bezout 484, lcm 492, hermit 489

2.7.15 hermit Hermite form

CALLING SEQUENCE :
[Ar,U]=hermit(A)
PARAMETERS :
A : polynomial matrix
Ar : triangular polynomial matrix
U : unimodolar polynomial matrix
DESCRIPTION :
Hermite form: U is an unimodular matrix such that A*U is in Hermite triangular form:
The output variable is Ar=A*U.
Warning: Experimental version
EXAMPLE :
s=poly(0,’s’);
p=[s, s*(s+1)ˆ2, 2*sˆ2+sˆ3];
[Ar,U]=hermit(p’*p);
clean(p’*p*U), det(U)
S EE A LSO : hrmt 490, htrianr 491

Scilab Group April 1993 489

htrianr Scilab Function

2.7.16 horner polynomial/rational evaluation

CALLING SEQUENCE :

horner(P,x)

PARAMETERS :

P : polynomial or rational matrix

x : real number or polynomial or rational

DESCRIPTION :
evaluates the polynomial or rational matrix P = P(s) when the variable s of the polynomial is replaced
by x:
horner(P,x)=P(x)
Example (Bilinear transform): Assume P = P(s) is a rational matrix then the rational matrix P((1+s)/(1-s))
is obtained by horner(P,(1+s)/(1-s)).
To evaluate a rational matrix at given frequencies use preferably the freq primitive.
EXAMPLES :

s=poly(0,’s’);M=[s,1/s];
horner(M,1)
horner(M,%i)
horner(M,1/s)

S EE A LSO : freq 339, repfreq 355, evstr 35

2.7.17 hrmt gcd of polynomials

CALLING SEQUENCE :

[pg,U]=hrmt(v)

PARAMETERS :

v : row of polynomials i.e. 1xk polynomial matrix

pg : polynomial
U : unimodular matrix polynomial

DESCRIPTION :
[pg,U]=hrmt(v) returns a unimodular matrix U and pg = gcd of row of polynomials v such that
v*U = [pg,0].
EXAMPLE :

x=poly(0,’x’);
v=[x*(x+1),xˆ2*(x+1),(x-2)*(x+1),(3*xˆ2+2)*(x+1)];
[pg,U]=hrmt(v);U=clean(U)
det(U)

S EE A LSO : gcd 489, htrianr 491

Scilab Group April 1993 490

lcm Scilab Function

2.7.18 htrianr triangularization of polynomial matrix

CALLING SEQUENCE :

[Ar,U,rk]=htrianr(A)

PARAMETERS :

A : polynomial matrix
Ar : polynomial matrix
U : unimodular polynomial matrix
rk : integer, normal rank of A

DESCRIPTION :
triangularization of polynomial matrix A.
A is [m,n] , m <= n.
Ar=A*U
Warning: there is an elimination of ”small” terms (see function code).
EXAMPLE :

x=poly(0,’x’);
M=[x;xˆ2;2+xˆ3]*[1,x-2,xˆ4];
[Mu,U,rk]=htrianr(M)
det(U)
M*U(:,1:2)

S EE A LSO : hrmt 490, colcompr 486

2.7.19 invr inversion of (rational) matrix

CALLING SEQUENCE :

F = invr(H)

PARAMETERS :

H : polynomial or rational matrix

F : polynomial or rational matrix

DESCRIPTION :
If H is a polynomial or rational function matrix, invr computes Hˆ(-1) using Leverrier’s algorithm
(see function code)
EXAMPLE :

s=poly(0,’s’)
H=[s,s*s+2;1-s,1+s]; invr(H)
[Num,den]=coffg(H);Num/den
H=[1/s,(s+1);1/(s+2),(s+3)/s];invr(H)

S EE A LSO : glever 512, coffg 485, inv 516

Scilab Group April 1993 491

ldiv Scilab Function

2.7.20 lcm least common multiple

CALLING SEQUENCE :

[pp,fact]=lcm(p)

PARAMETERS :

p :
fact : polynomial vector
pp : polynomial

DESCRIPTION :
pp=lcm(p) computes the lcm pp of polynomial vector p.
[pp,fact]=lcm(p) computes in addition the vector fact such that:
p.*fact=pp*ones(p)
EXAMPLE :

s=poly(0,’s’);
p=[s,s*(s+1)ˆ2,sˆ2*(s+2)];
[pp,fact]=lcm(p);
p.*fact, pp

S EE A LSO : gcd 489, bezout 484

2.7.21 lcmdiag least common multiple diagonal factorization

CALLING SEQUENCE :

[N,D]=lcmdiag(H)
[N,D]=lcmdiag(H,flag)

PARAMETERS :

H : rational matrix
N : polynomial matrix
D : diagonal polynomial matrix
flag : character string: ’row’ or ’col’ (default)

DESCRIPTION :
[N,D]=lcmdiag(H,’row’) computes a factorization D*H=N, i.e. H=Dˆ(-1)*N where D is a diagonal
matrix with D(k,k)=lcm of kth row of H(’den’).
[N,D]=lcmdiag(H) or [N,D]=lcmdiag(H,’col) returns H=N*Dˆ(-1) with diagonal D and D(k,k)=lcm
of kth col of H(’den’)
EXAMPLE :

s=poly(0,’s’);
H=[1/s,(s+2)/s/(s+1)ˆ2;1/(sˆ2*(s+2)),2/(s+2)];
[N,D]=lcmdiag(H);
N/D-H

S EE A LSO : lcm 492, gcd 489, bezout 484

Scilab Group April 1993 492

pdivg Scilab Function

2.7.22 ldiv polynomial matrix long division

CALLING SEQUENCE :

[x]=ldiv(n,d,k)

PARAMETERS :

n,d : two real polynomial matrices

k : integer

DESCRIPTION :
x=ldiv(n,d,k) gives the k first coefficients of the long division of n by d i.e. the Taylor expansion
of the rational matrix [nij(z)/dij(z)] near infinity.
Coefficients of expansion of nij/dij are stored in x((i-1)*n+k,j) k=1:n
EXAMPLE :

wss=ssrand(1,1,3);[a,b,c,d]=abcd(wss);
wtf=ss2tf(wss);
x1=ldiv(numer(wtf),denom(wtf),5)
x2=[c*b;c*a*b;c*aˆ2*b;c*aˆ3*b;c*aˆ4*b]
wssbis=markp2ss(x1’,5,1,1);
wtfbis=clean(ss2tf(wssbis))
x3=ldiv(numer(wtfbis),denom(wtfbis),5)

S EE A LSO : arl2 321, markp2ss 347, pdiv 493

2.7.23 numer numerator

CALLING SEQUENCE :

NUM=numer(R)

PARAMETERS :

R : rational matrix

DESCRIPTION :
Utility fonction. NUM=numer(R) returns the numerator NUM of a rational function matrix R (R may
be also a constant or polynomial matrix). numer(R) is equivalent to R(2) or R(’num’)
S EE A LSO : denom 486

2.7.24 pdiv polynomial division

CALLING SEQUENCE :

[R,Q]=pdiv(P1,P2)
[Q]=pdiv(P1,P2)

PARAMETERS :

P1 : polynomial matrix
P2 : polynomial or polynomial matrix

Scilab Group April 1993 493

polfact Scilab Function

R,Q : two polynomial matrices

DESCRIPTION :
Element-wise euclidan division of the polynomial matrix P1 by the polynomial P2 or by the polynomial
matrix P2. Rij is the matrix of remainders, Qij is the matrix of quotients and P1ij = Qij*P2 +
Qij or P1ij = Qij*P2ij + Qij.
EXAMPLE :

x=poly(0,’x’);
p1=(1+xˆ2)*(1-x);p2=1-x;
[r,q]=pdiv(p1,p2)
p2*q-p1
p2=1+x;
[r,q]=pdiv(p1,p2)
p2*q+r-p1

S EE A LSO : ldiv 493, gcd 489

2.7.25 pol2des polynomial matrix to descriptor form

CALLING SEQUENCE :

[N,B,C]=pol2des(Ds)
PARAMETERS :

Ds : polynomial matrix
N, B, C : three real matrices
DESCRIPTION :
Given the polynomial matrix Ds=D 0 +D 1 s +D 2 sˆ2 +... +D k sˆk, pol2des returns three
matrices N, B, C, with N nilpotent such that:
Ds = C (s*N-eye())ˆ-1 B
EXAMPLE :

s=poly(0,’s’);
G=[1,s;1+sˆ2,3*sˆ3];[N,B,C]=pol2des(G);
G1=clean(C*inv(s*N-eye())*B),G2=numer(G1)

S EE A LSO : ss2des 361, tf2des 390

AUTHOR : F.D.

2.7.26 pol2str polynomial to string conversion

CALLING SEQUENCE :

[str]=pol2str(p)
PARAMETERS :

p : real polynomial
str : character string
DESCRIPTION :
converts polynomial to character string (utility function).
S EE A LSO : string 284, pol2tex 664

Scilab Group April 1993 494

ROOTS Scilab Function

2.7.27 polfact minimal factors

CALLING SEQUENCE :

[f]=polfact(p)

PARAMETERS :

p : polynomial
f : vector [f0 f1 ... fn] such that p=prod(f)
f0 : constant
fi : polynomial

DESCRIPTION :
f=polfact(p) returns the minimal factors of p i.e. f=[f0 f1 ... fn] such that p=prod(f)

S EE A LSO : lcm 492, cmndred 485, factors 488

2.7.28 residu residue

CALLING SEQUENCE :

[V]=residu(P,Q1,Q2)

PARAMETERS :

P, Q1, Q2 : polynomials or matrix polynomials with real or complex coefficients.

DESCRIPTION :
V=residu(P,Q1,Q2) returns the matrix V such that V(i,j) is the sum of the residues of the
rational fraction P(i,j)/(Q1(i,j)*Q2(i,j)) calculated at the zeros of Q1(i,j).
Q1(i,j) and Q2(i,j) must not have any common root.
EXAMPLE :

s=poly(0,’s’);
H=[s/(s+1)ˆ2,1/(s+2)];N=numer(H);D=denom(H);
w=residu(N.*horner(N,-s),D,horner(D,-s)); //N(s) N(-s) / D(s) D(-s)
sqrt(sum(w)) //This is H2 norm
h2norm(tf2ss(H))
//
p=(s-1)*(s+1)*(s+2)*(s+10);a=(s-5)*(s-1)*(s*s)*((s+1/2)**2);
b=(s-3)*(s+2/5)*(s+3);
residu(p,a,b)+531863/4410 //Exact
z=poly(0,’z’);a=zˆ3+0.7*zˆ2+0.5*z-0.3;b=zˆ3+0.3*zˆ2+0.2*z+0.1;
atild=gtild(a,’d’);btild=gtild(b,’d’);
residu(b*btild,z*a,atild)-2.9488038 //Exact
a=a+0*%i;b=b+0*%i;
real(residu(b*btild,z*a,atild)-2.9488038) //Complex case

S EE A LSO : pfss 353, bdiag 502, roots 496, poly 65, gtild 380
AUTHOR : F.D.

Scilab Group April 1993 495

SFACT Scilab Function

2.7.29 roots roots of polynomials

CALLING SEQUENCE :
[x]=roots(p)
PARAMETERS :
p : polynomial with real or complex coefficients
DESCRIPTION :
x=roots(p) returns in the complex vector x the roots of the polynomial p. Degree of p must be
<=100.
EXAMPLE :
p=poly([0,10,1+%i,1-%i],’x’);
roots(p)
A=rand(3,3);roots(poly(A,’x’)) // Evals by characteristic polynomial
spec(A)
S EE A LSO : poly 65

2.7.30 routh t Routh’s table

CALLING SEQUENCE :
r=routh_t(h [,k]).
PARAMETERS :
h : square rational matrix
DESCRIPTION :
r=routh t(h,k) computes Routh’s table of denominator of the system described by transfer matrix
SISO h with the feedback by the gain k.
If k=poly(0,’k’) we will have a polynomial matrix with dummy variable k, formal expression of the
Routh table.

2.7.31 rowcompr row compression of polynomial matrix

CALLING SEQUENCE :
[X,rk,Ac]=rowcompr(A)
PARAMETERS :
A : polynomial matrix
Y : square polynomial matrix (left unimodular basis)
rk : normal rank of A
Ac : Ac=X*A, polynomial matrix
DESCRIPTION :
row compression of polynomial matrix A .
X is a left polynomial unimodular basis which row compressed thee rows of A. rk is the normal rank of
A.
Warning: elimination of ”small” terms (use with care!).
S EE A LSO : colcompr 486

Scilab Group April 1993 496

SIMP Scilab Function

2.7.32 sfact discrete time spectral factorization

CALLING SEQUENCE :

F=sfact(P)

PARAMETERS :

P : real polynomial matrix

DESCRIPTION :
Finds F, a spectral factor of P. P is a polynomial matrix such that each root of P has a mirror image w.r.t
the unit circle. Problem is singular if a root is on the unit circle.
sfact(P) returns a polynomial matrix F(z) which is antistable and such that
P = F(z)* F(1/z) *zˆn
For scalar polynomials a specific algorithm is implemented. Algorithms are adapted from Kucera’s book.
EXAMPLE :

//Simple polynomial example

z=poly(0,’z’);
p=(z-1/2)*(2-z)
w=sfact(p);
w*numer(horner(w,1/z))
//matrix example
F1=[z-1/2,z+1/2,zˆ2+2;1,z,-z;zˆ3+2*z,z,1/2-z];
P=F1*gtild(F1,’d’); //P is symmetric
F=sfact(P)
roots(det(P))
roots(det(gtild(F,’d’))) //The stable roots
roots(det(F)) //The antistable roots
clean(P-F*gtild(F,’d’))
//Example of continuous time use
s=poly(0,’s’);
p=-3*(s+(1+%i))*(s+(1-%i))*(s+0.5)*(s-0.5)*(s-(1+%i))*(s-(1-%i));p=real(p);
//p(s) = polynomial in sˆ2 , looks for stable f such that p=f(s)*f(-s)
w=horner(p,(1-s)/(1+s)); // bilinear transform w=p((1-s)/(1+s))
wn=numer(w); //take the numerator
fn=sfact(wn);f=numer(horner(fn,(1-s)/(s+1))); //Factor and back transform
f=f/sqrt(horner(f*gtild(f,’c’),0));f=f*sqrt(horner(p,0)); //normalization
roots(f) //f is stable
clean(f*gtild(f,’c’)-p) //f(s)*f(-s) is p(s)

S EE A LSO : gtild 380, fspecg 377

2.7.33 simp rational simplification

CALLING SEQUENCE :

[N1,D1]=simp(N,D)
H1=simp(H)

PARAMETERS :

N,D : real polynomials or real matrix polynomials

Scilab Group April 1993 497

sylmX Scilab Function

H : rational matrix (i.e matrix with entries n/d ,n and d real polynomials)

DESCRIPTION :
[n1,d1]=simp(n,d) calculates two polynomials n1 and d1 such that n1/d1 = n/d.
If N and D are polynomial matrices the calculation is performed element-wise.
H1=simp(H) is also valid (each entry of H is simplified in H1).
Caution:
-no threshold is given i.e. simp cannot forces a simplification.
-For linear dynamic systems which include integrator(s) simplification changes the static gain. (H(0) for
continuous systems or H(1) for discrete systems)
-for complex data, simp returns its input(s).
-rational simplification is called after nearly each operations on rationals. It is possible to toggle simplifica-
tion on or off using simp mode function.
EXAMPLES :

s=poly(0,’s’);
[n,d]=simp((s+1)*(s+2),(s+1)*(s-2))

simp_mode(%F);hns=s/s
simp_mode(%T);hns=s/s

S EE A LSO : roots 496, trfmod 228, poly 65, clean 484, simp_mode 498

2.7.34 simp mode toggle rational simplification

CALLING SEQUENCE :

mod=simp_mode()
simp_mode(mod)

PARAMETERS :

mod : a boolean

DESCRIPTION :
rational simplification is called after nearly each operations on rationals. It is possible to toggle simplifica-
tion on or off using simp mode function.
simp mod(%t) set rational simplification mode on
simp mod(%f) set rational simplification mode off
mod=simp mod() returns in mod the current rational simplification mode
EXAMPLES :

s=poly(0,’s’);
mod=simp_mode()
simp_mode(%f);hns=s/s
simp_mode(%t);hns=s/s
simp_mode(mod);

S EE A LSO : simp 497

Scilab Group April 1993 498

systmat Scilab Function

2.7.35 sylm Sylvester matrix

CALLING SEQUENCE :

[S]=sylm(a,b)

PARAMETERS :

a,b : two polynomials

S : matrix

DESCRIPTION :
sylm(a,b) gives the Sylvester matrix associated to polynomials a and b, i.e. the matrix S such that:
coeff( a*x + b*y )’ = S * [coeff(x)’;coeff(y)’].
Dimension of S is equal to degree(a)+degree(b).
If a and b are coprime polynomials then
rank(sylm(a,b))=degree(a)+degree(b)) and the instructions
u = sylm(a,b) \\ eye(na+nb,1)
x = poly(u(1:nb),’z’,’coeff’)
y = poly(u(nb+1:na+nb),’z’,’coeff’)
compute Bezout factors x and y of minimal degree such that a*x+b*y = 1

2.7.36 systmat system matrix

CALLING SEQUENCE :

[Sm]=systmat(Sl);

PARAMETERS :

Sl : linear system (syslin list) or descriptor system

Sm : matrix pencil

DESCRIPTION :
System matrix of the linear system Sl (syslin list) in state-space form (utility function).
Sm = [-sI + A B;
[ C D]
For a descriptor system (Sl=list(’des’,A,B,C,D,E)), systmat returns:
Sm = [-sE + A B;
[ C D]

S EE A LSO : ss2des 361, sm2des 360, sm2ss 360

Scilab Group April 1993 499

systmat Scilab Function

2.8 Linear Algebra

Scilab Group April 1993 500

aff2ab Scilab Function

2.8.1 aff2ab linear (affine) function to A,b conversion

CALLING SEQUENCE :

[A,b]=aff2ab(afunction,dimX,D [,flag])

PARAMETERS :

afunction : a scilab function Y =fct(X,D) where X, D, Y are list of matrices

dimX : a p x 2 integer matrix (p is the number of matrices in X)
D : a list of real matrices (or any other valid Scilab object).
flag : optional parameter (flag=’f’ or flag=’sp’)
A : a real matrix
b : a real vector having same row dimension as A

DESCRIPTION :
aff2ab returns the matrix representation of an affine function (in the canonical basis).
afunction is a function with imposed syntax: Y=afunction(X,D) where X=list(X1,X2,...,Xp)
is a list of p real matrices, and Y=list(Y1,...,Yq) is a list of q real real matrices which depend lin-
early of the Xi’s. The (optional) input D contains parameters needed to compute Y as a function of X. (It
is generally a list of matrices).
dimX is a p x 2 matrix: dimX(i)=[nri,nci] is the actual number of rows and columns of matrix Xi.
These dimensions determine na, the column dimension of the resulting matrix A: na=nr1*nc1 +...+
nrp*ncp.
If the optional parameter flag=’sp’ the resulting A matrix is returned as a sparse matrix.
This function is useful to solve a system of linear equations where the unknown variables are matrices.
EXAMPLE :

// Lyapunov equation solver (one unknown variable, one constraint)

deff(’Y=lyapunov(X,D)’,’[A,Q]=D(:);Xm=X(:); Y=list(A’’*Xm+Xm*A-Q)’)
A=rand(3,3);Q=rand(3,3);Q=Q+Q’;D=list(A,Q);dimX=[3,3];
[Aly,bly]=aff2ab(lyapunov,dimX,D);
[Xl,kerA]=linsolve(Aly,bly); Xv=vec2list(Xl,dimX); lyapunov(Xv,D)
Xm=Xv(:); A’*Xm+Xm*A-Q

// Lyapunov equation solver with redundant constraint X=X’

// (one variable, two constraints) D is global variable
deff(’Y=ly2(X,D)’,’[A,Q]=D(:);Xm=X(:); Y=list(A’’*Xm+Xm*A-Q,Xm’’-Xm)’)
A=rand(3,3);Q=rand(3,3);Q=Q+Q’;D=list(A,Q);dimX=[3,3];
[Aly,bly]=aff2ab(ly2,dimX,D);
[Xl,kerA]=linsolve(Aly,bly); Xv=vec2list(Xl,dimX); ly2(Xv,D)

// Francis equations
// Find matrices X1 and X2 such that:
// A1*X1 - X1*A2 + B*X2 -A3 = 0
// D1*X1 -D2 = 0
deff(’Y=bruce(X,D)’,’[A1,A2,A3,B,D1,D2]=D(:),...
[X1,X2]=X(:);Y=list(A1*X1-X1*A2+B*X2-A3,D1*X1-D2)’)
A1=[-4,10;-1,2];A3=[1;2];B=[0;1];A2=1;D1=[0,1];D2=1;
D=list(A1,A2,A3,B,D1,D2);
[n1,m1]=size(A1);[n2,m2]=size(A2);[n3,m3]=size(B);
dimX=[[m1,n2];[m3,m2]];
[Af,bf]=aff2ab(bruce,dimX,D);
[Xf,KerAf]=linsolve(Af,bf);Xsol=vec2list(Xf,dimX)
bruce(Xsol,D)

Scilab Group April 1993 501

bdiag Scilab Function

// Find all X which commute with A

deff(’y=f(X,D)’,’y=list(D(:)*X(:)-X(:)*D(:))’)
A=rand(3,3);dimX=[3,3];[Af,bf]=aff2ab(f,dimX,list(A));
[Xf,KerAf]=linsolve(Af,bf);[p,q]=size(KerAf);
Xsol=vec2list(Xf+KerAf*rand(q,1),dimX);
C=Xsol(:); A*C-C*A

S EE A LSO : linsolve 518

2.8.2 balanc matrix or pencil balancing

CALLING SEQUENCE :

[Ab,X]=balanc(A)
[Eb,Ab,X,Y]=balanc(E,A)

PARAMETERS :

A: a real square matrix

X: a real square invertible matrix
E: a real square matrix (same dimension as A)
Y: a real square invertible matrix.

DESCRIPTION :
Balance a square matrix to improve its condition number.
[Ab,X] = balanc(A) finds a similarity transformation X such that Ab = inv(X)*A*X has
approximately equal row and column norms.
For matrix pencils,balancing is done for improving the generalized eigenvalue problem.
[Eb,Ab,X,Y] = balanc(E,A) returns left and right transformations X and Y such that Eb=X*E*Y
Ab=X*A*Y
REMARK :
Balancing is made in the functions bdiag and spec.
EXAMPLE :

A=[1/2ˆ10,1/2ˆ10;2ˆ10,2ˆ10];
[Ab,X]=balanc(A);
norm(A(1,:))/norm(A(2,:))
norm(Ab(1,:))/norm(Ab(2,:))

S EE A LSO : bdiag 502

2.8.3 bdiag block diagonalization, generalized eigenvectors

CALLING SEQUENCE :

[Ab [,X [,bs]]]=bdiag(A [,rmax])

PARAMETERS :

A : real or complex square matrix

rmax : real number
Ab : real or complex square matrix
X : real or complex non-singular matrix

Scilab Group April 1993 502

chsolve Scilab Function

bs : vector of integers
DESCRIPTION :
[Ab [,X [,bs]]]=bdiag(A [,rmax])
performs the block-diagonalization of matrix A. bs gives the structure of the blocks (respective sizes of
the blocks). X is the change of basis i.e Ab = inv(X)*A*X is block diagonal.
rmax controls the conditioning of X; the default value is the l1 norm of A.
To get a diagonal form (if it exists) choose a large value for rmax (rmax=1/%eps for example). Gener-
ically (for real random A) the blocks are (1x1) and (2x2) and X is the matrix of eigenvectors.
EXAMPLE :
//Real case: 1x1 and 2x2 blocks
a=rand(5,5);[ab,x,bs]=bdiag(a);ab
//Complex case: complex 1x1 blocks
[ab,x,bs]=bdiag(a+%i*0);ab
S EE A LSO : schur 533, sylv 539, spec 537

2.8.4 chfact sparse Cholesky factorization

CALLING SEQUENCE :
spcho=chfact(A)
PARAMETERS :
A : square symmetric positive sparse matrix
spcho : list containing the Cholesky factors in coded form
DESCRIPTION :
spcho=chfact(A) computes the sparse Cholesky factors of sparse matrix A, assumed symmetric pos-
itive definite. This function is based on the Ng-Peyton programs (ORNL). See the Fortran programs for a
complete description of the variables in spcho. This function is to be used with chsolve.
S EE A LSO : chsolve 504, sparse 214, lufact 520, luget 520, spchol 536

2.8.5 chol Cholesky factorization

CALLING SEQUENCE :
[R]=chol(X)
PARAMETERS :
X : a symmetric positive definite real or complex matrix.
DESCRIPTION :
If X is positive definite, then R = chol(X) produces an upper triangular matrix R such that R’*R =
X.
chol(X) uses only the diagonal and upper triangle of X. The lower triangular is assumed to be the (com-
plex conjugate) transpose of the upper.
EXAMPLE :
W=rand(5,5)+%i*rand(5,5);
X=W*W’;
R=chol(X);
norm(R’*R-X)
S EE A LSO : spchol 536, qr 528, svd 538, bdiag 502, fullrf 510

Scilab Group April 1993 503

coff Scilab Function

2.8.6 chsolve sparse Cholesky solver

CALLING SEQUENCE :
sol=chsolve(spcho,rhs)
PARAMETERS :
spcho : list containing the Cholesky factors in coded form returned by chfact
rhs, sol : full column vectors
DESCRIPTION :
sol=chsolve(spcho,rhs) computes the solution of sol=A*rhs, with A a symmetric sparse pos-
itive definite matrix. This function is based on the Ng-Peyton programs (ORNL). See the Fortran programs
for a complete description of the variables in spcho.
EXAMPLE :
A=sprand(20,20,0.1);
A=A*A’+eye();
spcho=chfact(A);
sol=(1:20)’;rhs=A*sol;
spcho=chfact(A);
chsolve(spcho,rhs)
S EE A LSO : chfact 503, sparse 214, lufact 520, luget 520, spchol 536

2.8.7 classmarkov recurrent and transient classes of Markov matrix

CALLING SEQUENCE :
[perm,rec,tr,indsRec,indsT]=classmarkov(M)
PARAMETERS :
M : real N x N Markov matrix. Sum of entries in each row should add to one.
perm : integer permutation vector.
rec, tr : integer vector, number (number of states in each recurrent classes, number of transient states).
indsRec,indsT : integer vectors. (Indexes of recurrent and transient states).
DESCRIPTION :
Returns a permutation vector perm such that
M(perm,perm) = [M11 0 0 0 0 0]
[0 M22 0 0 0]
[0 0 M33 0]
[ ... ]
[0 0 Mrr 0]
[* * * Q]
Each Mii is a Markov matrix of dimension rec(i) i=1,..,r. Q is sub-Markov matrix of dimen-
sion tr. States 1 to sum(rec) are recurrent and states from r+1 to n are transient. One has perm=[indsRec,indsT]
where indsRec is a vector of size sum(rec) and indsT is a vector of size tr.
EXAMPLE :
//P has two recurrent classes (with 2 and 1 states) 2 transient states
P=genmarkov([2,1],2,’perm’)
[perm,rec,tr,indsRec,indsT]=classmarkov(P);
P(perm,perm)
S EE A LSO : genmarkov 511, eigenmarkov 507

Scilab Group April 1993 504

companion Scilab Function

2.8.8 coff resolvent (cofactor method)

CALLING SEQUENCE :

[N,d]=coff(M [,var])

PARAMETERS :

M : square real matrix

var : character string
N : polynomial matrix (same size as M)
d : polynomial (characteristic polynomial poly(A,’s’))

DESCRIPTION :
coff computes R=(s*eye()-M)ˆ-1 for M a real matrix. R is given by N/d.
N = numerator polynomial matrix.
d = common denominator.
var character string (’s’ if omitted)
EXAMPLE :

M=[1,2;0,3];
[N,d]=coff(M)
N/d
inv(%s*eye()-M)

S EE A LSO : coffg 485, ss2tf 363, nlev 522, poly 65

2.8.9 colcomp column compression, kernel, nullspace

CALLING SEQUENCE :

[W,rk]=colcomp(A [,flag] [,tol])

PARAMETERS :

A : real or complex matrix

flag : character string
tol : real number
W : square non-singular matrix (change of basis)
rk : integer (rank of A)

DESCRIPTION :
Column compression of A: Ac = A*W is column compressed i.e
Ac=[0,Af] with Af full column rank, rank(Af) = rank(A) = rk.
flag and tol are optional parameters: flag = ’qr’ or ’svd’ (default is ’svd’).
tol = tolerance parameter (of order %eps as default value).
The ma-rk first columns of W span the kernel of A when size(A)=(na,ma)
EXAMPLE :

A=rand(5,2)*rand(2,5);
[X,r]=colcomp(A);
norm(A*X(:,1:$-r),1)

S EE A LSO : rowcomp 531, fullrf 510, fullrfk 510, kernel 516

AUTHOR : F.D.

Scilab Group April 1993 505

det Scilab Function

2.8.10 companion companion matrix

CALLING SEQUENCE :

A=companion(p)

PARAMETERS :

p : polynomial or vector of polynomials

A : square matrix

DESCRIPTION :
Returns a matrix A with characteristic polynomial equal to p if p is monic. If p is not monic the
characteristic polynomial of A is equal to p/c where c is the coefficient of largest degree in p.
If p is a vector of monic polynomials, A is block diagonal, and the characteristic polynomial of the ith
block is p(i).
EXAMPLE :

s=poly(0,’s’);
p=poly([1,2,3,4,1],’s’,’c’)
det(s*eye()-companion(p))
roots(p)
spec(companion(p))

S EE A LSO : spec 537, poly 65, randpencil 529

AUTHOR : F.D.

2.8.11 cond condition number

CALLING SEQUENCE :

cond(X)

PARAMETERS :

X : real or complex square matrix

DESCRIPTION :
Condition number in 2-norm. cond(X) is the ratio of the largest singular value of X to the smallest.
EXAMPLE :

A=testmatrix(’hilb’,6);
cond(A)

S EE A LSO : rcond 531, svd 538

Scilab Group April 1993 506

ereduc Scilab Function

2.8.12 det determinant

CALLING SEQUENCE :

det(X)
[e,m]=det(X)

PARAMETERS :

X : real or complex square matrix, polynomial or rational matrix.

m : real or complex number, the determinant base 10 mantissae
e : integer, the determinant base 10 exponent

DESCRIPTION :
det(X) ( m*10ˆe is the determinant of the square matrix X.
For polynomial matrix det(X) is equivalent to determ(X).
For rational matrices det(X) is equivalent to detr(X).
EXAMPLE :

x=poly(0,’x’);
det([x,1+x;2-x,xˆ2])
w=ssrand(2,2,4);roots(det(systmat(w))),trzeros(w) //zeros of linear system
A=rand(3,3);
det(A), prod(spec(A))

S EE A LSO : detr 487, determ 487

2.8.13 eigenmarkov normalized left and right Markov eigenvectors

CALLING SEQUENCE :

[M,Q]=eigenmarkov(P)

PARAMETERS :

P : real N x N Markov matrix. Sum of entries in each row should add to one.
M : real matrix with N columns.
Q : real matrix with N rows.

DESCRIPTION :
Returns normalized left and right eigenvectors associated with the eigenvalue 1 of the Markov transition
matrix P. If the multiplicity of this eigenvalue is m and P is N x N, M is a m x N matrix and Q a N x m
matrix. M(k,:) is the probability distribution vector associated with the kth ergodic set (recurrent class).
M(k,x) is zero if x is not in the k-th recurrent class. Q(x,k) is the probability to end in the k-th recurrent
class starting from x. If Pˆk converges for large k (no eigenvalues on the unit circle except 1), then the
limit is Q*M (eigenprojection).
EXAMPLE :

//P has two recurrent classes (with 2 and 1 states) 2 transient states
P=genmarkov([2,1],2)
[M,Q]=eigenmarkov(P);
P*Q-Q
Q*M-Pˆ20

S EE A LSO : genmarkov 511, classmarkov 504

Scilab Group April 1993 507

expm Scilab Function

2.8.14 ereduc computes matrix column echelon form by qz transformations

CALLING SEQUENCE :

[E,Q,Z [,stair [,rk]]]=ereduc(X,tol)

PARAMETERS :

X : m x n matrix with real entries.

tol : real positive scalar.
E : column echelon form matrix
Q : m x m unitary matrix
Z : n x n unitary matrix
stair : vector of indexes,
* ISTAIR(i) = + j if the boundary element E(i,j) is a corner point.
* ISTAIR(i) = - j if the boundary element E(i,j) is not a corner point.
(i=1,...,M)
rk : integer, estimated rank of the matrix

DESCRIPTION :
Given an m x n matrix X (not necessarily regular) the function ereduc computes a unitary transformed
matrix E=Q*X*Z which is in column echelon form (trapezoidal form). Furthermore the rank of matrix X
is determined.
EXAMPLE :

X=[1 2 3;4 5 6]
[E,Q,Z ,stair ,rk]=ereduc(X,1.d-15)

S EE A LSO : fstair 509

AUTHOR : Th.G.J. Beelen (Philips Glass Eindhoven). SLICOT

2.8.15 exp element-wise exponential

CALLING SEQUENCE :

exp(X)

PARAMETERS :

X : scalar,vector or matrix with real or complex entries.

DESCRIPTION :
exp(X) is the (element-wise) exponential of the entries of X.
EXAMPLE :

x=[1,2,3+%i];
log(exp(x)) //element-wise
2ˆx
exp(x*log(2))

S EE A LSO : coff 505, log 195, expm 509

Scilab Group April 1993 508

fstair Scilab Function

2.8.16 expm square matrix exponential

CALLING SEQUENCE :

expm(X)

PARAMETERS :

X : square matrix with real or complex entries.

DESCRIPTION :

X is a square matrix expm(X) is the matrix

exp(X ) = I + X + X 2 =2 + :::
The computation is performed by first block-diagonalizing X and then applying a Pade approximation on
each block.
EXAMPLE :

X=[1 2;3 4]
expm(X)
logm(expm(X))

S EE A LSO : logm 196, bdiag 502, coff 505, log 195, exp 508

2.8.17 fstair computes pencil column echelon form by qz transformations

CALLING SEQUENCE :

[AE,EE,QE,ZE,blcks,muk,nuk,muk0,nuk0,mnei]=fstair(A,E,Q,Z,stair,rk,tol)

PARAMETERS :

A : m x n matrix with real entries.

tol : real positive scalar.
E : column echelon form matrix
Q : m x m unitary matrix
Z : n x n unitary matrix
stair : vector of indexes (see ereduc)
rk : integer, estimated rank of the matrix
AE : m x n matrix with real entries.
EE : column echelon form matrix
QE : m x m unitary matrix
ZE : n x n unitary matrix
nblcks :is the number of submatrices having full row rank >= 0 detected in matrix A.
muk: integer array of dimension (n). Contains the column dimensions mu(k) (k=1,...,nblcks) of the sub-
matrices having full column rank in the pencil sE(eps)-A(eps)
nuk: integer array of dimension (m+1). Contains the row dimensions nu(k) (k=1,...,nblcks) of the subma-
trices having full row rank in the pencil sE(eps)-A(eps)
muk0: integer array of dimension (n). Contains the column dimensions mu(k) (k=1,...,nblcks) of the
submatrices having full column rank in the pencil sE(eps,inf)-A(eps,inf)
nuk: integer array of dimension (m+1). Contains the row dimensions nu(k) (k=1,...,nblcks) of the subma-
trices having full row rank in the pencil sE(eps,inf)-A(eps,inf)

Scilab Group April 1993 509

fullrfk Scilab Function

mnei: integer array of dimension (4). mnei(1) = row dimension of sE(eps)-A(eps)

DESCRIPTION :

Given a pencil sE-A where matrix E is in column echelon form the function fstair computes
according to the wishes of the user a unitary transformed pencil QE(sEE-AE)ZE which is more or less
similar to the generalized Schur form of the pencil sE-A. The function yields also part of the Kronecker
structure of the given pencil.
Q,Z are the unitary matrices used to compute the pencil where E is in column echelon form (see
ereduc)
AUTHOR : Th.G.J. Beelen (Philips Glass Eindhoven). SLICOT
S EE A LSO : quaskro 528, ereduc 508

2.8.18 fullrf full rank factorization

CALLING SEQUENCE :

[Q,M,rk]=fullrf(A,[tol])

PARAMETERS :

A : real or complex matrix

tol : real number (threshold for rank determination)
Q,M : real or complex matrix
rk : integer (rank of A)

DESCRIPTION :
Full rank factorization : fullrf returns Q and M such that A = Q*M with range(Q)=range(A) and
ker(M)=ker(A), Q full column rank , M full row rank, rk = rank(A) = #columns(Q) = #rows(M).
tol is an optional real parameter (default value is sqrt(%eps)). The rank rk of A is defined as the
number of singular values larger than norm(A)*tol.
If A is symmetric, fullrf returns M=Q’.
EXAMPLE :

A=rand(5,2)*rand(2,5);
[Q,M]=fullrf(A);
norm(Q*M-A,1)
[X,d]=rowcomp(A);Y=X’;
svd([A,Y(:,1:d),Q]) //span(Q) = span(A) = span(Y(:,1:2))

S EE A LSO : svd 538, qr 528, fullrfk 510, rowcomp 531, colcomp 505
AUTHOR : F.D.

2.8.19 fullrfk full rank factorization of Aˆk

CALLING SEQUENCE :

[Bk,Ck]=fullrfk(A,k)

PARAMETERS :

A : real or complex matrix

k : integer

Scilab Group April 1993 510

givens Scilab Function

Bk,Ck : real or complex matrices

DESCRIPTION :
This function computes the full rank factorization of Aˆk i.e. Bk*Ck=Aˆk where Bk is full column
rank and Ck full row rank. One has range(Bk)=range(Aˆk) and ker(Ck)=ker(Aˆk).
For k=1, fullrfk is equivalent to fullrf.
EXAMPLE :

A=rand(5,2)*rand(2,5);[Bk,Ck]=fullrfk(A,3);
norm(Bk*Ck-Aˆ3,1)

S EE A LSO : fullrf 510, range 530

AUTHOR : F.D (1990)

2.8.20 genmarkov generates random markov matrix with recurrent and

transient classes

CALLING SEQUENCE :

M=genmarkov(rec,tr)
M=genmarkov(rec,tr,flag)

PARAMETERS :

rec : integer row vector (its dimension is the number of recurrent classes).
tr : integer (number of transient states)
M : real Markov matrix. Sum of entries in each row should add to one.
flag : string ’perm’. If given, a random permutation of the states is done.

DESCRIPTION :
Returns in M a random Markov transition probability matrix with size(rec,1) recurrent classes with
rec(1),...rec($) entries respectively and tr transient states.
EXAMPLE :

//P has two recurrent classes (with 2 and 1 states) 2 transient states
P=genmarkov([2,1],2,’perm’)
[perm,rec,tr,indsRec,indsT]=classmarkov(P);
P(perm,perm)

S EE A LSO : classmarkov 504, eigenmarkov 507

2.8.21 givens Givens transformation

CALLING SEQUENCE :

U=givens(xy)
U=givens(x,y)
[U,c]=givens(xy)
[U,c]=givens(x,y)

PARAMETERS :

x,y : two real or complex numbers

xy : real or complex size 2 column vector

Scilab Group April 1993 511

gschur Scilab Function

U : 2x2 unitary matrix

c : real or complex size 2 column vector

DESCRIPTION :
U = givens(x, y) or U = givens(xy) with xy = [x;y] returns a 2x2 unitary matrix U
such that:
U*xy=[r;0]=c.
Note that givens(x,y) and givens([x;y]) are equivalent.
EXAMPLE :

A=[3,4;5,6];
U=givens(A(:,1));
U*A

S EE A LSO : qr 528

2.8.22 glever inverse of matrix pencil

CALLING SEQUENCE :

[Bfs,Bis,chis]=glever(E,A [,s])

PARAMETERS :

E, A : two real square matrices of same dimensions

s : character string (default value ’s’)
Bfs,Bis : two polynomial matrices
chis : polynomial

DESCRIPTION :
Computation of (sE A) 1
by generalized Leverrier’s algorithm for a matrix pencil.

(s*E-A)ˆ-1 = (Bfs/chis) - Bis.

chis = characteristic polynomial (up to a multiplicative constant).

Bfs = numerator polynomial matrix.
Bis = polynomial matrix ( - expansion of (s*E-A)ˆ-1 at infinity).
Note the - sign before Bis.
CAUTION :
This function uses cleanp to simplify Bfs,Bis and chis.
EXAMPLE :

s=%s;F=[-1,s,0,0;0,-1,0,0;0,0,s-2,0;0,0,0,s-1];
[Bfs,Bis,chis]=glever(F)
inv(F)-((Bfs/chis) - Bis)

AUTHOR : F. D. (1988)
S EE A LSO : rowshuff 532, det 507, invr 491, coffg 485, pencan 524, penlaur
524

Scilab Group April 1993 512

gschur Scilab Function

2.8.23 gschur generalized Schur form (matrix pencils).

CALLING SEQUENCE :

[As,Es]=gschur(A,E)
[As,Es,Q,Z]=gschur(A,E)
[As,Es,Z,dim] = gschur(A,E,flag)
[As,Es,Z,dim]= gschur(A,E,extern)

PARAMETERS :

A, E : two real square matrices

flag : character string (’c’ or ’d’)
extern : Scilab “external” function (usual case). Could be also a list or a character string
As,Es : two real square matrices
Q, Z : two non-singular real matrices
dim : integer (dimension of subspace)

DESCRIPTION :

Schur form of matrix pencils (QZ algorithm):

[As,Es] = gschur(A,E)
produces a quasi triangular As matrix and a triangular Es matrix which are the generalized Schur
form of the pair A, E.
[As,Es,Q,Z] = gschur(A,E)
returns in addition two unitary matrices Q and Z such that As=Q*A*Z and Es=Q*E*Z.
Ordered stable form:
[As,Es,Z,dim] = gschur(A,E,’c’)
returns the real generalized Schur form of the pencil s*E-A. In addition, the dim first columns of Z
span a basis of the right eigenspace associated with eigenvalues with negative real parts (stable ”continuous
time” generalized eigenspace).
[As,Es,Z,dim] = gschur(A,E,’d’)
returns the real generalized Schur form of the pencil s*E-A. In addition, the dim first columns of
Z make a basis of the right eigenspace associated with eigenvalues with magnitude lower than 1 (stable
”discrete time” generalized eigenspace).
General subspace:
[As,Es,Z,dim] = gschur(A,E,extern)
returns the real generalized Schur form of the pencil s*E-A. In addition, the dim first columns of Z
make a basis of the right eigenspace associated with eigenvalues of the pencil which are selected according
to a rule which is given by the scilab function extern. (See schur for definition of this function).
EXAMPLE :

s=%s;
F=[-1,s,0,0;0,-1,0,0;0,0,2+s,0;0,0,0,-2+s];
roots(det(F))
[E,A]=pen2ea(F);
[As,Es,Z,dim] = gschur(A,E,’c’)
// Other example
a=rand(4,4);b=rand(4,4);[as,bs,qs,zs]=gschur(a,b);

Scilab Group April 1993 513

hess Scilab Function

norm(qs*a*zs-as)
norm(qs*b*zs-bs )
clear a;
a(8,8)=2;a(1,8)=1;a(2,[2,3,4,5])=[0.3,0.2,4,6];a(3,[2,3])=[-0.2,.3];
a(3,7)=.5;
a(4,4)=.5;a(4,6)=2;a(5,5)=1;a(6,6)=4;a(6,7)=2.5;a(7,6)=-10;a(7,7)=4;
b=eye(8,8);b(5,5)=0;
[al,be]=gspec(a,b);
[bs,as,q,n]=gschur(b,a,’disc’);n-4

S EE A LSO : external 38, gspec 514, pencan 524, penlaur 524, coffg 485, kroneck
517

2.8.24 gspec eigenvalues of matrix pencil

CALLING SEQUENCE :

[al,be]=gspec(A,E)
[al,be,Z]=gspec(A,E)

PARAMETERS :

A, E : real square matrices

al, be : real vectors
Z : real square non-singular matrix

DESCRIPTION :
[al,be] = gspec(A,E) returns the spectrum of the matrix pencil s E - A, i.e. the roots of the
polynomial matrix s E - A. The eigenvalues are given by al./be and if be(i) = 0 the ith eigenvalue
is at infinity. (For E = eye(A), al./be is spec(A)).
[al,be,Z] = gspec(A,E) returns in addition the matrix Z of generalized right eigenvectors of
the pencil.
EXAMPLE :

A=rand(3,3);
[al,be,Z] = gspec(A,eye(A));al./be
clean(inv(Z)*A*Z) //displaying the eigenvalues (generic matrix)
A=A+%i*rand(A);E=rand(A);
roots(det(%s*E-A)) //complex case

S EE A LSO : gschur 513, balanc 502, spec 537, kroneck 517

2.8.25 hess Hessenberg form

CALLING SEQUENCE :

H = hess(A)
[U,H] = hess(A)

PARAMETERS :

A : real or complex square matrix

H : real or complex square matrix
U : orthogonal or unitary square matrix

Scilab Group April 1993 514

im inv Scilab Function

DESCRIPTION :
[U,H] = hess(A) produces a unitary matrix U and a Hessenberg matrix H so that A = U*H*U’
and U’*U = Identity. By itself, hess(A) returns H.
The Hessenberg form of a matrix is zero below the first subdiagonal. If the matrix is symmetric or
Hermitian, the form is tridiagonal.
EXAMPLE :

A=rand(3,3);[U,H]=hess(A);
and( abs(U*H*U’-A)<1.d-10 )

S EE A LSO : qr 528, contr 328, schur 533

2.8.26 householder Householder orthogonal reflexion matrix

CALLING SEQUENCE :

u=householder(v [,w])

PARAMETERS :

v : real or complex column vector

w : real or complex column vector with same size as v. Default value is eye(v)
u : real or complex column vector

DESCRIPTION :
given 2 column vectors v, w of same size, householder(v,w) returns a unitary column vector u, such
that (eye()-2*u*u’)*v is proportional to w. (eye()-2*u*u’) is the orthogonal Householder
reflexion matrix .
w default value is eye(v). In this case vector (eye()-2*u*u’)*v is the vector eye(v)*norm(v).

S EE A LSO : qr 528, givens 511

2.8.27 im inv inverse image

CALLING SEQUENCE :

[X,dim]=im_inv(A,B [,tol])
[X,dim,Y]=im_inv(A,B, [,tol])

PARAMETERS :

A,B : two real or complex matrices with equal number of columns

X : orthogonal or unitary square matrix of order equal to the number of columns of A
dim : integer (dimension of subspace)
Y : orthogonal matrix of order equal to the number of rows of A and B.

DESCRIPTION :
[X,dim]=im_inv(A,B) computes A 1 (B ) i.e vectors whose image through A are in range(B)
The dim first columns of X span A 1 (B ):
tol is a threshold used to test if subspace inclusion; default value is tol = 100*%eps. If Y is re-
turned, then [Y*A*X,Y*B] is partitioned as follows:

[A11,A12;0,A22],[B1;0]

Scilab Group April 1993 515

colcomp Scilab Function

where B1 has full row rank (equals rank(B)) and A22 has full column rank and has dim columns.

EXAMPLE :

A=[rand(2,5);[zeros(3,4),rand(3,1)]];B=[[1,1;1,1];zeros(3,2)];
W=rand(5,5);A=W*A;B=W*B;
[X,dim]=im_inv(A,B)
svd([A*X(:,1:dim),B]) //vectors A*X(:,1:dim) belong to range(B)
[X,dim,Y]=im_inv(A,B);[Y*A*X,Y*B]

S EE A LSO : rowcomp 531, spaninter 534, spanplus 535, linsolve 518

AUTHOR : F. D.

2.8.28 inv matrix inverse

CALLING SEQUENCE :

inv(X)

PARAMETERS :

X : real or complex square matrix, polynomial matrix, rational matrix in transfer or state-space represen-
tation.

DESCRIPTION :
inv(X) is the inverse of the square matrix X. A warning message is printed if X is badly scaled or nearly
singular.
For polynomial matrices or rational matrices in transfer representation, inv(X) is equivalent to invr(X).
For linear systems in state-space representation (syslin list), invr(X) is equivalent to invsyslin(X).

EXAMPLE :

A=rand(3,3);inv(A)*A
//
x=poly(0,’x’);
A=[x,1,x;xˆ2,2,1+x;1,2,3];inv(A)*A
//
A=[1/x,2;2+x,2/(1+x)]
inv(A)*A
//
A=ssrand(2,2,3);
W=inv(A)*A
clean(ss2tf(W))

S EE A LSO : slash 71, backslash 26, pinv 525, qr 528, lufact 520, lusolve
521, invr 491, coff 505, coffg 485

2.8.29 kernel kernel, nullspace

CALLING SEQUENCE :

W=kernel(A [,tol,[,flag])

Scilab Group April 1993 516

kroneck Scilab Function

PARAMETERS :

A : full real or complex matrix or real sparse matrix

flag : character string ’svd’ (default) or ’qr’
tol : real number
W : full column rank matrix

DESCRIPTION :
W=kernel(A) returns the kernel (nullspace) of A.
flag and tol are optional parameters: flag = ’qr’ or ’svd’ (default is ’svd’).
tol = tolerance parameter (of order %eps as default value).
EXAMPLE :

A=rand(3,1)*rand(1,3);
A*kernel(A)
A=sparse(A);
clean(A*kernel(A))

S EE A LSO : colcomp 505, fullrf 510, fullrfk 510, linsolve 518

AUTHOR : F.D.

2.8.30 kroneck Kronecker form of matrix pencil

CALLING SEQUENCE :

[Q,Z,Qd,Zd,numbeps,numbeta]=kroneck(F)
[Q,Z,Qd,Zd,numbeps,numbeta]=kroneck(E,A)

PARAMETERS :

F : real matrix pencil F=s*E-A

E,A : two real matrices of same dimensions
Q,Z : two square orthogonal matrices
Qd,Zd : two vectors of integers
numbeps,numeta : two vectors of integers

DESCRIPTION :
Kronecker form of matrix pencil: kroneck computes two orthogonal matrices Q, Z which put the
pencil F=s*E -A into upper-triangular form:

| sE(eps)-A(eps) | X | X | X |
|----------------|----------------|------------|---------------|
| O | sE(inf)-A(inf) | X | X |
Q(sE-A)Z = |---------------------------------|----------------------------|
| | | | |
| 0 | 0 | sE(f)-A(f) | X |
|--------------------------------------------------------------|
| | | | |
| 0 | 0 | 0 | sE(eta)-A(eta)|

The dimensions of the four blocks are given by:

eps=Qd(1) x Zd(1), inf=Qd(2) x Zd(2), f = Qd(3) x Zd(3), eta=Qd(4)xZd(4)
The inf block contains the infinite modes of the pencil.
The f block contains the finite modes of the pencil

Scilab Group April 1993 517

lu Scilab Function

The structure of epsilon and eta blocks are given by:

numbeps(1) = # of eps blocks of size 0 x 1
numbeps(2) = # of eps blocks of size 1 x 2
numbeps(3) = # of eps blocks of size 2 x 3 etc...
numbeta(1) = # of eta blocks of size 1 x 0
numbeta(2) = # of eta blocks of size 2 x 1
numbeta(3) = # of eta blocks of size 3 x 2 etc...
The code is taken from T. Beelen (Slicot-WGS group).
EXAMPLE :

F=randpencil([1,1,2],[2,3],[-1,3,1],[0,3]);
Q=rand(17,17);Z=rand(18,18);F=Q*F*Z;
//random pencil with eps1=1,eps2=1,eps3=1; 2 J-blocks @ infty
//with dimensions 2 and 3
//3 finite eigenvalues at -1,3,1 and eta1=0,eta2=3
[Q,Z,Qd,Zd,numbeps,numbeta]=kroneck(F);
[Qd(1),Zd(1)] //eps. part is sum(epsi) x (sum(epsi) + number of epsi)
[Qd(2),Zd(2)] //infinity part
[Qd(3),Zd(3)] //finite part
[Qd(4),Zd(4)] //eta part is (sum(etai) + number(eta1)) x sum(etai)
numbeps
numbeta

S EE A LSO : gschur 513, gspec 514, systmat 499, pencan 524, randpencil 529,
trzeros 368

2.8.31 linsolve linear equation solver

CALLING SEQUENCE :

[x0,kerA]=linsolve(A,b [,x0])

PARAMETERS :

A : a na x ma real matrix (possibly sparse)

b : a na x 1 vector (same row dimension as A)
x0 : a real vector
kerA : a ma x k real matrix

DESCRIPTION :
linsolve computes all the solutions to A*x+b=0.
x0 is a particular solution (if any) and kerA= nullspace of A. Any x=x0+kerA*w with arbitrary w
satisfies A*x+b=0.
If compatible x0 is given on entry, x0 is returned. If not a compatible x0, if any, is returned.
EXAMPLE :

A=rand(5,3)*rand(3,8);
b=A*ones(8,1);[x,kerA]=linsolve(A,b);A*x+b //compatible b
b=ones(5,1);[x,kerA]=linsolve(A,b);A*x+b //uncompatible b
A=rand(5,5);[x,kerA]=linsolve(A,b), -inv(A)*b //x is unique

S EE A LSO : inv 516, pinv 525, colcomp 505, im_inv 515

Scilab Group April 1993 518

lufact Scilab Function

2.8.32 lu LU factors of Gaussian elimination

CALLING SEQUENCE :

[L,U]= lu(A)
[L,U,E]= lu(A)

PARAMETERS :

A : real or complex square matrix (n x n).

L,U : two real or complex matrices (n x n).
E : a (n x n) permutation matrix.

DESCRIPTION :
[L,U]= lu(A) produces two matrices L and U such that A = L*U with U upper triangular and
E*L lower triangular for a permutation matrix E.
If A has rank k, rows k+1 to n of U are zero.
[L,U,E]= lu(A) produces three matrices L, U and E such that E*A = L*U with U upper tri-
angular and E*L lower triangular for a permutation matrix E.
REMARK :

If A is a real matrix, using the function lufact and luget it is possible to obtain the permutation
matrices and also when A is not full rank the column compression of the matrix L.

[h,rk]=lufact(sparse(a)) // lufact works with sparse real matrices

[P,L,U,Q]=luget(h)
ludel(h)
P=full(P);L=full(L);U=full(U);Q=full(Q);
// P,Q are permutation matrices P*L*U*Q=A

S EE A LSO : lufact 520, luget 520, lusolve 521, qr 528, svd 538

2.8.33 ludel utility function used with lufact

CALLING SEQUENCE :

ludel(hand)

PARAMETERS :

hand : handle to sparse lu factors (output of lufact)

DESCRIPTION :
This function is used in conjunction with lufact. It clears the internal memory space used to store the
result of lufact.
The sequence of commands [p,r]=lufact(A);x=lusolve(p,b);ludel(p); solves the sparse
linear system A*x = b and clears p.
S EE A LSO : sparse 214, lufact 520, luget 520

Scilab Group April 1993 519

lufact Scilab Function

2.8.34 lufact sparse lu factorization

CALLING SEQUENCE :

[hand,rk]=lufact(A,prec)

PARAMETERS :

A : square sparse matrix

hand : handle to sparse lu factors
rk : integer (rank of A)
prec : a vector of size two prec=[eps,reps] giving the absolute and relative thresolds.

DESCRIPTION :
[hand,rk]=lufact(A) performs the lu factorization of sparse matrix A. hand (no display) is used
by lusolve (for solving linear system) and luget (for retrieving the factors). hand should be cleared
by the command: ludel(hand);
The A matrix needs not be full rank but must be square (since A is assumed sparse one may add zeros if
necessary to squaring down A).
eps : The absolute magnitude an element must have to be considered as a pivot candidate, except as
a last resort. This number should be set significantly smaller than the smallest diagonal element that
is is expected to be placed in the matrix. the default value is %eps.
reps : This number determines what the pivot relative threshold will be. It should be between zero
and one. If it is one then the pivoting method becomes complete pivoting, which is very slow and
tends to fill up the matrix. If it is set close to zero the pivoting method becomes strict Markowitz with
no threshold. The pivot threshold is used to eliminate pivot candidates that would cause excessive
element growth if they were used. Element growth is the cause of roundoff error. Element growth
occurs even in well-conditioned matrices. Setting the reps large will reduce element growth and
roundoff error, but setting it too large will cause execution time to be excessive and will result in a
large number of fill-ins. If this occurs, accuracy can actually be degraded because of the large number
of operations required on the matrix due to the large number of fill-ins. A good value seems to be
0.001 which is the default value. The default is chosen by giving a value larger than one or less than
or equal to zero. This value should be increased and the matrix resolved if growth is found to be
excessive. Changing the pivot threshold does not improve performance on matrices where growth is
low, as is often the case with ill-conditioned matrices. reps was choosen for use with nearly diagonally
dominant matrices such as node- and modified-node admittance matrices. For these matrices it is
usually best to use diagonal pivoting. For matrices without a strong diagonal, it is usually best to use
a larger threshold, such as 0.01 or 0.1.

EXAMPLE :

a=rand(5,5);b=rand(5,1);A=sparse(a);
[h,rk]=lufact(A);
x=lusolve(h,b);a*x-b
ludel(h)

S EE A LSO : sparse 214, lusolve 521, luget 520

2.8.35 luget sparse lu factorization

CALLING SEQUENCE :

[P,L,U,Q]=luget(ptr)

Scilab Group April 1993 520

lyap Scilab Function

PARAMETERS :

ptr : pointer, output of lufact

P : sparse permutation matrix
L : sparse matrix, lower triangular if ptr is obtained from a non singular matrix
U : square non singular upper triangular sparse matrix with ones along the main diagonal
Q : sparse permutation matrix
DESCRIPTION :
[P,L,U,Q]=luget(ptr) with ptr obtained by the command [ptr,rk]=lufact(A) with A a
sparse matrix returns four sparse matrices such that P*L*U*Q=A.
The A matrix needs not be full rank but must be square (since A is assumed sparse one may add zeros if
necessary to squaring down A).
If A is singular, the L matrix is column compressed (with rk independent nonzero columns): the nonsin-
gular sparse matrix Q’*inv(U) column compresses A.
EXAMPLE :

a=rand(5,2)*rand(2,5);A=sparse(a);
[ptr,rk]=lufact(A);[P,L,U,Q]=luget(ptr);
full(L), P*L*U*Q-A
clean(P*L*U*Q-A)
ludel(ptr)

S EE A LSO : sparse 214, lusolve 521, luget 520, clean 484

2.8.36 lusolve sparse linear system solver

CALLING SEQUENCE :

lusolve(hand,b)
lusolve(A,b)
PARAMETERS :

b : full real matrix

A : real square sparse invertible matrix
hand : handle to a previously computed sparse lu factors (output of lufact)
DESCRIPTION :
x=lusolve(hand,b) solves the sparse linear system A*x = b.
[hand,rk]=lufact(A) is the output of lufact.
x=lusolve(A,b) solves the sparse linear system \fVA*x = b\fR.
EXAMPLE :

non_zeros=[1,2,3,4];rows_cols=[1,1;2,2;3,3;4,4];
sp=sparse(rows_cols,non_zeros);
[h,rk]=lufact(sp);x=lusolve(h,[1;1;1;1]);ludel(h)
rk,sp*x

non_zeros=[1,2,3,4];rows_cols=[1,1;2,2;3,3;4,4];
sp=sparse(rows_cols,non_zeros);
x=lusolve(sp,-ones(4,1));
sp*x

S EE A LSO : sparse 214, lufact 520, slash 71, backslash 26

Scilab Group April 1993 521

orth Scilab Function

2.8.37 lyap Lyapunov equation

CALLING SEQUENCE :

[X]=lyap(A,C,’c’)
[X]=lyap(A,C,’d’)

PARAMETERS :

A, C : real square matrices, C must be symmetric

DESCRIPTION :
X = lyap(A,C,flag) solves the continuous time or discrete time matrix Lyapunov matrix equa-
tion:
A’*X + X*A = C ( flag=’c’ )
A’*X*A - X = C ( flag=’d’ )
Note that a unique solution exist if and only if an eigenvalue of A is
not an eigenvalue of -A (flag=’c’) or 1 over an eigenvalue of A
(flag=’d’).
EXAMPLE :

A=rand(4,4);C=rand(A);C=C+C’;
X=lyap(A,C,’c’);
A’*X + X*A -C
X=lyap(A,C,’d’);
A’*X*A - X -C

S EE A LSO : sylv 539, ctr_gram 330, obs_gram 349

2.8.38 nlev Leverrier’s algorithm

CALLING SEQUENCE :

[num,den]=nlev(A,z [,rmax])
PARAMETERS :

A : real square matrix

z : character string
rmax : optional parameter (see bdiag)
DESCRIPTION :
[num,den]=nlev(A,z [,rmax]) computes: (zI A) 1
by block diagonalization of A followed
by Leverrier’s algorithm on each block.
REMARK :
This algorithm is better than the usual leverrier algorithm but still not perfect!
EXAMPLE :

A=rand(3,3);x=poly(0,’x’);
[NUM,den]=nlev(A,’x’)
clean(den-poly(A,’x’))
clean(NUM/den-inv(x*eye()-A))

S EE A LSO : coff 505, coffg 485, glever 512, ss2tf 363

AUTHOR : F. D., S. S.

Scilab Group April 1993 522

pencan Scilab Function

2.8.39 orth orthogonal basis

CALLING SEQUENCE :

Q=orth(A)

PARAMETERS :

A : real or complex matrix

Q : real or complex matrix

DESCRIPTION :
Q=orth(A) returns Q, an orthogonal basis for the span of A. Range(Q) = Range(A) and Q’*Q=eye.
The number of columns of Q is the rank of A as determined by the QR algorithm.
EXAMPLE :

A=rand(5,3)*rand(3,4);
[X,dim]=rowcomp(A);X=X’;
svd([orth(A),X(:,1:dim)])

S EE A LSO : qr 528, rowcomp 531, colcomp 505, range 530

2.8.40 pbig eigen-projection

CALLING SEQUENCE :

[Q,M]=pbig(A,thres,flag)

PARAMETERS :

A : real square matrix

thres : real number
flag : character string (’c’ or ’d’)
Q,M : real matrices

DESCRIPTION :
Projection on eigen-subspace associated with eigenvalues with real part >= thres (flag=’c’) or with
magnitude >= thres (flag=’d’).
The projection is defined by Q*M, Q is full column rank, M is full row rank and M*Q=eye.
If flag=’c’, the eigenvalues of M*A*Q = eigenvalues of A with real part >= thres.
If flag=’d’, the eigenvalues of M*A*Q = eigenvalues of A with magnitude >= thres.
If flag=’c’ and if [Q1,M1] = full rank factorization (fullrf) of eye()-Q*M then eigenvalues
of M1*A*Q1 = eigenvalues of A with real part < thres.
If flag=’d’ and if [Q1,M1] = full rank factorization (fullrf) of eye()-Q*M then eigenvalues of
M1*A*Q1 = eigenvalues of A with magnitude < thres.
EXAMPLE :

A=diag([1,2,3]);X=rand(A);A=inv(X)*A*X;
[Q,M]=pbig(A,1.5,’d’);
spec(M*A*Q)
[Q1,M1]=fullrf(eye()-Q*M);
spec(M1*A*Q1)

S EE A LSO : psmall 527, projspec 526, fullrf 510

AUTHOR : F. D. (1988)

Scilab Group April 1993 523

penlaur Scilab Function

2.8.41 pencan canonical form of matrix pencil

CALLING SEQUENCE :

[Q,M,i1]=pencan(Fs)
[Q,M,i1]=pencan(E,A)

PARAMETERS :

Fs : a regular pencil s*E-A

E,A : two real square matrices
Q,M : two non-singular real matrices
i1 : integer

DESCRIPTION :
Given the regular pencil Fs=s*E-A, pencan returns matrices Q and M such than M*(s*E-A)*Q is
in ”canonical” form.
M*E*Q is a block matrix

[I,0;
0,N]

with N nilpotent and i1 = size of the I matrix above.

M*A*Q is a block matrix:

[Ar,0;
0,I]

EXAMPLE :

F=randpencil([],[1,2],[1,2,3],[]);
F=rand(6,6)*F*rand(6,6);
[Q,M,i1]=pencan(F);
W=clean(M*F*Q)
roots(det(W(1:i1,1:i1)))
det(W($-2:$,$-2:$))

S EE A LSO : glever 512, penlaur 524, rowshuff 532

AUTHOR : F. D.

2.8.42 penlaur Laurent coefficients of matrix pencil

CALLING SEQUENCE :

[Si,Pi,Di,order]=penlaur(Fs)
[Si,Pi,Di,order]=penlaur(E,A)

PARAMETERS :

Fs : a regular pencil s*E-A

E, A : two real square matrices
Si,Pi,Di : three real square matrices
order : integer

Scilab Group April 1993 524

polar Scilab Function

DESCRIPTION :
penlaur computes the first Laurent coefficients of (s*E-A)ˆ-1 at infinity.
(s*E-A)ˆ-1 = ... + Si/s - Pi - s*Di + ... at s = infinity.
order = order of the singularity (order=index-1).
The matrix pencil Fs=s*E-A should be invertible.
For a index-zero pencil, Pi, Di,... are zero and Si=inv(E).
For a index-one pencil (order=0),Di =0.
For higher-index pencils, the terms -sˆ2 Di(2), -sˆ3 Di(3),... are given by:
Di(2)=Di*A*Di, Di(3)=Di*A*Di*A*Di (up to Di(order)).
REMARK :
Experimental version: troubles when bad conditioning of so*E-A
EXAMPLE :

F=randpencil([],[1,2],[1,2,3],[]);
F=rand(6,6)*F*rand(6,6);[E,A]=pen2ea(F);
[Si,Pi,Di]=penlaur(F);
[Bfs,Bis,chis]=glever(F);
norm(coeff(Bis,1)-Di,1)

S EE A LSO : glever 512, pencan 524, rowshuff 532

AUTHOR : F. D. (1988,1990)

2.8.43 pinv pseudoinverse

CALLING SEQUENCE :

pinv(A,[tol])

PARAMETERS :

A : real or complex matrix

tol : real number

DESCRIPTION :
X = pinv(A) produces a matrix X of the same dimensions as A’ such that:
A*X*A = A, X*A*X = X and both A*X and X*A are Hermitian .
The computation is based on SVD and any singular values lower than a tolerance are treated as zero: this
tolerance is accessed by X=pinv(A,tol).
EXAMPLE :

A=rand(5,2)*rand(2,4);
norm(A*pinv(A)*A-A,1)

S EE A LSO : rank 530, svd 538, qr 528

2.8.44 polar polar form

CALLING SEQUENCE :

[Ro,Theta]=polar(A)

PARAMETERS :

A : real or complex square matrix

Scilab Group April 1993 525

projspec Scilab Function

Ro, Theta : real matrices

DESCRIPTION :
[Ro,Theta]=polar(A) returns the polar form of A i.e.:
A=Ro*expm(%i*Theta) Ro symmetric >=0 and Theta hermitian >=0.
EXAMPLE :

A=rand(5,5);
[Ro,Theta]=polar(A);
norm(A-Ro*expm(%i*Theta),1)

S EE A LSO : expm 509, svd 538

AUTHOR : F. D.

2.8.45 proj projection

CALLING SEQUENCE :

P = proj(X1,X2)

PARAMETERS :

X1,X2 : two real matrices with equal number of columns

P : real projection matrix (Pˆ2=P)

DESCRIPTION :
P is the projection on X2 parallel to X1.
EXAMPLE :

X1=rand(5,2);X2=rand(5,3);
P=proj(X1,X2);
norm(Pˆ2-P,1)
trace(P) // This is dim(X2)
[Q,M]=fullrf(P);
svd([Q,X2]) // span(Q) = span(X2)

S EE A LSO : projspec 526, orth 523, fullrf 510

AUTHOR : F. D.

2.8.46 projspec spectral operators

CALLING SEQUENCE :

[S,P,D,i]=projspec(A)

PARAMETERS :

A : square matrix
S, P, D : square matrices
i : integer (index of the zero eigenvalue of A).

Scilab Group April 1993 526

qr Scilab Function

DESCRIPTION :
Spectral characteristics of A at 0.
S = reduced resolvent at 0 (S = -Drazin inverse(A)).
P = spectral projection at 0.
D = nilpotent operator at 0.
index = index of the 0 eigenvalue.
One has (s*eye()-A)ˆ(-1) = Dˆ(i-1)/sˆi +... + D/sˆ2 + P/s - S - s*Sˆ2 -...
around the singularity s=0.
EXAMPLE :

deff(’j=jdrn(n)’,’j=zeros(n,n);for k=1:n-1;j(k,k+1)=1;end’)
A=sysdiag(jdrn(3),jdrn(2),rand(2,2));X=rand(7,7);
A=X*A*inv(X);
[S,P,D,index]=projspec(A);
index //size of J-block
trace(P) //sum of dimensions of J-blocks
A*S-(eye()-P)
norm(Dˆindex,1)

S EE A LSO : coff 505

AUTHOR : F. D.

2.8.47 psmall spectral projection

CALLING SEQUENCE :

[Q,M]=psmall(A,thres,flag)

PARAMETERS :

A : real square matrix

thres : real number
flag : character string (’c’ or ’d’)
Q,M : real matrices

DESCRIPTION :
Projection on eigen-subspace associated with eigenvalues with real part < thres (flag=’c’) or with
modulus < thres (flag=’d’).
The projection is defined by Q*M, Q is full column rank, M is full row rank and M*Q=eye.
If flag=’c’, the eigenvalues of M*A*Q = eigenvalues of A with real part < thres.
If flag=’d’, the eigenvalues of M*A*Q = eigenvalues of A with magnitude < thres.
If flag=’c’ and if [Q1,M1] = full rank factorization (fullrf) of eye()-Q*M then eigenvalues
of M1*A*Q1 = eigenvalues of A with real part >= thres.
If flag=’d’ and if [Q1,M1] = full rank factorization (fullrf) of eye()-Q*M then eigenvalues of
M1*A*Q1 = eigenvalues of A with magnitude >= thres.
EXAMPLE :

A=diag([1,2,3]);X=rand(A);A=inv(X)*A*X;
[Q,M]=psmall(A,2.5,’d’);
spec(M*A*Q)
[Q1,M1]=fullrf(eye()-Q*M);
spec(M1*A*Q1)

S EE A LSO : pbig 523, proj 526, projspec 526

AUTHOR : F. D. (1988)

Scilab Group April 1993 527

quaskro Scilab Function

2.8.48 qr QR decomposition

CALLING SEQUENCE :

[Q,R]=qr(X)
[Q,R,E]=qr(X)
[Q,R,rk,E]=qr(X [,tol])

PARAMETERS :

X : real or complex matrix

tol : nonnegative real number
Q : square orthogonal or unitary matrix
R : matrix with same dimensions as X
E : permutation matrix
rk : integer (QR-rank of X*E)

DESCRIPTION :
[Q,R] = qr(X) produces an upper triangular matrix R of the same dimension as X and a unitary
matrix Q so that X = Q*R.
[Q,R,E] = qr(X) produces a (column) permutation matrix E, an upper triangular R with decreasing
diagonal elements and a unitary Q so that X*E = Q*R.
[Q,R,rk,E] = qr(X ,tol) returns rk = rank estimate of X i.e. rk is the number of diagonal
elements in R which are larger than tol.
[Q,R,rk,E] = qr(X) returns rk = rank estimate of X i.e. rk is the number of diagonal ele-
ments in R which are larger than R(1,1)*%eps*max(size(R).
EXAMPLE :

A=rand(5,2)*rand(2,5);
[Q,R,rk,E] = qr(A,1.d-10);
norm(Q’*A-R)
svd([A,Q(:,1:rk)]) //span(A) =span(Q(:,1:rk))

S EE A LSO : rank 530, svd 538, rowcomp 531, colcomp 505

2.8.49 quaskro quasi-Kronecker form

CALLING SEQUENCE :

[Q,Z,Qd,Zd,numbeps,numbeta]=quaskro(F)
[Q,Z,Qd,Zd,numbeps,numbeta]=quaskro(E,A)
[Q,Z,Qd,Zd,numbeps,numbeta]=quaskro(F,tol)
[Q,Z,Qd,Zd,numbeps,numbeta]=quaskro(E,A,tol)

PARAMETERS :

F : real matrix pencil F=s*E-A (s=poly(0,’s’))

E,A : two real matrices of same dimensions
tol : a real number (tolerance, default value=1.d-10)
Q,Z : two square orthogonal matrices
Qd,Zd : two vectors of integers
numbeps : vector of integers

Scilab Group April 1993 528

range Scilab Function

DESCRIPTION :
Quasi-Kronecker form of matrix pencil: quaskro computes two orthogonal matrices Q, Z which put
the pencil F=s*E -A into upper-triangular form:

| sE(eps)-A(eps) | X | X |
|----------------|----------------|------------|
| O | sE(inf)-A(inf) | X |
Q(sE-A)Z = |=================================|============|
| | |
| O | sE(r)-A(r) |

The dimensions of the blocks are given by:

eps=Qd(1) x Zd(1), inf=Qd(2) x Zd(2), r = Qd(3) x Zd(3)
The inf block contains the infinite modes of the pencil.
The f block contains the finite modes of the pencil
The structure of epsilon blocks are given by:
numbeps(1) = # of eps blocks of size 0 x 1
numbeps(2) = # of eps blocks of size 1 x 2
numbeps(3) = # of eps blocks of size 2 x 3 etc...
The complete (four blocks) Kronecker form is given by the function kroneck which calls quaskro on
the (pertransposed) pencil sE(r)-A(r).
The code is taken from T. Beelen
S EE A LSO : kroneck 517, gschur 513, gspec 514

2.8.50 randpencil random pencil

CALLING SEQUENCE :

F=randpencil(eps,infi,fin,eta)

PARAMETERS :

eps : vector of integers

infi : vector of integers
fin : real vector, or monic polynomial, or vector of monic polynomial
eta : vector of integers
F : real matrix pencil F=s*E-A (s=poly(0,’s’))

DESCRIPTION :
Utility function. F=randpencil(eps,infi,fin,eta) returns a random pencil F with given Kro-
necker structure. The structure is given by: eps=[eps1,...,epsk]: structure of epsilon blocks (size
eps1x(eps1+1),....) fin=[l1,...,ln] set of finite eigenvalues (assumed real) (possibly []) infi=[k1,...,kp]
size of J-blocks at infinity ki>=1 (infi=[] if no J blocks). eta=[eta1,...,etap]: structure ofeta
blocks (size eta1+1)xeta1,...)
epsi’s should be >=0, etai’s should be >=0, infi’s should be >=1.
If fin is a (monic) polynomial, the finite block admits the roots of fin as eigenvalues.
If fin is a vector of polynomial, they are the finite elementary divisors of F i.e. the roots of p(i) are
finite eigenvalues of F.
EXAMPLE :

Scilab Group April 1993 529

rcond Scilab Function

F=randpencil([0,1],[2],[-1,0,1],[3]);
[Q,Z,Qd,Zd,numbeps,numbeta]=kroneck(F);
Qd, Zd
s=poly(0,’s’);
F=randpencil([],[1,2],sˆ3-2,[]); //regular pencil
det(F)

S EE A LSO : kroneck 517, pencan 524, penlaur 524

2.8.51 range range (span) of Aˆk

CALLING SEQUENCE :

[X,dim]=range(A,k)

PARAMETERS :

A : real square matrix

k : integer
X : non-singular real matrix
dim : integer (dimension of subspace)

DESCRIPTION :
Computation of Range Aˆk ; the first dim columns of X span the range of Aˆk.
S EE A LSO : fullrfk 510, rowcomp 531
AUTHOR : F. D.

2.8.52 rank rank

CALLING SEQUENCE :

[i]=rank(X)
[i]=rank(X,tol)

PARAMETERS :

X : real or complex matrix

tol : nonnegative real number

DESCRIPTION :
rank(X) is the numerical rank of X i.e. the number of singular values of X that are larger than
norm(size(X),’inf’) * norm(X) * %eps.
rank(X,tol) is the number of singular values of X that are larger than tol.
REMARK :
Note that the default value of tol is proportional to norm(X). As a consequence
rank([1.d-80,0;0,1.d-80]) is 2 !.
EXAMPLE :

rank([1.d-80,0;0,1.d-80])
rank([1,0;0,1.d-80])

S EE A LSO : svd 538, qr 528, rowcomp 531, colcomp 505, lu 519

Scilab Group April 1993 530

rowshuff Scilab Function

2.8.53 rcond inverse condition number

CALLING SEQUENCE :

rcond(X)

PARAMETERS :

X : real or complex square matrix

DESCRIPTION :
rcond(X) is an estimate for the reciprocal of the condition of X in the 1-norm.
If X is well conditioned, rcond(X) is close to 1. If not, rcond(X) is close to 0.
[r,z]=rcond(X) sets r to rcond(X) and returns z such that
norm(X*z,1) = r*norm(X,1)*norm(z,1) Thus, if rcond is small z is a vector in the ker-
nel.
EXAMPLE :

A=diag([1:10]);
rcond(A)
A(1,1)=0.000001;
rcond(A)

S EE A LSO : svd 538, cond 506, inv 516

2.8.54 rowcomp row compression, range

CALLING SEQUENCE :

[W,rk]=rowcomp(A [,flag] [,tol])

PARAMETERS :

A : real or complex matrix

flag : character string
tol : real number
W : square non-singular matrix (change of basis)
rk : integer (rank of A)

DESCRIPTION :
Row compression of A. Ac = W*A is a row compressed matrix: i.e. Ac=[Af;0] with Af full row
rank.
flag and tol are optional parameters: flag=’qr’ or ’svd’ (default ’svd’).
tol is a tolerance parameter (of order sqrt(%eps) as default value).
The rk first columns of W’ span the range of A.
The rk first (top) rows of W span the row range of A.
REMARK :
A non zero vector x belongs to range(A) iff W*x is row compressed in accordance with Ac i.e the norm
of its last components is small w.r.t its first components.
EXAMPLE :

Scilab Group April 1993 531

rref Scilab Function

A=rand(5,2)*rand(2,4); // 4 col. vectors, 2 independent.

[X,dim]=rowcomp(A);Xp=X’;
svd([Xp(:,1:dim),A]) //span(A) = span(Xp(:,1:dim)
x=A*rand(4,1); //x belongs to span(A)
y=X*x
norm(y(dim+1:$))/norm(y(1:dim)) // small

S EE A LSO : colcomp 505, fullrf 510, fullrfk 510

AUTHOR : F. D.

2.8.55 rowshuff shuffle algorithm

CALLING SEQUENCE :

[Ws,Fs1]=rowshuff(Fs, [alfa])

PARAMETERS :

Fs : square real pencil Fs = s*E-A

Ws : polynomial matrix
Fs1 : square real pencil F1s = s*E1 -A1 with E1 non-singular
alfa : real number (alfa = 0 is the default value)

DESCRIPTION :
Shuffle algorithm: Given the pencil Fs=s*E-A , returns Ws=W(s) (square polynomial matrix) such that:
Fs1 = s*E1-A1 = W(s)*(s*E-A) is a pencil with non singular E1 matrix.
This is possible iff the pencil Fs = s*E-A is regular (i.e. invertible). The degree of Ws is equal to the
index of the pencil.
The poles at infinity of Fs are put to alfa and the zeros of Ws are at alfa.
Note that (s*E-A)ˆ-1 = (s*E1-A1)ˆ-1 * W(s) = (W(s)*(s*E-A))ˆ-1 *W(s)
EXAMPLE :

F=randpencil([],[2],[1,2,3],[]);
F=rand(5,5)*F*rand(5,5); // 5 x 5 regular pencil with 3 evals at 1,2,3
[Ws,F1]=rowshuff(F,-1);
[E1,A1]=pen2ea(F1);
svd(E1) //E1 non singular
roots(det(Ws))
clean(inv(F)-inv(F1)*Ws,1.d-7)

S EE A LSO : pencan 524, glever 512, penlaur 524

AUTHOR : F. D.

2.8.56 rref computes matrix row echelon form by lu transformations

CALLING SEQUENCE :

R=rref(A)

PARAMETERS :

A : m x n matrix with scalar entries

R : m x n matrix,row echelon form of a

Scilab Group April 1993 532

schur Scilab Function

DESCRIPTION :
rref computes the row echelon form of the given matrix by left lu decomposition. If ones need the
transformation used just call X=rref([A,eye(m,m)]) the row echelon form R is X(:,1:n) and
the left transformation L is given by X(:,n+1:n+m) such as L*A=R
EXAMPLE :

A=[1 2;3 4;5 6];

X=rref([A,eye(3,3)]);
R=X(:,1:2)
L=X(:,3:5);L*A

S EE A LSO : lu 519, qr 528

2.8.57 schur [ordered] Schur decomposition

CALLING SEQUENCE :

[U,T] = schur(A)
[U,dim]=schur(A,flag)
[U,dim]=schur(A,myfunction)

PARAMETERS :

A : real or complex matrix. For ordered forms A is assumed real.

flag : character string (’c’ or ’d’)
myfunction : an “external” function (this parameter can also be a list or character string)
U : orthogonal or unitary square matrix
T : matrix
dim : integer

DESCRIPTION :
Schur forms, ordered Schur forms
USUAL SCHUR FORM :
[U,T] = schur(A) produces a Schur matrix T and a unitary matrix U so that A = U*T*U’ and
U’*U = eye(U). By itself, schur(A) returns T. If A is complex, the Complex Schur Form is returned in
matrix T. The Complex Schur Form is upper triangular with the eigenvalues of A on the diagonal. If A is
real, the Real Schur Form is returned. The Real Schur Form has the real eigenvalues on the diagonal and
the complex eigenvalues in 2-by-2 blocks on the diagonal.
ORDERED STABLE FORM :
[U,dim]=schur(A,’c’) returns an unitary matrix U which transforms A into schur form. In
addition, the dim first columns of U make a basis of the eigenspace of A associated with eigenvalues with
negative real parts (stable ”continuous time” eigenspace).
[U,dim]=schur(A,’d’) returns an unitary matrix U which transforms A into schur form. In ad-
dition, the dim first columns of U span a basis of the eigenspace of A associated with eigenvalues with
magnitude lower than 1 (stable ”discrete time” eigenspace).
GENERAL EIGENSPACE :
[U,dim]=schur(A,a_function) returns an unitary matrix U which transforms A into schur
form. In addition, the dim first columns of U span a basis of the eigenspace of A associated with the
eigenvalues which are selected by the function a function.
This function must be of the following type (here a function is ”rule”):

function [flag]=rule(x)

flag=...

Scilab Group April 1993 533

spanplus Scilab Function

x is a vector with three components which characterizes either a real eigenvalue or a pair of complex
conjugate eigenvalues.
If x(1)=1, a real eigenvalue is considered and this eigenvalue is x(2)/x(3).
If x(1)=2, a pair of complex conjugate eigenvalues is considered. The sum of these two eigenvalues (twice
the real part) is x(2) and the product (squared magnitude) is x(3).
On return, flag should be 1 if the real eigenvalue is selected or the pair of eigenvalues is selected and 0
otherwise.
EXAMPLE OF FUNCTION :

function [flag]=disc(x)
ls =x(1);flag=0;
select ls
case 1 then if abs(x(2)) < ro*abs(x(3)) then flag=1;end
case 2 then if x(3) < ro*ro then flag=1;end
end
The function disc selects the eigenvalues with magnitude lower than a given scalar ro. And for ro=1
the calling sequence [U,dim]=schur(A,’d’) and [U,dim]=schur(A,disc) are equivalent.
Another useful example is %choose (see function code in SCIDIR/macros/percent)
EXAMPLE :

A=diag([-0.9,-2,2,0.9]);X=rand(A);A=inv(X)*A*X;
[U,d]=schur(A,’c’);
A1=U’*A*U;
spec(A1(1:d,1:d)) //stable cont. eigenvalues
[U,d]=schur(A,’c’);
A1=U’*A*U;
spec(A1(1:d,1:d)) //stable disc. eigenvalues

S EE A LSO : gschur 513, ricc 356, pbig 523, psmall 527

2.8.58 spaninter subspace intersection

CALLING SEQUENCE :

[X,dim]=spaninter(A,B [,tol])
PARAMETERS :

A, B : two real or complex matrices with equal number of rows

X : orthogonal or unitary square matrix
dim : integer, dimension of subspace range(A) inter range(B)
DESCRIPTION :
[X,dim]=spaninter(A,B) computes the intersection of range(A) and range(B).
The first dim columns of X span this intersection i.e. X(:,1:dim) is an orthogonal basis for R(A) \ R(B )
In the X basis A and B are respectively represented by:
X’*A and X’*B.
tol is a threshold (sqrt(%eps) is the default value).
EXAMPLE :

A=rand(5,3)*rand(3,4); // A is 5 x 4, rank=3
B=[A(:,2),rand(5,1)]*rand(2,2);
[X,dim]=spaninter(A,B);
X1=X(:,1:dim); //The intersection
svd(A),svd([X1,A]) // X1 in span(A)
svd(B),svd([B,X1]) // X1 in span(B)

Scilab Group April 1993 534

spantwo Scilab Function

S EE A LSO : spanplus 535, spantwo 535

AUTHOR : F. D.

2.8.59 spanplus sum of subspaces

CALLING SEQUENCE :

[X,dim,dima]=spanplus(A,B[,tol])

PARAMETERS :

A, B : two real or complex matrices with equal number of rows

X : orthogonal or unitary square matrix
dim, dima : integers, dimension of subspaces
tol : nonnegative real number

DESCRIPTION :
[X,dim,dima]=spanplus(A,B) computes a basis X such that:
the first dima columns of X span Range(A) and the following (dim-dima) columns make a basis of A+B
relative to A.
The dim first columns of X make a basis for A+B.
One has the following canonical form for [A,B]:
[*,*] (dima rows)
X’*[A,B]=[0,*] (dim-dima rows)
[0,0]
tol is an optional argument (see function code).
EXAMPLE :

A=rand(6,2)*rand(2,5); // rank(A)=2
B=[A(:,1),rand(6,2)]*rand(3,3); //two additional independent vectors
[X,dim,dimA]=spanplus(A,B);
dimA
dim

S EE A LSO : spaninter 534, im_inv 515, spantwo 535

AUTHOR : F. D.

2.8.60 spantwo sum and intersection of subspaces

CALLING SEQUENCE :

[Xp,dima,dimb,dim]=spantwo(A,B, [tol])

PARAMETERS :

A, B : two real or complex matrices with equal number of rows

Xp : square non-singular matrix
dima, dimb, dim : integers, dimension of subspaces
tol : nonnegative real number

DESCRIPTION :
Given two matrices A and B with same number of rows, returns a square matrix Xp (non singular but not
necessarily orthogonal) such that :

Scilab Group April 1993 535

spec Scilab Function

[A1, 0] (dim-dimb rows)

Xp*[A,B]=[A2,B2] (dima+dimb-dim rows)
[0, B3] (dim-dima rows)
[0 , 0]
The first dima columns of inv(Xp) span range(A).
Columns dim-dimb+1 to dima of inv(Xp) span the intersection of range(A) and range(B).
The dim first columns of inv(Xp) span range(A)+range(B).
Columns dim-dimb+1 to dim of inv(Xp) span range(B).
Matrix [A1;A2] has full row rank (=rank(A)). Matrix [B2;B3] has full row rank (=rank(B)). Ma-
trix [A2,B2] has full row rank (=rank(A inter B)). Matrix [A1,0;A2,B2;0,B3] has full row rank
(=rank(A+B)).
EXAMPLE :

A=[1,0,0,4;
5,6,7,8;
0,0,11,12;
0,0,0,16];
B=[1,2,0,0]’;C=[4,0,0,1];
Sl=ss2ss(syslin(’c’,A,B,C),rand(A));
[no,X]=contr(Sl(’A’),Sl(’B’));CO=X(:,1:no); //Controllable part
[uo,Y]=unobs(Sl(’A’),Sl(’C’));UO=Y(:,1:uo); //Unobservable part
[Xp,dimc,dimu,dim]=spantwo(CO,UO); //Kalman decomposition
Slcan=ss2ss(Sl,inv(Xp));

S EE A LSO : spanplus 535, spaninter 534

AUTHOR : F. D.

2.8.61 spchol sparse cholesky factorization

CALLING SEQUENCE :

[R,P] = spchol(X)

PARAMETERS :

X : symmetric positive definite real sparse matrix

P : permutation matrix
R : cholesky factor

DESCRIPTION :
[R,P] = spchol(X) produces a lower triangular matrix R such that P*R*R’*P’ = X.
EXAMPLE :

X=[
3., 0., 0., 2., 0., 0., 2., 0., 2., 0., 0. ;
0., 5., 4., 0., 0., 0., 0., 0., 0., 0., 0. ;
0., 4., 5., 0., 0., 0., 0., 0., 0., 0., 0. ;
2., 0., 0., 3., 0., 0., 2., 0., 2., 0., 0. ;
0., 0., 0., 0. , 5., 0., 0., 0., 0., 0., 4. ;
0., 0., 0., 0., 0., 4., 0., 3., 0., 3., 0. ;
2., 0., 0., 2., 0., 0., 3., 0., 2., 0., 0. ;
0., 0., 0., 0., 0., 3., 0., 4., 0., 3., 0. ;
2., 0., 0., 2., 0., 0., 2., 0., 3., 0., 0. ;
0., 0., 0., 0., 0., 3., 0., 3., 0., 4., 0. ;

Scilab Group April 1993 536

sva Scilab Function

0., 0., 0., 0., 4., 0., 0., 0., 0., 0., 5.];
X=sparse(X);[R,P] = spchol(X);
max(P*R*R’*P’-X)
S EE A LSO : sparse 214, lusolve 521, luget 520, chol 503

2.8.62 spec eigenvalues

CALLING SEQUENCE :
evals=spec(A)
PARAMETERS :
A : real or complex square matrix
evals : real or complex vector
DESCRIPTION :
evals=spec(A) returns in vector evals the eigenvalues of A.
Eigenvectors are obtained by bdiag.
EXAMPLE :
A=diag([1,2,3]);X=rand(3,3);A=inv(X)*A*X;
spec(A)
//
x=poly(0,’x’);
pol=det(x*eye()-A)
roots(pol)
//
[Ab,X,bs]=bdiag(A);
Ab
clean(inv(X)*A*X)
S EE A LSO : poly 65, det 507, gspec 514, schur 533, bdiag 502, colcomp 505

2.8.63 sqroot W*W’ hermitian factorization

CALLING SEQUENCE :
sqroot(X)
PARAMETERS :
X : symmetric non negative definite real or complex matrix
DESCRIPTION :
W=sqroot(X) returns W such that X=W*W’ (uses SVD).
EXAMPLE :
X=rand(5,2)*rand(2,5);X=X*X’;
W=sqroot(X)
norm(W*W’-X,1)
//
X=rand(5,2)+%i*rand(5,2);X=X*X’;
W=sqroot(X)
norm(W*W’-X,1)
S EE A LSO : chol 503, svd 538

Scilab Group April 1993 537

svd Scilab Function

2.8.64 sva singular value approximation

CALLING SEQUENCE :
[U,s,V]=sva(A,k)
[U,s,V]=sva(A,tol)
PARAMETERS :
A : real or complex matrix
k : integer
tol : nonnegative real number
DESCRIPTION :
Singular value approximation.
[U,S,V]=sva(A,k) with k an integer >=1, returns U,S and V such that B=U*S*V’ is the best
L2 approximation of A with rank(B)=k.
[U,S,V]=sva(A,tol) with tol a real number, returns U,S and V such that B=U*S*V’ such
that L2-norm of A-B is at most tol.
EXAMPLE :
A=rand(5,4)*rand(4,5);
[U,s,V]=sva(A,2);
B=U*s*V’;
svd(A)
svd(B)
clean(svd(A-B))
S EE A LSO : svd 538

2.8.65 svd singular value decomposition

CALLING SEQUENCE :
s=svd(X)
[U,S,V]=svd(X)
[U,S,V]=svd(X,0)
[U,S,V,rk]=svd(X [,tol])
PARAMETERS :
X : a real or complex matrix
s : real vector (singular values)
S : real diagonal matrix (singular values)
U,V : orthogonal or unitary square matrices (singular vectors).
tol : real number
DESCRIPTION :
[U,S,V] = svd(X) produces a diagonal matrix S , of the same dimension as X and with non-
negative diagonal elements in decreasing order, and unitary matrices U and V so that X = U*S*V’.
[U,S,V] = svd(X,0) produces the "economy size" decomposition. If X is m-by-n with
m > n, then only the first n columns of U are computed and S is n-by-n.
s = svd(X) by itself, returns a vector s containing the singular values.
[U,S,V,rk]=svd(X,tol) gives in addition rk, the numerical rank of X i.e. the number of singular
values larger than tol.
The default value of tol is the same as in rank.
EXAMPLE :

Scilab Group April 1993 538

trace Scilab Function

X=rand(4,2)*rand(2,4)
svd(X)
sqrt(spec(X*X’))

S EE A LSO : rank 530, qr 528, colcomp 505, rowcomp 531, sva 538, spec 537

2.8.66 sylv Sylvester equation.

CALLING SEQUENCE :

sylv(A,B,C,flag)

PARAMETERS :

A,B,C : three real matrices of appropriate dimensions.

flag character string (’c’ or ’d’)

DESCRIPTION :
X = sylv(A,B,C,’c’) computes X, solution of the ”continuous time” Sylvester equation
A*X+X*B=C
X=sylv(A,B,C,’d’) computes X, solution of the ”discrete time” Sylvester equation
A*X*B-X=C

EXAMPLE :

A=rand(4,4);C=rand(4,3);B=rand(3,3);
X = sylv(A,B,C,’c’);
norm(A*X+X*B-C)
X=sylv(A,B,C,’d’)
norm(A*X*B-X-C)

S EE A LSO : lyap 522

2.8.67 trace trace

CALLING SEQUENCE :

trace(X)

PARAMETERS :

X : real or complex square matrix, polynomial or rational matrix.

DESCRIPTION :
trace(X) is the trace of the matrix X.
Same as sum(diag(X)).
EXAMPLE :

A=rand(3,3);
trace(A)-sum(spec(A))

S EE A LSO : det 507

Scilab Group April 1993 539

trace Scilab Function

2.9 Metanet

Scilab Group April 1993 540

add node Scilab function

2.9.1 add edge adds an edge or an arc between two nodes

CALLING SEQUENCE :

g1 = add_edge(i,j,g)

PARAMETERS :

i : integer, number of start node

j : integer, number of end node
g : graph list
g1 : graph list of the new graph with the added edge

DESCRIPTION :
add edge returns the graph g1 with a new edge from node number i to node number j. If the graph
is directed, the edge is an arc. The number of edges plus 1 is taken as the name of the new edge.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
g=add_edge(1,7,g);
g(’edge_color’)=[ones(ta) 11];
show_graph(g);

S EE A LSO : add_node 541, delete_arcs 551, delete_nodes 552

2.9.2 add node adds a disconnected node to a graph

CALLING SEQUENCE :

g1 = add_node(g,[xy,name])

PARAMETERS :

g : graph list
xy : optional row vector of coordinates of new node
name : optional name of the added node
g1 : graph list of the new graph with the added node

DESCRIPTION :
add node adds a disconnected node to graph g and returns the new graph g1.
The coordinates of the new node can be given as a row vector of coordinates in xy. If the nodes of
graph g have no coordinates (elements node x and node y are []), to give xy has no effect. If the
nodes of graph g have coordinates and xy is not given, the new node has (0,0) as coordinates.
If name is given, it is the name of the new node, otherwise the number of nodes plus 1 is taken as the
name of the new node.
EXAMPLE :

Scilab Group September 1996 541

arc graph Scilab function

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
n=g(’node_number’);
g1=add_node(g,[270 140]);
g1(’node_color’)=[ones(1,n) 11];
show_graph(g1);

S EE A LSO : add_edge 541, delete_arcs 551, delete_nodes 552

2.9.3 adj lists computes adjacency lists

CALLING SEQUENCE :

[lp,la,ls] = adj_lists(g)
[lp,la,ls] = adj_lists(directed,n,tail,head)

PARAMETERS :

g : graph list
directed : integer, 0 (undirected graph) or 1 (directed graph)
n : integer, the number of nodes of the graph
tail : the row vector of the numbers of the tail nodes of the graph (its size is the number of edges of the
graph)
head : the row vector of the numbers of the head nodes of the graph (its size is the number of edges of the
graph)
lp : row vector, pointer array of the adjacency lists description of the graph (its size is the number of nodes
of the graph + 1)
la : row vector, arc array of the adjacency lists description of the graph (its size is the number of edges of
the graph)
ls : row vector, node array of the adjacency lists description of the graph (its size is the number of edges
of the graph)

DESCRIPTION :
adj lists computes the row vectors of the adjacency lists description of the graph g. It is also possible
to give adj lists the description of the graph given by the number of nodes n and the row vectors
tail and head.
EXAMPLE :

ta=[2 3 3 5 3 4 4 5 8];
he=[1 2 4 2 6 6 7 7 4];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[129 200 283 281 128 366 122 333];
g(’node_y’)=[61 125 129 189 173 135 236 249];
show_graph(g);
[lp,la,ls]=adj_lists(g)
[lp,la,ls]=adj_lists(1,g(’node_number’),ta,he)

S EE A LSO : chain_struct 546, graph_2_mat 558

Scilab Group September 1996 542

articul Scilab function

2.9.4 arc graph graph with nodes corresponding to arcs

CALLING SEQUENCE :

g1 = arc_graph(g)

PARAMETERS :

g : graph list of the old graph

g1 : graph list of the new graph

DESCRIPTION :
arc graph returns the directed graph g1 with the nodes corresponding to the arcs of the directed graph
g. g1 is defined in the following way:
- its nodes correspond to the arcs of g - 2 nodes of the new graph are adjacent if and only if the
corresponding arcs of the graph g are consecutive.
The coordinates of the nodes of g1 are given by the middle points of the corresponding edges of g.
If such an arc graph does not exist, an empty vector is returned.
EXAMPLE :

ta=[1 1 2 4 4 5 6 7 2 3 5 1];
he=[2 6 3 6 7 8 8 8 4 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[281 284 360 185 405 182 118 45];
g(’node_y’)=[262 179 130 154 368 248 64 309];
show_graph(g);
g1=arc_graph(g);
show_graph(g1,’new’);

S EE A LSO : line_graph 564

2.9.5 arc number number of arcs of a graph

CALLING SEQUENCE :

ma = arc_number(g)

PARAMETERS :

g : graph list
ma : integer, number of arcs

DESCRIPTION :
arc number returns the number ma of arcs of the graph. If the graph is directed, it is the number of
edges. If the graph is undirected, it is twice the number of edges.
S EE A LSO : edge_number 553, node_number 579

Scilab Group September 1996 543

bandwr Scilab function

2.9.6 articul finds one or more articulation points

CALLING SEQUENCE :

nart = articul([i],g)

PARAMETERS :

g : graph list
i : integer
nart : integer row vector

DESCRIPTION :
articul finds one or more articulation points (if they exist) of the graph g. nart is the row vector of
numbers of articulation nodes: deleting one of these nodes increases the number of connected components
of the graph. i is the optional node number from which the algorithm starts. The default is 1. Note that
the result depends strongly on this starting node.
EXAMPLE :

ta=[2 1 3 2 2 4 4 5 6 7 8 8 9 10 10 10 10 11 12 13 14 15 16 17 17];
he=[1 10 2 5 7 3 2 4 5 8 6 9 7 7 11 13 15 12 13 14 11 16 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
nart = articul(g)
show_nodes(nart);

2.9.7 bandwr bandwidth reduction for a sparse matrix

CALLING SEQUENCE :

[iperm,mrepi,prof,ierr] = bandwr(sp,[iopt])
[iperm,mrepi,prof,ierr] = bandwr(lp,ls,n,[iopt])

PARAMETERS :

sp : sparse matrix
lp : integer row vector
ls : integer row vector
n : integer
iopt : integer
iperm : integer row vector
mrepi : integer row vector
prof : integer row vector
ierr : integer

DESCRIPTION :
bandwr solves the problem of bandwidth reduction for a sparse matrix: the matrix is supposed to be
upper triangular with a full diagonal (it is easy to complete a non symmetric matrix, and then discards the
added terms).

Scilab Group September 1996 544

best match Scilab function

In the first calling sequence, sp denotes a sparse matrix; the optional argument iopt is 0 or 1: 1 if reduc-
ing the profile of the matrix is more important than reducing the bandwidth and 0 if bandwidth reduction is
most important.
The second calling sequence corresponds to the description of a graph: lp is a row vector, pointer array
of the adjacency lists description of a graph (its size is the number of nodes of the graph + 1); ls is a row
vector, node array of the adjacency lists description (its size is the number of edges of the graph i.e. the
number of non-zero terms of the corresponding sparse matrix). n is the number of nodes (dimension of
sp).
iperm is the permutation vector for reordering the rows and columns which reduces the bandwidth and/or
profile (new numbering of the nodes of the graph); mrepi is the inverse permutation (mrepi(iperm) is the
identity). prof is the array giving the profile of the sparse matrix after the bandwidth reduction if iopt
is 1. If iopt is 0 this array is zero except for the first term giving the bandwidth. The simple com-
mand max(prof(2:$)-prof(1:($-1))) returns the bandwidth of the matrix. ierr is an integer
indicating an error if its value is not zero.
EXAMPLE :

ta=[2 1 3 2 2 4 4 5 6 7 8 8 9 10 10 10 10 11 12 13 13 14 15 16 16 17 17];
he=[1 10 2 5 7 3 2 4 5 8 6 9 7 7 11 13 15 12 13 9 14 11 16 1 17 14 15];
g=make_graph(’foo’,0,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
// THE GRAPH
show_graph(g);
a=graph_2_mat(g,’node-node’);
ww=tril(a)’+eye();
ww1=full(ww);
xset(’window’,0)
hist3d((ww1+tril(ww1’,-1)+tril(ww1,-1)’),52,85);
// BANDWIDTH REDUCTION FOR THE MATRIX
[iperm,mrepi,prof,ierr]=bandwr(ww);
max(prof(2:$)-prof(1:($-1)))
// GRAPH WITH THE NEW NUMBERING
g2=g;g2(’node_name’)=string(iperm);
show_graph(g2,’new’)
// NEW MATRIX
n=g(’node_number’);
yy=ww1(mrepi,mrepi);
xset(’window’,1)
hist3d((yy+tril(yy’,-1)+tril(yy,-1)’),52,85);
// STARTING WITH THE SAME MATRIX
[ij,v,mn]=spget(ww);
g1=make_graph(’foo’,0,n,ij(:,1)’,ij(:,2)’);
g1(’node_x’)=g(’node_x’);g1(’node_y’)=g(’node_y’);
// GRAPH
//show_graph(g1,’rep’);
[lp,la,ls] = adj_lists(1,n,g1(’tail’),g1(’head’));
[iperm,mrepi,prof,ierr]=bandwr(lp,ls,n,0);
g2=g;g2(’node_name’)=string(iperm);
show_graph(g2,’new’);

2.9.8 best match best matching of a graph

Scilab Group September 1996 545

chain struct Scilab function

CALLING SEQUENCE :

[card,match] = best_match(g)

PARAMETERS :

g : graph list
card : integer
match : integer row vector

DESCRIPTION :
best match finds an optimal matching for the graph g. The output are card and the vector match.
card is the cardinality of an optimal matching. match(i) is the node adjacent to node i in the optimal
matching or 0 if i is unmatched.
EXAMPLE :

ta=[27 27 3 12 11 12 27 26 26 25 25 24 23 23 21 22 21 20 19 18 18];
ta=[ta 16 15 15 14 12 9 10 6 9 17 8 17 10 20 11 23 23 12 18 28];
he=[ 1 2 2 4 5 11 13 1 25 22 24 22 22 19 13 13 14 16 16 9 16];
he=[he 10 10 11 12 2 6 5 5 7 8 7 9 6 11 4 18 13 3 28 17];
n=28;
g=make_graph(’foo’,0,n,ta,he);
xx=[46 120 207 286 366 453 543 544 473 387 300 206 136 250 346 408];
g(’node_x’)=[xx 527 443 306 326 196 139 264 55 58 46 118 513];
yy=[36 34 37 40 38 40 35 102 102 98 93 96 167 172 101 179];
g(’node_y’)=[yy 198 252 183 148 172 256 259 258 167 109 104 253];
show_graph(g);
[card,match] = best_match(g);
sp=sparse([ta’ he’],[1:size(ta,2)]’,[n,n]);
sp1=sparse([[1:n]’ match’],ones(1,size(match,2))’,[n,n]);
[ij,v,mn]=spget(sp.*sp1);
show_arcs(v’);
//
// WITH A LARGER GRAPH
g=load_graph(SCI+’/demos/metanet/mesh1000’);
g(’directed’)=0;
ta=g(’tail’);he=g(’head’);n=node_number(g);
show_graph(g,’new’,[3000,1000]);
[card,match] = best_match(g);
sp=sparse([ta’ he’],[1:size(ta,2)]’,[n,n]);
sp1=sparse([[1:n]’ match’],ones(1,size(match,2))’,[n,n]);
[ij,v,mn]=spget(sp.*sp1);
show_arcs(v’);

S EE A LSO : perfect_match 581

2.9.9 chain struct chained structure from adjacency lists of a graph

CALLING SEQUENCE :

[fe,che,fn,chn] = chain_struct(g)
[fe,che,fn,chn] = chain_struct(lp,la,ls)

PARAMETERS :

g : graph list

Scilab Group September 1996 546

circuit Scilab function

lp : row vector, pointer array of the adjacency lists description of the graph (its size is the number of nodes
of the graph + 1)
la : row vector, arc array of the adjacency lists description of the graph (its size is the number of edges of
the graph)
ls : row vector, node array of the adjacency lists description of the graph (its size is the number of edges
of the graph)
fe : row vector of the numbers of the first edges starting from nodes (its size is the number of nodes of the
graph)
che : row vector of the numbers of the chained edges (its size is the number of edges of the graph)
fn : row vector of the numbers of the first nodes reached by the edges of fe (its size is the number of
nodes of the graph)
chn : row vector of the nodes reached by the edges of che

DESCRIPTION :
chain struct computes the row vectors of the edge chained structure description of the graph g. It is
also possible to give directly chain struct the adjacency lists of the graph. This is more efficient if the
adjacency lists are already available since chain struct uses them to make computations.
The vectors fe, che, fn and chn describe the chained structure in the following way:
fe(i)) is the number of the first edge starting from node i
che(fe(i)) is the number of the second edge starting from node i, che(che(fe(i))) is the
number of the third edge starting from node i and so on until the value is 0
fn(i) is the number of the first node reached from node i
ch(i) is the number of the node reached by edge che(i).
EXAMPLE :

ta=[1 1 2 3 5 4 6 7 7 3 3 8 8 5];
he=[2 3 5 4 6 6 7 4 3 2 8 1 7 4];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[116 231 192 323 354 454 305 155];
g(’node_y’)=[118 116 212 219 117 185 334 316];
show_graph(g);
[fe,che,fn,chn] = chain_struct(g)

S EE A LSO : adj_lists 542, graph_2_mat 558

2.9.10 check graph checks a Scilab graph list

CALLING SEQUENCE :

check_graph(g)

PARAMETERS :

g : graph list to check

DESCRIPTION :
check graph checks its argument g to see if it is a graph list. The checking is not only syntac-
tic (number of elements of the list, compatible sizes of the vectors), but also semantic in the sense that
check graph checks that node number, tail and head elements of the list can really represent a
graph.
Moreover, the names of the node must be different. In fact, this do not give errors in Scilab, but strange
behaviour can appear when using the Metanet window. So, this is not checked by check graph because
it is time consuming. It is only checked when loading, saving or showing a graph.
S EE A LSO : graph-list 555

Scilab Group September 1995 547

con nodes Scilab function

2.9.11 circuit finds a circuit or the rank function in a directed graph

CALLING SEQUENCE :

[p,r] = circuit(g)

PARAMETERS :

g : graph list
p : row vector of integer numbers of the arcs of the circuit if it exists
r : row vector of rank function if there is no circuit

DESCRIPTION :
circuit tries to find a circuit for the directed graph g. It returns the circuit p as a row vector of the
corresponding arc numbers if it exists and it returns the empty vector [] otherwise. If the graph has no
circuit, the rank function is returned in r, otherwise its value is the empty vector [].
EXAMPLE :

// graph with circuit

ta=[1 1 2 3 5 4 6 7 7 3 3 8 8 5];
he=[2 3 5 4 6 6 7 4 3 2 8 1 7 4];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[116 231 192 323 354 454 305 155];
g(’node_y’)=[ 118 116 212 219 117 185 334 316];
show_graph(g);
p=circuit(g)
show_arcs(p)
// graph without circuit
g=make_graph(’foo’,1,4,[1 2 2 3],[2 3 4 4]);
[p,r]=circuit(g)

2.9.12 con nodes set of nodes of a connected component

CALLING SEQUENCE :

ns = con_nodes(i,g)

PARAMETERS :

i : integer, number of the connected component

g : graph list
ns : row vector, node numbers of the connected component

DESCRIPTION :
con nodes returns the row vector ns of the numbers of the nodes which belong to the connected
component number i. If i is not the number of a connected component, the empty vector [] is returned.

EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 7 7 9 10 12 12 13 13 14 15];
he=[2 6 3 4 5 1 3 5 1 8 9 8 11 10 11 11 15 13 14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[197 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[76 181 276 278 276 83 174 281 177 86 175 90 290 397 399];

Scilab Group September 1995 548

contract edge Scilab function

show_graph(g);
con_nodes(2,g)
x_message(’Displaying the nodes of component #2’);
n=g(’node_number’);
nodecolor=0*ones(1,n);
nodecolor(1,con_nodes(2,g))=11*ones(con_nodes(2,g));
g(’node_color’)=nodecolor;
nodediam=20.*ones(1,n);
nodediam(1,con_nodes(2,g))=30*ones(con_nodes(2,g));
g(’node_diam’)=nodediam;
show_graph(g);

S EE A LSO : connex 549, is_connex 563, strong_connex 590, strong_con_nodes

589

2.9.13 connex connected components

CALLING SEQUENCE :

[nc,ncomp] = connex(g)

PARAMETERS :

g : graph list
nc : integer, number of connected components
ncomp : row vector of connected components

DESCRIPTION :
connex returns the number nc of connected components of graph g and a row vector ncomp giving
the number of the connected component for each node. For instance, if i is a node number, ncomp[i]
is the number of the connected component to which node number i belongs.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 7 7 7 8 9 10 12 12 13 13 14 15];
he=[2 6 3 4 5 1 3 5 1 7 5 8 9 5 8 11 10 11 11 15 13 14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[197 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[76 181 276 278 276 83 174 281 177 86 175 90 290 397 399];
show_graph(g);
[nc,ncomp]=connex(g)
g(’node_color’)=10+ncomp;
g(’node_diam’)=10+10*ncomp;
x_message(’Displaying the connected components of this graph’);
show_graph(g);

S EE A LSO : con_nodes 548, is_connex 563, strong_connex 590, strong_con_nodes

589

2.9.14 contract edge contracts edges between two nodes

CALLING SEQUENCE :

g1 = contract_edge(i,j,g)

Scilab Group September 1996 549

convex hull Scilab function

PARAMETERS :

i : integer, number of start or end node of edge

j : integer, number of end or start node of edge
g : graph list
g1 : graph list of the new graph

DESCRIPTION :
contract edge returns the graph g1, the edges between the nodes number i and j being deleted, the
nodes being reduced to one node with the same name as node i and located at the middle point between
the 2 previous nodes.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
g1=contract_edge(10,13,g);
show_graph(g1,’new’);

S EE A LSO : add_edge 541, add_node 541, delete_arcs 551, delete_nodes 552

2.9.15 convex hull convex hull of a set of points in the plane

CALLING SEQUENCE :

[nhull,ind] = convex_hull(xy)

PARAMETERS :

xy : 2 x n real matrix
nhull : integer
ind : integer row vector

DESCRIPTION :
convex hull finds the convex hull of a given set of n points in the plane. xy is the 2 x n matrix of the
(x,y) coordinates of the given points. convex hull returns in nhull the number of the points of the
boundary of the convex hull and in ind the row vector (of size nhull) giving the indices in xy of the
points of the boundary. The order in ind corresponds to consecutive points on the boundary.
EXAMPLE :

ta=[27 27 3 12 11 12 27 26 26 25 25 24 23 23 21 22 21 20 19 18 18];
ta=[ta 16 15 15 14 12 9 10 6 9 17 8 17 10 20 11 23 23 12 18 28];
he=[ 1 2 2 4 5 11 13 1 25 22 24 22 22 19 13 13 14 16 16 9 16];
he=[he 10 10 11 12 2 6 5 5 7 8 7 9 6 11 4 18 13 3 28 17];
g=make_graph(’foo’,0,28,ta,he);
xx=[46 120 207 286 366 453 543 544 473 387 300 206 136 250 346 408];
g(’node_x’)=[xx 527 443 306 326 196 139 264 55 58 46 118 513];
yy=[36 34 37 40 38 40 35 102 102 98 93 96 167 172 101 179];

Scilab Group September 1996 550

delete arcs Scilab function

g(’node_y’)=[yy 198 252 183 148 172 256 259 258 167 109 104 253];
show_graph(g);
xy=[g(’node_x’);g(’node_y’)];
[nhull,ind] = convex_hull(xy)
show_nodes(ind);

2.9.16 cycle basis basis of cycle of a simple undirected graph

CALLING SEQUENCE :

spc = cycle_basis(g)

PARAMETERS :

g : graph list
spc : sparse matrix

DESCRIPTION :
First a spanning tree is found by using min weight tree and then used to find all fundamental cycles
with respect to this tree. They are returned as a set of cycles, each cycle being represented by a set of edges.
These cycles are returned in a sparse matrix spc: each line of this matrix corresponds to a cycle.
The graph g is supposed to be a simple undirected and connected graph (cycle basis does not
check that the graph is simple, use graph simp before calling it if necessary).
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
gt=make_graph(’foo’,1,17,ta,he);
gt(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
gt(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187
151 301];
gt(’edge_color’)=modulo([1:(edge_number(gt))],15)+1;
gt(’node_diam’)=[1:(gt(’node_number’))]+20;
show_graph(gt);
g=graph_simp(gt);
g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’node_diam’)=gt(’node_diam’);
g(’default_edge_hi_width’)=12;
show_graph(g);
spc=cycle_basis(g);
for kk=1:(size(spc,1)),
aaa=spc(kk,:);aaa=full(aaa);aaa(aaa==0)=[];
show_arcs(aaa);
end;

S EE A LSO : min_weight_tree 577, graph_simp 561

2.9.17 delete arcs deletes all the arcs or edges between a set of nodes

CALLING SEQUENCE :

Scilab Group September 1996 551

delete nodes Scilab function

g1 = delete_arcs(ij,g)

PARAMETERS :

ij : matrix of integers (number of nodes)

g : graph list
g1 : graph list of the new graph without the arcs or edges defined by ij

DESCRIPTION :
If g is a directed graph, delete arcs returns the graph g1 with the arcs defined by matrix ij being
deleted. ij must be a n x 2 matrix of node numbers: the n arcs to be deleted are defined by couples of
nodes (ij(i,1), ij(i,2)).
If g is an undirected graph, the edges corresponding to matrix ij are deleted.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
ij=[13 10;8 6;5 4;4 2];
gt=delete_arcs(ij,g);
show_graph(gt,’new’);
g(’directed’)=0;
gt=delete_arcs(ij,g);
show_graph(gt,’new’);

S EE A LSO : add_edge 541, add_node 541, delete_nodes 552

2.9.18 delete nodes deletes nodes

CALLING SEQUENCE :

g1 = delete_nodes(v,g)

PARAMETERS :

v : vector of integers, numbers of nodes to be deleted

g : graph list
g1 : graph list of the new graph with deleted nodes

DESCRIPTION :
delete nodes returns the graph g1, with the nodes given by the vector v being deleted.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);

Scilab Group September 1996 552

gen net Scilab function

g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
v=[10 13 4];
gt=delete_nodes(v,g);
show_graph(gt,’new’);
S EE A LSO : add_edge 541, add_node 541, delete_arcs 551

2.9.19 edge number number of edges of a graph

CALLING SEQUENCE :
ma = edge_number(g)
PARAMETERS :
g : graph list
m : integer, number of edges
DESCRIPTION :
edge number returns the number m of edges of the graph. If the graph is directed, it is the number
of arcs. If the graph is undirected, it is half the number of edges. It is always equal to the dimension of
g(’tail’) and g(’head’).
S EE A LSO : arc_number 543, node_number 579

2.9.20 find path finds a path between two nodes

CALLING SEQUENCE :
p = find_path(i,j,g)
PARAMETERS :
i : integer, number of start node
j : integer, number of end node
g : graph list
p : row vector of integer numbers of the arcs of the path if it exists
DESCRIPTION :
find path returns a path p from node number i to node number j if one exists, and the empty vector
[] otherwise.
EXAMPLE :
ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
p=find_path(1,14,g);
edgecolor=1*ones(ta); edgecolor(p)=11*ones(p); g(’edge_color’)=edgecolor;
show_graph(g); show_arcs(p);

Scilab Group September 1996 553

girth Scilab function

S EE A LSO : nodes_2_path 579, shortest_path 586

2.9.21 gen net generation of a network

CALLING SEQUENCE :

g = gen_net(name,directed,v)
g = gen_net()

PARAMETERS :

name : string, the name of the graph

directed : integer, 0 (undirected graph) or 1 (directed graph)
v : row vector with 12 values for defining the network
g : graph list

DESCRIPTION :
gen net generates a network g. The arguments are the name of the graph, a flag equal to 0 (undirected
graph) or to 1 (directed graph) and a vector describing the network (see below).
If no argument are given, a dialog box for the definition of all the arguments is opened.
v must be a row vector with 12 values. The meaning of the values are:
Seed for random: used for initialization of random generation
Number of nodes
Number of sources
Number of sinks
Minimum cost
Maximum cost
Input supply
Output supply
Minimum capacity
Maximum capacity
Percentage of edges with costs: between 0 and 100
Percentage of edges with capacities: between 0 and 100
The cost of edges without cost are put to minimum cost. The maximum capacity of edges without
capacity are put to maximum upply
The result is a network g built on a planar connected graph, by using a triangulation method. Moreover,
computations are made in order to have a coherent network. Values of costs and maximum capacities are
put on the edges. Minimum capacities are reduced to 0.
EXAMPLE :

v=[1,10,2,1,0,10,100,100,0,100,50,50];
g=gen_net(’foo’,1,v);
show_graph(g)
// generating using dialogs
g=gen_net();
show_graph(g)

S EE A LSO : mesh2d 569

Scilab Group September 1996 554

graph-list Scilab type

2.9.22 girth girth of a directed graph

CALLING SEQUENCE :

d = girth(g)

PARAMETERS :

g : graph list
d : integer

DESCRIPTION :
girth computes the length (number of arcs) of the shortest cycle in an unweighted directed graph g.
EXAMPLE :

ta=[1 6 2 4 7 5 6 8 4 3 5 1];
he=[2 1 3 6 4 8 8 7 2 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[285 284 335 160 405 189 118 45];
g(’node_y’)=[266 179 83 176 368 252 64 309];
show_graph(g);
d=girth(g)

2.9.23 glist graph list creation

CALLING SEQUENCE :

g = glist(a1, ... ,a34)

DESCRIPTION :
glist(a1,....a34) is a shortcut to to tlist([’graph’,’name’,’directed’,’node number’,’tail’,’hea
’node name’,’node type’,’node x’,’node y’,’node color’,.. ’node diam’,’node border’,’node
’edge name’,’edge color’,’edge width’,’edge hi width’,.. ’edge font size’,’edge length’,’e
’edge min cap’,’edge max cap’,’edge q weight’,’edge q orig’,.. ’edge weight’,’default node
’default edge width’,’default edge hi width’,.. ’default font size’,’node label’,’edge lab
... ,a34) It is a low level function to create graph lists, mainly used by programmers. No checking
is done. For standard creation of graph lists, use make graph.
S EE A LSO : check_graph 547, graph-list 555, make_graph 566

2.9.24 graph-list description of graph list

DESCRIPTION :
A graph in Scilab is represented by a Scilab typed list. We call it a graph list.
You will find below the complete description of the list. Each element is described by one or more lines.
The first line gives the name of the element and its definition. Additional informations, such as the default
for elements that can have one, are given in the other lines. Indeed, only the 5 first elements must have a
value in the list, all the others can be given the empty vector [] as a value, and then the default is used
when it is needed by functions or by the Metanet window. For instance, you can define a graph list by

g=make_graph(’min’,1,1,[1],[1]);

Scilab Group September 1996 555

graph-list Scilab type

which is the simplest graph you can create in Metanet (it is directed, has one node and one loop arc on
this node).
The name of the element in the list is very important because it is used to access the elements of the list.
For instance, if g is a graph list, to get the name of the graph, you only have to do:
g(’name’)
and if you want to change the name of the graph to ’toto’, you have to do:
g(’name’)=’toto’;
Moreover, you can get the number of edges and the number of arcs of the graph by using edge number(g)
and arc number(g) (these names do not correspond to elements of the list). For compatibility, node number(g)
can also be used instead of g(’node number’).
A graph list can be syntactically correct but not represent a good graph. You can use the function
check graph to check it. Moreover it is a good idea to give nodes different names. In fact, this does not
give errors in Scilab, but strange behaviour can appear when using the Metanet window. This is not checked
by check graph because it is time consuming. It is only checked when loading, saving or showing a
graph.
The elements of a graph list are given below:

name: - the name of the graph

- it is a string with a maximum of 80 characters
directed: - flag giving the type of the graph
- it is equal to 1 (graph directed) or equal to 0 (graph undirected)
node number: - number of nodes
tail: - row vector of the tail node numbers
head: - row vector of the head node numbers
node name: - row vector of node names
- the names of the nodes must be different
- default is the node numbers as node names
node type: - row vector of the node types
- the type is an integer from 0 to 2, default is 0 (plain node):
- 0 = plain node
- 1 = sink node
- 2 = source node
node x: - row vector of the x coordinate of the nodes
- default is computed
node y: - row vector of the y coordinate of the nodes
- default is computed
node color: - row vector of the node colors
- the color is an integer from 0 to 16, default is 0 (default foreground):
- 0 = default foreground
- 1 = navyblue
- 2 = blue
- 3 = skyblue
- 4 = aquamarine
- 5 = forestgreen
- 6 = green
- 7 = lightcyan
- 8 = cyan
- 9 = orange
- 10 = red
- 11 = magenta
- 12 = violet
- 13 = yellow
- 14 = gold

Scilab Group September 1996 556

graph-list Scilab type

- 15 = beige
- 16 = background
node diam: - row vector of the size of the node diameters in pixels
- a node is drawn as a circle
- default is the value of element default node diam
node border: - row vector of the size of the node borders in pixels
- a node is drawn as a circle
- default is the value of element default node border
node font size: - row vector of the size of the font used to draw the name of the node
- you can choose 8, 10, 12, 14, 18 or 24
- default is the value of element default font size
node demand: - row vector of the node demands
- default is 0
edge name: - row vector of the edge names
- it is better that the names of the edges are different, but this is not an error
- default is the edge numbers as edge names
edge color: - row vector of the edge colors
- the color is an integer from 0 to 16 (see node color)
- default is 0 (default foreground)
edge width: - row vector of the size of the edge widths in pixels
- default is the value of element default edge width
edge hi width: - row vector of the size of the highlighted edge widths in pixels
- default is the value of element default edge hi width
edge font size: - row vector of the size of the fonts used to draw the name of the edge
- you can choose 8, 10, 12, 14, 18 or 24
- default is the value of element default font size
edge length: - row vector of the edge lengths
- default is 0
edge cost: - row vector of the edge costs
- default is 0
edge min cap: - row vector of the edge minimum capacities
- default is 0
edge max cap: - row vector of the edge maximum capacities
- default is 0
edge q weight: - row vector of the edge quadratic weights
- default is 0
edge q orig: - row vector of the edge quadratic origins
- default is 0
edge weight: - row vector of the edge weights
- default is 0
default node diam: - default size of the node diameters of the graph
- default is 20 pixels
default node border: - default size of the node borders of the graph
- default is 2 pixels
default edge width: - default size of the edge widths of the graph
- default is 1 pixel
default edge hi width: - default size of the highlighted edge widths of the graph
- default is 3 pixels
default font size: - default size of the font used to draw the names of nodes and edges
- default is 12
node label: - row vector of node labels
edge label: - row vector of edge labels

EXAMPLE :
g=load_graph(SCI+’/demos/metanet/mesh100’);

Scilab Group September 1996 557

graph center Scilab function

g(’node_color’)=int(rand(1:g(’node_number’))*16);
g(’edge_color’)=int(rand(1:edge_number(g))*16);
show_graph(g)

S EE A LSO : arc_number 543, check_graph 547, edge_number 553, glist 555, make_graph
566, node_number 579

2.9.25 graph 2 mat node-arc or node-node incidence matrix of a graph

CALLING SEQUENCE :

a = graph_2_mat(g,mat)

PARAMETERS :

g : graph list
mat : optional string, ’node-arc’ or ’node-node’ matrix
a : sparse node-arc or node-node incidence matrix

DESCRIPTION :
graph 2 mat computes the node-arc or the node-node incidence matrix corresponding to the graph g.
If the optional argument mat is omitted or is the string ’node-arc’, the node-arc matrix is com-
puted. If mat is the string ’node-node’, the node-node matrix is computed.
If n is the number of nodes of the graph and m is the number of edges of the graph, the node-arc matrix
is a Scilab sparse matrix of size (n,m).
It is defined as follows. If the graph is directed:
a(i,j) = +1 if node i is the tail of arc j a(i,j) = -1 if node i is the head of arc j If the
graph is undirected:
a(i,j) = 1 if node i is the tail or the head of arc j If n is the number of nodes of the graph, the
node-node matrix is a Scilab sparse matrix of size (n,n).
It is defined as follows:
a(i,j) = 1 if there is an arc from node i to node j
EXAMPLE :

g=load_graph(SCI+’/demos/metanet/colored’);
a=graph_2_mat(g)
a=graph_2_mat(g,’node-node’)

S EE A LSO : mat_2_graph 566

2.9.26 graph center center of a graph

CALLING SEQUENCE :

[no,rad] = graph_center(g)

PARAMETERS :

g : graph list
no : integer
rad : integer

Scilab Group September 1996 558

graph diameter Scilab function

DESCRIPTION :
graph center computes the center of the graph g i.e. the node for which the largest of the shortest
paths to all the other nodes is minimum. The lengths of the arcs are supposed to be integer (and the default
value is 1). The output is the value rad of the length of the radius and no which is the node number of
the center of the graph.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 11 12 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 15 12 13 9 14 11 16 1 17 14 15];
g=make_graph(’foo’,0,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
[no,rad] = graph_center(g)
show_nodes(no);

S EE A LSO : graph_diameter 560

2.9.27 graph complement complement of a graph

CALLING SEQUENCE :

g1 = graph_complement(g,[gmax])

PARAMETERS :

g : graph list
gmax : graph list
g1 : graph list of the new graph

DESCRIPTION :
graph complement returns the undirected graph g1 which is the complement of the graph g with
respect to the corresponding complete graph. When gmax is given, the complement is made with respect to
gmax. g and gmax are supposed to be simple graphs (use graph simp before calling graph complement
if necessary) and to have the same number of nodes.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 11 12 13 13 13 14 15 17 17 16 16];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 15 12 13 9 10 14 11 16 14 15 1 17];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
g1=graph_complement(g);
show_graph(g1,’new’);
g=graph_complement(g1);
show_graph(g);

S EE A LSO : graph_sum 561, graph_simp 561

Scilab Group September 1996 559

graph simp Scilab function

2.9.28 graph diameter diameter of a graph

CALLING SEQUENCE :
[d,p] = graph_diameter(g)
PARAMETERS :
g : graph list
d : integer
p : integer row vector
DESCRIPTION :
graph diameter computes the diameter of the graph g i.e. the largest shortest path between two
nodes. The length of the arcs are supposed to be integer (and the default value is 1). The output is the value
d of the length of the diameter and p is the corresponding path.
EXAMPLE :
ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 11 12 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 15 12 13 9 14 11 16 1 17 14 15];
g=make_graph(’foo’,0,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
[d,p] = graph_diameter(g)
show_arcs(p);
S EE A LSO : graph_center 558

2.9.29 graph power kth power of a directed 1-graph

CALLING SEQUENCE :
g1 = graph_power(g,k)
PARAMETERS :
g : graph list of the graph
k : integer
g1 : graph list of the new graph
DESCRIPTION :
graph power computes the directed graph g1 which is the kth power of directed 1-graph g. There
is an arc between two nodes in g1 if there exists a path between these nodes of length at most k in g.
graph power(g,1) is graph g.
If such a graph does not exist, an empty vector is returned.
EXAMPLE :
ta=[1 1 2 4 4 5 6 7 2 3 5 1];
he=[2 6 3 6 7 8 8 8 4 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[285 284 335 160 405 189 118 45];
g(’node_y’)=[266 179 83 176 368 252 64 309];
show_graph(g);
g1=graph_power(g,2);
show_graph(g1,’new’);

Scilab Group September 1996 560

graph sum Scilab function

2.9.30 graph simp converts a graph to a simple undirected graph

CALLING SEQUENCE :

g1 = graph_simp(g)

PARAMETERS :

g : graph list of the old graph

g1 : graph list of the new graph

DESCRIPTION :
graph simp returns the simple undirected graph g1 corresponding to multigraph g. It deletes loops in
g, replaces directed edges with undirected edges and replaces multiple edges with single edges.
EXAMPLE :

ta=[1 1 1 2 2 2 3 4 4 4 5 5 6 7 7 8 8 9 9 10 10 10 10 10 11 12 12 13 13
13 14 15 16 16 17 17];
he=[1 2 10 3 5 7 4 2 9 9 4 6 6 8 2 6 9 7 4 7 11 13 13 15 12 11 13 9 10 14
11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 98 164 162 273 235 267 384 504 493 409 573 601
627 642];
g(’node_y’)=[ 59 133 223 311 227 299 221 288 384 141 209 299 398 383 187
121 301];
show_graph(g);
g1=graph_simp(g);
show_graph(g1,’new’);

2.9.31 graph sum sum of two graphs

CALLING SEQUENCE :

g2 = graph_sum(g,g1)

PARAMETERS :

g : graph list
g1 : graph list
g2 : graph list of the new graph

DESCRIPTION :
graph sum creates a graph g2 with an adjacency matrix equal to the sum of the adjacency matrices of
the two graphs g and g1. g and g1 are supposed to be simple graphs (use graph simp before calling
graph complement if necessary) and to have the same number of nodes.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];

Scilab Group September 1996 561

graph union Scilab function

g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’edge_width’)=ones(1,(edge_number(g)));
g(’node_diam’)=[1:(g(’node_number’))]+20;
g(’node_name’)=[’A’ ’B’ ’C’ ’D’ ’E’ ’F’ ’G’ ’H’ ’I’ ’J’ ’K’ ’L’ ’M’ ’N’ ’O’
’P’ ’Q’];
show_graph(g);
ta=[2 3 4 5 11 12 1];
he=[10 5 6 7 15 17 7];
g1=make_graph(’foo’,1,17,ta,he);
g1(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g1(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187
151 301];
g1(’edge_color’)=modulo([1:(edge_number(g1))],15)+1;
g1(’edge_width’)=10*ones(1,(edge_number(g1)));
g1(’node_diam’)=[1:(g1(’node_number’))]+20;
g1(’node_name’)=[’A’ ’B’ ’C’ ’D’ ’E’ ’F’ ’G’ ’H’ ’I’ ’J’ ’K’ ’L’ ’M’ ’N’
’O’ ’P’ ’Q’];
show_graph(g1,’new’);
g2=graph_sum(g,g1);
show_graph(g2,’new’);

S EE A LSO : graph_complement 559, graph_union 562

2.9.32 graph union union of two graphs

CALLING SEQUENCE :

g2 = graph_union(g,g1)

PARAMETERS :

g : graph list
g1 : graph list
g2 : graph list of the new graph

DESCRIPTION :
graph union creates a new graph g2. The node set of g2 is the union (in the usual sense) of the node
sets of g and g1. g2 has an edge for each edge of g and an edge for each edge of g1. The edges of g
and g1 having the same endpoints are kept and in this case g2 has multiple edges.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’node_diam’)=[1:(g(’node_number’))]+20;
g(’node_name’)=[’A’ ’B’ ’C’ ’D’ ’E’ ’F’ ’G’ ’H’ ’I’ ’J’ ’K’ ’L’ ’M’ ’N’ ’O’
’P’ ’Q’];

Scilab Group September 1996 562

is connex Scilab function

show_graph(g);
l=netwindows(); nw=l(2);
v=[7 8 9 10 11 12 13];
show_nodes(v);
g1=subgraph(v,’nodes’,g);
show_graph(g1,’new’);
v=[1 2 5 6 7 8 9 10];
netwindow(nw);
show_nodes(v);
g2=subgraph(v,’nodes’,g);
show_graph(g2,’new’);
g=graph_union(g1,g2);
show_graph(g,’new’);

S EE A LSO : supernode 592, subgraph 590

2.9.33 hamilton hamiltonian circuit of a graph

CALLING SEQUENCE :

cir = hamilton(g)

PARAMETERS :

g : graph list
cir : integer row vector

DESCRIPTION :
hamilton finds an hamiltonian circuit (if it exists) of the directed graph g.
EXAMPLE :

ta=[2 1 3 2 2 4 4 5 6 7 8 8 9 10 10 10 10 11 12 13 13 14 15 16 16 17 17];
he=[1 10 2 5 7 3 2 4 5 8 6 9 7 7 11 13 15 12 13 9 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
cir=hamilton(g)
show_arcs(cir);

2.9.34 is connex connectivity test

CALLING SEQUENCE :

res = is_connex(g)

PARAMETERS :

g : graph list
res : integer, result of the test

Scilab Group September 1995 563

line graph Scilab function

DESCRIPTION :
is connex returns 1 if the graph g is connected and 0 otherwise.
EXAMPLE :

g=make_graph(’foo’,1,3,[1,2,3,1],[2,3,1,3]);
is_connex(g)
g=make_graph(’foo’,1,4,[1,2,3,1],[2,3,1,3]);
is_connex(g)

S EE A LSO : con_nodes 548, strong_connex 590

2.9.35 knapsack solves a 0-1 multiple knapsack problem

CALLING SEQUENCE :

[earn,ind] = knapsack(profit,weight,capa,[bck])

PARAMETERS :

profit : integer row vector

weight : integer row vector
capa : integer row vector
bck : integer
earn : integer
ind : integer row vector

DESCRIPTION :
knapsack solve a 0-1 multiple knapsack problem with n (n >= 2) items and m knapsacks (m >= 1).
profit is the vector of the (integer) profits of the n items and weight is the vector of the corresponding
(integer) weights. capa is the vector of the (integer) capacities of the m knapsacks. bck is an optional
integer: the maximum number of backtrackings to be performed, if heuristic solution is required. If the
exact solution is required bck can be omitted or can have a negative value. earn is the value of the
criterium for the ”optimal” solution and ind is a vector giving the optimal location: ind(i) gives the
number of the knapsack where item i is inserted and this value is 0 if the item i is not in the optimal solution.
We recall that the problem to be solved is the following: p(i) and w denote respectively the profit
and the weight of the item i 1=1,...,n; c(j) denotes the capacity of the knapsack j j=1,...,m; q(j,i)
denotes the quantity of item i in knapsack j (in fact 0 or 1).
We want to maximize the global profit E: E=p(1)*[x(1,1)+...+x(m,1)]+...+p(n)*[x(1,n)+...+x(m,n)]
under the constraints: [w(1)*x(j,1)+...+w(n)*x(j,m)] <= c(j) ; j=1,...,m [x(1,i)+...+x(m,i)]
<= 1 ; i=1,...,n x(j,i)= 0 or 1 p(),w(),c() are positive integers.
EXAMPLE :

weight=ones(1,15).*.[1:4];
profit=ones(1,60);
capa=[15 45 30 60];
[earn,ind]=knapsack(profit,weight,capa)

S EE A LSO : qassign 584

2.9.36 line graph graph with nodes corresponding to edges

CALLING SEQUENCE :

Scilab Group September 1996 564

make graph Scilab function

g1 = line_graph(g)

PARAMETERS :

g : graph list of the old graph

g1 : graph list of the new graph

DESCRIPTION :
line graph returns the graph g1 with the nodes corresponding to the edges of the graph g. g1 is
defined in the following way: - its nodes correspond to the edges of g - 2 nodes of the new graph are
adjacent if and only if the corresponding edges of the graph g are adjacent.
The coordinates of the nodes of g1 are given by the middle points of the corresponding edges of g.
EXAMPLE :

ta=[1 1 2 4 4 5 6 7 2 3 5 1];
he=[2 6 3 6 7 8 8 8 4 7 3 5];
g=make_graph(’foo’,0,8,ta,he);
g(’node_x’)=[281 284 360 185 405 182 118 45];
g(’node_y’)=[262 179 130 154 368 248 64 309];
show_graph(g);
g1=line_graph(g);
show_graph(g1,’new’);

S EE A LSO : arc_graph 543

2.9.37 load graph loads a graph

CALLING SEQUENCE :

g = load_graph(name)

PARAMETERS :

name : string, the path of the graph to load

g : graph list

DESCRIPTION :
name is the name of a graph file which contains the ASCII description of a graph. Such a file must have
the "graph" extension. name can be the name or the pathname of the file; if the "graph" extension
is missing in name, it is assumed. load graph returns the corresponding graph list.
EXAMPLE :

g=load_graph(SCI+’/demos/metanet/mesh100.graph’);
show_graph(g);
g=load_graph(SCI+’/demos/metanet/colored’);
show_graph(g,’new’);

S EE A LSO : save_graph 585

Scilab Group September 1995 565

mat 2 graph Scilab function

2.9.38 make graph makes a graph list

CALLING SEQUENCE :

g = make_graph(name,directed,n,tail,head)

PARAMETERS :

name : string, the name of the graph

directed : integer, 0 (undirected graph) or 1 (directed graph)
n : integer, the number of nodes of the graph
tail : row vector of the numbers of the tail nodes of the graph (its size is the number of edges of the
graph)
head : row vector of the numbers of the head nodes of the graph (its size is the number of edges of the
graph)
g : graph list

DESCRIPTION :
make graph makes a graph list according to its arguments which are respectively the name of the graph,
a flag for directed or undirected, the number of nodes and the row vectors tail and head. These are the
minimal data needed for a graph.
If n is a positive number, graph g has n nodes; this number must be greater than or equal to max(max(tail),max(head)
If it is greater than this number,graph g has isolated nodes. The nodes names are taken as the nodes num-
bers.
If n is equal to 0, graph g has no isolated node and the number of nodes is computed from tail and
head. The nodes names are taken from the numbers in tail and head.
EXAMPLE :

// creating a directed graph with 3 nodes and 4 arcs.

g=make_graph(’foo’,1,3,[1,2,3,1],[2,3,1,3]);
// creating a directed graph with 13 nodes and 14 arcs.
ta=[1 1 2 7 8 9 10 10 10 10 11 12 13 13];
he=[2 10 7 8 9 7 7 11 13 13 12 13 9 10];
g=make_graph(’foo’,1,13,ta,he);
g(’node_x’)=[120 98 87 188 439 698 226 127 342 467 711 779 477];
g(’node_y’)=[ 21 184 308 426 435 428 129 360 435 55 109 320 321];
show_graph(g)
// creating same graph without isolated node and 14 arcs.
g=make_graph(’foo’,1,0,ta,he);
g(’node_x’)=[120 98 226 127 342 467 711 779 477];
g(’node_y’)=[ 21 184 129 360 435 55 109 320 321];
show_graph(g,’new’)

S EE A LSO : graph-list 555

2.9.39 mat 2 graph graph from node-arc or node-node incidence matrix

CALLING SEQUENCE :

g = mat_2_graph(a,directed,[mat])

PARAMETERS :

a : sparse node-arc or node-node incidence matrix

Scilab Group September 1995 566

max cap path Scilab function

directed : integer, 0 (undirected graph) or 1 (directed graph)

mat : optional string, ’node-arc’ or ’node-node’ matrix
g : graph list

DESCRIPTION :
mat 2 graph computes the graph g corresponding to the node-arc or the node-node incidence matrix
a. Note that a checking is made to insure that a is a sparse node-arc or node-node incidence matrix of
a directed (directed = 1) or undirected (directed = 0) graph. If the optional argument mat is
omitted or is the string ’node-arc’, a must be a node-arc matrix. If mat is the string ’node-node’,
a must be a node-node matrix.
EXAMPLE :

g=load_graph(SCI+’/demos/metanet/colored’);
show_graph(g);
a=graph_2_mat(g);
g1=mat_2_graph(a,1);
g1(’node_x’)=g(’node_x’); g1(’node_y’)=g(’node_y’);
show_graph(g1,’new’);
a=graph_2_mat(g,’node-node’);
g1=mat_2_graph(a,1,’node-node’);
g1(’node_x’)=g(’node_x’); g1(’node_y’)=g(’node_y’);
show_graph(g1,’new’);

S EE A LSO : adj_lists 542, chain_struct 546, graph_2_mat 558

2.9.40 max cap path maximum capacity path

CALLING SEQUENCE :

[p,cap] = max_cap_path(i,j,g)

PARAMETERS :

i,j : integers, node numbers

g : graph list
p : row vector of integer numbers of the arcs of the path if it exists
cap : value of the capacity of the path

DESCRIPTION :
max cap path returns the path with maximum capacity from node i to node j for the graph g if it
exists and returns the empty vector [] otherwise.
The capacities of the edges are given by the element edge max cap of the graph list. If its value is
not given (empty vector []), max cap path returns the empty vector []. The capacities must be strictly
positive, i.e negative capacities are considered as equal to 0 (no capacity at all).
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
ma=edge_number(g);

Scilab Group September 1995 567

max flow Scilab function

g(’edge_max_cap’)=int(rand(1,ma)*16)+5;
[p,cap]=max_cap_path(1,14,g);
edgecolor=1*ones(1,ma); edgecolor(p)=11*ones(p); g(’edge_color’)=edgecolor;
x_message([’The maximum capacity is: ’+string(cap);
’Showing the corresponding path’]);
show_graph(g); show_arcs(p);

2.9.41 max clique maximum clique of a graph

CALLING SEQUENCE :

[size,nodes] = max_clique(g,[ind])

PARAMETERS :

g : graph list
ind : integer (optional)
size : integer
nodes : integer row vector

DESCRIPTION :
max clique computes the maximum clique of the graph g i.e. the complete subgraph of maximum
size. ind is a parameter for the choice of the method: if ind is 0 the method is a partial enumerative
algorithm and if ind is 1 the algorithm is based on quadratic zero-one programming. The default is 0. The
output size is the number of the nodes of the clique found by the algorithm and nodes is the vector of
the corresponding nodes.
EXAMPLE :

ta=[1 2 3 4 5 6 6 7 8 9 10 16 16 10 11 11 12 12 11 14 15 15 13 7 13 13];
he=[2 3 4 5 6 7 8 8 9 10 16 2 3 11 12 13 1 14 14 15 5 9 12 4 14 15];
g=make_graph(’foo’,0,16,ta,he);
g(’node_x’)=[106 199 369 467 470 403 399 347 308 269 184 108 199 268 345
272];
g(’node_y’)=[341 420 422 321 180 212 286 246 193 244 243 209 59 134 51
348];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
[ns,no] = max_clique(g);
show_nodes(no);
g1=graph_complement(g);
[ns,no] = max_clique(g1);
show_nodes(no);

2.9.42 max flow maximum flow between two nodes

CALLING SEQUENCE :

[v,phi,flag] = max_flow(i,j,g)

PARAMETERS :

i : integer, number of start node

j : integer, number of end node

Scilab Group September 1995 568

mesh2d Scilab function

g : graph list
v : value of the maximum flow it is exists
phi : row vector of the value of the flow on the arcs
flag : feasible problem flag (0 or 1)

DESCRIPTION :
max flow returns the value of maximum flow v from node number i to node number j if it exists,
and the value of the flow on each arc as a row vector phi. All the computations are made with integer
numbers. The graph must be directed. If the problem is not feasible, flag is equal to 0, otherwise it is
equal to 1.
The bounds of the flow are given by the elements edge min cap and edge max cap of the graph
list. The value of the maximum capacity must be greater than or equal to the value of the minimum capacity.
If the value of edge min cap or edge max cap is not given (empty row vector []), it is assumed to
be equal to 0 on each edge.
EXAMPLE :

ta=[1 1 2 2 3 3 4 4 5 5 5 5 6 6 6 7 7 15 15 15 15 15 15];
ta=[ta, 15 8 9 10 11 12 13 14];
he=[10 13 9 14 8 11 9 11 8 10 12 13 8 9 12 8 11 1 2 3 4];
he=[he, 5 6 7 16 16 16 16 16 16 16];
n=16;
g=make_graph(’foo’,1,n,ta,he);
g(’node_x’)=[42 615 231 505 145 312 403 233 506 34 400 312 142 614 260 257];
g(’node_y’)=[143 145 154 154 147 152 157 270 273 279 269 273 273 274 50 376];
ma=edge_number(g);
g(’edge_max_cap’)=ones(1,ma);
g(’edge_min_cap’)=zeros(1,ma);
source=15; sink=16;
nodetype=0*ones(1,n); nodetype(source)=2; nodetype(sink)=1;
g(’node_type’)=nodetype;
nodecolor=0*ones(1,n); nodecolor(source)=11; nodecolor(sink)=11;
g(’node_color’)=nodecolor;
show_graph(g);
[v,phi,ierr]=max_flow(source,sink,g);
ii=find(phi<>0); edgecolor=phi; edgecolor(ii)=11*ones(ii);
g(’edge_color’)=edgecolor;
edgefontsize=8*ones(1,ma); edgefontsize(ii)=18*ones(ii);
g(’edge_font_size’)=edgefontsize;
g(’edge_label’)=string(phi);
show_graph(g);

2.9.43 mesh2d triangulation of n points in the plane

CALLING SEQUENCE :

[nutr,A] = mesh2d(x,y,[front])

PARAMETERS :

x : real row array

y : real row array
front : integer row array
nutr : integer matrix
A : sparse 0-1 matrix

Scilab Group September 1996 569

mesh2d Scilab function

DESCRIPTION :
The arrays x and y are the coordinates of n points in the plane. mesh2d returns a matrix nutr(3,nbt)
of the numbers of the nodes of the nbt triangles of the triangulation of the points. It returns also a sparse
matrix A representing the connections between the nodes (A(i,j)=1 if (i,j) is a side of one of the
triangles or i=j). In the case of 3 parameters front is the array defining the boundary: it is the array
of the indices of the points located on the boundary . The boundary is defined such that the normal to the
boundary is oriented towards outside. The boundary is given by its connected components: a component is
the part (i1,i2) such that front(i1)=front(i2) (the external boundary is defined in the coun-
terclockwise way, see the examples below). The error cases are the following: err = 0 if no errors were
encountered; err = 3 all nodes are collinear.
If the boundary is given, the other error cases are: err = 2 some points are identical; err = 5 wrong
boundary array; err = 6 crossed boundary; err = 7 wrong orientation of the boundary; err = 10 an interior
point is on the boundary; err = 8 size limitation; err = 9 crossed boundary; err = 12 some points are identical
or size limitation.
EXAMPLE :

// FIRST CASE
theta=0.025*[1:40]*2.*%pi;
x=1+cos(theta);
y=1.+sin(theta);
theta=0.05*[1:20]*2.*%pi;
x1=1.3+0.4*cos(theta);
y1=1.+0.4*sin(theta);
theta=0.1*[1:10]*2.*%pi;
x2=0.5+0.2*cos(theta);
y2=1.+0.2*sin(theta);
x=[x x1 x2];
y=[y y1 y2];
//
nu=mesh2d(x,y);
nbt=size(nu,2);
jj=[nu(1,:)’ nu(2,:)’;nu(2,:)’ nu(3,:)’;nu(3,:)’ nu(1,:)’];
as=sparse(jj,ones(size(jj,1),1));
ast=tril(as+abs(as’-as));
[jj,v,mn]=spget(ast);
n=size(x,2);
g=make_graph(’foo’,0,n,jj(:,1)’,jj(:,2)’);
g(’node_x’)=300*x;
g(’node_y’)=300*y;
g(’default_node_diam’)=10;
show_graph(g)
// SECOND CASE !!! NEEDS x,y FROM FIRST CASE
x3=2.*rand(1:200);
y3=2.*rand(1:200);
wai=((x3-1).*(x3-1)+(y3-1).*(y3-1));
ii=find(wai >= .94);
x3(ii)=[];y3(ii)=[];
wai=((x3-0.5).*(x3-0.5)+(y3-1).*(y3-1));
ii=find(wai <= 0.055);
x3(ii)=[];y3(ii)=[];
wai=((x3-1.3).*(x3-1.3)+(y3-1).*(y3-1));
ii=find(wai <= 0.21);
x3(ii)=[];y3(ii)=[];
xnew=[x x3];ynew=[y y3];
fr1=[[1:40] 1];fr2=[[41:60] 41];fr2=fr2($:-1:1);

Scilab Group September 1996 570

metanet Scilab function

fr3=[[61:70] 61];fr3=fr3($:-1:1);
front=[fr1 fr2 fr3];
//
nu=mesh2d(xnew,ynew,front);
nbt=size(nu,2);
jj=[nu(1,:)’ nu(2,:)’;nu(2,:)’ nu(3,:)’;nu(3,:)’ nu(1,:)’];
as=sparse(jj,ones(size(jj,1),1));
ast=tril(as+abs(as’-as));
[jj,v,mn]=spget(ast);
n=size(xnew,2);
g=make_graph(’foo’,0,n,jj(:,1)’,jj(:,2)’);
g(’node_x’)=300*xnew;
g(’node_y’)=300*ynew;
g(’default_node_diam’)=10;
show_graph(g)
// REGULAR CASE !!! NEEDS PREVIOUS CASES FOR x,y,front
xx=0.1*[1:20];
yy=xx.*.ones(1,20);
zz= ones(1,20).*.xx;
x3=yy;y3=zz;
wai=((x3-1).*(x3-1)+(y3-1).*(y3-1));
ii=find(wai >= .94);
x3(ii)=[];y3(ii)=[];
wai=((x3-0.5).*(x3-0.5)+(y3-1).*(y3-1));
ii=find(wai <= 0.055);
x3(ii)=[];y3(ii)=[];
wai=((x3-1.3).*(x3-1.3)+(y3-1).*(y3-1));
ii=find(wai <= 0.21);
x3(ii)=[];y3(ii)=[];
xnew=[x x3];ynew=[y y3];
nu=mesh2d(xnew,ynew,front);
nbt=size(nu,2);
jj=[nu(1,:)’ nu(2,:)’;nu(2,:)’ nu(3,:)’;nu(3,:)’ nu(1,:)’];
as=sparse(jj,ones(size(jj,1),1));
ast=tril(as+abs(as’-as));
[jj,v,mn]=spget(ast);
n=size(xnew,2);
g=make_graph(’foo’,0,n,jj(:,1)’,jj(:,2)’);
g(’node_x’)=300*xnew;
g(’node_y’)=300*ynew;
g(’default_node_diam’)=3;
show_graph(g)

2.9.44 metanet opens a Metanet window

CALLING SEQUENCE :

window = metanet([path,winsize])

PARAMETERS :

path : string, directory where graph files are searched

winsize : row vector defining the size of Metanet window
window : integer, window number

Scilab Group September 1995 571

min lcost cflow Scilab function

DESCRIPTION :
This function is used to open a Metanet window from Scilab.
path is an optional argument; it is the directory where graph files are searched. If this path is the
pathname of a graph, this graph is displayed in the Metanet window and the directory of this pathname
becomes the default directory. By default, path is the working directory.
winsize is an optional argument; it is a row vector [width height] giving the size in pixels of
Metanet window. The default is [1000 1000].
Usually, show graph is used and metanet is seldom used.
Each time metanet is executed, a new window is created and its number is incremented by 1.
S EE A LSO : netclose 578, netwindow 578, netwindows 579, show_graph 587

2.9.45 metanet sync asynchronous or synchronous mode in Metanet

CALLING SEQUENCE :

res = metanet_sync([flag])

PARAMETERS :

res : integer
flag : integer

DESCRIPTION :
By default Metanet windows work with Scilab in asynchronous mode, ie Scilab proceeds without wait-
ing for graphics commands sent to Metanet window to terminate: these commands are show graph,
show arcs and show nodes. This mode is the most efficient. But when running a lots of such graphi-
cal commands, problems can arise.
metanet sync(0) changes to asynchronous mode (default).
metanet sync(1) changes to synchronous mode.
metanet sync() returns the current mode (0 = asynchronous, 1 = synchronous).

2.9.46 min lcost cflow minimum linear cost constrained flow

CALLING SEQUENCE :

[c,phi,v,flag] = min_lcost_cflow(i,j,cv,g)

PARAMETERS :

i : integer, source node number

j : integer, sink node number
cv : scalar, value of constrained flow
g : graph list
c : value of cost
phi : row vector of the values of flow on the arcs
v : value of flow from source to sink
flag : feasible constrained flow flag (0 or 1)

DESCRIPTION :
min lcost cflow computes the minimum cost flow in the network g, with the value of the flow from
source node i to sink node j constrained to be equal to cv.
min lcost cflow returns the total cost of the flows on the arcs c, the row vector of the flows on
the arcs phi and the value of the flow v on the virtual arc from sink to source. If v is less than cv, a
message is issued, but the computation is done: in this case flag is equal to 0, otherwise it is equal to 1.

Scilab Group September 1995 572

min lcost flow1 Scilab function

The bounds of the flows are given by the elements edge min cap and edge max cap of the graph
list. The value of the minimum capacity must be equal to zero, and the value of the maximum capacity must
be non negative and must be integer numbers. If the value of edge min cap or edge max cap is not
given (empty row vector []), it is assumed to be equal to 0 on each edge.
The costs on the edges are given by the element edge cost of the graph list. The costs must be non
negative. If the value of edge cost is not given (empty row vector []), it is assumed to be equal to 0 on
each edge.
The demands, element node demand of the graph list, must be equal to zero.
This function uses the algorithm of Busacker and Goven.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15 14 9 11 10];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14 4 6 9 1];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[194 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[56 181 276 278 276 103 174 281 177 86 175 90 290 397 399];
show_graph(g);
g1=g; ma=arc_number(g1); n=g1(’node_number’);
g1(’edge_min_cap’)=0*ones(1,ma);
rand(’uniform’);
g1(’edge_max_cap’)=round(20*rand(1,ma))+ones(1,ma);
g1(’edge_cost’)=10*rand(1,ma)+ones(1,ma);
source=15; sink=1; cv=5;
[c,phi,v]=min_lcost_cflow(source,sink,cv,g1);
x_message([’The cost is: ’+string(c);
’Showing the flow on the arcs’]);
nodetype=0*ones(1,n); nodetype(source)=2; nodetype(sink)=1;
g1(’node_type’)=nodetype;
ii=find(phi<>0); edgecolor=phi; edgecolor(ii)=11*ones(ii);
g1(’edge_color’)=edgecolor;
edgefontsize=8*ones(1,ma); edgefontsize(ii)=18*ones(ii);
nodecolor=0*ones(1,n); nodecolor(source)=11; nodecolor(sink)=11;
g1(’node_color’)=nodecolor;
g1(’edge_font_size’)=edgefontsize;
g1(’edge_label’)=string(phi);
show_graph(g1);

S EE A LSO : min_lcost_flow1 573, min_lcost_flow2 574, min_qcost_flow 576

2.9.47 min lcost flow1 minimum linear cost flow

CALLING SEQUENCE :

[c,phi,flag] = min_lcost_flow1(g)

PARAMETERS :

g : graph list
c : value of cost
phi : row vector of the value of flow on the arcs
flag : feasible problem flag (0 or 1)

DESCRIPTION :

Scilab Group September 1995 573

min lcost flow2 Scilab function

min lcost flow1 computes the minimum linear cost flow in the network g. It returns the total cost
of the flows on the arcs c and the row vector of the flows on the arcs phi. If the problem is not feasible
(impossible to find a compatible flow for instance), flag is equal to 0, otherwise it is equal to 1.
The bounds of the flow are given by the elements edge min cap and edge max cap of the graph
list. The value of the minimum capacity and of the maximum capacity must be non negative and must be
integer numbers. The value of the maximum capacity must be greater than or equal to the value of the
minimum capacity. If the value of edge min cap or edge max cap is not given (empty row vector
[]), it is assumed to be equal to 0 on each edge.
The costs on the edges are given by the element edge cost of the graph list. The costs must be non
negative. If the value of edge cost is not given (empty row vector []), it is assumed to be equal to 0 on
each edge.
The demands, element node demand of the graph list, must be equal to zero.
This function uses the out-of-kilter algorithm.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15 14 9 11 10
1 8];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14 4 6 9 1 12
14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[194 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[56 221 316 318 316 143 214 321 217 126 215 80 330 437 439];
show_graph(g);
g1=g;ma=arc_number(g1);
rand(’uniform’);
while %T then
g1(’edge_min_cap’)=round(20*rand(1,ma));
g1(’edge_max_cap’)=round(20*rand(1,ma))+g1(’edge_min_cap’)+33*ones(1,ma);
g1(’edge_cost’)=round(10*rand(1,ma))+ones(1,ma);
[c,phi,flag]=min_lcost_flow1(g1);
if flag==1 then break; end;
end;
x_message([’The cost is: ’+string(c);
’Showing the flow on the arcs ’]);
ii=find(phi<>0); edgecolor=phi; edgecolor(ii)=11*ones(ii);
g1(’edge_color’)=edgecolor;
edgefontsize=8*ones(1,ma); edgefontsize(ii)=18*ones(ii);
g1(’edge_font_size’)=edgefontsize;
g1(’edge_label’)=string(phi);
show_graph(g1);

S EE A LSO : min_lcost_cflow 572, min_lcost_flow2 574, min_qcost_flow 576

2.9.48 min lcost flow2 minimum linear cost flow

CALLING SEQUENCE :

[c,phi,flag] = min_lcost_flow2(g)

PARAMETERS :

g : graph list
c : value of cost
phi : row vector of the value of flow on the arcs

Scilab Group September 1995 574

min qcost flow Scilab function

flag : feasible problem flag (0 or 1)

DESCRIPTION :
min lcost flow2 computes the minimum linear cost flow in the network g. It returns the total cost
of the flows on the arcs c and the row vector of the flows on the arcs phi. If the problem is not feasible
(impossible to find a compatible flow for instance), flag is equal to 0, otherwise it is equal to 1.
The bounds of the flow are given by the elements edge min cap and edge max cap of the graph
list. The value of the minimum capacity must be equal to zero. The values of the maximum capacity must
be non negative and must be integer numbers. If the value of edge min cap or edge max cap is not
given (empty row vector []), it is assumed to be equal to 0 on each edge.
The costs on the edges are given by the element edge cost of the graph list. The costs must be non
negative and must be integer numbers. If the value of edge cost is not given (empty row vector []), it
is assumed to be equal to 0 on each edge.
The demand on the nodes are given by the element node demand of the graph list. The demands
must be integer numbers. Note that the sum of the demands must be equal to zero for the problem to be
feasible. If the value of node demand is not given (empty row vector []), it is assumed to be equal to 0
on each node.
This functions uses a relaxation algorithm due to D. Bertsekas.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15 14 9 11 10
1 8];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14 4 6 9 1 12
14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[194 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[56 221 316 318 316 143 214 321 217 126 215 80 330 437 439];
show_graph(g);
g1=g; ma=arc_number(g1); n=g1(’node_number’);
g1(’edge_min_cap’)=0.*ones(1,ma);
x_message([’Random generation of data’;
’The first(s) generated problem(s) may be unfeasible’]);
while %T then
rand(’uniform’);
g1(’edge_max_cap’)=round(20*rand(1,ma))+20*ones(1,ma);
g1(’edge_cost’)=round(10*rand(1,ma)+ones(1,ma));
rand(’normal’);
dd=20.*rand(1,n)-10*ones(1,n);
dd=round(dd-sum(dd)/n*ones(1,n));
dd(n)=dd(n)-sum(dd);
g1(’node_demand’)=dd;
[c,phi,flag]=min_lcost_flow2(g1);
if flag==1 then break; end;
end;
x_message([’The cost is: ’+string(c);
’Showing the flow on the arcs and the demand on the nodes’]);
ii=find(phi<>0); edgecolor=phi; edgecolor(ii)=11*ones(ii);
g1(’edge_color’)=edgecolor;
edgefontsize=8*ones(1,ma); edgefontsize(ii)=18*ones(ii);
g1(’edge_font_size’)=edgefontsize;
g1(’edge_label’)=string(phi);
g1(’node_label’)=string(g1(’node_demand’));
show_graph(g1);

S EE A LSO : min_lcost_cflow 572, min_lcost_flow1 573, min_qcost_flow 576

Scilab Group September 1995 575

min weight tree Scilab function

2.9.49 min qcost flow minimum quadratic cost flow

CALLING SEQUENCE :

[c,phi,flag] = min_qcost_flow(eps,g)

PARAMETERS :

eps : scalar, precision

g : graph list
c : value of cost
phi : row vector of the value of flow on the arcs
flag : feasible problem flag (0 or 1)

DESCRIPTION :
min qcost flow computes the minimum quadratic cost flow in the network g. It returns the total cost
of the flows on the arcs c and the row vector of the flows on the arcs phi. eps is the precision of the
iterative algorithm. If the problem is not feasible (impossible to find a compatible flow for instance), flag
is equal to 0, otherwise it is equal to 1.
The bounds of the flow are given by the elements edge min cap and edge max cap of the graph
list. The value of the maximum capacity must be greater than or equal to the value of the minimum capacity.
If the value of edge min cap or edge max cap is not given (empty row vector []), it is assumed to
be equal to 0 on each edge.
The costs on the edges are given by the elements edge q orig and edge q weight of the graph
list. The cost on arc u is given by:
(1/2)*edge q weight[u](phi[u]-edge q orig[u])ˆ2 The costs must be non negative.
If the value of edge q orig or edge q weight is not given (empty row vector []), it is assumed to
be equal to 0 on each edge.
This function uses an algorithm due to M. Minoux.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15 14 9 11 10
1 8];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14 4 6 9 1 12
14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[194 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[56 221 316 318 316 143 214 321 217 126 215 80 330 437 439];
show_graph(g);
g1=g; ma=arc_number(g1);
rand(’uniform’);
while %T then
g1(’edge_min_cap’)=round(5*rand(1,ma));
g1(’edge_max_cap’)=round(20*rand(1,ma))+30*ones(1,ma);
g1(’edge_q_orig’)=0*ones(1,ma);
g1(’edge_q_weight’)=ones(1,ma);
[c,phi,flag]=min_qcost_flow(0.001,g1);
if flag==1 then break; end;
end;
x_message([’The cost is: ’+string(c);
’Showing the flow on the arcs’]);
ii=find(phi<>0); edgecolor=phi; edgecolor(ii)=11*ones(ii);
g1(’edge_color’)=edgecolor;
edgefontsize=8*ones(1,ma); edgefontsize(ii)=18*ones(ii);
g1(’edge_font_size’)=edgefontsize;

Scilab Group September 1995 576

neighbors Scilab function

g1(’edge_label’)=string(phi);
show_graph(g1);

S EE A LSO : min_lcost_cflow 572, min_lcost_flow1 573, min_lcost_flow2 574

2.9.50 min weight tree minimum weight spanning tree

CALLING SEQUENCE :

t = min_weight_tree([i],g)

PARAMETERS :

i : integer, node number of the root of the tree

g : graph list
t : row vector of integer numbers of the arcs of the tree if it exists

DESCRIPTION :
min weight tree tries to find a minimum weight spanning tree for the graph g. The optional argument
i is the number of the root node of the tree; its default value is node number 1. This node is meaningless
for an undirected graph.
The weights are given by the element edge weight of the graph list. If its value is not given (empty
vector []), it is assumed to be equal to 0 on each edge. Weigths can be positive, equal to 0 or negative.
To compute a spanning tree without dealing with weights, give to weights a value of 0 on each edge or the
empty vector [].
min weight tree returns the tree t as a row vector of the arc numbers (directed graph) or edge
numbers (undirected graph) if it exists or the empty vector [] otherwise. If the tree exists, the dimension
of t is the number of nodes less 1. If t(i) is the root of the tree: - for j < i, t(j) is the number of the
arc in the tree after node t(j) - for j > i, t(j) is the number of the arc in the tree before node t(j)
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
t=min_weight_tree(1,g);
g1=g; ma=arc_number(g1); n=g1(’node_number’);
nodetype=0*ones(1,n); nodetype(1)=2; g1(’node_type’)=nodetype;
edgecolor=1*ones(1,ma); edgecolor(t)=11*ones(t); g1(’edge_color’)=edgecolor;
edgewidth=1*ones(1,ma); edgewidth(t)=4*ones(t); g1(’edge_width’)=edgewidth;
x_message(’Minimum weight tree from node 1’);
show_graph(g1);

2.9.51 neighbors nodes connected to a node

CALLING SEQUENCE :

a = neighbors(i,g)

Scilab Group September 1996 577

netwindows Scilab function

PARAMETERS :

i : integer
g : graph list
a : vector of integers

DESCRIPTION :
neighbors returns the numbers of the nodes connected with node i for graph g (directed or not).
EXAMPLE :

ta=[1 6 2 4 7 5 6 8 4 3 5 1];
he=[2 1 3 6 4 8 8 7 2 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[285 284 335 160 405 189 118 45];
g(’node_y’)=[266 179 83 176 368 252 64 309];
show_graph(g);
a=neighbors(6,g)
show_nodes(a);

S EE A LSO : predecessors 584, successors 591

”Scilab function”

2.9.52 netclose closes a Metanet window

CALLING SEQUENCE :

netclose(window)

PARAMETERS :

window : integer, window number

DESCRIPTION :
Each Metanet window has a window number returned by the metanet and show graph functions.
This function is used to close the Metanet window with number window.
S EE A LSO : metanet 571, netwindow 578, netwindows 579, show_graph 587

2.9.53 netwindow chooses a Metanet window

CALLING SEQUENCE :

netwindow(window)

PARAMETERS :

window : integer, window number

DESCRIPTION :
This function is used to change the Metanet window. Each Metanet window has a window number returned
by the metanet and show graph functions. To use the Metanet window associated to window num-
ber window, use netwindow(window). The numbers of existing windows are given by the function
netwindows.
S EE A LSO : metanet 571, netclose 578, netwindows 579, show_graph 587

Scilab Group September 1995 578

nodes 2 path Scilab function

2.9.54 netwindows gets the numbers of Metanet windows

CALLING SEQUENCE :

l = netwindows()

PARAMETERS :

l : list

DESCRIPTION :
This function returns a list l. Its first element is the row vector of all the Metanet windows and the second
element is the number of the current Metanet window. This number is equal to 0 if no current Metanet
window exists.
S EE A LSO : metanet 571, netclose 578, netwindow 578, show_graph 587

2.9.55 node number number of nodes of a graph

CALLING SEQUENCE :

n = node_number(g)

PARAMETERS :

g : graph list
n : integer, number of nodes

DESCRIPTION :
node number returns the number n of nodes of the graph.
S EE A LSO : arc_number 543, edge_number 553

2.9.56 nodes 2 path path from a set of nodes

CALLING SEQUENCE :

p = nodes_2_path(ns,g)

PARAMETERS :

ns : row vector of integer numbers of the set of nodes

g : graph list
p : row vector of integer numbers of the arcs of the path if it exists

DESCRIPTION :
nodes 2 path returns the path p corresponding to the node sequence ns given by its node numbers
if it exists ; it returns the empty vector [] otherwise.
EXAMPLE :

Scilab Group September 1995 579

path 2 nodes Scilab function

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
ns=[1 10 15 16 17 14 11 12 13 9 7 8 6];
g1=g; nodecolor=1*ones(g(’node_x’)); nodecolor(ns)=11*ones(ns);
g1(’node_color’)=nodecolor;
show_graph(g1); show_nodes(ns);
p=nodes_2_path(ns,g);
g1=g; edgecolor=1*ones(ta); edgecolor(p)=11*ones(p);
g1(’edge_color’)=edgecolor;
show_graph(g1); show_arcs(p);
show_nodes(ns,’sup’);

S EE A LSO : path_2_nodes 580

2.9.57 nodes degrees degrees of the nodes of a graph

CALLING SEQUENCE :

[outdegree,indegree] = graph_degree(g)

PARAMETERS :

g : graph list
outdegree : row vector of the out degrees of the nodes
indegree : row vector of the in degrees of the nodes

DESCRIPTION :
nodes degrees returns the 2 row vectors of the out and in degrees of the nodes of the graph g.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
[outdegree,indegree]=nodes_degrees(g)

S EE A LSO : adj_lists 542

2.9.58 path 2 nodes set of nodes from a path

CALLING SEQUENCE :

ns = path_2_nodes(p,g)

Scilab Group September 1995 580

perfect match Scilab function

PARAMETERS :

p : row vector of integer numbers of the arcs of the path

g : graph list
ns : row vector of integer numbers of the set of nodes

DESCRIPTION :
path 2 nodes returns the set of nodes ns corresponding to the path p given by its arc numbers ; if p
is not a path, the empty vector [] is returned.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
p=[2 16 23 25 26 22 17 18 19 13 10 11];
g1=g; edgecolor=1*ones(ta); edgecolor(p)=11*ones(p);
g1(’edge_color’)=edgecolor;
show_graph(g1); show_arcs(p);
ns=path_2_nodes(p,g);
g1=g; nodecolor=1*ones(g1(’node_number’)); nodecolor(ns)=11*ones(ns);
g1(’node_color’)=nodecolor;
show_graph(g1);show_nodes(ns);
show_arcs(p,’sup’);

S EE A LSO : nodes_2_path 579

2.9.59 perfect match min-cost perfect matching

CALLING SEQUENCE :

[cst,nmatch] = perfect_match(g,arcost)

PARAMETERS :

g : graph list
arcost : integer row vector
cst : integer
nmatch : integer row vector

DESCRIPTION :
perfect match finds a perfect min-cost matching for the graph g. g must be an undirected graph
with an even number of nodes. arcost is the vector of the (integer) costs of the arcs (the dimension of
arcost is twice the number of edges of the graph). The output is the vector nmatch of the perfect
matching and the corresponding cost cst.
EXAMPLE :

ta=[27 27 3 12 11 12 27 26 26 25 25 24 23 23 21 22 21 20 19 18 18];
ta=[ta 16 15 15 14 12 9 10 6 9 17 8 17 10 20 11 23 23 12 18 28];
he=[ 1 2 2 4 5 11 13 1 25 22 24 22 22 19 13 13 14 16 16 9 16];
he=[he 10 10 11 12 2 6 5 5 7 8 7 9 6 11 4 18 13 3 28 17];

Scilab Group September 1996 581

plot graph Scilab function

n=28;
g=make_graph(’foo’,0,n,ta,he);
xx=[46 120 207 286 366 453 543 544 473 387 300 206 136 250 346 408];
g(’node_x’)=[xx 527 443 306 326 196 139 264 55 58 46 118 513];
yy=[36 34 37 40 38 40 35 102 102 98 93 96 167 172 101 179];
g(’node_y’)=[yy 198 252 183 148 172 256 259 258 167 109 104 253];
show_graph(g);m2=2*size(ta,2);
arcost=round(100.*rand(1,m2));
[cst,nmatch] = perfect_match(g,arcost);
sp=sparse([ta’ he’],[1:size(ta,2)]’,[n,n]);
sp1=sparse([[1:n]’ nmatch’],ones(1,size(nmatch,2))’,[n,n]);
[ij,v,mn]=spget(sp.*sp1);
show_arcs(v’);

S EE A LSO : best_match 545

2.9.60 pipe network solves the pipe network problem

CALLING SEQUENCE :

[x,pi] = pipe_network(g)

PARAMETERS :

g : graph list
x : row vector of the value of the flow on the arcs
pi : row vector of the value of the potential on the nodes

DESCRIPTION :
pipe network returns the value of the flows and of the potentials for the pipe network problem: flow
problem with two Kirchhoff laws. The graph must be directed. The problem must be feasible (the sum of
the node demands must be equal to 0). The resistances on the arcs must be strictly positive and are given as
the values of the element ’edge weigth’ of the graph list.
The problem is solved by using sparse matrices LU factorization.
EXAMPLE :

ta=[1 1 2 2 3 3 4 4 5 5 5 5 6 6 6 7 7 15 15 15 15 15 15];
ta=[ta, 15 8 9 10 11 12 13 14];
he=[10 13 9 14 8 11 9 11 8 10 12 13 8 9 12 8 11 1 2 3 4];
he=[he, 5 6 7 16 16 16 16 16 16 16];
n=16;
g=make_graph(’foo’,1,n,ta,he);
g(’node_x’)=[42 615 231 505 145 312 403 233 506 34 400 312 142 614 260 257];
g(’node_y’)=[143 145 154 154 147 152 157 270 273 279 269 273 273 274 50 376];
show_graph(g);
g(’node_demand’)=[0 0 0 0 0 0 0 0 0 0 0 0 0 0 -100 100];
w = [1 3 2 6 4 7 8 1 2 2 2 4 7 8 9 2 3 5 7 3 2 5 8 2 5 8];
g(’edge_weight’)=[w, 6 4 3 5 6];
[x,pi] = pipe_network(g)

2.9.61 plot graph general plot of a graph

CALLING SEQUENCE :

Scilab Group September 1996 582

predecessors Scilab function

plot_graph(g,[rep,rep1])

PARAMETERS :

g : graph list
rep : row vector of 13 values for the parameters of the plot
rep1 : row vector of 4 values defining the plotting rectangle

DESCRIPTION :
plot graph plots graph g in a Scilab graphical window. The optional arguments rep and rep1
define the parameters of the plot. If there are not given, a dialog box for the definition of these parameters
is opened.
rep must be a row vector with 13 integer numbers which must be 1 or 2. The meaning of the values
of rep are:
Frame definition: 1 = Automatic 2 = Given (see below)
Plotting arrows: 1 = yes, 2 = no
Plotting sink and source nodes: 1 = yes, 2 = no
Plotting node names: 1 = yes, 2 = no
Plotting node labels: 1 = yes, 2 = no
Plotting arc names : 1 = yes, 2 = no
Plotting arc labels: 1 = yes, 2 = no
Plotting node demand: 1 = yes, 2 = no
Plotting edge length: 1 = yes, 2 = no
Plotting edge cost: 1 = yes, 2 = no
Plotting edge min cap: 1 = yes, 2 = no
Plotting edge max cap: 1 = yes, 2 = no
Plotting edge weight: 1 = yes, 2 = no
If rep(1) is 2, the frame definition must be given by rep1. Otherwise, rep1can be omitted. rep1
must be a row vector [orx,ory,w,h] giving respectively the coordinates of the upper-left point, the
width and the height of the plotting rectangle.
EXAMPLE :

// simple graph with different choices for the plot

ta=[2 2 1 1 2 4 3 3 4];
he=[2 2 3 2 3 2 1 2 1];
g=make_graph(’foo’,1,4,ta,he);
g(’node_type’)=[1 1 1 2];g(’node_name’)=string([1:4]);
g(’node_x’)=[73 737 381 391]; g(’node_y’)=[283 337 458 142];
g(’node_color’)=[3 3 3 11];
g(’node_diam’)=[30 30 30 60];
g(’edge_color’)=[10 0 2 6 11 11 0 0 11];
rep=[2 2 1 1 2 2 2 2 2 2 2 2 2];
rep1=[100 -400 650 300];
xbasc(); plot_graph(g,rep,rep1);
rep=[2 1 1 1 2 2 2 2 2 2 2 2 2];
x_message(’plot the graph with different parameters’);
xbasc(); plot_graph(g,rep,rep1);
// plotting using dialogs
xbasc(); plot_graph(g);
xset("thickness",4);
xbasc();
plot_graph(g);
xset(’default’);

S EE A LSO : show_graph 587

Scilab Group September 1996 583

salesman Scilab function

2.9.62 predecessors tail nodes of incoming arcs of a node

CALLING SEQUENCE :

a = predecessors(i,g)

PARAMETERS :

i : integer
g : graph list
a : row vector of integers

DESCRIPTION :
predecessors returns the row vector of the numbers of the tail nodes of the incoming arcs to node i
for a directed graph g .
EXAMPLE :

ta=[1 6 2 4 7 5 6 8 4 3 5 1];
he=[2 1 3 6 4 8 8 7 2 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[285 284 335 160 405 189 118 45];
g(’node_y’)=[266 179 83 176 368 252 64 309];
show_graph(g);
a=predecessors(8,g)
show_nodes(a);

S EE A LSO : neighbors 577, successors 591

2.9.63 qassign solves a quadratic assignment problem

CALLING SEQUENCE :

[crit,order] = qassign(c,f,d)

PARAMETERS :

c : real matrix
f : real matrix
d : real matrix
crit : real scalar
order : integer row vector

DESCRIPTION :
qassign solves the quadratic assignment problem i.e. minimize the global criterium: crit = e(1)+...+e(n)
where e(i) = c(i,l(i))+ fd(i) where fd(i) = f(i,1)*d(l(i),l(1))+...+f(i,n)*d(l(i),l(n))
c, f and d are n x n real arrays; their diagonal entries are zero.
EXAMPLE :

n=15;
d=100*rand(15,15);
d=d-diag(diag(d));
c=zeros(n,n);f=c;
f(2:n,1)=ones(1:n-1)’;
[crit,order]=qassign(c,f,d)

S EE A LSO : knapsack 564

Scilab Group September 1996 584

save graph Scilab function

2.9.64 salesman solves the travelling salesman problem

CALLING SEQUENCE :

cir = salesman(g,[nstac])

PARAMETERS :

g : graph list
nstac : integer
cir : integer row vector

DESCRIPTION :
salesman solves the travelling salesman problem. g is a directed graph; nstac is an optional integer
which is a given bound for the allowed memory size for solving this problem. Its value is 100*n*n by
default where n is the number of nodes.
EXAMPLE :

ta=[2 1 3 2 2 4 4 5 6 7 8 8 9 10 10 10 10 11 12 13 13 14 15 16 16 17 17];
he=[1 10 2 5 7 3 2 4 5 8 6 9 7 7 11 13 15 12 13 9 14 11 16 1 17 14 15];
g=make_graph(’foo’,0,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
g1=make_graph(’foo1’,1,17,[ta he],[he ta]);
m=arc_number(g1);
g1(’edge_length’)=5+round(30*rand(1,m));
cir = salesman(g1);
ii=find(cir > edge_number(g));
if(ii <> []) then cir(ii)=cir(ii)-edge_number(g);end;
show_arcs(cir);

2.9.65 save graph saves a graph

CALLING SEQUENCE :

save_graph(g,path)

PARAMETERS :

g : graph list
name : string, the path of the graph to save

DESCRIPTION :
save graph saves the graph g in a graph file. path is the name of the graph file where the graph
will be saved. path can be the name or the pathname of the file; if the "graph" extension is missing in
path, it is assumed. If path is the name of a directory, the name of the graph is used as the name of the
file.
EXAMPLE :

Scilab Group September 1995 585

show arcs Scilab function

g=load_graph(SCI+’/demos/metanet/mesh100’);
show_graph(g);
unix(’rm mymesh100.graph’)
save_graph(g,’mymesh100.graph’);
g=load_graph(’mymesh100’);
show_graph(g,’new’);

S EE A LSO : load_graph 565

2.9.66 shortest path shortest path

CALLING SEQUENCE :

[p,lp] = shortest_path(i,j,g,[typ])
PARAMETERS :

i : integer, number of start node

j : integer, number of end node
g : graph list
typ : string, type of shortest path
p : row vector of integer numbers of the arcs of the shortest path if it exists
lp : length of shortest path
DESCRIPTION :
shortest path returns the shortest path p from node i to node j if it exists, and the empty vector
[] otherwise. The optional argument typ is a string which defines the type of shortest path, ’arc’ for the
shortest path with respect to the number of arcs and ’length’ for the shortest path with respect to the length
of the edges edge length.
For the shortest path with respect to the length of the edges, the lengths are given by the element
edge length of the graph list. If its value is not given (empty vector []), it is assumed to be equal to 0
on each edge. Lengths can be positive, equal to 0 or negative.
When a shortest path exists, lp is the length of this path.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15 14 9 11 10];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14 4 6 9 1];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[194 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[56 181 276 278 276 103 174 281 177 86 175 90 290 397 399];
show_graph(g);
g1=g;ma=prod(size(g1(’head’)));
rand(’uniform’);
g1(’edge_length’)=int(20*rand(1,ma));
[p,lp]=shortest_path(13,1,g1,’length’);
p
x_message([’Showing the arcs of the shortest path ’;
’Choose ""Display arc names"" in the Graph menu to see arc names’]);
g1(’edge_name’)=string(g1(’edge_length’));
edgecolor=ones(1:ma);edgecolor(p)=11*ones(p);
g1(’edge_color’)=edgecolor;
edgefontsize=12*ones(1,ma);edgefontsize(p)=18*ones(p);
g1(’edge_font_size’)=edgefontsize;
show_graph(g1);

S EE A LSO : find_path 553, nodes_2_path 579

Scilab Group September 1995 586

show graph Scilab function

2.9.67 show arcs highlights a set of arcs

CALLING SEQUENCE :

show_arcs(p,[sup])

PARAMETERS :

p : row vector of arc numbers (directed graph) or edge numbers (undirected graph)
sup : string, superposition flag

DESCRIPTION :
show arcs highlights the set of arcs or edges p of the displayed graph in the current Metanet window.
If the optional argument sup is equal to the string ’sup’, the highlighting is superposed on the previous
one.
By default, this function works in asynchronous mode (see metanet sync).
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
t=min_weight_tree(1,g); g1=g; ma=edge_number(g1);
edgecolor=1*ones(1,ma); g1(’edge_color’)=edgecolor;
edgewidth=1*ones(1,ma); edgewidth(t)=4*ones(t); g1(’edge_width’)=edgewidth;
for i=8:12,
edgecolor(t)=i*ones(t); g1(’edge_color’)=edgecolor;
unix(’sleep 2’); show_graph(g1);
show_arcs(t);
end;

S EE A LSO : metanet_sync 572, show_nodes 588

2.9.68 show graph displays a graph

CALLING SEQUENCE :

nw = show_graph(g,[smode,scale])
nw = show_graph(g,’new’,[scale,winsize])

PARAMETERS :

g : graph list
smode : string, mode value
winsize : row vector defining the size of Metanet window
scale : real value, scale factor
nw : integer

Scilab Group September 1995 587

split edge Scilab function

DESCRIPTION :
show graph displays the graph g in the current Metanet window. If there is no current Metanet window,
a Metanet window is created. The return value nw is the number of the Metanet window where the graph
is displayed.
If the optional argument smode is equal to the string ’rep’ or is not given and if there is already a graph
displayed in the current Metanet window, the new graph is displayed instead.
If the optional argument smode is equal to the string ’new’, a new Metanet window is created. In this
case, if the optional argument winsize is given as a row vector [width height], it is the size in
pixels of Metanet window. The default is [1000 1000].
The optional argument scale is the value of the scale factor when drawing the graph. The default
value is 1.
The labels of the nodes and edges, if they exist, are displayed.
By default, this function works in asynchronous mode (see metanet sync).
EXAMPLE :
ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g,2);
show_graph(g,0.5);
show_graph(g,1);
S EE A LSO : metanet_sync 572

2.9.69 show nodes highlights a set of nodes

CALLING SEQUENCE :
show_nodes(nodes,[sup])
PARAMETERS :
nodes : row vector of node numbers
sup : string, superposition flag
DESCRIPTION :
show nodes highlights the set of nodes nodes of the displayed graph in the current Metanet window.
If the optional argument sup is equal to the string ’sup’, the highlighting is superposed on the previous
one.
By default, this function works in asynchronous mode (see metanet sync).
EXAMPLE :
ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 11 12 13 13 13 14 15 16 16 17 17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 15 12 13 9 10 14 11 16 1 17 14 15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
for i=2:3:g(’node_number’), show_nodes([i]); end;
for i=1:3:g(’node_number’), show_nodes([i],’sup’); end;
S EE A LSO : metanet_sync 572, show_arcs 587

Scilab Group September 1996 588

strong con nodes Scilab function

2.9.70 split edge splits an edge by inserting a node

CALLING SEQUENCE :

g1 = split_edge(i,j,g,name)

PARAMETERS :

i : integer, number of start node of edge

j : integer, number of end node of edge
g : graph list
name : optional name of the added node
g1 : graph list of the new graph

DESCRIPTION :
split edge returns the graph g1, the edge from node number i to node number j being splitted: a
new node is created and located at the middle point between the 2 previous nodes. This new node is linked
with the 2 nodes i and j. If name is given, it is the name of the new node, otherwise the number of nodes
plus 1 is taken as the name of the new node.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
show_graph(g);
gt=split_edge(1,2,g);
show_graph(gt,’new’);

S EE A LSO : add_edge 541, add_node 541, delete_arcs 551, delete_nodes 552

2.9.71 strong con nodes set of nodes of a strong connected component

CALLING SEQUENCE :

ns = strong_con_nodes(i,g)

PARAMETERS :

i : integer, number of the strong connected component

g : graph list
ns : row vector, node numbers of the strong connected component

DESCRIPTION :
strong con nodes returns the row vector ns of the numbers of the nodes which belong to the strong
connected component number i.
EXAMPLE :

Scilab Group September 1995 589

subgraph Scilab function

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[197 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[76 181 276 278 276 83 174 281 177 86 175 90 290 397 399];
show_graph(g);
ncomp=strong_con_nodes(3,g);
n=g(’node_number’);
nodecolor=0*ones(1,n); nodecolor(ncomp)=11*ones(ncomp);
g(’node_color’)=nodecolor;
nodediam=20*ones(1,n); nodediam(ncomp)=40*ones(ncomp);
g(’node_diam’)=nodediam;
x_message(’Set of nodes of the strong connected component #3’);
show_graph(g);

S EE A LSO : connex 549, con_nodes 548, strong_connex 590

2.9.72 strong connex strong connected components

CALLING SEQUENCE :

[nc,ncomp] = strong_connex(g)

PARAMETERS :

g : graph list
nc : integer, number of strong connected components
ncomp : row vector of strong connected components

DESCRIPTION :
strong connex returns the number nc of strong connected components for the graph g and a row
vector ncomp giving the number of the strong connected component for each node. For instance, if i is
a node number, ncomp[i] is the number of the strong connected component to which node i belongs.
EXAMPLE :

ta=[1 1 2 2 2 3 4 4 5 6 6 6 7 7 7 8 9 10 12 12 13 13 13 14 15];
he=[2 6 3 4 5 1 3 5 1 7 10 11 5 8 9 5 8 11 10 11 9 11 15 13 14];
g=make_graph(’foo’,1,15,ta,he);
g(’node_x’)=[197 191 106 194 296 305 305 418 422 432 552 550 549 416 548];
g(’node_y’)=[76 181 276 278 276 83 174 281 177 86 175 90 290 397 399];
show_graph(g);
[nc,ncomp]=strong_connex(g);
g1=g; g1(’node_color’)=8+ncomp; g1(’node_diam’)=10+5*ncomp;
x_message(’Connected components of the graph’);
show_graph(g1);

S EE A LSO : connex 549, con_nodes 548, strong_con_nodes 589

2.9.73 subgraph subgraph of a graph

CALLING SEQUENCE :

g1 = subgraph(v,ind,g)

Scilab Group September 1996 590

successors Scilab function

PARAMETERS :

v : row vector, numbers of nodes or edges

ind : string, ’nodes’ or ’edges’
g : graph list
g1 : graph list of the new graph

DESCRIPTION :
subgraph returns the graph g1, built with the numbers given by the the row vector v. If ind is the
string ’nodes’, g1 is built with the node numbers given by v and the connected edges of these nodes in
g. If ind is the string ’edges’, g1 is built with the edge numbers given by v and the tail-head nodes
of these edges in g.
All the characteristics of the old nodes and edges of g are preserved.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
v=[2 3 4 5 17 13 10];
show_nodes(v);
g1=subgraph(v,’nodes’,g);
show_graph(g1);
v=[10 13 12 16 20 19];
show_graph(g);
show_arcs(v);
g1=subgraph(v,’edges’,g);
show_graph(g1);

S EE A LSO : add_edge 541, add_node 541, delete_arcs 551, delete_nodes 552,

supernode 592

2.9.74 successors head nodes of outgoing arcs of a node

CALLING SEQUENCE :

a = successors(i,g)

PARAMETERS :

i : integer
g : graph list
a : row vector of integers

DESCRIPTION :
successors returns the row vector of the numbers of the head nodes of the outgoing arcs from node i
for a directed graph g .
EXAMPLE :

Scilab Group September 1996 591

trans closure Scilab function

ta=[1 6 2 4 7 5 6 8 4 3 5 1];
he=[2 1 3 6 4 8 8 7 2 7 3 5];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[285 284 335 160 405 189 118 45];
g(’node_y’)=[266 179 83 176 368 252 64 309];
show_graph(g);
a=successors(6,g)
show_nodes(a);

S EE A LSO : neighbors 577, predecessors 584

2.9.75 supernode replaces a group of nodes with a single node

CALLING SEQUENCE :

g1 = supernode(v,g)

PARAMETERS :

v : row vector, nodes numbers

g : graph list
g1 : graph list of the new graph

DESCRIPTION :
supernode returns the graph g1 with the nodes with numbers given by the vector v being contracted
in a single node. The number of the supernode is the lowest number in v. The characteristics of the old
nodes and edges are preserved. The supernode is located at the mean center of v. Its diameter and border
are twice the previous of the replaced node.
The demand of the new node, if it exists, is the sum of the demands of the shrunken nodes.
EXAMPLE :

ta=[1 1 2 2 2 3 4 5 5 7 8 8 9 10 10 10 10 10 11 12 13 13 13 14 15 16 16 17
17];
he=[2 10 3 5 7 4 2 4 6 8 6 9 7 7 11 13 13 15 12 13 9 10 14 11 16 1 17 14
15];
g=make_graph(’foo’,1,17,ta,he);
g(’node_x’)=[283 163 63 57 164 164 273 271 339 384 504 513 439 623 631 757
642];
g(’node_y’)=[59 133 223 318 227 319 221 324 432 141 209 319 428 443 187 151
301];
g(’edge_color’)=modulo([1:(edge_number(g))],15)+1;
g(’node_diam’)=[1:(g(’node_number’))]+20;
show_graph(g);
v=[7 10 13 9];
show_nodes(v);
g1=supernode(v,g);
show_graph(g1,’new’);

S EE A LSO : add_edge 541, add_node 541, delete_arcs 551, delete_nodes 552

2.9.76 trans closure transitive closure

CALLING SEQUENCE :

Scilab Group September 1995 592

trans closure Scilab function

g1 = trans_closure(g)

PARAMETERS :

g : graph list
g1 : graph list

DESCRIPTION :
trans closure returns as a new graph list g1 the transitive closure of the graph g. This graph must
be directed and connected. If <name> if the name of graph g, <name> trans closure is the name
of the transitive closure.
EXAMPLE :

ta=[2 3 3 5 3 4 4 5 8];
he=[1 2 4 2 6 6 7 7 4];
g=make_graph(’foo’,1,8,ta,he);
g(’node_x’)=[129 200 283 281 128 366 122 333];
g(’node_y’)=[61 125 129 189 173 135 236 249];
show_graph(g);
g1=trans_closure(g);
vv=1*ones(ta); aa=sparse([ta’ he’],vv’);
ta1=g1(’tail’); he1=g1(’head’);
ww=1*ones(ta1); bb=sparse([ta1’ he1’],ww’);
dif=bb-aa; lim=size(ta1); edgecolor=0*ones(ta1);
for i=1:lim(2)
if dif(ta1(i),he1(i))==1 then edgecolor(i)=11; end;
end;
g1(’edge_color’)=edgecolor;
x_message(’Transitive closure of the graph’);
show_graph(g1);

Scilab Group September 1995 593

trans closure Scilab function

2.10 Scicos

Scilab Group September 1995 594

scicos menus Scicos GUI

2.10.1 Scicos editor

2.10.1.1 scicos Block diagram editor and GUI for the hybrid simulator scicosim

CALLING SEQUENCE :

sys=scicos()
sys=scicos(sys,[menus])
sys=scicos(file,[menus])

PARAMETERS :

sys : a Scicos data structure

file : a character string. The path of a file containing the image of a Scicos data structure. These files
may have .cos or .cosf extensions.
menus : a vector of character strings. It allows to select some of the Scicos menus. If menus==[]
Scicos draws the diagram and the contents of each super blocks in separate windows without menu
bar. This option is useful to print diagrams.

DESCRIPTION :
Scicos is a visual editor for constructing models of hybrid dynamical systems. Invoking Scicos with no
argument opens up an empty Scicos window. Models can then be assembled, loaded, saved, compiled,
simulated, using GUI of Scicos. The input and ouput arguments are only useful for debugging purposes.
Scicos serves as an interface to the various block diagram compilers and the hybrid simulator scicosim.
S EE A LSO : scicosim 626, scicos_main 620, scicos_menus 595

2.10.1.2 scicos menus Scicos menus description

DESCRIPTION :
Here is a list of operations available in Scicos:

Main menus :

Edit : Opens the diagram/palette edition menu.

Simulate : Opens the compilation/execution menu.
Diagram : Opens the diagram/file management menu.
Block : Opens the block management menu.
Misc : Opens miscellaneous menu items.
Diagram/palette edition menu. : This menu allows to edit diagram and palettes
Palettes : opens up a selection dialog where user may select a desired palette among all defined palettes.
Context : opens up a dialog where user may enter and modify Scilab instructions to be executed when
diagram is loaded (Edit../Load menu) or evaluated (Simulate../Eval menu) (of course
instructions are also evaluated when dialog returns).These instructions may be used to define Scilab
variables whose names are used in the block parameters definition expressions.
Move : To move a block in main Scicos window, select first the Move menu item, then click on the
selected block, drag the mouse to the desired block position and click again to fix the position.
Copy : To copy a block in main Scicos window, select first the Copy menu item, then click left on the
to-be-copied block (in Scicos window or in a palette) , and finally click where you want the copy to
be placed in Scicos window. This menu item remains active until user choose an other one
Copy Region: To copy a region in main Scicos window, select first the Copy menu item, then click
right on a corner of the desired region (in Scicos window or in a palette) , drag to select the desired
region, click to fix the selected region and finally click where you want the copy to be placed in Scicos
window. If source diagram is a big region, selection may take a while.

Scilab Group Janvier 1996 595

scicos menus Scicos GUI

Replace : To replace a block in the active editor Scicos window select first the Replace menu item,
then select the replacement block (in Scicos window or in a palette) , and finally click on the to-be-
replaced block. It is not possible to replace a connected block with another block with different port
locations.
Align : To obtain nice diagrams, you can align ports of different blocks, vertically and horizontally.
select first the Align menu item, then on the first port and finally on the second port. The block
corresponding to the second port is moved. Connected blocks cannot be aligned.
AddNew :To add a newly defined block to the current palette or diagram select first this menu item, a dialog
box will pop up asking for the name of the GUI function associated with the block. If this function
is not already loaded it is searched in the current directory. The user may then click at the desired
position of the block in the palette or diagram .
Link : This menu item is defined only in diagram edition mode. To connect an output port to an input
port, select first the Link menu item, then on the intermediate points, if necessary, and finally on the
input port. Scicos tries to draw horizontal and vertical lines to form links.
To split a link, select first the Link menu item, then on the link where the split should be placed, and
finally on an input port. Only one link can go from and to a port. Link color can be changed directly
by clicking on the link.
This menu item remains active until user choose an other one
Delete : To delete a block or a link, select first the Delete menu item, then click left on the selected
object. If you delete a block all links connected to it are deleted as well. This menu item remains
active until user choose an other one.
Delete Region :To delete a region in main Scicos window select first the Delete Region menu item,
then click right on a corner of the desired region (in Scicos window or in a palette), drag to select de
desired region, click to fix the selected region. If source diagram is a big region, selection may take a
while.
Flip : To reverse the positions of the (regular) inputs and outputs of a block placed on its sides, click on
the Flip menu item first and then on the selected block. This does not affect the order, nor the position
of the input and output event ports which are numbered from left to right. A connected block cannot
be flipped.
Undo : Click on the Undo menu item to undo the last edit operation.
Simulation menu :
Setup : In the main Scicos window, clicking on the Setup menu item invokes a dialog box that allows you
to change integration parameters: absolute and relative error tolerances for the ode solver, the time
tolerance (the smallest time interval for which the ode solver is used to update continuous states), and
the maximum time increase realized by a single call to the ode solver.
Compile : This menu item need never be used since compilation is performed automatically, if necessary,
before the beginning of every simulation (Run menu item).
Normally, a new compilation is not needed if only system parameters and internal states are modified.
In some cases however modifications are not correctly updated and a manual compilation may be
needed before a Restart or a Continue. Click on this menu item to compile the block diagram. Please
report if you encounter such a case.
Eval : blocks dialogs answers can be defined using Scilab expressions. These expressions are evaluated
immediately and they are also stored as character strings. Click on the Eval menu item to have
them re-evaluated according to the new values of underlying Scilab variables defined by context for
example.
Run : To start the simulation. If the system has already been simulated, a dialog box appears where you
can choose to Continue, Restart or End the simulation. You may interrupt the simulation by clicking
on the ”stop” button, change any of the block parameters and continue or restart the simulation with
the new values.
Diagram menu :
Replot : Scicos window stores the complete history of the editing session. Click on the Replot menu item
to erase the history and replot the diagram or palette. Replot diagram before printing or exporting
Scicos diagrams.
New : Clicking on the New menu item creates an empty diagram in the main Scicos window. If the previous

Scilab Group Janvier 1996 596

scicos menus Scicos GUI

content of the window is not saved, it will be lost.

Purge : Suppress deleted blocks out of Scicos data structure. This menu changes block indexing and
implies compilation of the diagram before compilation.
Rename : Click on this menu item to change the diagram or palette’s name. A dialog window will pop up.
Make block : Click on this menu item to save the Super Block as a new Scicos block. A Scilab function
is generated and saved in <window name>.sci file in the desired directory. <window name> is the
name of the Super Block appearing on top of the window. A dialog allows choosing the directory.
This block may be added to a palette using Edit/AddNew menu item.
Save : Saves the block diagram in the current binary file selected by a previous call to SaveAs or Load
menu item. If no current binary file, diagram is saved in the current directory as <window name>.cos.
Save As : Saves the block diagram in a binary file. A file selection dialog will pop up.
FSave : Save the diagram in a formatted ascii file. A dialog box allows choosing the file name which
must have a .cosf extension.
Formatted save is slower than regular save but has the advantage that the generated file is system
independent (usefull for exchanging data on different computers.
Load : Loads an ascii or binary file containing a saved block diagram. A file selection dialog will pop
up.
Save as Palette : select the Save as Palette menu item to save the block diagram as a palette in a
binary file. A dialog box allows choosing the file which must have a .cos extension. The palette takes
the name of the file (without the extension).
.scilab user file is updated.
FSave as Palette : select the FSave as Palette menu item to save the block diagram as a palette in
an ascii formatted file. A dialog box allows choosing the file which must have a .cosf extension. The
palette takes the name of the file (without the extension).
Load as Palette :select the Load menu item to load an ascii or binary file containing a saved block
diagram as a palette. A dialog box allows user choosing the file.
Exit : Click on the Exit menu item to close current diagram. If current diagram is not a Super block Exit
menu item leave Scicos and return to Scilab session. Save your diagram or palette before leaving.
Object menu :
Set :To change the parameters of a regular block or link, to open a super block, select first this menu
item, click next on the desired object. A dialog or edition window appear that allows you to modify
object
Resize : To change the size of a block , select first this menu item, click next on the desired block. A
dialog appears that allows you to change the width and/or height of the block shape.
Icon : To change the icon of a block drawn by standard draw, select first this menu item, click
next on the desired block. A dialog appears that allows you to enter Scilab instructions used to draw
the icon. These instructions may refer to orig and sz variables and more generaly to the block
data structure named o in this context (see scicos block). If Icon description selects colors for
drawing, it is necessary to get it through scs color function to have Color menu item work
properly.
Color : To change the background of a block drawn by standard draw, or color of a link select first
this menu item, click next on the selected object. A color palette appears where user may select the
block background color.
Label : To change or define the blocks label, select first this menu item, click next on the desired block.
A dialog appears that allows you to enter the desired label. Labels may be used within blocks com-
putational functions as an identification (see getlabel function).
Miscellaneous menu :
Window : Clicking on the Window menu item invokes a dialog box that allows you to change the editor
window dimensions.
Shift :To shift the diagram to left, right, up or down, select this menu item, then click on the point you
want to appear in the middle of the graphics window.
Zoom in : When you select this menu item the diagram is zoomed in by a factor of 10%
Zoom out : When you select this menu item the diagram is zoomed out by a factor of 10%
Options : Select this menu item to set display options.

Scilab Group Janvier 1996 597

ANIMXY f Scicos Block

Help : To get help on an object or menu menu items, select first Help menu item and then on the selected
object or menu item.
Calc: : When you click on this menu item you switch Scilab to the pause mode (see the help on pause).
In the Scilab main window and you may enter Scilab instructions to compute whatever you want. to
go back to Scicos you need to enter ””return”” or ”[...]=return(...)” Scilab instruction. ’ If you use
”[...]=return(...)” Scilab instruction take care not to modify Scicos variables such as ”scs m”,”scs gc”,
”menus”,”datam”,... ’ If you have modified Scicos graphic window you may restore it using the
Scicos ”Replot” menu.

S EE A LSO : scicos 595

2.10.2 Blocks
2.10.2.1 ABSBLK f Scicos abs block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block realizes element-wise vector absolute value operation. This block has a single input and a single
output port. Port dimension is determined by the context.

2.10.2.2 AFFICH f Scicos numerical display

DIALOGUE PARAMETERS :

font : integer, the selected font number (see xset)

fontsize : integer, the selected font size (set xset)
color : integer, the selected color for the text (see xset)
Total numer of digits : an integer greater than 3, the maximum number of digits used to represent
the number (sign, integer part and rational part)
rational part number of digits : an integer greater than or equal 0, the number of digits used
to represent the rational part

DESCRIPTION :
This block displays the value of its unique input inside the block (in the diagram) during simulation. The
block must be located in the main Scicos window.
Warning: each time the block is moved user must click on it to set its parameters. The display position
is then automatically updated.
S EE A LSO : SCOPE_f 615

2.10.2.3 ANDLOG f Scicos logical AND block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block, with two event inputs and a regular output, outputs +1 or -1 on its regular ouput depending on
input events.
+1 : When events are synchronously present on both event input ports
-1 : When only one event is present.

S EE A LSO : IFTHEL_f 608

Scilab Group Janvier 1996 598

CLKINV f Scicos Block

2.10.2.4 ANIMXY f Scicos 2D animated visualization block

DESCRIPTION :
This block realizes the visualization of the evolution of the two regular input signals by drawing the second
input as a function of the first at instants of events on the event input port.
DIALOGUE PARAMETERS :

Curve colors : an integer. It is the color number (>=0) or marker type (<0) used to draw the evolution
of the input port signal. See xset() for color (dash type) definitions.
Line or mark size : an integer.
Output window number : The number of graphic window used for the display. It is often good to
use high values to avoid conflict with palettes and Super Block windows. If you have more than one
scope, make sure they don’t have the same window numbers (unless superposition of the curves is
desired).
Output window position : a 2 vector specifying the coordinates of the upper left corner of the
graphic window. Answer [] for default window position.
Output window size : a 2 vector specifying the width and height of the graphic window. Answer []
for default window dimensions.
Xmin, Xmax : Minimum and maximum values of the first input; used to set up the X-axis of the plot in
the graphics window.
Ymin, Ymax : Minimum and maximum values of the second input; used to set up the Y-axis of the plot
in the graphics window.
Buffer size : an integer. In order to minimize the number of graphics outputs, data may buffered.

REMARKS :
Output window number, Output window size, Output window position are only taken into account at the
initialisation time of the simulation.
S EE A LSO : SCOPE_f 615, EVENTSCOPE_f 605, SCOPXY_f 615

2.10.2.5 BIGSOM f Scicos addition block

DIALOGUE PARAMETERS :

Input signs : a vector sgn of weights (generaly +1 or -1). The number of input signs fix the number
of input ports.

DESCRIPTION :
This block realize weighted sum of the input vectors. The output is vector kth component is the sum of the
kth components of each input ports weighted by sgn(k).
S EE A LSO : GAIN_f 606, SOM_f 616

2.10.2.6 CLINDUMMY f Scicos dummy continuous system with state

DESCRIPTION :
This block should be placed in any block diagram that contains a zero-crossing block but no continuous
system with state. The reason for that is that it is the ode solver that find zero crossing surfaces.
S EE A LSO : ZCROSS_f 619

Scilab Group Janvier 1996 599

CLKSOM f Scicos Block

2.10.2.7 CLKINV f Scicos Super Block event input port

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent an event input port.
In a Super Block, the event input ports must be numbered from 1 to the number of event input ports.
DIALOGUE PARAMETERS :
Port number : an integer defining the port number.
S EE A LSO : IN_f 609, OUT_f 611, CLKOUTV_f 600

2.10.2.8 CLKIN f Scicos Super Block event input port

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent an event input port.
In a Super Block, the event input ports must be numbered from 1 to the number of event input ports.
DIALOGUE PARAMETERS :
Port number : an integer defining the port number.
S EE A LSO : IN_f 609, OUT_f 611, CLKOUT_f 600

2.10.2.9 CLKOUTV f Scicos Super Block event output port

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent an event output port.
In a Super Block, the event output ports must be numbered from 1 to the number of event output ports.
DIALOGUE PARAMETERS :
Port number : an integer giving the port number.
S EE A LSO : IN_f 609, OUT_f 611, CLKINV_f 600

2.10.2.10 CLKOUT f Scicos Super Block event output port

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent an event output port.
In a Super Block, the event output ports must be numbered from 1 to the number of event output ports.
DIALOGUE PARAMETERS :
Port number : an integer giving the port number.
S EE A LSO : IN_f 609, OUT_f 611, CLKIN_f 600

2.10.2.11 CLKSOMV f Scicos event addition block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block is an event addition block with up to three inputs. The output reproduces the events on all the
input ports. Strictly speaking, CLKSOMV is not a Scicos block because it is discarded at the compilation
phase. The inputs and output of CLKSOMV are synchronized.

Scilab Group Janvier 1996 600

CLSS f Scicos Block

2.10.2.12 CLKSOM f Scicos event addition block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block is an event addition block with up to three inputs. The output reproduces the events on all the
input ports. Strictly speaking, CLKSOM is not a Scicos block because it is discarded at the compilation
phase. The inputs and output of CLKSOM are synchronized.

2.10.2.13 CLKSPLIT f Scicos event split block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block is an event split block with an input and two outputs. The outputs reproduces the event the input
port on each output ports. Strictly speaking, CLKSPLIT is not a Scicos block because it is discarded at the
compilation phase. This block is automatically created when creating a new link issued from a link.
The inputs and output of CLKSPLIT are synchronized.

2.10.2.14 CLOCK f Scicos periodic event generator

DESCRIPTION :
This block is a Super Block constructed by feeding back the output of an event delay block into its input
event port. The unique output of this block generates a regular train of events.
DIALOGUE PARAMETERS :

Period : scalar. One over the frequency of the clock. Period is the time that separates two output events.
Init time : scalar. Starting date. if negative the clock never starts.

S EE A LSO : EVTDLY_f 605

2.10.2.15 CLR f Scicos continuous-time linear system (SISO transfer function)

DIALOGUE PARAMETERS :

Numerator : a polynomial in s.
Denominator : a polynomial in s.

DESCRIPTION :
This block realizes a SISO linear system represented by its rational transfer function Numerator/Denominator.
The rational function must be proper.
S EE A LSO : CLSS_f 602, INTEGRAL_f 608

Scilab Group Janvier 1996 601

DELAYV f Scicos Block

2.10.2.16 CLSS f Scicos continuous-time linear state-space system

DESCRIPTION :
This block realizes a continuous-time linear state-space system.

xdot=A*x+B*u
y =C*x+D*u

The system is defined by the (A,B,C,D) matrices and the initial state x0. The dimensions must be
compatible.
DIALOGUE PARAMETERS :

A : square matrix. The A matrix

B : the B matrix, [] if system has no input
C : the C matrix , [] if system has no output
D : the D matrix, [] if system has no D term.
x0 : vector. The initial state of the system.

S EE A LSO : CLR_f 601, INTEGRAL_f 608

2.10.2.17 CONST f Scicos constant value(s) generator

DIALOGUE PARAMETERS :

constants : a real vector. The vector size gives the size of the output port. The value constants(i)
is assigned to the ith component of the output.

DESCRIPTION :
This block is a constant value(s) generator.

2.10.2.18 COSBLK f Scicos cosine block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block realizes vector cosine operation. y(i)=cos(u(i)). The port input and output port sizes are
equal and determined by the context.
S EE A LSO : SINBLK_f 616, GENSIN_f 607

2.10.2.19 CURV f Scicos block, tabulated function of time

DIALOGUE PARAMETERS :
Tabulated function is entered using a graphics curve editor (see edit curv in Scilab documentation)
DESCRIPTION :
This block defines a tabulated function of time. Between mesh points block performs a linear interpolation.
Outside tabulation block outputs last tabulated value.
User may define the tabulation of the function using a curve editor.

Scilab Group Janvier 1997 602

DLRADAPT f Scicos Block

2.10.2.20 DELAYV f Scicos time varying delay block

DIALOGUE PARAMETERS :

Number inputs : size of the delayed vector (-1 not allowed)

Register initial state : register initial state vector. Dimension must be greater than or equal to
2
Max delay : Maximum delay that can be produced by this block

DESCRIPTION :
This block implements a time varying discretized delay. The value of the delay is given by the second input
port. The delayed signal enters the first input port and leaves the unique output prot.
The first event output port must be connected to unique input event port if auto clocking is desired.
But the input event port can also be driven by outside clock. In that case, the max delay is size of initial
condition times the period of the incoming clock.
The second output event port generates an event if the second input goes above the maximum delay
specified. This signal can be ignored. In that case the output will be delayed by max delay.
S EE A LSO : DELAY_f 603, EVTDLY_f 605, REGISTER_f 613

2.10.2.21 DELAY f Scicos delay block

DIALOGUE PARAMETERS :

Discretization time step : positive scalar, delay discretization time step

Register initial state : register initial state vector. Dimension must be greater than or equal to
2

DESCRIPTION :
This block implements as a discretized delay. It is in fact a Scicos super block formed by a shift register
and a clock.
value of the delay is given by the discretization time step multiplied by the number of states of the
register minus one
S EE A LSO : DELAYV_f 603, EVTDLY_f 605, REGISTER_f 613

2.10.2.22 DEMUX f Scicos demultiplexer block

DIALOGUE PARAMETERS :

number of output ports : positive integer less than or equal to 8.

DESCRIPTION :
Given a vector valued input this block splits inputs over vector valued outputs. So u=[y1;y2....;yn],
where yi are numbered from top to bottom. Input and Output port sizes are determined by the context.
S EE A LSO : MUX_f 610

Scilab Group Janvier 1997 603

EVENTSCOPE f Scicos Block

2.10.2.23 DLRADAPT f Scicos discrete-time linear adaptive system

DIALOGUE PARAMETERS :

Vector of p mesh points : a vector which defines u2 mesh points. Numerator roots : a matrix,
each line gives the roots of the numerator at the corresponding mesh point.
Denominator roots : a matrix, each line gives the roots of the denominator at the corresponding
mesh point.
gain : a vector, each vector entry gives the transfer gain at the corresponding mesh point.
past inputs : a vector of initial value of past degree(Numerator) inputs
past outputs : a vector of initial value of past degree(Denominator) outputs

DESCRIPTION :
This block realizes a SISO linear system represented by its rational transfer function whose numerator and
denominator roots are tabulated functions of the second block input. The rational function must be proper.
Roots are interpolated linearly between mesh points.
S EE A LSO : DLSS_f 604, DLR_f 604

2.10.2.24 DLR f Scicos discrete-time linear system (transfer function)

DIALOGUE PARAMETERS :

Numerator : a polynomial in z.
Denominator : a polynomial in z.

DESCRIPTION :
This block realizes a SISO linear system represented by its rational transfer function (in the symbolic
variable z). The rational function must be proper.
S EE A LSO : DLSS_f 604, DLRADAPT_f 604

2.10.2.25 DLSS f Scicos discrete-time linear state-space system

DESCRIPTION :
This block realizes a discrete-time linear state-space system. The system is defined by the (A,B,C,D)
matrices and the initial state x0. The dimensions must be compatible. At the arrival of an input event on the
unique input event port, the state is updated.
DIALOGUE PARAMETERS :

A : square matrix. The A matrix

B : the B matrix
C : the C matrix
x0 : vector. The initial state of the system.

S EE A LSO : DLR_f 604, INTEGRAL_f 608, CLSS_f 602, DLSS_f 604

Scilab Group Janvier 1996 604

EXPBLK f Scicos Block

2.10.2.26 EVENTSCOPE f Scicos event visualization block

DESCRIPTION :
This block realizes the visualization of the input event signals.
DIALOGUE PARAMETERS :

Number of event inputs : an integer giving the number of event input ports colors : a vector of
integers. The i-th element is the color number (>=0) or dash type (<0) used to draw the evolution of
the i-th input port signal. See xset for color (dash type) definitions.
Output window number : The number of graphic window used for the display. It is often good to
use high values to avoid conflict with palettes and Super Block windows. If you have more than one
scope, make sure they don’t have the same window numbers (unless superposition of the curves is
desired). Output window position : a 2 vector specifying the coordinates of the upper left corner of
the graphic window. Answer [] for default window position.
Output window size : a 2 vector specifying the width and height of the graphic window. Answer []
for default window dimensions.
Refresh period : Maximum value on the X-axis (time). The plot is redrawn when time reaches a
multiple of this value.

REMARKS :
Output window number, Output window size, Output window position are only taken into account at the
initialisation time of the simulation.
S EE A LSO : SCOPXY_f 615, SCOPE_f 615, ANIMXY_f 599

2.10.2.27 EVTDLY f Scicos event delay block

DESCRIPTION :
One event is generated Delay after an event enters the unique input event port. Block may also generate
an initial output event.
DIALOGUE PARAMETERS :

Delay : scalar. Time delay between input and output event.

Auto-exec : scalar. If Auto-exec>=0 block initially generates an output event at date Auto-exec.

S EE A LSO : CLOCK_f 601

2.10.2.28 EVTGEN f Scicos event firing block

DESCRIPTION :
One event is generated on the unique output event port if Event time is larger than equal to zero, if
not, no event is generated.
DIALOGUE PARAMETERS :

Event time : scalar. date of the initial event

S EE A LSO : CLOCK_f 601, EVTDLY_f 605

Scilab Group Janvier 1997 605

GENERIC f Scicos Block

2.10.2.29 EXPBLK f Scicos aˆu block

DIALOGUE PARAMETERS :

a : real positive scalar

DESCRIPTION :
This block realizes y(i)=aˆu(i). The input and output port sizes are determined by the compiler.

2.10.2.30 GAINBLK f Scicos gain block

DIALOGUE PARAMETERS :

Gain : a real matrix.

DESCRIPTION :
This block is a gain block. The output is the Gain times the regular input (vector). The dimensions of Gain
determines the input (number of columns) and output (number of rows) port sizes.

2.10.2.31 GAIN f Scicos gain block

DIALOGUE PARAMETERS :

Gain : a real matrix.

DESCRIPTION :
This block is a gain block. The output is the Gain times the regular input (vector). The dimensions of Gain
determines the input (number of columns) and output (number of rows) port sizes.
This block is obsolete. Use GAINBLK f block instead of it

2.10.2.32 GENERAL f Scicos general zero crossing detector

DESCRIPTION :
Depending on the sign (just before the crossing) of the inputs and the input numbers of the inputs that
have crossed zero, an event is programmed (or not) with a given delay, for each output. The number of
combinations grows so fast that this becomes unusable for blocks having more than 2 or 3 inputs. For the
moment this block is not documented.
DIALOGUE PARAMETERS :

Size of regular input : integer.

Number of output events : integer.
the routing matrix : matrix. number of rows is the number of output events. The columns cor-
respond to each possible combination of signs and zero crossings of the inputs. The entries of the
matrix give the delay for generating the output event (<0 no event is generated).

S EE A LSO : NEGTOPOS_f 611, POSTONEG_f 611, ZCROSS_f 619

Scilab Group Janvier 1996 606

HALT f Scicos Block

2.10.2.33 GENERIC f Scicos generic interfacing function

DESCRIPTION :
This block can realize any type of block. The computational function must already be defined in Scilab,
Fortran or C code.
DIALOGUE PARAMETERS :

simulation function : a character string, the name of the computational function

function type : a non negative integer, the type of the computational function
input port sizes : a vector of integers, size of regular input ports.
output port sizes : a vector of integers, size of regular output ports.
input event port sizes : a vector of ones, size of event input ports. The size of the vector gives
the number of event input ports.
output event port sizes : a vector of ones, size of event output ports. The size of the vector
gives the number of of event output ports.
Initial continuous state : a column vector.
Initial discrete state : a column vector.
System type : a string: c,d, z or l (CBB, DBB, zero crossing or synchro).
Real parameter vector : column vector. Any parameters used in the block can be defined here as
a column vector.
Integer parameter vector : column vector. Any integer parameters used in the block can be
defined here as a column vector.
initial firing : vector. Size of this vector corresponds to the number of event outputs. The value
of the i-th entry specifies the time of the preprogrammed event firing on the i-th output event port. If
less than zero, no event is preprogrammed.
direct feedthrough : character ”y” or ”n”, specifies if block has a direct input to output feedthrough.
Time dependance : character ”y” or ”n”, specifies if block output depends explicitly on time.

S EE A LSO : scifunc_block 619

2.10.2.34 GENSIN f Scicos sinusoid generator

DESCRIPTION :
This block is a sine wave generator: M*sin(F*t+P)
DIALOGUE PARAMETERS :

Magnitude : a scalar. The magnitude M.

Frequency : a scalar. The frequency F.
Phase : a scalar. The phase P.

S EE A LSO : GENSQR_f 607, RAND_f 612, SAWTOOTH_f 614

2.10.2.35 GENSQR f Scicos square wave generator

DESCRIPTION :
This block is a square wave generator: output takes values -M and M. Every time an event is received on
the input event port, the output switches from -M to M, or M to -M.
DIALOGUE PARAMETERS :

Amplitude : a scalar M.

S EE A LSO : GENSIN_f 607, SAWTOOTH_f 614, RAND_f 612

Scilab Group Janvier 1996 607

INVBLK f Scicos Block

2.10.2.36 HALT f Scicos Stop block

DIALOGUE PARAMETERS :
State on halt : scalar. A value to be placed in the state of the block. For debugging purposes this
allows to distinguish between different halts.
DESCRIPTION :
This block has a unique input event port. Upon the arrival of an event, the simulation is stopped and the
main Scicos window is activated. Simulation can be restarted or continued (Run button).

2.10.2.37 IFTHEL f Scicos if then else block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
One event is generated on one of the output event ports when an input event arrives. Depending on the sign
of the regular input, the event is generated on the first or second output.
This is a synchro block, i.e., input and output event are synchronized.

2.10.2.38 INTEGRAL f Scicos simple integrator

DESCRIPTION :
This block is an integrator. The output is the integral of the input.
DIALOGUE PARAMETERS :
Initial state : a scalar. The initial condition of the integrator.
S EE A LSO : CLSS_f 602, CLR_f 601

2.10.2.39 INTRP2BLK f Scicos 2D linear interpolation block

DIALOGUE PARAMETERS :
X coord. : an n-vector (strictly increasing)
Y coord. : an m-vector (strictly increasing)
Z values : an mxn matrix
DESCRIPTION :
The output of this block is a function of the inputs obtained by bilinear interpolation. This block has two
scalar inputs and a single scalar output. The X(i) and Y(i) give respectively the X coordinate and the Y
coordinate of the i-th data point to be interpolated and Z(Y(i),X(i)) its value.

2.10.2.40 INTRPLBLK f Scicos linear interpolation block

DIALOGUE PARAMETERS :
X coord. : a vector (strictly increasing)
Y coord. : a vector (same size as X coord)
DESCRIPTION :
The output of this block is a function of the input obtained by linear interpolation. This block has a single
scalar input and a single scalar output port. The X coord. and Y coord. give respectively the X coordinate
and the Y coordinate of the data points to be interpolated. X coord must be strictly increasing.

Scilab Group Janvier 1997 608

MCLOCK f Scicos Block

2.10.2.41 INVBLK f Scicos inversion block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block computes y(i)=1/u(i). The input (output) size is determined by the context

2.10.2.42 IN f Scicos Super Block regular input port

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent a regular input port. The input size
is determined by the context.
In a Super Block, regular input ports must be numbered from 1 to the number of regular input ports.
DIALOGUE PARAMETERS :

Port number : an integer giving the port number.

S EE A LSO : CLKIN_f 600, OUT_f 611, CLKOUT_f 600

2.10.2.43 LOGBLK f Scicos logarithm block

DIALOGUE PARAMETERS :

a : real scalar greater than 1

DESCRIPTION :
This block realizes y(i)=log(u(i))/log(a). The input and output port sizes are determined by the
context.

2.10.2.44 LOOKUP f Scicos Lookup table with graphical editor

DESCRIPTION :
This block realizes a non-linear function defined using a graphical editor.

2.10.2.45 MAX f Scicos max block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
The block outputs the maximum of the input vector: y=max(u1,...un). The input vector size is
determined by the compiler according to the connected blocks port sizes.
S EE A LSO : MIN_f 610

Scilab Group Janvier 1996 609

OUT f Scicos Block

2.10.2.46 MCLOCK f Scicos 2 frequency event clock

DESCRIPTION :
This block is a Super Block constructed by feeding back the outputs of an MFCLCK block into its input
event port. The two outputs of this block generate regular train of events, the frequency of the first input
being equal to that of the second output divided by an integer n. The two outputs are synchronized (this is
impossible for standard blocks; this is a Super Block).
DIALOGUE PARAMETERS :

Basic period : scalar. equals 1/f, f being the highest frequency.

n : an intger >1. the frequency of the first output event is f/n.

S EE A LSO : MFCLCK_f 610, CLOCK_f 601

2.10.2.47 MFCLCK f Scicos basic block for frequency division of event clock

DESCRIPTION :
This block is used in the Super Block MCLOCK. The input event is directed once every n times to output
1 and the rest of the time to output 2. There is a delay of ”Basic period” in the transmission of the event. If
this period >0 then the second output is initially fired. It is not if this period=0. In the latter case, the input
is driven by an event clock and in the former case, feedback can be used.
DIALOGUE PARAMETERS :

Basic period : positive scalar.

n : an integer greater than 1.

S EE A LSO : MCLOCK_f 610, CLOCK_f 601

2.10.2.48 MIN f Scicos min block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
The block outputs the minimum of the input vector: y=min(u1,...un). The input vector size is
determined by the compiler according to the connected blocks port sizes.
S EE A LSO : MAX_f 609

2.10.2.49 MUX f Scicos multiplexer block

DIALOGUE PARAMETERS :

number of output ports : integer greater than or equal to 1 and less than 8

DESCRIPTION :
Given n vector valued inputs this block merges inputs in an single output vector. So y=[u1;u2....;un],
where ui are numbered from top to bottom. Input and Output port sizes are determined by the context.
S EE A LSO : MUX_f 610

Scilab Group Janvier 1996 610

QUANT f Scicos Block

2.10.2.50 NEGTOPOS f Scicos negative to positive detector

DESCRIPTION :
An output event is generated when the unique input crosses zero with a positive slope.
S EE A LSO : POSTONEG_f 611, ZCROSS_f 619, GENERAL_f 606

2.10.2.51 OUT f Scicos Super Block regular output port

DIALOGUE PARAMETERS :

Port number : an integer giving the port number.

DESCRIPTION :
This block must only be used inside Scicos Super Blocks to represent a regular output port.
In a Super Block, regular output ports must be numbered from 1 to the number of regular output ports.
size of the output is determined by the compiler according to the connected blocks port sizes.
S EE A LSO : CLKIN_f 600, IN_f 609, CLKOUT_f 600

2.10.2.52 POSTONEG f Scicos positive to negative detector

DESCRIPTION :
An output event is generated when the unique input crosses zero with a negative slope.
S EE A LSO : NEGTOPOS_f 611, ZCROSS_f 619, GENERAL_f 606

2.10.2.53 POWBLK f Scicos uˆa block

DIALOGUE PARAMETERS :

a : real scalar

DESCRIPTION :
This block realizes y(i)=u(i)ˆa. The input and output port sizes are determined by the compiler
according to the connected blocks port sizes.

2.10.2.54 PROD f Scicos element wise product block

DESCRIPTION :
The output is the element wize product of the inputs.

Scilab Group Janvier 1997 611

READC f Scicos Block

2.10.2.55 QUANT f Scicos Quantization block

DIALOGUE PARAMETERS :

Step : scalar, Quantization step

Quantization method : scalar with possible values 1,2,3 or 4
1 : Round method
2 : Truncation method
3 : Floor method
4 : Ceil method

DESCRIPTION :
This block outputs the quantization of the input according to a choice of methods
for Round method
y(i)=Step*(int(u(i)/Step+0.5)-0.5) if u(i)<0.
y(i)=Step*(int(u(i)/Step-0.5)+0.5). if u(i)>=0.
For truncation method
y(i)=Step*(int(u(i)/Step+0.5)) if u(i)<0.
y(i)=Step*(int(u(i)/Step-0.5)) if u(i)>=0.
For floor method
y(i)=Step*(int(u(i)/Step+0.5)) .
For ceil method
y(i)=Step*(int(u(i)/Step-0.5)) .

2.10.2.56 RAND f Scicos random wave generator

DESCRIPTION :
This block is a random wave generator: each output component takes piecewise constant random values.
Every time an event is received on the input event port, the outputs take new independent random values.
output port size is given by the size of A and B vectors
DIALOGUE PARAMETERS :

flag : 0 or 1. 0 for uniform distribution on [A,A+B] and 1 for normal distribution N(A,B*B).
A : scalar
B : scalar

S EE A LSO : GENSIN_f 607, SAWTOOTH_f 614, GENSQR_f 607

2.10.2.57 READC f Scicos ”read from C binary file” block

DIALOGUE PARAMETERS :

Time record Selection : an empty matrix or a positive integer. If an integer i is given the ith
element of the read record is assumed to be the date of the output event. If empty no output event
exists.
Output record selection : a vector of positive integer. [k1,..,kn],The kith element of the
read record gives the value of ith output.
Input file name : a character string defining the path of the file
Input Format : a character string defining the format to use

Scilab Group Janvier 1999 612

RFILE f Scicos Block

"l","s","ul","us","d","f","c","uc" : for reading respectively long, ashort, unsigned long,

unsigned short, double, float, char and unsigned char. If required by the swap mode, the bytes
which are read are automatically swapped if necessary (by checking little-endian status) in order to
produce machine independent binary files ( in little-endian mode).
"ull","uls","ubl","ubs", : can be used for reading respectively unsigned little-endian long or
short and unsigned big-endian long or short.
"dx","fx","lx","sx" : with x=b or x=l can be used for reading double, float, long or short as
big or little endian.
Record size : The file is supposed to be formed by a sequence of data with same format. these data
are organized in a sequence of record each of them containing Record size data.
Buffer size : To improve efficiency it is possible to buffer the input data. read on the file is only done
after each Buffer size call to the block.
Initial record index : a scalar. This fixes the first record of the file to use.
Swap mode : With Swap mode=1 the file is supposed to be coded in ”little endian IEEE format” and
data are swaped if necessary to match the IEEE format of the processor. If Swap mode=0 then
automatic bytes swap is disabled.

DESCRIPTION :
This block allows user to read datas in a C file. Output record selection and Time record
Selection allows the user to select data among file records.
Each call to the block advance one record in the file.
S EE A LSO : RFILE_f 613, mget 242

2.10.2.58 REGISTER f Scicos shift register block

DESCRIPTION :
This block realizes a shift register. At every input event, the register is shifted one step.
DIALOGUE PARAMETERS :

Initial condition : a column vector. It contains the initial state of the register.

S EE A LSO : DELAY_f 603, DELAYV_f 603, EVTDLY_f 605

2.10.2.59 RELAY f Scicos relay block

DIALOGUE PARAMETERS :

number of inputs : a scalar. Number of regular and event inputs.

initial connected input : an integer. It must be between 1 and the number of inputs.

DESCRIPTION :
This block routes one of the regular inputs to the unique regular output. the choice of which input is to be
routed is done, initially by the ”initial connected input” parameter. Then, every time an input event arrives
on the i-th input event port, the i-th regular input port is routed to the regular output.

2.10.2.60 RFILE f Scicos ”read from file” block

DIALOGUE PARAMETERS :

Time record Selection : an empty matrix or a positive integer. If an integer i is given the ith
element of the read record is assumed to be the date of the output event. If empty no output event
exists.

Scilab Group Janvier 1996 613

SCOPE f Scicos Block

Output record selection : a vector of positive integer. [k1,..,kn],The kith element of the
read record gives the value of ith output.
Input file name : a character string defining the path of the file
Input Format : a character string defining the Fortran format to use or nothing for an unformatted
(binary) write. If given, the format must began by a left parenthesis and end by a right parenthesis.
example: (e10.3).
Buffer size : To improve efficiency it is possible to buffer the input data. read on the file is only done
after each Buffer size call to the block.
size of output : a scalar. This fixes the number of ”value” read.

DESCRIPTION :
This block allows user to read datas in a file, in formatted or binary mode. Output record selection
and Time record Selection allows the user to select data among file records.
Each call to the block advance one record in the file.
S EE A LSO : WFILE_f 618

2.10.2.61 SAMPLEHOLD f Scicos Sample and hold block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
Each time an input event is received block copy its input on the output and hold it until input event. For
periodic Sample and hold, event input must be generated by a Clock.
S EE A LSO : DELAY_f 603, CLOCK_f 601

2.10.2.62 SAT f Scicos Saturation block

DESCRIPTION :
This block realizes the non-linear function: saturation.
DIALOGUE PARAMETERS :

Min : a scalar. Lower saturation bound

Max : a scalar. Upper saturation bound
Slope : a scalar. The slope of the line going through the origin and describing the behaviour of the
function around zero.

S EE A LSO : LOOKUP_f 609

2.10.2.63 SAWTOOTH f Scicos sawtooth wave generator

DESCRIPTION :
This block is a sawtooth wave generator: output is (t-t i) from ti to t (i+1) where t i and t (i+1) denote the
times of two successive input events.
DIALOGUE PARAMETERS :
None.
S EE A LSO : GENSIN_f 607, GENSQR_f 607, RAND_f 612

Scilab Group Janvier 1996 614

SCOPXY f Scicos Block

2.10.2.64 SCOPE f Scicos visualization block

DESCRIPTION :
This block realizes the visualization of the evolution of the signals on the standard input port(s) at instants
of events on the event input port.
DIALOGUE PARAMETERS :

Curve colors : a vector of integers. The i-th element is the color number (>0) or dash type (<0) used
to draw the evolution of the i-th input port signal. See plot2d for color (dash type) definitions.
Output window number : The number of graphic window used for the display. It is often good to
use high values to avoid conflict with palettes and Super Block windows. If you have more than one
scope, make sure they don’t have the same window numbers (unless superposition of the curves is
desired).
Output window position : a 2 vector specifying the coordinates of the upper left corner of the
graphic window. Answer [] for default window position.
Output window size : a 2 vector specifying the width and height of the graphic window. Answer []
for default window dimensions.
Ymin, Ymax : Minimum and maximum values of the input; used to set up the Y-axis of the plot in the
graphics window.
Refresh period : Maximum value on the X-axis (time). The plot is redrawn when time reaches a
multiple of this value.
Buffer size : To improve efficiency it is possible to buffer the input data. The drawing is only done
after each Buffer size call to the block.
Accept herited events : if 0 SCOPE f draws a new point only when an event occurs on its event
input port. if 1 SCOPE f draws a new point when an event occurs on its event input port and when
it’s regular input changes due to an event on an other upstrem block (herited events).

REMARKS :
Output window number, Output window size, Output window position are only taken into account at the
initialisation time of the simulation.
S EE A LSO : SCOPXY_f 615, EVENTSCOPE_f 605, ANIMXY_f 599

2.10.2.65 SCOPXY f Scicos visualization block

DESCRIPTION :
This block realizes the visualization of the evolution of the two regular input signals by drawing the second
input as a function of the first at instants of events on the event input port.
DIALOGUE PARAMETERS :

Curve colors : an integer. It is the color number (>0) or dash type (<0) used to draw the evolution of
the input port signal. See plot2d for color (dash type) definitions.
Line or mark size : an integer.
Output window number : The number of graphic window used for the display. It is often good to
use high values to avoid conflict with palettes and Super Block windows. If you have more than one
scope, make sure they don’t have the same window numbers (unless superposition of the curves is
desired).
Output window position : a 2 vector specifying the coordinates of the upper left corner of the
graphic window. Answer [] for default window position.
Output window size : a 2 vector specifying the width and height of the graphic window. Answer []
for default window dimensions.
Xmin, Xmax : Minimum and maximum values of the first input; used to set up the X-axis of the plot in
the graphics window.

Scilab Group Janvier 1996 615

STOP f Scicos Block

Ymin, Ymax : Minimum and maximum values of the second input; used to set up the Y-axis of the plot
in the graphics window.
Buffer size : To improve efficiency it is possible to buffer the input data. The drawing is only done
after each Buffer size call to the block.
REMARKS :
Output window number, Output window size, Output window position are only taken into account at the
initialisation time of the simulation.
S EE A LSO : SCOPE_f 615, EVENTSCOPE_f 605, ANIMXY_f 599

2.10.2.66 SELECT f Scicos selector block

DIALOGUE PARAMETERS :
number of inputs : a scalar. Number of regular and event inputs.
initial connected input : an integer. It must be between 1 and the number of inputs.
DESCRIPTION :
This block routes one of the regular inputs to the unique regular output. the choice of which input is to be
routed is done, initially by the ”initial connected input” parameter. Then, every time the block is activated
through its i-th input activation port, the i-th regular input value port is put to the regular output.

2.10.2.67 SINBLK f Scicos sine block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block realizes vector sine operation. y(i)=sin(u(i)). The input and output port sizes are equal
and determined by the context.

2.10.2.68 SOM f Scicos addition block

DIALOGUE PARAMETERS :
Input signs : a (1x3) vector of +1 and -1. If -1, the corresponding input is multiplied by -1 before
addition.
DESCRIPTION :
This block is a sum. The output is the element-wise sum of the inputs.
Input ports are located at up, left or right and down position. You must specify 3 gain numbers but if
only two links are connected only the first values are used, ports are numbered anti-clock wise.
S EE A LSO : GAIN_f 606

2.10.2.69 SPLIT f Scicos regular split block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block is a regular split block with an input and two outputs. The outputs reproduces the input port on
each output ports. Strictly speaking, SPLIT is not a Scicos block because it is discarded at the compilation
phase. This block is automatically created when creating a new link issued from a link.
Port sizes are determined by the context.

Scilab Group Janvier 1996 616

TEXT f Scicos Block

2.10.2.70 STOP f Scicos Stop block

DIALOGUE PARAMETERS :

State on halt : scalar. A value to be placed in the state of the block. For debugging purposes this
allows to distinguish between different halts.

DESCRIPTION :
This block has a unique input event port. Upon the arrival of an event, the simulation is stopped and the
main Scicos window is activated. Simulation can be restarted or continued (Run button).

2.10.2.71 SUPER f Scicos Super block

DESCRIPTION :
This block opens up a new Scicos window for editing a new block diagram. This diagram describes the
internal functions of the super block.
Super block inputs and outputs (regular or event) are designated by special (input or output) blocks.
Regular input blocks must be numbered from 1 to the number of regular input ports. Regular input ports of
the super block are numbered from the top of the block shape to the bottom.
Regular output portss must be numbered from 1 to the number of regular output ports. Regular output
ports of the super block are numbered from the top of the block shape to the bottom.
Event input blocks must be numbered from 1 to the number of event input ports. Event input ports of
the super block are numbered from the left of the block shape to the right.
Event output ports must be numbered from 1 to the number of event output ports. Event output ports of the
super block are numbered from the left of the block shape to the right.
S EE A LSO : CLKIN_f 600, OUT_f 611, CLKOUT_f 600, IN_f 609

2.10.2.72 TANBLK f Scicos tan block

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block realizes vector tangent operation. input (output) port size is determined by the compiler.
S EE A LSO : SINBLK_f 616

2.10.2.73 TCLSS f Scicos jump continuous-time linear state-space system

DESCRIPTION :
This block realizes a continuous-time linear state-space system with the possibility of jumps in the state.
The number of inputs to this block is two. The first input is the regular input of the linear system, the second
carries the new value of the state which is copied into the state when an event arrives at the unique event
input port of this block. That means the state of the system jumps to the value present on the second input
(of size equal to that of the state). The system is defined by the (A,B,C,D) matrices and the initial state x0.
The dimensions must be compatible. The sizes of inputs and outputs are adjusted automatically.
DIALOGUE PARAMETERS :

A : square matrix. The A matrix

B : the B matrix

Scilab Group Janvier 1997 617

WRITEC f Scicos Block

C : the C matrix
D : the D matrix
x0 : vector. The initial state of the system.

S EE A LSO : CLSS_f 602, CLR_f 601

2.10.2.74 TEXT f Scicos text drawing block

DIALOGUE PARAMETERS :

txt : a character string, Text to be displayed

font : a positive integer less than 6, number of selected font (see xset)
siz : a positive integer, selected font size (see xset)

DESCRIPTION :
This special block is only use to add text at any point of the diagram window. It has no effect on the
simulation.

2.10.2.75 TIME f Scicos time generator

DIALOGUE PARAMETERS :
None.
DESCRIPTION :
This block is a time generator. The unique regular output is the current time.

2.10.2.76 TRASH f Scicos Trash block

DIALOGUE PARAMETERS :
None
DESCRIPTION :
This block does nothing. It simply allows to safely connect the outputs of other blocks which should be
ignored. Useful for sinking outputs of no interest. The input size is determined by the compiler.

2.10.2.77 WFILE f Scicos ”write to file” block

DIALOGUE PARAMETERS :

input size : a scalar. This fixes the input size

Output file name : a character string defining the path of the file
Output Format : a character string defining the Fortran format to use or nothing for an unformatted
(binary) write. If given, the format must began by a left parenthesis and end by a right parenthesis.
example: (e10.3).
Buffer size : To improve efficiency it is possible to buffer the input data. write on the file is only done
after each Buffer size calls to the block.

DESCRIPTION :
This block allows user to save data in a file, in formatted and binary mode. Each call to the block cor-
responds to a record in the file. Each record has the following form: [t,V1,...,Vn] where t is the
value of time when block is called and Vi is the ith input value
S EE A LSO : RFILE_f 613

Scilab Group Janvier 1999 618

scifunc block Scicos Block

2.10.2.78 WRITEC f Scicos ”write to C binary file” block

DIALOGUE PARAMETERS :

Input size : a scalar, the size of the input

Output file name : a character string defining the path of the file
Output Format : a character string defining the format to use
"l","s","ul","us","d","f","c","uc" : for reading respectively long, ashort, unsigned long,
unsigned short, double, float, char and unsigned char. If required by the swap mode, the bytes
which are read are automatically swapped if necessary (by checking little-endian status) in order to
produce machine independent binary files ( in little-endian mode).
"ull","uls","ubl","ubs", : can be used for reading respectively unsigned little-endian long or
short and unsigned big-endian long or short.
"dx","fx","lx","sx" : with x=b or x=l can be used for reading double, float, long or short as
big or little endian.
Buffer size : To improve efficiency it is possible to buffer the input data. read on the file is only done
after each Buffer size call to the block.
Swap mode : With Swap mode=1 the file is supposed to be coded in ”little endian IEEE format” and
data are swaped if necessary to match the IEEE format of the processor. If Swap mode=0 then
automatic bytes swap is disabled.

DESCRIPTION :
This block allows user to write datas in a C binary file.
S EE A LSO : READC_f 612, mput 246

2.10.2.79 ZCROSS f Scicos zero crossing detector

DESCRIPTION :
An output event is generated when all inputs (if more than one) cross zero simultaneously.
DIALOGUE PARAMETERS :

Number of inputs : a positive integer.

S EE A LSO : POSTONEG_f 611, GENERAL_f 606

2.10.2.80 scifunc block Scicos block defined interactively

DESCRIPTION :
This block can realize any type of Scicos block. The function of the block is defined interactively using
dialogue boxes and in Scilab language. During simulation, these instructions are interpreted by Scilab;
the simulation of diagrams that include these types of blocks is slower. For more information see Scicos
reference manual.
DIALOGUE PARAMETERS :

number of inputs : a scalar. Number of regular input ports

number of outputs : a scalar. Number of regular output ports
number of input events : a scalar. Number of input event ports
number of output events : a scalar. Number of output event ports
Initial continuous state : a column vector.
Initial discrete state : a column vector.
System type : a string: c or d (CBB or DBB, other types are not supported).

Scilab Group Janvier 1996 619

scicos block

System parameter : column vector. Any parameters used in the block can be defined here a column
vector.
initial firing : vector. Size of this vector corresponds to the number of event outputs. The value
of the i-th entry specifies the time of the preprogrammed event firing on the i-th output event port. If
less than zero, no event is preprogrammed.
Instructions : other dialogues are opened consecutively where used may input Scilab code associated
with the computations needed (block initialization, outputs, continuous and discrete state, output
events date, block ending),

S EE A LSO : GENERIC_f 607

2.10.3 Data Structures

2.10.3.1 scicos main Scicos editor main data structure

DEFINITION :

scs_m=list(params,o_1,....,o_n)

PARAMETERS :

params : Scilab list, params=list(wpar,title,tol,tf,context,void,options,void,void,doc))

wpar : viewing parameters: [w,h,Xshift,Yshift]
w : real scalar,Scicos editor window width
h : real scalar,Scicos editor window height
Xshift : real scalar, diagram drawing x offset within Scicos editor window
Yshift : real scalar, diagram drawing y offset within Scicos editor window
title : character string, diagram title and default name of save file name
tol : 1 x 4 vector [atol,rtol,ttol,maxt], where atol, rtol are respectively absolute and
relative tolerances for the ode solver, ttol is the minimal distance between to different events time
and maxt is maximum integration time interval for a single call to the ode solver.
tf : real scalar, final time for simulation.
context : vector of character strings, Scilab instructions used to define Scilab variables used in block
definitions as symbolic parameters.
void : unused fields
options : list(With3D,Color3D)
With3D : boolean, true for 3D shape blocks
Color3D : vector with three entries [R,G,B]. defines the color of 3D shape
doc : user defined diagram documentation structure, default value is list()
o i : block or link or deleted object data structure.
See scicos block and scicos link).
Deleted object data structure is marked list(’Deleted’).
scs m : main Scicos structure

DESCRIPTION :
Scicos editor uses and modifies the Scicos editor main data structure to keep all information relative to the
edited diagram. Scicos compiler uses it as a input.
S EE A LSO : scicos 595, scicos_block 621, scicos_link 622

Scicos data structure Scilab Group 620

scicos model

2.10.3.2 scicos block Scicos block data structure

DEFINITION :

blk=list(’Block’,graphics,model,void,gui)

PARAMETERS :

"Block" : keyword used to define list as a Scicos block representation

graphics : Scilab list, graphic properties data structure
model : Scilab list, system properties data structure.
void : unused, reserved for future use.
gui : character string, the name of the graphic user interface function (generally written in Scilab) associ-
ated with the block.
blk : Scilab list, Scicos block data structure

DESCRIPTION :
Scicos editor creates and uses for each block a data structure containing all information relative to the
graphic interface and simulation part of the block. Each of them are stored in the Scicos editor main data
structure. Index of these in Scicos editor main data structure is given by the creation order.
For Super blocks model(8) contains a data structure similar to the scicos main data structure.
S EE A LSO : scicos_graphics 621, scicos_model 622

2.10.3.3 scicos graphics Scicos block graphics data structure

DEFINITION :

graphics=list(orig,sz,flip,exprs,pin,pout,pein,peout,gr_i)

PARAMETERS :

orig : 2 x 1 vector, the coordinate of down-left point of the block shape.

sz : vector [w,h], where w is the width and h the height of the block shape.
flip : boolean, the block orientation. if true the input ports are on the left of the box and output ports are
on the right. if false the input ports are on the right of the box and output ports are on the left.
exprs : column vector of strings, contains expressions answered by the user at block set time.
pin : column vector of integers. If pin(k)<>0 then kth input port is connected to the pin(k)<>0
block, else the port is unconnected. If no input port exist pin==[].
pout : column vector of integers. If pout(k)<>0 then kth output port is connected to the pout(k)<>0
block, else the port is unconnected. If no output port exist pout==[].
pein : column vector of ones. If pein(k)<>0 then kth event input port is connected to the pein(k)<>0
block, else the port is unconnected. If no event input port exist pein==[].
peout : column vector of integers. If peout(k)<>0 then kth event output port is connected to the
epout(k)<>0 block, else the port is unconnected. If no event output port exist peout==[].
gr i : column vector of strings, contains Scilab instructions used to customize the block graphical aspect.
This field may be set with "Icon" sub menu.
graphics : Scilab list, Scicos block graphics data structure.

DESCRIPTION :
Scicos block graphics data structure contains all information relative to graphical display of the block and
to user dialogue. Fields may be fixed by block definition or set as a result of user dialogue or connections.
S EE A LSO : scicos 595, scicos_model 622, scicos_main 620

Scicos data structure Scilab Group 621

scicos link

2.10.3.4 scicos model Scicos block functionality data structure

DEFINITION :

model=list(sim,in,out,evtin,evtout,state,dstate,..
rpar,ipar,blocktype,firing,dep_ut,label,import,ID)

PARAMETERS :

sim : list(fun,typ) or fun. In the latest case typ is supposed to be 0.

fun : character string, the name of the block simulation function (a linked C or Fortran procedure or a
Scilab function).
typ : integer, calling sequence type of simulation function (see documentation for more precision).
in : column vector of integers, input port sizes indexed from top to bottom of the block. If no input port
exist in==[].
out : column vector of integers, output port sizes indexed from top to bottom of the block. If no output
port exist in==[].
evtin : column vector of ones, the size of evtin gives the number of event input ports. If no event
input port exists evtin must be equal to [].
evtout : column vector of ones, the size of evtout gives the number of event output ports. If no event
output port exists evtout must be equal to [].
state : column vector, the initial continuous state of the block. Must be [] if no continuous state.
dstate : column vector, the initial discrete state of the block. Must be [] if no discrete state.
rpar : column vector, the vector of floating point block parameters. Must be [] if no floating point
parameters.
ipar : column vector, the vector of integer block parameters. Must be [] if no integer parameters.
blocktype : a character with possible values:
: ’c’ block output depend continuously of the time.
: ’d’ block output changes only on input events.
: ’z’ zero crossing block
: ’l’ logical block
firing : a vector whose size is equal to the size of evtout> It contains output initial event dates
(Events generated before any input event arises). Negative values stands for no initial event on the
corresponding port.
dep ut : 1x 2 vector of boolean [dep u, dep t], dep u must be true if output depends continuously
of the input, dep t must be true if output depends continuously of the time.
label : a character string, used as a label
import : Unused.
ID : a character string, used as an identifier.
model : Scilab list, Scicos block model data structure.

DESCRIPTION :
Scicos block model data structure contains all information relative to the simulation functionality of the
block. Fields may be fixed by block definition or set.
If block is a super block, the fields state,dstate,ipar,blocktype,firing, dep ut, are un-
used.
The rpar field contains a data structure similar to the scicos main data structure.
S EE A LSO : scicos 595, scicos_model 622, scicos_main 620

2.10.3.5 scicos link Scicos link data structure

DEFINITION :

Scicos data structure Scilab Group 622

scicos cpr

lnk=list(’Link’,xx,yy,’drawlink’,id,[0,0],ct,from,to)

PARAMETERS :

"Link" : keyword used to define list as a Scicos link representation

xx : vector of x coordinates of the link path.
yy : vector of y coordinates of the link path.
id : Character string, the link id
ct : 2 x 1 vector, [color,typ] where color defines the color used for the link drawing and typ
defines its type (0 for regular link ,1 for event link).
from : 2 x 1 vector, [block,port] where block is the index of the block at the origin of the link
and port is the index of the port.
to : 2 x 1 vector, [block,port] where block is the index of the block at the end of the link and
port is the index of the port.

DESCRIPTION :
Scicos editor creates and uses for each link a data structure containing all information relative to the graphic
interface and interconnection information. Each of them are stored in the Scicos editor main data structure.
Index of these in Scicos editor main data structure is given by the creation order.
S EE A LSO : scicos 595, scicos_main 620, scicos_graphics 621, scicos_model
622

2.10.3.6 scicos cpr Scicos compiled diagram data structure

DEFINITION :

cpr=list(state,sim,cor,corinv)

PARAMETERS :

state : Scilab tlist contains initial state.

state(’x’) : continuous state vector.
state(’z’) : discrete state vector.
state(’tevts’) : vector of event dates
state(’evtspt’) : vector of event pointers
state(’pointi’) : pointer to next event state(’npoint’) : not used yet state(’outtb’) : vector of in-
puts/outputs initial values.
sim : Scilab tlist. Usually generated by Scicos Compile menu. Some useful entries are:
sim(’rpar’) : vector of blocks’ floating point parameters
sim(’rpptr’) : (nblk+1) x 1 vector of integers,
sim(’rpar’)(rpptr(i):(rpptr(i+1)-1)) is the vector of floating point parameters of
the ith block.
sim(’ipar’) : vector of blocks’ integer parameters
sim(’ipptr’) : (nblk+1) x 1 vector of integers,
sim(’ipar’)(ipptr(i):(ipptr(i+1)-1)) is the vector of integer parameters of the ith
block.
sim(’funs’) : vector of strings containing the names of each block simulation function
sim(’xptr’) : (nblk+1) x 1 vector of integers,
state(’x’)(xptr(i):(xptr(i+1)-1)) is the continuous state vector of the ith block.
sim(’zptr’) : (nblk+1) x 1 vector of integers,
state(’z’)(zptr(i):(zptr(i+1)-1)) is the discrete state vector of the ith block.
sim(’inpptr’) : (nblk+1) x 1 vector of integers,
inpptr(i+1)-inpptr(i) gives the number of input ports. inpptr(i)th points to the begin-
ning of ith block inputs within the indirection table inplnk.

Scicos data structure Scilab Group 623

standard draw

sim(’inplnk’) : nblink x 1 vector of integers,

inplnk(inpptr(i)-1+j) is the index of the link connected to the jth input port of the ith
block. where j goes from 1 to inpptr(i+1)-inpptr(i)).
sim(’outptr’) : (nblk+1) x 1 vector of integers,
outptr(i+1)-outptr(i) gives the number of output ports. outptr(i)th points to the be-
ginning of ith block outputs within the indirection table outlnk.
sim(’outlnk’) : nblink x 1 vector of integers,
outlnk(outptr(i)-1+j) is the index of the link connected to the jth output port of the ith
block. where j goes from 1 to outptr(i+1)-outptr(i)).
sim(’lnkptr’) : (nblink+1) x 1 vector of integers,
kth entry points to the beginning of region within outtb dedicated to link indexed k.
sim(’funs’) : vector of strings containing the names of each block simulation function
sim(’funtyp’) : vector of block block types.
cor : is a list with same recursive structure as scs m each leaf contains the index of associated block in
cpr data structure.
corinv : corinv(i) is the path of i th block defined in cpr data structure in the scs m data structure.

DESCRIPTION :
Scicos compiled diagram data structure contains all information needed to simulate the system (see scicosim).

S EE A LSO : scicos 595, scicos_model 622, scicos_main 620, scicosim 626

2.10.4 Useful Functions

2.10.4.1 standard define Scicos block initial definition function

CALLING SEQUENCE :

o=standard_define(sz,model,dlg,gr_i)

PARAMETERS :

o : Scicos block data structure (see scicos block)

sz : 2 vector, giving the initial block width and height
model : initial model data structure definition (see scicos model)
dlg : vector of character strings,initial parameters expressions
gr i : vector of character strings, initial icon definition instructions

DESCRIPTION :
This function creates the initial block data structure given the initial size sz, this initial model definition
model, the initial parameters expressions dlg and initial icon definition instructions gr i
S EE A LSO : scicos_model 622

2.10.4.2 standard draw Scicos block drawing function

CALLING SEQUENCE :

standard_draw(o)

PARAMETERS :

o : Scicos block data structure (see scicos block)

Scicos function Scilab Group 624

standard output

DESCRIPTION :
standard draw is the Scilab function used to display standard blocks in interfacing functions.
It draws a block with a rectangular shape with any number of regular or event input respectively on the left
and right faces of the block (if not flipped), event input or output respectively on the top and bottom faces
of the block. Number of ports, size, origin, orientation, background color, icon of the block are taken from
the block data structure o.
S EE A LSO : scicos_block 621

2.10.4.3 standard input get Scicos block input port positions

CALLING SEQUENCE :

[x,y,typ]=standard_input(o)

PARAMETERS :

o : Scicos block data structure (see scicos block)

x : vector of x coordinates of the block regular and event input ports
y : vector of y coordinates of the block regular and event output ports
typ : vector of input ports types (+1 : regular port; -1:event port)

DESCRIPTION :
standard input is the Scilab function used to get standard blocks input port position and types in
interfacing functions.
Port positions are computed, each time they are required, as a function of block dimensions.
S EE A LSO : scicos_block 621

2.10.4.4 standard origin Scicos block origin function

CALLING SEQUENCE :

[x,y]=standard_draw(o)

PARAMETERS :

o : Scicos block data structure (see scicos block)

x : x coordinate of the block origin (bottom left corner)
y : y coordinate of the block origin (bottom left corner)

DESCRIPTION :
standard origin is the Scilab function used to get standard blocks position in interfacing functions.
S EE A LSO : scicos_block 621

2.10.4.5 standard output get Scicos block output port positions

CALLING SEQUENCE :

[x,y,typ]=standard_output(o)

PARAMETERS :

o : Scicos block data structure (see scicos block)

Scicos function Scilab Group 625

curblock

x : vector of x coordinates of the block regular and event output ports

y : vector of y coordinates of the block regular and event output ports
typ : vector of output ports types (+1 : regular port; -1:event port)

DESCRIPTION :
standard output is the Scilab function used to get standard blocks output port position and types in
interfacing functions.
Port positions are computed, each time they are required, as a function of block dimensions.
S EE A LSO : scicos_block 621

2.10.4.6 scicosim Scicos simulation function

CALLING SEQUENCE :

[state,t]=scicosim(state,0,tf,sim,’start’ [,tol])
[state,t]=scicosim(state,tcur,tf,sim,’run’ [,tol])
[state,t]=scicosim(state,tcur,tf,sim,’finish’ [,tol])

PARAMETERS :

state : Scilab tlist contains scicosim initial state. Usually generated by Scicos Compile or Run
menus (see scicos cpr for more details).
tcur : initial simulation time
tf : final simulation time (Unused with options ’start’ and ’finish’
sim : Scilab tlist. Usually generated by Scicos Compile menu (see scicos cpr for more details).
tol : 4 vector [atol,rtol,ttol,deltat] where atol, rtol are respectively the absolute and
relative tolerances for ode solver (see ode), ttol is the precision on event dates. deltat is max-
imum integration interval for each call to ode solver.
t : final reached time

DESCRIPTION :
Simulator for Scicos compiled diagram. Usually scicosim is called by scicos to perform simulation
of a diagram.
But scicosim may also be called outside Scicos. Typical usage in such a case may be:

1 Use Scicos to define a block diagram, compile it.

2 Save the compiled diagram using Save,SaveAs Scicos menus .
3 In Scilab, load saved file using load function. You get variables scicos ver, scs m, cpr

scs m is the diagram Scicos main data structure.

cpr is the data structure list(state,sim,cor,corinv) if the diagram had been compiled before
saved, else cpr=list()

4 Extract state, sim out of cpr

5 Execute [state,t]=scicosim(state,0,tf,sim,’start’ [,tolerances]) for initial-
isation.
6 Execute [state,t]=scicosim(state,0,tf,sim,’run’ [,tolerances]) for simulation
from 0 to tf. Many successives such calls may be performed changing initial and final time.
7 Execute [state,t]=scicosim(state,0,tf,sim,’finish’ [,tolerances]) at the very
end of the simulation to close files,...
For advanced user it is possible to ”manually” change some parameters or state values

S EE A LSO : scicos 595, scicos_cpr 623

Scicos function Scilab Group 626

getscicosvars Scicos function

2.10.4.7 curblock get current block index in a Scicos simulation function

CALLING SEQUENCE :

k=curblock()

PARAMETERS :

k : integer, index of the block corresponding to the Scilab simulation function where this function is called.

DESCRIPTION :
During simulation it may be interesting to get the index of the current block to trace execution, to get its
label, to animate the block icon according to simulation...
For block with a computational function written in Scilab, Scilab primitive function curblock() allows
to get the index of the current block in the compiled data structure.
To obtain path to the block in the Scicos main structure user may uses the corinv table (see scicos cpr).
For block with a computational function written in C user may uses the C function k=C2F(getcurblock)().
Where C2F is the C compilation macro defined in <SCIDIR>/routines/machine.h
For block with a computational function written in Fortran user may uses the integer function k=getcurblock().

S EE A LSO : getblocklabel 627, getscicosvars 627, setscicosvars 628, scicos_cpr

623, scicos_main 620

2.10.4.8 getblocklabel get label of a Scicos block at running time

CALLING SEQUENCE :

label=getblocklabel()
label=getblocklabel(k)

PARAMETERS :

k : integer, index of the block. if k is omitted kis supposed to be equal to curblock().

label : a character string, The label of kth block (see Label button in Block menu.

DESCRIPTION :
For display or debug purpose it may be usefull to give label to particular blocks of a diagram. This may be
done using Scicos editor (Label button in Block menu). During simulation, value of these labels may
be obtained in any Scilab block with getblocklabel Scilab primitive function.
For C or fortran computational functions, user may use C2F(getlabel) to get a block label. See
routines/scicos/import.c file for more details
Block indexes are those relative to the compile structurecpr.
S EE A LSO : curblock 627, getscicosvars 627, setscicosvars 628

2.10.4.9 getscicosvars get Scicos data structure while running

CALLING SEQUENCE :
v=getscicosvars(name)
PARAMETERS :

name : a character string, the name of the required structure

v : vector of the structure value

Scilab Group Janvier 1996 627

setscicosvars Scicos function

DESCRIPTION :
This function may be used in a Scilab block to get value of some particular global data while running. It
allows to write diagram monitoring blocks.
for example the instruction disp(getscicosvars(’x’)) displays the entire continuous state of the
diagram.

x=getscicosvars(’x’);
xptr=getscicosvars(’xptr’);
disp(x(xptr(k):xptr(k+1)-1))

displays the continuous state of the k block

name data structure definition
’x’ continuous state
’xptr’ continuous state splitting vector
’z’ discrete state
’zptr’ discrete state splitting vector
’rpar’ real parameters vector
’rpptr’ rpar splitting vector
’ipar’ integer parameters vector
’ipptr’ ipar splitting vector
’outtb’ vector of all input/outputs values
’inpptr’ inplnk splitting vector
’outptr’ outlnk splitting vector
’inplnk’ vector of input port values address in lnkptr
’outlnk’ vector of output port values address in lnpkpr
’lnkptr’ outtb splitting vector
See scicos cpr for more detail on these data structures.
For C or fortran computational function the C procedure C2F(getscicosvars) may used. See routines/scicos/import
file for more details.
S EE A LSO : setscicosvars 628, scicosim 626, curblock 627, scicos_cpr 623,
getblocklabel 627

2.10.4.10 setscicosvars set Scicos data structure while running

CALLING SEQUENCE :
setscicosvars(name,v)
PARAMETERS :

name : a character string, the name of the required structure

v : vector of the new structure value

DESCRIPTION :
This function may be used in a Scilab block to set value of some particular global data while running. It
allows to write diagram supervisor blocks.
for example the instructions

x=getscicosvars(’x’);
xptr=getscicosvars(’xptr’);
x(xptr(k):xptr(k+1)-1)=xk
setscicosvars(’x’,x)

Changes the continuous state of the k block to xk.

Scilab Group Janvier 1996 628

setscicosvars Scicos function

name data structure definition

’x’ continuous state
’xptr’ continuous state splitting vector
’z’ discrete state
’zptr’ discrete state splitting vector
’rpar’ real parameters vector
’rpptr’ rpar splitting vector
’ipar’ integer parameters vector
’ipptr’ ipar splitting vector
’outtb’ vector of all input/outputs values
’inpptr’ inplnk splitting vector
’outptr’ outlnk splitting vector
’inplnk’ vector of input port values address in lnkptr
’outlnk’ vector of output port values address in lnpkpr
’lnkptr’ outtb splitting vector
See scicos cpr for more detail on these data structures.
For C or fortran computational function the C procedure C2F(setscicosvars) may used. See routines/scicos/import
file for more details.
Warning: The use of this function requires a deep knowledge on how scicosim works, it must be used very
carefully. Unpredicted parameters, state, link values changes may produce erroneous simulations.
S EE A LSO : getscicosvars 627, scicosim 626, curblock 627, scicos_cpr 623,
getblocklabel 627

Scilab Group Janvier 1996 629

setscicosvars Scicos function

2.11 Sound

Scilab Group Janvier 1996 630

auwrite Scilab Function

2.11.1 analyze frequency plot of a sound signal

CALLING SEQUENCE :
analyze (w [,fmin,fmax,rate,points])
PARAMETERS :
fmin,fmax,rate,points : scalars. default values fmin=100,fmax=1500,rate=22050,points=8192;
DESCRIPTION :
Make a frequency plot of the signal w with sampling rate rate. The data must be at least points long.
The maximal frequency plotted will be fmax, the minimal fmin.
EXAMPLE :

// At first we create 0.5 seconds of sound parameters.

t=soundsec(0.5);
// Then we generate the sound.
s=sin(440*t)+sin(220*t)/2+sin(880*t)/2;
[nr,nc]=size(t);
s(nc/2:nc)=sin(330*t(nc/2:nc));
analyze(s);

2.11.2 auread load .au sound file

CALLING SEQUENCE :

y=auread(aufile)
y=auread(aufile,ext)
[y,Fs,bits]=auread(aufile)
[y,Fs,bits]=auread(aufile,ext)

PARAMETERS :

aufile : string (The .au extension is appended if no extension is given)

Fs
: integer, frequency sampling in Hz.
ext : string (’size’ or ’snd’) or integer (to read n samples) or 1 x 2 integer vector [n1,n2] (to read
from n1 to n2).

DESCRIPTION :
Utility function to read .au sound file. auread(aufile) loads a sound file specified by the string
aufile, returning the sampled data in y. Amplitude values are in the range [-1,+1].
Supports multi-channel data in the following formats: 8-bit mu-law, 8-, 16-, and 32-bit linear, and floating
point.
[y,Fs,bits]=auread(aufile) returns the sample rate (Fs) in Hertz and the number of bits per
sample used to encode the data in the file.
auread(aufile,n) returns the first n samples from each channel.
auread(aufile,[n1,n2]) returns samples n1 to n2.
auread(aufile,’size’) returns the size of the audio data contained in the file in place of the actual
audio data, returning the vector as [samples channels].
auread(aufile,’snd’) returns information about the sample and data as a tlist.
S EE A LSO : savewave 634, analyze 631, mapsound 633

Scilab Group April 1993 631

loadwave Scilab Function

2.11.3 auwrite writes .au sound file

CALLING SEQUENCE :

auwrite(y,aufile)
auwrite(y,Fs,aufile)
auwrite(y,Fs,bits,aufile)
auwrite(y,Fs,bits,method,aufile)

PARAMETERS :

y : real vector or matrix with entries in [-1,1].

aufile : string (The .au extension is appended if no extension is given)
Fs : integer, frequency sampling in Hz.
bits : integer, number of bits in the encoding.
method : string , ’mu’ (default) or ’linear’, encoding method.

DESCRIPTION :
Utility function to save .au sound file. auwrite(y,aufile) writes a sound file specified by the
string aufile. The data should be arranged with one channel per column. Amplitude values outside the
range [-1,+1] are ignored. Supports multi-channel data for 8-bit mu-law, and 8- and 16-bit linear formats.
auwrite(y,Fs,aufile) specifies in Fs the sample rate of the data in Hertz.
auwrite(y,Fs,bits,aufile) selects the number of bits in the encoder. Allowable settings are
bits=8 and bits=16.
auwrite(y,Fs,bits,method,aufile) allows selection of the encoding method, which can
be either ’mu’ or ’linear’. Note that mu-law files must be 8-bit. By default, method=’mu’.
S EE A LSO : auread 631, wavread 635, savewave 634, analyze 631, mapsound
633

2.11.4 lin2mu linear signal to mu-law encoding

CALLING SEQUENCE :

mu=lin2mu(y)

PARAMETERS :

y : real vector
mu : real vector

DESCRIPTION :
Utility fct: converts linear signal to mu-law encoding. mu = lin2mu(y) converts linear audio signal
amplitudes in the range -1 <= y <= 1 to mu-law in the range 0 <= mu <= 255.
S EE A LSO : mu2lin 633

2.11.5 loadwave load a sound <<wav>> file into scilab

CALLING SEQUENCE :

x=loadwave(’file-name’);
[x,y]=loadwave(’file-name’);

Scilab Group April 1993 632

playsnd Scilab Function

PARAMETERS :

x : vector
y : vector

DESCRIPTION :
Reads a .wav sound file into Scilab. If y is given, it is filled with information about the sample. (See the
message sent by loadwave).
S EE A LSO : savewave 634, analyze 631, mapsound 633

2.11.6 mapsound Plots a sound map

CALLING SEQUENCE :

mapsound (w,dt,fmin,fmax,simpl,rate)

PARAMETERS :
dt,fmin,fmax,simpl,rate: : scalars. default values dt=0.1,fmin=100,fmax=1500,simpl=1,rate=22050;
DESCRIPTION :
Plots a sound map for a sound. It does FFT at time increments dt. rate is the sampling rate. simpl
points are collected for speed reasons. fmin and fmax are used for graphic boundaries.
EXAMPLE :

// At first we create 0.5 seconds of sound parameters.

t=soundsec(0.5);
// Then we generate the sound.
s=sin(440*t)+sin(220*t)/2+sin(880*t)/2;
[nr,nc]=size(t);
s(nc/2:nc)=sin(330*t(nc/2:nc));
mapsound(s);

2.11.7 mu2lin mu-law encoding to linear signal

CALLING SEQUENCE :

mu=lin2mu(y)

PARAMETERS :

y : real vector
mu : real vector

DESCRIPTION :
Utility fct: y=mu2lin(mu) converts mu-law encoded 8-bit audio signals, stored in the range 0 <= mu
<= 255, to linear signal amplitude in the range -s < y < s where s = 32124/32768 ˜= .9803. The input mu
is often obtained using mget(...,’uc’) to read byte-encoded audio files. Translation of C program by Craig
Reese: IDA/Supercomputing Research Center Joe Campbell: Department of Defense
S EE A LSO : mu2lin 633

Scilab Group April 1993 633

sound Scilab Function

2.11.8 playsnd sound player facility

CALLING SEQUENCE :

[]=playsnd(y,fs,bits)

PARAMETERS :

y : real vector
fs : real number, sampling frequency
bits : real number, number of bits (usually 8 or 16)

DESCRIPTION :
Redirects a linear signal to /dev/audio/.
S EE A LSO : lin2mu 632

2.11.9 savewave save data into a sound <<wav>> file.

CALLING SEQUENCE :

savewave(’file-name’,x [, rate ]);

PARAMETERS :

x : vector
rate : a scalar. 22050 is the default value.

DESCRIPTION :
save x into a wav sound file. you can transform other sound files into wav file with the sox program.
EXAMPLE :

// At first we create 0.5 seconds of sound parameters.

t=soundsec(0.5);
// Then we generate the sound.
s=sin(440*t)+sin(220*t)/2+sin(880*t)/2;
[nr,nc]=size(t);
s(nc/2:nc)=sin(330*t(nc/2:nc));
savewave(TMPDIR+’/foo.wav’,s);

S EE A LSO : loadwave 632, analyze 631, mapsound 633

2.11.10 sound sound player facility

CALLING SEQUENCE :

sound(y)
sound(y,fs)
sound(y,fs,bits)

PARAMETERS :

y : real vector
fs : real number, sampling frequency

Scilab Group April 1993 634

wavwrite Scilab Function

bits : real number, number of bits (usually 8 or 16)

DESCRIPTION :
sound(y,fs) sends the signal in vector y (with sample frequency fs) out to the speaker. Values in y
are assumed to be in the range -1.0 <= y <= 1.0. Values outside that range are ugnored. Stereo sounds
are played, on platforms that support it, when y is an N-by-2 matrix. sound(y) plays the sound at
the default sample rate of 8192 Hz. sound(y,fs,nbits) plays the sound using nbits bits/sample if
possible. Most platforms support bits=8 or 16.
S EE A LSO : playsnd 634

2.11.11 wavread load .wav sound file

CALLING SEQUENCE :

y=wavread(wavfile)
y=wavread(wavfile,ext)
[y,Fs,bits]=wavread(wavfile)
[y,Fs,bits]=wavread(wavfile,ext)

PARAMETERS :

wavfile : string (The .wav extension is appended if no extension is given)

Fs : integer, frequency sampling in Hz.
ext : string (’size’) or integer (to read n samples) or 1 x 2 integer vector [n1,n2] (to read from n1 to
n2).

DESCRIPTION :
Utility function to read .wav sound file. wavread(wavfile) loads a sound file specified by the string
wavfile, returning the sampled data in y. Amplitude values are in the range [-1,+1]. Supports multi-channel
data in the following formats: 8-bit mu-law, 8-, 16-, and 32-bit linear, and floating point.
[y,Fs,bits]=wavread(wavfile) returns the sample rate (Fs) in Hertz and the number of bits per
sample used to encode the data in the file.
wavread(wavfile,n) returns the first n samples from each channel.
wavread(wavfile,[n1,n2]) returns samples n1 to n2.
read(wavfile,’size’) returns the size of the audio data contained in the file in place of the actual
audio data, returning the vector as [samples channels].
S EE A LSO : auread 631, savewave 634, analyze 631, mapsound 633

2.11.12 wavwrite writes .wav sound file

CALLING SEQUENCE :

wavwrite(y,wavfile)
wavwrite(y,Fs,wavfile)
wavwrite(y,Fs,bits,wavfile)

PARAMETERS :

y : real vector or matrix with entries in [-1,1].

wavfile : string (The .wav extension is appended if no extension is given)
Fs : integer, frequency sampling in Hz.
bits : integer, number of bits in the encoding.
method : string , ’mu’ (default) or ’linear’, encoding method.

Scilab Group April 1993 635

wavwrite Scilab Function

DESCRIPTION :
Utility function to save .wav sound file. wavwrite(y,wavfile) writes a sound file specified by
the string wavfile. The data should be arranged with one channel per column. Amplitude values outside the
range [-1,+1] are ignored. Supports multi-channel data for 8-bit mu-law, and 8- and 16-bit linear formats.
wavwrite(y,Fs,wavfile) specifies in Fs the sample rate of the data in Hertz.
wavwrite(y,Fs,bits,wavfile) selects the number of bits in the encoder. Allowable settings
are bits=8 and bits=16.
S EE A LSO : auread 631, wavread 635, savewave 634, analyze 631, mapsound
633

Scilab Group April 1993 636

wavwrite Scilab Function

2.12 Cumulative Distribution Functions, Inverses, Random variables

Scilab Group April 1993 637

cdfchi Scilab Function

2.12.1 cdfbet cumulative distribution function Beta distribution

CALLING SEQUENCE :

[P,Q]=cdfbet("PQ",X,Y,A,B)
[X,Y]=cdfbet("XY",A,B,P,Q)
[A]=cdfbet("A",B,P,Q,X,Y)
[B]=cdfbet("B",P,Q,X,Y,A)

PARAMETERS :

P,Q,X,Y,A,B : five real vectors of the same size.

P,Q (Q=1-P) : The integral from 0 to X of the beta distribution (Input range: [0, 1].)
Q : 1-P
X,Y (Y=1-X) : Upper limit of integration of beta density (Input range: [0,1], Search range: [0,1]) A,B :
The two parameters of the beta density (input range: (0, +infinity), Search range: [1D-300,1D300] )

DESCRIPTION :
Calculates any one parameter of the beta distribution given values for the others (The beta density is
proportional to tˆ(A-1) * (1-t)ˆ(B-1).
Cumulative distribution function (P) is calculated directly by code associated with the following reference.
DiDinato, A. R. and Morris, A. H. Algorithm 708: Significant Digit Computation of the Incomplete Beta
Function Ratios. ACM Trans. Math. Softw. 18 (1993), 360-373.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.2 cdfbin cumulative distribution function Binomial distribution

CALLING SEQUENCE :

[P,Q]=cdfbin("PQ",S,Xn,Pr,Ompr)
[S]=cdfbin("S",Xn,Pr,Ompr,P,Q)
[Xn]=cdfbin("Xn",Pr,Ompr,P,Q,S)
[Pr,Ompr]=cdfbin("PrOmpr",P,Q,S,Xn)

PARAMETERS :

P,Q,S,Xn,Pr,Ompr : six real vectors of the same size.

P,Q (Q=1-P) : The cumulation from 0 to S of the binomial distribution. (Probablility of S or fewer
successes in XN trials each with probability of success PR.) Input range: [0,1].
S : The number of successes observed. Input range: [0, XN] Search range: [0, XN]
Xn : The number of binomial trials. Input range: (0, +infinity). Search range: [1E-300, 1E300]
Pr,Ompr (Ompr=1-Pr) : The probability of success in each binomial trial. Input range: [0,1]. Search
range: [0,1]

DESCRIPTION :
Calculates any one parameter of the binomial distribution given values for the others.
Formula 26.5.24 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to reduce
the binomial distribution to the cumulative incomplete beta distribution.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

Scilab Group Dec 1997 638

cdfchn Scilab Function

2.12.3 cdfchi cumulative distribution function chi-square distribution

CALLING SEQUENCE :

[P,Q]=cdfchi("PQ",X,Df)
[X]=cdfchi("X",Df,P,Q);
[Df]=cdfchi("Df",P,Q,X)

PARAMETERS :

P,Q,Xn,Df : four real vectors of the same size.

P,Q (Q=1-P) : The integral from 0 to X of the chi-square distribution. Input range: [0, 1].
X : Upper limit of integration of the non-central chi-square distribution. Input range: [0, +infinity). Search
range: [0,1E300]
Df : Degrees of freedom of the chi-square distribution. Input range: (0, +infinity). Search range: [ 1E-300,
1E300]

DESCRIPTION :
Calculates any one parameter of the chi-square distribution given values for the others.
Formula 26.4.19 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to reduce
the chisqure distribution to the incomplete distribution.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.4 cdfchn cumulative distribution function non-central chi-square

distribution

CALLING SEQUENCE :

[P,Q]=cdfchn("PQ",X,Df,Pnonc)
[X]=cdfchn("X",Df,Pnonc,P,Q);
[Df]=cdfchn("Df",Pnonc,P,Q,X)
[Pnonc]=cdfchn("Pnonc",P,Q,X,Df)

PARAMETERS :

P,Q,X,Df,Pnonc : five real vectors of the same size.

P,Q (Q=1-P) : The integral from 0 to X of the non-central chi-square distribution. Input range: [0,
1-1E-16).
X : Upper limit of integration of the non-central chi-square distribution. Input range: [0, +infinity).
Search range: [0,1E300]
Df : Degrees of freedom of the non-central chi-square distribution. Input range: (0, +infinity). Search
range: [ 1E-300, 1E300]
Pnonc : Non-centrality parameter of the non-central chi-square distribution. Input range: [0, +infinity).
Search range: [0,1E4]

DESCRIPTION :
Calculates any one parameter of the non-central chi-square distribution given values for the others.
Formula 26.4.25 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to com-
pute the cumulative distribution function.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.

Scilab Group Dec 1997 639

cdffnc Scilab Function

The computation time required for this routine is proportional to the noncentrality parameter (PNONC).
Very large values of this parameter can consume immense computer resources. This is why the search
range is bounded by 10,000.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.5 cdff cumulative distribution function F distribution

CALLING SEQUENCE :

[P,Q]=cdff("PQ",F,Dfn,Dfd)
[F]=cdff("F",Dfn,Dfd,P,Q);
[Dfn]=cdff("Dfn",Dfd,P,Q,F);
[Dfd]=cdff("Dfd",P,Q,F,Dfn)

PARAMETERS :

P,Q,F,Dfn,Dfd : five real vectors of the same size.

P,Q (Q=1-P) : The integral from 0 to F of the f-density. Input range: [0,1].
F : Upper limit of integration of the f-density. Input range: [0, +infinity). Search range: [0,1E300]
Dfn : Degrees of freedom of the numerator sum of squares. Input range: (0, +infinity). Search range: [
1E-300, 1E300]
Dfd : Degrees of freedom of the denominator sum of squares. Input range: (0, +infinity). Search range: [
1E-300, 1E300]

DESCRIPTION :
Calculates any one parameter of the F distribution given values for the others.
Formula 26.6.2 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to reduce
the computation of the cumulative distribution function for the F variate to that of an incomplete beta.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
The value of the cumulative F distribution is not necessarily monotone in either degrees of freedom. There
thus may be two values that provide a given CDF value. This routine assumes monotonicity and will find
an arbitrary one of the two values.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.6 cdffnc cumulative distribution function non-central f-distribution

CALLING SEQUENCE :

[P,Q]=cdffnc("PQ",F,Dfn,Dfd,Pnonc)
[F]=cdffnc("F",Dfn,Dfd,Pnonc,P,Q);
[Dfn]=cdffnc("Dfn",Dfd,Pnonc,P,Q,F);
[Dfd]=cdffnc("Dfd",Pnonc,P,Q,F,Dfn)
[Pnonc]=cdffnc("Pnonc",P,Q,F,Dfn,Dfd);

PARAMETERS :

P,Q,F,Dfn,Dfd,Pnonc : six real vectors of the same size.

P,Q (Q=1-P) The integral from 0 to F of the non-central f-density. Input range: [0,1-1E-16).
F : Upper limit of integration of the non-central f-density. Input range: [0, +infinity). Search range:
[0,1E300]

Scilab Group Dec 1997 640

cdfnbn Scilab Function

Dfn : Degrees of freedom of the numerator sum of squares. Input range: (0, +infinity). Search range: [
1E-300, 1E300]
Dfd : Degrees of freedom of the denominator sum of squares. Must be in range: (0, +infinity). Input
range: (0, +infinity). Search range: [ 1E-300, 1E300]
Pnonc : The non-centrality parameter Input range: [0,infinity) Search range: [0,1E4]

DESCRIPTION :
Calculates any one parameter of the Non-central F distribution given values for the others.
Formula 26.6.20 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to com-
pute the cumulative distribution function.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
The computation time required for this routine is proportional to the noncentrality parameter (PNONC).
Very large values of this parameter can consume immense computer resources. This is why the search
range is bounded by 10,000.
The value of the cumulative noncentral F distribution is not necessarily monotone in either degrees of
freedom. There thus may be two values that provide a given CDF value. This routine assumes monotonicity
and will find an arbitrary one of the two values.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.7 cdfgam cumulative distribution function gamma distribution

CALLING SEQUENCE :

[P,Q]=cdfgam("PQ",X,Shape,Scale)
[X]=cdfgam("X",Shape,Scale,P,Q)
[Shape]=cdfgam("Shape",Scale,P,Q,X)
[Scale]=cdfgam("Scale",P,Q,X,Shape)

PARAMETERS :

P,Q,X,Shape,Scale : five real vectors of the same size.

P,Q (Q=1-P) The integral from 0 to X of the gamma density. Input range: [0,1].
X : The upper limit of integration of the gamma density. Input range: [0, +infinity). Search range:
[0,1E300]
Shape : The shape parameter of the gamma density. Input range: (0, +infinity). Search range: [1E-
300,1E300]
Scale : The scale parameter of the gamma density. Input range: (0, +infinity). Search range: (1E-
300,1E300]

DESCRIPTION :
Calculates any one parameter of the gamma distribution given values for the others.
Cumulative distribution function (P) is calculated directly by the code associated with:
DiDinato, A. R. and Morris, A. H. Computation of the incomplete gamma function ratios and their inverse.
ACM Trans. Math. Softw. 12 (1986), 377-393.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
The gamma density is proportional to T**(SHAPE - 1) * EXP(- SCALE * T)
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

Scilab Group Dec 1997 641

cdfnor Scilab Function

2.12.8 cdfnbn cumulative distribution function negative binomial distribution

CALLING SEQUENCE :

[P,Q]=cdfnbn("PQ",S,Xn,Pr,Ompr)
[S]=cdfnbn("S",Xn,Pr,Ompr,P,Q)
[Xn]=cdfnbn("Xn",Pr,Ompr,P,Q,S)
[Pr,Ompr]=cdfnbn("PrOmpr",P,Q,S,Xn)

PARAMETERS :

P,Q,S,Xn,Pr,Ompr : six real vectors of the same size.

P,Q (Q=1-P) : The cumulation from 0 to S of the negative binomial distribution. Input range: [0,1].
S : The upper limit of cumulation of the binomial distribution. There are F or fewer failures before the
XNth success. Input range: [0, +infinity). Search range: [0, 1E300]
Xn : The number of successes. Input range: [0, +infinity). Search range: [0, 1E300]
Pr : The probability of success in each binomial trial. Input range: [0,1]. Search range: [0,1].
Ompr : 1-PR Input range: [0,1]. Search range: [0,1] PR + OMPR = 1.0

DESCRIPTION :
Calculates any one parameter of the negative binomial distribution given values for the others.
The cumulative negative binomial distribution returns the probability that there will be F or fewer failures
before the XNth success in binomial trials each of which has probability of success PR.
The individual term of the negative binomial is the probability of S failures before XN successes and is
Choose( S, XN+S-1 ) * PRˆ(XN) * (1-PR)ˆS
Formula 26.5.26 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to reduce
calculation of the cumulative distribution function to that of an incomplete beta.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.9 cdfnor cumulative distribution function normal distribution

CALLING SEQUENCE :

[P,Q]=cdfnor("PQ",X,Mean,Std)
[X]=cdfnor("X",Mean,Std,P,Q)
[Mean]=cdfnor("Mean",Std,P,Q,X)
[Std]=cdfnor("Std",P,Q,X,Mean)

PARAMETERS :

P,Q,X,Mean,Std : six real vectors of the same size.

P,Q (Q=1-P) : The integral from -infinity to X of the normal density. Input range: (0,1].
X :Upper limit of integration of the normal-density. Input range: ( -infinity, +infinity)
Mean : The mean of the normal density. Input range: (-infinity, +infinity)
Sd : Standard Deviation of the normal density. Input range: (0, +infinity).

DESCRIPTION :
Calculates any one parameter of the normal distribution given values for the others.
A slightly modified version of ANORM from Cody, W.D. (1993). ”ALGORITHM 715: SPECFUN - A
Portabel FORTRAN Package of Special Function Routines and Test Drivers” acm Transactions on Mathe-
matical Software. 19, 22-32. is used to calulate the cumulative standard normal distribution.

Scilab Group Dec 1997 642

grand Scilab Function

The rational functions from pages 90-95 of Kennedy and Gentle, Statistical Computing, Marcel Dekker,
NY, 1980 are used as starting values to Newton’s Iterations which compute the inverse standard normal.
Therefore no searches are necessary for any parameter.
For X < -15, the asymptotic expansion for the normal is used as the starting value in finding the inverse
standard normal. This is formula 26.2.12 of Abramowitz and Stegun.
The normal density is proportional to exp( - 0.5 * (( X - MEAN)/SD)**2)
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.10 cdfpoi cumulative distribution function poisson distribution

CALLING SEQUENCE :
[P,Q]=cdfpoi("PQ",S,Xlam)
[S]=cdfpoi("S",Xlam,P,Q)
[Xlam]=cdfpoi("Xlam",P,Q,S);
PARAMETERS :
P,Q,S,Xlam : four real vectors of the same size.
P,Q (Q=1-P) : The cumulation from 0 to S of the poisson density. Input range: [0,1].
S :Upper limit of cumulation of the Poisson. Input range: [0, +infinity). Search range: [0,1E300]
Xlam : Mean of the Poisson distribution. Input range: [0, +infinity). Search range: [0,1E300]
DESCRIPTION :
Calculates any one parameter of the Poisson distribution given values for the others.
Formula 26.4.21 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to
reduce the computation of the cumulative distribution function to that of computing a chi-square, hence an
incomplete gamma function.
Cumulative distribution function (P) is calculated directly. Computation of other parameters involve a
seach for a value that produces the desired value of P. The search relies on the monotinicity of P with the
other parameter.
From DCDFLIB: Library of Fortran Routines for Cumulative Distribution Functions, Inverses, and Other
Parameters (February, 1994) Barry W. Brown, James Lovato and Kathy Russell. The University of Texas.

2.12.11 cdft cumulative distribution function Student’s T distribution

CALLING SEQUENCE :
[P,Q]=cdft("PQ",T,Df)
[T]=cdft("T",Df,P,Q)
[Df]=cdft("Df",P,Q,T)
PARAMETERS :
P,Q,T,Df : six real vectors of the same size.
P,Q (Q=1-P) : The integral from -infinity to t of the t-density. Input range: (0,1].
T : Upper limit of integration of the t-density. Input range: ( -infinity, +infinity). Search range: [ -1E150,
1E150 ]
DF: Degrees of freedom of the t-distribution. Input range: (0 , +infinity). Search range: [1e-300, 1E10]
DESCRIPTION :
Calculates any one parameter of the T distribution given values for the others.
Formula 26.5.27 of Abramowitz and Stegun, Handbook of Mathematical Functions (1966) is used to reduce
the computation of the cumulative distribution function to that of an incomplete beta.
Computation of other parameters involve a seach for a value that produces the desired value of P. The search
relies on the monotinicity of P with the other parameter.

Scilab Group Dec 1997 643

grand Scilab Function

2.12.12 grand Random number generator

CALLING SEQUENCE :

Y=grand(m,n,’option’ [,arg1,..,argn])
Y=grand(x,’option’ [,arg1,....,argn])
Y=grand(’option’)
Y=grand(’option’ [,arg1,....,argn])

PARAMETERS :

grand(’advnst’,K) : Advances the state of the current generator by 2ˆK values and resets the initial
seed to that value.
Y=grand(m,n,’bet’,A,B), Y=grand(x,’bet’,A,B) : Returns random deviates from the
beta distribution with parameters A and B. The density of the beta is xˆ(a-1) * (1-x)ˆ(b-1)
/ B(a,b) for 0 < x < 1 Method: R. C. H. Cheng Generating Beta Variables with Noninte-
gral Shape Parameters Communications of the ACM, 21:317-322 (1978) (Algorithms BB and BC)
Y=grand(m,n,’bin’,N,P), Y=grand(x,’bin’,N,P) : Generates random deviates from a
binomial distribution whose number of trials is N and whose probability of an event in each trial is P.
N is the number of trials in the binomial distribution from which a random deviate is to be generated.
P is the probability of an event in each trial of the binomial distribution from which a random deviate
is to be generated. (0.0 <= P <= 1.0)
Method: This is algorithm BTPE from: Kachitvichyanukul, V. and Schmeiser, B. W. Binomial Ran-
dom Variate Generation. Communications of the ACM, 31, 2 (February, 1988) 216.
Y=grand(m,n,’chi’,Df), Y=grand(x,’chi’,Df) : Generates random deviates from the dis-
tribution of a chisquare with DF degrees of freedom random variable. Uses relation between chisquare
and gamma.
Y=grand(m,n,’def’), Y=grand(x,’def’) : Returns random floating point numbers from a
uniform distribution over 0 - 1 (endpoints of this interval are not returned) using the current generator
Y=grand(m,n,’exp’,Av), Y=grand(x,’exp’,Av) : Generates random deviates from an ex-
ponential distribution with mean AV. For details see: Ahrens, J.H. and Dieter, U. Computer Methods
for Sampling From the Exponential and Normal Distributions. Comm. ACM, 15,10 (Oct. 1972), 873
- 882.
Y=grand(m,n,’f’,Dfn,Dfd), Y=grand(x,’f’,Dfn,Dfd) : Generates random deviates from
the F (variance ratio) distribution with DFN degrees of freedom in the numerator and DFD degrees
of freedom in the denominator. Method: Directly generates ratio of chisquare variates
Y=grand(m,n,’gam’,Shape,Scale), Y=grand(x,’gam’,Shape,Scale) : Generates ran-
dom deviates from the gamma distribution whose density is (Scale**Shape)/Gamma(Shape) * X**(Shape-
1) * Exp(-Scale*X) For details see:
(Case R >= 1.0) : Ahrens, J.H. and Dieter, U. Generating Gamma Variates by a Modified Rejection
Technique. Comm. ACM, 25,1 (Jan. 1982), 47 - 54. Algorithm GD
(Case 0.0 < R < 1.0) : Ahrens, J.H. and Dieter, U. Computer Methods for Sampling from Gamma,
Beta, Poisson and Binomial Distributions. Computing, 12 (1974), 223-246/ Adapted algorithm GS.
G=grand(’getcgn’) : Returns in G the number of the current random number generator (1..32)
Sd=grand(’getsd’) : Returns the value of two integer seeds of the current generator Sd=[sd1,sd2]
grand(’initgn’,I) : Reinitializes the state of the current generator
I = -1 : sets the state to its initial seed
I = 0 : sets the state to its last (previous) seed
I = 1 : sets the state to a new seed 2ˆw values from its last seed
Y=grand(m,n,’lgi’),Y=grand(x,’lgi’) : Returns random integers following a uniform dis-
tribution over (1, 2147483562) using the current generator.
Y=grand(M,’mn’,Mean,Cov) :Generate M Multivariate Normal random deviates Mean must be a
Nx1 matrix and Cov a NxN positive definite matrix Y is a NxM matrix

Scilab Group Dec 1997 644

grand Scilab Function

Y=grand(n,’markov’,P,x0) Generates n successive states of a Markov chain described by the

transition matrix P. Initial state is given by x0. If x0 is a matrix of size m=size(x0,’*’) then
Y is a matrix of size m*n. Y(i,:) is the sample path obtained from initial state x0(i).
Y=grand(M,’mul’,N,P) Generate M observations from the Multinomial distribution. N is the num-
ber of categories, P is the vector of probabilities. P(i) is the probability that an event will be classified
into category i. Thus, P(i) must be [0,1]. P is of size N-1, (the probability of category N is 1-sum(P).
Y(:,i) is an observation from multinomial distribution. All Y(:,i) will be nonnegative and their sum
will be N. Y is of size NxM
Algorithm from page 559 of Devroye, Luc. Non-Uniform Random Variate Generation. Springer-
Verlag, New York, 1986.
Y=grand(m,n,’nbn’,N,P),Y=grand(x,’nbn’,N,P) : Generates random deviates from a neg-
ative binomial distribution. N is the required number of events (N > 0). P is The probability of an
event during a Bernoulli trial (0.0 < P < 1.0).
Method: Algorithm from page 480 of Devroye, Luc. Non-Uniform Random Variate Generation.
Springer-Verlag, New York, 1986.
Y=grand(m,n,’nch’,Df,Xnon), Y=grand(x,’nch’,Df,Xnon) : Generates random deviates
from the distribution of a noncentral chisquare with DF degrees of freedom and noncentrality param-
eter XNONC. DF is he degrees of freedom of the chisquare (Must be >= 1.0) XNON the Noncen-
trality parameter of the chisquare (Must be >= 0.0) Uses fact that noncentral chisquare is the sum
of a chisquare deviate with DF-1 degrees of freedom plus the square of a normal deviate with mean
XNONand standard deviation 1.
Y=grand(m,n,’nf’,Dfn,Dfd,Xnon), Y=grand(x,’nf’,Dfn,Dfd,Xnon) : Generates ran-
dom deviates from the noncentral F (variance ratio) distribution with DFN degrees of freedom in the
numerator, and DFD degrees of freedom in the denominator, and noncentrality parameter XNONC.
DFN is the numerator degrees of freedom (Must be >= 1.0) DFD is the Denominator degrees of
freedom (Must be positive) XNON is the Noncentrality parameter (Must be nonnegative) Method:
Directly generates ratio of noncentral numerator chisquare variate to central denominator chisquare
variate.
Y=grand(m,n,’nor’,Av,Sd), Y=grand(x,’nor’,Av,Sd) : Generates random deviates from
a normal distribution with mean, AV, and standard deviation, SD. AV is the mean of the normal
distribution. SD is the standard deviation of the normal distribution. For details see: Ahrens, J.H.
and Dieter, U. Extensions of Forsythe’s Method for Random Sampling from the Normal Distribution.
Math. Comput., 27,124 (Oct. 1973), 927 - 937.
Sd=grand(’phr2sd’,’string’) : Uses a phrase (character string) to generate two seeds for the
RGN random number generator. Sd is an integer vector of size 2 Sd=[Sd1,Sd2]
Y=grand(m,n,’poi’,mu), Y=grand(x,’poi’,mu) : Generates random deviates from a Pois-
son distribution with mean MU. MU is the mean of the Poisson distribution from which random
deviates are to be generated (MU >= 0.0). For details see: Ahrens, J.H. and Dieter, U. Computer
Generation of Poisson Deviates From Modified Normal Distributions. ACM Trans. Math. Software,
8, 2 (June 1982),163-179
Mat=grand(M,’prm’,vect) : Generate M random permutation of column vector vect. Mat is of
size (size(vect)xM)
grand(’setall’,ISEED1,ISEED2) : Sets the initial seed of generator 1 to ISEED1 and ISEED2.
The initial seeds of the other generators are set accordingly, and all generators states are set to these
seeds.
grand(’setcgn’,G) : Sets the current generator to G. All references to a generator are to the current
generator.
grand(’setsd’,ISEED1,ISEED2) : Resets the initial seed and state of generator g to ISEED1 and
ISEED2. The seeds and states of the other generators remain unchanged.
Y=grand(m,n,’uin’,Low,High), Y=grand(x,’uin’,Low,High) : Generates integers uni-
formly distributed between LOW and HIGH. Low is the low bound (inclusive) on integer value to be
generated. High is the high bound (inclusive) on integer value to be generated. If (HIGH-LOW) >
2,147,483,561 prints error message
Y=grand(m,n,’unf’,Low,High),Y=grand(x,’unf’,Low,High) : Generates reals uniformly

Scilab Group Dec 1997 645

grand Scilab Function

distributed between LOW and HIGH. Low is the low bound (exclusive) on real value to be generated
High is the high bound (exclusive) on real value to be generated

DESCRIPTION :
Interface fo Library of Fortran Routines for Random Number Generation (Barry W. Brown and James
Lovato, Department of Biomathematics, The University of Texas, Houston)
This set of programs contains 32 virtual random number generators. Each generator can provide
1,048,576 blocks of numbers, and each block is of length 1,073,741,824. Any generator can be set to
the beginning or end of the current block or to its starting value. The methods are from the paper cited
immediately below, and most of the code is a transliteration from the Pascal of the paper into Fortran.
P. L’Ecuyer and S. Cote. Implementing a Random Number Package with Splitting Facilities. ACM
Transactions on Mathematical Software 17:1, pp 98-111.
Most users won’t need the sophisticated capabilities of this package, and will desire a single generator.
This single generator (which will have a non-repeating length of 2.3 X 10ˆ18 numbers) is the default. In
order to accommodate this use, the concept of the current generator is added to those of the cited paper;
references to a generator are always to the current generator. The current generator is initially generator
number 1; it can be changed by ’setcgn’, and the ordinal number of the current generator can be obtained
from ’getcgn’.
The user of the default can set the initial values of the two integer seeds with ’setall’. If the user does
not set the seeds, the random number generation will use the default values, 1234567890 and 123456789.
The values of the current seeds can be achieved by a call to ’getsd’. Random number may be obtained as
integers ranging from 1 to a large integer by reference to option ’lgi’ or as a floating point number between
0 and 1 by a reference to option ’def’. These are the only routines needed by a user desiring a single stream
of random numbers.
CONCEPTS :
A stream of pseudo-random numbers is a sequence, each member of which can be obtained either as an
integer in the range 1..2,147,483,563 or as a floating point number in the range [0..1]. The user is in charge
of which representation is desired.
The method contains an algorithm for generating a stream with a very long period, 2.3 X 10ˆ18. This
stream in partitioned into G (=32) virtual generators. Each virtual generator contains 2ˆ20 (=1,048,576)
blocks of non-overlapping random numbers. Each block is 2ˆ30 (=1,073,741,824) in length.
The state of a generator is determined by two integers called seeds. The seeds can be initialized by the
user; the initial values of the first must lie between 1 and 2,147,483,562, that of the second between 1 and
2,147,483,398. Each time a number is generated, the values of the seeds change. Three values of seeds
are remembered by the generators at all times: the value with which the generator was initialized, the value
at the beginning of the current block, and the value at the beginning of the next block. The seeds of any
generator can be set to any of these three values at any time.
Of the 32 virtual generators, exactly one will be the current generator, i.e., that one will be used to
generate values for ’lgi’ and ’def’. Initially, the current generator is set to number one. The current generator
may be changed by calling ’setcgn’, and the number of the current generator can be obtained using ’getcgn’.

TEST EXAMPLE :
An example of the need for these capabilities is as follows. Two statistical techniques are being compared
on data of different sizes. The first technique uses bootstrapping and is thought to be as accurate using less
data than the second method which employs only brute force.
For the first method, a data set of size uniformly distributed between 25 and 50 will be generated. Then
the data set of the specified size will be generated and alalyzed. The second method will choose a data set
size between 100 and 200, generate the data and alalyze it. This process will be repeated 1000 times.
For variance reduction, we want the random numbers used in the two methods to be the same for each
of the 1000 comparisons. But method two will use more random numbers than method one and without
this package, synchronization might be difficult.
With the package, it is a snap. Use generator 1 to obtain the sample size for method one and generator 2
to obtain the data. Then reset the state to the beginning of the current block and do the same for the second
method. This assures that the initial data for method two is that used by method one. When both have
concluded, advance the block for both generators.

Scilab Group Dec 1997 646

grand Scilab Function

INTERFACE :
A random number is obtained either as a random integer between 1 and 2,147,483,562 by using option
’lgi’ (large integer) or as a random floating point number between 0 and 1 by using option ’def’.
The seed of the first generator can be set by using option ’setall’; the values of the seeds of the other 31
generators are calculated from this value.
The number of the current generator can be set by using option ’setcgn’ The number of the current
generator can be obtained by using option ’getcgn’.

Scilab Group Dec 1997 647

grand Scilab Function

2.13 TCL/Tk interface

Scilab Group Dec 1997 648

TK EvalFile Scilab Function

2.13.1 ScilabEval tcl instruction : Evaluate a string with scilab interpreter

CALLING SEQUENCE :
ScilabEval str
PARAMETERS :

o str : tcl string character Contains the string to evaluate with the current scilab interpreter.

DESCRIPTION :
This function must be called in a tcl/tk script executed from scilab. It allows to associate scilab actions to
tcl/tk widgets (graphic objects). The string str is put in the scilab interpreter buffer which then evaluates it.
This has in general no border effect in the tcl/tk interpreter.
EXAMPLE (TCL/TK SCRIPT) :

//Create a Tcl script using ScilabEval

tcl_script=[’toplevel .w1’
’button .w1.b -text ""Click here to see a new Scilab Graphic Window""\’
’ -command {ScilabEval ""xselect()""}’
’pack .w1.b ’]
mputl(tcl_script,TMPDIR+’/test.tcl’)
// Execute the tcl script
TK_EvalFile(TMPDIR+’/test.tcl’)

S EE A LSO : TK_EvalFile 649, TK_EvalStr 650, TK_GetVar 651, TK_Setvar ??

AUTHOR : Bertrand Guiheneuf

2.13.2 TK EvalFile Reads and evaluate a tcl/tk file

CALLING SEQUENCE :

TK_EvalFile(filename)

PARAMETERS :

filename : string character Contains the name of the file to read and evaluate.

DESCRIPTION :
With this routine, one can read and evaluate the content of a file containing tcl/tk scripts. This allows to
create powerful tk interfaces.
The filename might be relative or absolute.
ADVANTAGES AND DRAWBACKS OF THIS FUNCTIONALITY :
This routines allows to use directly tcl/tk scripts. This thus allows, for instance to use Interface Builders
such as SpecTcl to design the interface. The interfaces built directly with tcl/tk scripts are much faster
than th ones built with the Scilab Graphic Object library provided with tksci (see uicontrol for example).
Indeed, those Objects are warpings around tk graphic widgets. Nevertheless, this way of creating graphic
user interface sould only be used when one aims at adressing directly specific tk/tcl features. There are two
main reasons for this. First of all, there is no simple way to manipulate scilab objects from within a tcl/tk
script. Thus, the interface designer has to write two sets of callbacks routines. One to describe the changes
occuring in the interface when the user acts on the widgets. The second set of call routines will perform the
(pure) scilab reactions to the user actions.
Here is an example: Suppose you design a scrollbar corresponding to a spline tension value. You want the
spline to be displayed in a graphic windows and updated each time the user moves the scrollbar. At the
same time, you want the value of this tension parameter to be displayed within the Interface. You will have

Fractales Group 02 June 1998 649

TK GetVar Scilab Function

to write a first tcl/tk (callback) function which will be automatically called by the tk scrollbar (’-command’
option). This callback function will update the displayed value of the parameter in the interface and will
then call the scilab routine (’ScilabEval’ command) to update the graph.
REMARKS ON THE TCL/TK SCRIPT STYLE :
Because Scilab manages the tcl/tk events, it creates the root window ”.”, this window should not be de-
stroyed nor directly used by your tcl/tk scripts. You should thus always create your own toplevel windows.
Moreover, since this module was written at a time when namespaces didn’t exist, some variables defined by
scilab tcl/tk scripts could bother your code.
AUTHOR : Bertrand Guiheneuf
EXAMPLE :

TK_EvalFile(SCI+’/demos/tk/puzzle’)

SEE ALSO :
ScilabEval, TK EvalStr, TK GetVar, TK Setvar

2.13.3 TK EvalStr Evaluate a string whithin the tcl/tk interpreter

CALLING SEQUENCE :

TK_EvalStr(str)

PARAMETERS :

str : string or vector of strings, contains the tcl/tk instructions

DESCRIPTION :
This routine allows to evaluate tcl/tk instructions with the tcl/tk interpreter launched with scilab.
When tcl/tk support is enabled in scilab, you can evaluate tcl/tk expression from scilab interpreter. In
fact, scilab launches a slave tcl/tk interpreter. The scilab instruction TK EvalStr() can be used to evaluate
expression without having to write a tcl/tk in a separated file (this is done using TK EvalFile).
AUTHOR : Bertrand Guiheneuf
EXAMPLE :

//with one call

TK_EvalStr([’toplevel .foo1’
’label .foo1.l -text ""TK married Scilab !!!""’
’pack .foo1.l’
’button .foo1.b -text close -command {destroy .foo1}’
’pack .foo1.b’])

//step by step (debugging)

TK_EvalStr(’toplevel .foo2’);
// creates a toplevel TK window.
TK_EvalStr(’label .foo2.l -text ""TK married Scilab !!!""’);
// create a static label
TK_EvalStr(’pack .foo2.l’);
// pack the label widget. It appears on the screen.
text=’button .foo2.b -text close -command {destroy .foo2}’;
TK_EvalStr(text);
TK_EvalStr(’pack .foo2.b’);

S EE A LSO : ScilabEval 649, TK_EvalFile 649, TK_GetVar 651, TK_Setvar ??

Fractales Group 04 June 1998 650

close Scilab Function

2.13.4 TK GetVar Get a tcl/tk variable value

CALLING SEQUENCE :
value=TK SetVar(varname)
PARAMETERS :
o varname : string character Contains the name of the tcl/tk variable.
o value : string character Contains the value of the tcl/tk variable ’varname’.
DESCRIPTION :
When tcl/tk support is enabled in scilab, this routine can be used to retreive the value of a tcl/tk variable.
EXAMPLE :
TK_EvalStr(’toplevel .tst1’);
// creates a toplevel TK window.
TK_EvalStr(’entry .tst1.e -textvariable tvar’);
// create an editable entry
TK_EvalStr(’set tvar foobar’);
// set the entry value
TK_EvalStr(’pack .tst1.e’);
// pack the entry widget. It appears on the screen.
text=TK_GetVar(’tvar’)
// retrieve the variable value
// change the entry text and repeat the last command ...

S EE A LSO : ScilabEval 649, TK_EvalFile 649, TK_EvalStr 650, TK_SetVar 651

AUTHOR : Bertrand Guiheneuf

2.13.5 TK SetVar Set a tcl/tk variable value

CALLING SEQUENCE :
TK_SetVar(varname, value)
PARAMETERS :
varname : string character Contains the name of the tcl/tk variable to set.
value : string character Contains the value to set up in the tcl/tk variable
DESCRIPTION :
This routine allows to set a variable within the tcl/tk interpreter. When tcl/tk support is enabled in scilab,
this routine can be used to set up the value of a tcl/tk variable. This can be useful to change some value in
the tcl/tk without having to build a tcl/tk instruction (and use TK EvalStr).
EXAMPLE :
TK_EvalStr(’toplevel .tst2’);
// creates a toplevel TK window.
TK_EvalStr(’label .tst2.l -textvariable tvar’);
// create a static label
TK_EvalStr(’pack .tst2.l’);
// pack the label widget. It appears on the screen.
TK_SetVar(’tvar’,’This text has been set directly within scilab’);

AUTHOR : Bertrand Guiheneuf

SEE ALSO :
ScilabEval, TK EvalFile, TK EvalStr, TK GetVar

Fractales Group 04 June 1998 651

figure Scilab Function

2.13.6 close close a figure

CALLING SEQUENCE :
close(h)
PARAMETERS :
o h : integer Handle of the window to close
DESCRIPTION :
This routine close a tksci figure (toplevel window). If a handle is given, the figure corresponding to this
handle is closed. Otherwise, the current (active) figure is closed.
EXAMPLE :
h=figure();
// creates figure number 1.
uicontrol( h, ’style’,’text’, ...
’string’,’scilab is great’, ...
’position’,[50 70 100 100], ...
’fontsize’,15);
// put a clever text in figure 1
figure();
// create figure 2
uicontrol( ’style’,’text’, ...
’string’,’Really great’, ’position’,[50 70 100 100], ’fontsize’,15);
// put a text in figure 2
close();
// close the current graphic window (ie fig. 2)
close(h);
// close figure 1

S EE A LSO : figure 652, gcf 654

AUTHOR : Bertrand Guiheneuf

2.13.7 figure create a figure

CALLING SEQUENCE :
hn=figure(h, [prop1, value1 ...])
PARAMETERS :

o h : integer Handle of the window to create. If not specified, the first free handle is used
o propf1, 2 ...g : character string name of a property to set
o valf1, 2 ...g : scilab object value to give to the corresponding property
o hn : handle of the newly created window

DESCRIPTION :

This routine creates a tksci figure (toplevel window). If a handle is given, the figure corresponding to
this handle is created . Otherwise, the window is created with the first free handle, that is the lowest integer
not already used by a window. The property named ’position’ allows to control the geometrical aspect of
the control. It is a [ 1,4] real vector x y w h where the letters stand for the x location of the left bottom
corner, the y location of the left bottom corner, the width and the height of the uicontrol.
One can also set this property by giving a string where the fields are separated by a ’j’, ie ”xjyjwjh”.
EXAMPLE :

Fractales Group 04 June 1998 652

gcf Scilab Function

h=figure(3);
// creates figure number 1.
uicontrol( h, ’style’,’text’, ...
’string’,’This is a figure’, ...
’position’,[50 70 100 100], ...
’fontsize’,15);
// put a text in figure 3
figure();
// create figure 1
uicontrol( ’style’,’text’, ...
’string’,’Another figure’, ...
’position’,[50 70 100 100], ...
’fontsize’,15);
// put a text in figure 1
close();
// close the current graphic window (ie fig. 1)
close(h);
// close figure 3

S EE A LSO : close 652, gcf 654

AUTHOR : Bertrand Guiheneuf

2.13.8 findobj find an object with specified property

CALLING SEQUENCE :
h=findobj(prop,value)
PARAMETERS :

o prop : string character Name of the property to test.

o value : string character specify the value the tested propoerty should be equal to. o h : handle of the
found object.

DESCRIPTION :
This routine is currentlyt used to find objects knowing their ’tag’ property. It returns handle of the first
found object which property ’prop’ is equal to ’value’. If such an object does not exist, the function returns
a void matrix.
EXAMPLE :

h=figure();
// creates figure number 1.
uicontrol( h, ’style’,’text’, ...
’string’,’This is a figure’, ...
’position’,[50 70 100 100], ...
’fontsize’,15, ...
’tag’,’Alabel’);
// put a text in figure 1
lab=findobj(’tag’,’Alabel’);
// find the object which ’tag’ value is ’Alabel’
disp(’the handle of the label is ’+string(lab));
close();

S EE A LSO : uicontrol 655, uimenu 657, set 655, get 654

AUTHOR : Bertrand Guiheneuf

Fractales Group 04 June 1998 653

get Scilab Function

2.13.9 gcf gets the current active tksci figure

CALLING SEQUENCE :
h=gcf()
PARAMETERS :

o h : handle of the current figure.

DESCRIPTION :
The current figure is the last created (and still existent) figure.
EXAMPLE :

figure(5);
figure();
figure();
gcf()
// returns 2
close(gcf());
// close figure 2
gcf()
// returns 1
close(1);
gcf()
// returns 5
close(5);

S EE A LSO : figure 652, close 652

AUTHOR : Bertrand Guiheneuf

2.13.10 get Retrieve a property value from an User Interface object.

CALLING SEQUENCE :
val=get(h,prop)
PARAMETERS :

o h : integer the handle of the object to retrieve a property

o Bprop : character string name of the property
o val : scilab object value of the property

DESCRIPTION :
This routine can be used to retrieve a specified property from a GUI object. Property name are character
strings like ’style’, ’position’ .... This routine returns the value associated to the specified property. Ob-
viously, the type of the returned object depends on the property one aims at querying. For example, the
’style’ property which represents the kind of Object the UI control is (ie button, label, list, ..... ) will be
represented as a string. On the contrary, the ’position’ property, which represents the geometrical aspect of
the UI control, will be coded as a [1,4] vector.
EXAMPLE :

h=uicontrol(’string’, ’Button’);
// Opens a window with a button.
p=get(h,’position’);
// get the geometric qspect of the button
disp(’Button width: ’ + string(p(3)));

Fractales Group 04 June 1998 654

uicontrol Scilab Function

// print the width of the button

close();
// close figure

S EE A LSO : uicontrol 655, uimenu 657, set 655

AUTHOR : Bertrand Guiheneuf

2.13.11 set set a property value of a User Interface object.

CALLING SEQUENCE :
get(h,prop,val)
PARAMETERS :

o h : integer the handle of the object which to set a property up

o prop : character string name of the property
o val : scilab object value to give to the property

DESCRIPTION :
This routine can be used to set a GUI object specified property. Property name are character strings like
’style’, ’position’ .... The type of the value field depends on the property one aims at setting. For example,
the ’style’ property which represents the kind of Object the UI control is (ie button, label, list, ..... ) will be
represented as a string. On the contrary, the ’position’ property, which represents the geometrical aspect of
the UI control, will be coded as a [1,4] vector.
EXAMPLE :

h=uicontrol(’string’, ’Button’);
// Opens a window with a button.
set(h,’position’,[ 50 50 100 100]);
// set the geometric aspect of the button
close();
// close figure

S EE A LSO : uicontrol 655, uimenu 657, get 654

AUTHOR : Bertrand Guiheneuf

2.13.12 uicontrol create a Graphic User Interface object

CALLING SEQUENCE :

h=uicontrol([prop1,val1] [,prop2, val2] ...)

h=uicontrol(f,[prop1, val1] [,prop2, val2] ...)

PARAMETERS :

o f : integer handle of the figure which will contain the control

o propf1, 2 ...g : character string name of a property to set
o valf1, 2 ...g : scilab object value to give to the corresponding property
o h : handle of the created object

Fractales Group 04 June 1998 655

uicontrol Scilab Function

DESCRIPTION :
this routine creates an object in a figure. If the handle of the figure is given (as the first parameter), the
uicontrol is created in this figure. If no handle is given, the uicontrol is created in the current figure (
which may be obtained with a call to gcf() ). If there is no current figure, then one is created before the
creation of the uicontrol. Then when the control is created, the properties given as parameters are set with
the coresponding values. It is equivalent to create the uicontrol, and then set its properties with the set()
command. Nevertheless, it generally more efficient to set the properties in the call to uicontrol(). This is
particularly true coincerning the ’style’ field. Indeed, the default value for this property is ’pushbutton’. So
if you do not set it at creation time, a button will be created, and will be transformed to another uicontrol
when you call the get(h,’style’, ... ) instruction. Scilab and all the graphic objects communicate through
the property mechanism. Thus, to create adapted uicontrol, one has to know the use of the property fields.
Those are descibed under:
PROPERTIES :

BackgroundColor [1,3] real vector or string Background color of the uicontrol. A color is specified as
Red, Green and Blue values. Those values are real in [ 0,1]. The color can be given as a real vector,
ie [R,G,B] or a string where each value is separated by a j, ie ”RjGjB”
callback string String evaluated by the scilab interpreter when an usicontrol is activated. (for example
when you click on a button).
fontangle string : f’normal’g j italic j oblique For a control containing some text, this property sets the
slant of the font.
fontsize real For a control containing some text, this property sets the size of the font in FontUnits.
fontunits string : fpointsg j pixels j normalized For a control containing some text, this property sets
the units with which the fontsize is specified.
fontweight string : light j fnormalg j demi j bold For a control containing some text, this property sets
the weight of the used font
ListboxTop integer For a ListBox, this property tells which item of the list appears on the first line of
the visible area of the list.
Max scalar Specifies the largest value the ’value’ property can be set to. It has however differnet meaning
on each uicontrol:
o Check Boxes : Max is the value the ’value’ property take when control is checked
o Silders : Maximinum value of the slider
o List boxes : if (Max-Min)>1 the list allows multiple selection, Otherwise not.
Min scalar Specifies the lowest value the ’value’ property can be set to. It has however differnet meaning
on each uicontrol:
o Check Boxes : Min is the value the ’value’ property take when control is unchecked
o Silders : Mininum value of the slider
o List boxes : if (Max-Min)>1 the list allows multiple selection, Otherwise not.
Parent integer Handle of the control parent. Changing this property allows to move a control from a
figure to another.
Position [1,4] real vector or string This property is used to set or get the geometrical configuration of
a control. It is a real; vector : x y w h where the letters stand for the x location of the left bottom
corner, the y location of the left bottom corner, the width and the height of the uicontrol. The unit is
determined by the ’Unit’ property. One can also set this property by giving a string where the fields
are separated by a ’j’, ie ”xjyjwjh”.
SliderStep [1,2] real vector or string small big This property represents the step a slider is moved when
the user click on the arrow (small step) or on the slide bar (big step).
String string Generally, this property represents the text appearing in a uicontrol. Its exact meaning
sometimes depends on the uicontrol style:
o List Boxes, Popup Menu the value can be a vector of string or a string where the items are separated by
a ’j’.
Style string : fpushbuttong j radiobutton j checkbox j edit j text j slider j frame jlistbox j popupmenu
Style of the uicontrol. Here is a short description of each one:
o pushbutton A rectangular button generally used to run a callback.
o radiobutton A button whith to states : on or off.

Fractales Group 04 June 1998 656

uimenu Scilab Function

o checkbox a small uicontrol that have to state : on or off

o edit an editable string control
o text a text control (generally static).
o slider a scale control, that is a scrollbar use to set values between in range with the mouse.
o frame a control representing a zone used to group of related controls.
o listbox a control representing a list of item that can be scrolled. The item can be selected with the
mouse.
o popupmenu a button which make a menu appear when clicked.
Tag string this property is generally used to identify the control. It allows to give it a ”name”. Mainly used
in conjontion with findobj().
Units string : fpointsg j pixels j normalized Set the units used to specify the ’position’ property.
Userdata scilab object this can be used to associate any scilab object to an uicontrol.
Value Value of the uicontrol. The eact meaning depends on the style of the uicontrol.
o Check boxes, Radio buttons value is set to Max (see above) when on and Min when off.
o List Boxes, Popu Menu value is a vector of indexes corresponding to the index of the selected entry in
the list. 1 is the first item of the list.
o Sliders value indicated by the slider bar.

EXAMPLE :

f=figure();
// create a figure
h=uicontrol(f,’style’,’listbox’, ...
’position’, [10 10 150 160]);
// create a listbox
set(h, ’string’, "item 1|item 2|item3");
// fill the list
set(h, ’value’, [1 3]);
// select item 1 and 3 in the list
close();
// close the figure
f=figure();
// create a figure
h=uicontrol(f,’style’,’listbox’, ...
’position’, [10 10 150 160]);
// create a listbox
set(h, ’string’, "item 1|item 2|item3");
// fill the list
set(h, ’value’, [1 3]);
// select (highlight) the item 1 and 3 in the list
close();
//close the figure

S EE A LSO : figure 652, set 655, get 654, uimenu 657

AUTHOR : Bertrand Guiheneuf

2.13.13 uimenu Create a menu or a submenu in a figure

CALLING SEQUENCE :
h=uimenu(parent,prop1, val1, prop2, val2 ...)
PARAMETERS :

o parent : integer Handle of menu’s parent

o propi : string character name of a property to set up

Fractales Group 05 June 1998 657

uimenu Scilab Function

o vali : scilab object value to affect to the corresponding property

o h : integer handle of the corresponding menu

DESCRIPTION :
This allows to create menus in a figure. If ’parent’ is a figure, then the menu item will be added to the menu
bar of the figure. If ’parent’ is a menu item , then the new item will be added to the parent item, allowing
to create cascaded submenu. The ’callback’ property allows to set up the scilab instruction to call when the
item is selected by the user. The ’label’ property allows to set up the text appearing for the item.
EXAMPLE :

f=figure(’position’, [10 10 300 200]);

// create a figure
m=uimenu(f,’label’, ’windows’);
// create an item on the menu bar
m1=uimenu(m,’label’, ’operations’);
m2=uimenu(m,’label’, ’quit scilab’, ’callback’, "exit");
//create two items in the menu "windows"
m11=uimenu(m1,’label’, ’new window’, ’callback’,"xselect()");
m12=uimenu(m1,’label’, ’clear window’, ’callback’,"xbasc()");
// create a submenu to the item "operations"
close(f);
// close the figure

S EE A LSO : figure 652, uicontrol 655, set 655, get 654

AUTHOR : Bertrand Guiheneuf

Fractales Group 05 June 1998 658

uimenu Scilab Function

2.14 Language and data translation tools

Fractales Group 05 June 1998 659

fun2string Scilab Function

2.14.1 ascii string ascii conversions

CALLING SEQUENCE :
a=ascii(txt)
txt=ascii(a)
PARAMETERS :
txt : character string or matrix of strings.
a : vector of integer ascii codes
DESCRIPTION :
This function convert Scilab string to a vector of ascii code or vector of ascii code to Scilab strings.
If txt is a matrix of string, ascii(txt) is equivalent to ascii(strcat(txt))
S EE A LSO : code2str 280, str2code 282

2.14.2 excel2sci reads ascii Excel files

CALLING SEQUENCE :
M=excel2sci(fname [,sep])
PARAMETERS :
fname : character string. The file path
sep : character string. Excel separator used, default value is ”,”
M : matrix of strings
DESCRIPTION :
Given an ascii file created by Excel using ”Text and comma” format exel2sci(fname) returns the
corresponding Scilab matrix of strings. Use exel2sci(fname,sep ) for an other choice of separator.
Note: You may eval all or part ot M using function evstr.
S EE A LSO : read 254, evstr 35

2.14.3 formatman formats all help files in a directory in ascii, text or html

CALLING SEQUENCE :
formatman(path [,to])
PARAMETERS :
path : character string, giving the path of the directory
to : character string with possible values ”ascii”, ”tex”,”html”
DESCRIPTION :
This function, not yet fully checked, formats all help files (*.man) of a given directory written in a subset
of TROFF (text formatting language) to ascii tex or html
Known TROFF directives are .TH, .SH, .TP, .RS, .RE, .LP, .IG, .nf, .fi, .TS, .TE, .ft, .IP
Font handling like
\fV, \fR, , , , ]
are ignored
ascii mode generates a .cat file for each .man file and a whatis file
tex mode generates a .tex file for each .man file and a whatis.tex file
html mode generates a .html file for each .man file and a index.html file
S EE A LSO : help 298, man 305

Scilab Group April 1998 660

mfile2sci Scilab Function

2.14.4 fun2string generates ascii definition of a scilab function

CALLING SEQUENCE :

txt=fun2string(fun,name)

PARAMETERS :

fun : a function type variable

name : a character string, the generated function name
txt : a column vector of strings, the text giving the scilab instructions

DESCRIPTION :
Given a loaded Scilab function pseudo-code fun2string allow to re-generate the the code. Note that as
comments are not retained in loaded functions the comments cannot be regenerated. The generated code is
indented and beautified.
The mechanism is similar, but simpler than the mfile2sci one. It may be adapted for syntax translations.
EXAMPLE :

txt=fun2string(asinh,’foo’);
write(%io(2),txt,’(a)’)

S EE A LSO : getf 272, edit 267, macrovar 274

2.14.5 mfile2sci Matlab M file to scilab translation function

CALLING SEQUENCE :

mfile2sci(M_file_path [,result_path [,Imode [,Recmode]]])

PARAMETERS :

M file path : a character string which gives the path of Matlab M file to translate
result path : a character string which gives the directory where the result has to be written. Default
value is current directory.
Imode : Boolean flag, If true mfile2sci ask user for variable type and sizes when he cannot infer them.
Default value : %f
Recmode : Boolean flag, used by translatepaths function. Must be %f to translate a single mfile.

DESCRIPTION :
mfile2sci, is Matlab M-file to Scilab function traduction tools. It tries whenever possible to replace call to
Matlab functions by the equivalent scilab primitives and functions.
To translate a Matlab M-file just enter the scilab instruction: mfile2sci(file)
where file is a character string giving the path name of the M-file mfile2sci will generate three files in
the same directory

<function name>.sci : the scilab equivalent of the m file

<function name>.cat : the scilab help file associated to the function
sci <function name>.sci : the scilab function required to translate the calls to this Matlab M file
in other Matlab M files. This function may be improved ”by hand”. This function only useful for
translation not for use of translated functions.

Scilab Group April 1998 661

mfile2sci Scilab Function

Some functions like eye, ones, size, sum,... behave differently according to the dimension of their argu-
ments. When mfile2sci cannot infer dimensions it replaces these function call by a call to an emulation
function named mtlb <function name>. For efficiency these functions may be replaced by the proper
scilab equivalent instructions.
Some other functions like plot, has no straightforward translation in scilab. They are also replaced by an
emulation function named mtlb <function name>.
When translation may be incorrect or may be improved mfile2sci adds a comment which began by ”//!”
REMARKS :
This function is a still under developpement and is delivered as beta test.
Some Matlab4 basic functions are not yet translated. It is quite simple to add it. See <SCIDIR>/macros/m2sci/README
for more details.
KNOWN BUGS :

1- : eval function instructions passed as strings are not translated.

2- : most of plot function are not yet translated
3- : if, for, endded by the end of file produce an error, add the closing end’s
4- : Loop variable of for clause is available afterwards if loops terminates normally in matlab; it is cleared
in Scilab generated code.
5- : inequality comparison which implies complex numbers produce a run time error such as ”undefined
variable : %s 2 s”. User can define these operation with Matlab meaning with the following function
definition:
deff(’r=%s 1 s(a,b)’,’r=real(a)<real(b)’)
deff(’r=%s 2 s(a,b)’,’r=real(a)>real(b)’)
deff(’r=%s 3 s(a,b)’,’r=real(a)<=real(b)’)
deff(’r=%s 4 s(a,b)’,’r=real(a)>=real(b)’)
6- : When i is a vector, Matlab allows insertions like a(i)=v for any v. In scilab v must have the same
shape as a(i). This produces run time errors ”submatrix incorrectly defined”. Rewrite them as a(i)=v.’
.

EXAMPLE :

//create a simple m_file

write(TMPDIR+’/rot90.m’,[’function B = rot90(A,k)’
’[m,n] = size(A);’
’if nargin == 1’
’ k = 1;’
’else’
’ k = rem(k,4);’
’ if k < 0’
’ k = k + 4;’
’ end’
’end’
’if k == 1’
’ A = A.’’;’
’ B = A(n:-1:1,:);’
’elseif k == 2’
’ B = A(m:-1:1,n:-1:1);’
’elseif k == 3’
’ B = A(m:-1:1,:);’
’ B = B.’’;’
’else’
’ B = A;’
’end’]);
// translate it dor scilab

Scilab Group April 1998 662

mtlb save Scilab Function

mfile2sci(TMPDIR+’/rot90.m’,TMPDIR)
// show the new code
write(%io(2),read(TMPDIR+’/rot90.sci’,-1,1,’(a)’))
// get it into scilab
getf(TMPDIR+’/rot90.sci’)
//execute it
m=rand(4,2);rot90(m,1)

S EE A LSO : translatepaths 665

AUTHOR : Serge Steer, INRIA

2.14.6 mtlb load load variables from file with matlab4 format.

CALLING SEQUENCE :

mtlb_load fname
mtlb_load xxx.yyy
mtlb_load fname -ascii

PARAMETERS :

fname : a file name

xxx.yyy : a file name with extension

DESCRIPTION :
mtlb load load variables on file with matlab4 formats.

mtlb load fname loads in scilab all variables stored in file binary fname.mat .
mtlb load fname -ascii loads in scilab variable stored in ascii file fname, which must contain
a rectangular array of numeric data, arranged in m lines with n values in each line. The result is an
m-by-n matrix named fname .
mtlb load xxx.yyy reads the ascii file xxx.yyy, which must contain a rectangular array of numeric
data, arranged in m lines with n values in each line. The result is an m-by-n matrix named xxx.
"stdio" value for fname doesnt redirect load from standard input.

S EE A LSO : mtlb_save 663, save 258, load 239

2.14.7 mtlb save save variables on file with matlab4 format.

CALLING SEQUENCE :

mtlb_save fname
mtlb_save fname X
mtlb_save fname X Y Z
mtlb_save fname X Y Z -ascii
mtlb_save fname X Y Z -ascii -double
mtlb_save fname X Y Z -ascii -double -tabs

PARAMETERS :

fname : a file name

X Y Z : variable names

Scilab Group April 1993 663

sci2for Scilab Function

DESCRIPTION :
mtlb save save variables on file with matlab4 formats.
mtlb save fname saves all the current scilab variables which have corresponding matlab type to the
binary ”MAT-file” named fname.mat. The data may be retrieved with mtlb load.
mtlb save fname X saves only variable X.
mtlb save fname X Y Z saves variables X, Y, and Z.
mtlb save fname X Y Z -ascii uses 8-digit ASCII form instead of binary.
mtlb save fname X Y Z -ascii -double uses 16-digit ASCII form.
mtlb save fname X Y Z -ascii -double -tabs delimits with tabs.
"stdio" value for fname doesnt redirect save to standard output.

S EE A LSO : mtlb_load 663, save 258, load 239

2.14.8 pol2tex convert polynomial to TeX format

CALLING SEQUENCE :

[y]=pol2tex(x)

PARAMETERS :

x : polynomial
y : list

DESCRIPTION :
Latex source code for the polynomial x. (For use with texprint)
EXAMPLE :

s=poly(0,’s’);
p=sˆ3+2*s-5;
pol2tex(p)

S EE A LSO : texprint 665

2.14.9 sci2for scilab function to Fortran routine conversion

CALLING SEQUENCE :

txt=sci2for(fun,nam,vtps [,lvtps])

PARAMETERS :

fun : Scilab function

nam : character string, the name of generated subroutine
vtps : list
lvtps : list
txt : string, text of the subroutine Fortran code

DESCRIPTION :

The elements of the list vtps give the type and dimensions of the input variables of the calling se-
quence and lvtps optionally gives the type and dimensions of the output variables. This last parameter
is usefull if type and/or dimension inference cannot be able to determine the desired values.
These lists are structured as described below:

Scilab Group April 1993 664

translatepaths Scilab Function

vtps(i)=list(typ,row_dim,col_dim)

where :

typ : is a character string giving the type of the variable :

"0" : constant,integer vector or matrix
"1" : constant,double precision vector or matrix
"10" : character string
row dim : character string (row dimension)
col dim : character string (column dimension)
txt : Fortran code

Generated code may use routines of scilab libraries and some others whose source code may be found in
<SCIDIR>/util/sci2for.f
REMARKS :
This function is just a try. Only simple function may be translated. Many function calls have not yet Fortran
equivalent, to add the translation of a new function call you may define a scilab function. whose name is
f <name of function>. see <SCIDIR>/macros/sci2for/f *.sci files for examples.
The following keywords :

work,iwork,ierr
iw* iiw*
ilbN (N integer)

may not appear in the function code.

S EE A LSO : function 268

2.14.10 texprint TeX output of Scilab object

CALLING SEQUENCE :

[text]= texprint(a)

PARAMETERS :

a : Scilab object
text : list

DESCRIPTION :
returns the Tex source code of the Scilab variable a. a is a matrix (constant, polynomial, rational) or a
linear system (syslin list).
EXAMPLE :

s=poly(0,’s’);
texprint([1/s,sˆ2])

S EE A LSO : pol2tex 664, pol2str 494

2.14.11 translatepaths translate a set of Matlab M file directories to scilab

CALLING SEQUENCE :

translatepaths(dirs_path ,res_path)

Scilab Group April 1998 665

translatepaths Scilab Function

PARAMETERS :

dir path : a character string vector which gives the paths of Matlab M file directories to translate
res path : a character string which gives the path of the directory where the scilab functions are written
to.

DESCRIPTION :
translatepaths, translate all Matlab M-file contained in a set of directories to Scilab functions. Each
function is translated by mfile2sci.
Trace of translation informations are stored in a file named "log" in the res path directory
S EE A LSO : mfile2sci 661
AUTHOR : Serge Steer, INRIA

Scilab Group April 1998 666

translatepaths Scilab Function

2.15 Interprocess communication toolbox

Scilab Group April 1998 667

pvm addhosts Scilab function

”Scilab description”

2.15.1 AdCommunications advanced communication toolbox for parallel

programming

DESCRIPTION :
This the beta version of the Advanced Communications Toolbox (ACT).
This toolbox is based on existing libraries, such as
PVM - Parallel Vitual Machine
PBLAS - Message Passing Library dedicated to Matrix
ScaLapack - Parallel linear algebra Library
ACT manage remote executions of softwares and allow efficient exchanges of messages between those
softwares. It offers the possibility to exploit numerous machines on a network, as a virtual computer, by
creating a distributed group of independent softwares.
S EE A LSO : Example 668

2.15.2 Example just to test the environment

DESCRIPTION :

We are the knights who say ni!

2.15.3 pvm communications with other applications using Parallel Virutal

Machine

DESCRIPTION :
PVM is a software system that enables a collection of heterogeneous computers to be used as a coherent
and flexible concurrent computational resource.
The individual computers may be shared- or local-memory multiprocessors, vector supercomputers,
specialized graphics engines, or scalar workstations, that may be interconnected by a variety of networks,
such as ethernet, FDDI.
Daemon programs (pvmd3) provide communication and process control between computers (see PVM
manpage and manual for more details).
Most important functions of the PVM communication library are included in Scilab.
WARNING :
PVM must be installed in your envriromnent before using it in Scilab. PVM scilab have been developped
using the version 3.3.7 of the PVM library.
AUTHORS :
PVM have been developped by A. L. Beguelin, J. J. Dongarra, G. A. Geist, W. C. Jiang, R. J. Manchek, B.
K. Moore, V. S. Sunderam (see http://www.netlib.org/pvm3)
S EE A LSO : pvm_barrier ??, pvm_mytid 676, pvm_bcast 669, pvm_parent ??, pvm_config
670, pvm_delhosts 671, pvm_recv 677, pvm_exit 672, pvm_send 679, pvm_getinst
673, pvm_spawn 681, pvm_gettid ??, pvm_spawn_independent 681, pvm_gsize 674,
pvm_tasks ??, pvm_joingroup 675, pvm_tidtohost 683 pvm kill, pvm lvgroup, pvm start,
pvm halt

Scilab // Group May 1998 668

pvm bufinfo Scilab function

2.15.4 pvm addhosts add hosts to the virtual machine.

CALLING SEQUENCE :

[infos] = pvm_addhosts(hosts)
PARAMETERS :

hosts : row of strings, naming the hosts to be added.

infos : row of integer, corresponding to the status for each host.
DESCRIPTION :
pvm addhosts adds the computers named in hosts to the configuration of computers making up the
virtual machine. The names should have the same syntax as lines of a pvmd hostfile (see man page for
pvmd3): A hostname followed by options of the form xx=y.
The array infos can be checked to determine the status for each host. Values less than zero indicate an
error, while positive values are TIDs of the new hosts.
The status of hosts can be requested by the application using pvm config. If a host fails it will be
automatically deleted from the configuration. Using pvm addhosts a replacement host can be added by the
application, however it is the responsibility of the application developer to make his application tolerant of
host failure. Another use of this feature would be to add more hosts as they become available, for example
on a weekend, or if the application dynamically determines it could use more computational power.
EXAMPLE :

info = pvm_addhosts(["isostar","loop"])

S EE A LSO : pvm_delhosts 671, pvm_config 670

2.15.5 pvm bcast broacasts a message to all members of a group

CALLING SEQUENCE :

[info] = pvm_bcast(group, buff, msgtag)

PARAMETERS :

group : string, string group name of an existing group.

buff : data to be send.
msgtag : integer, message tag supplied by the user.
info : integer,
DESCRIPTION :
pvm bcast broadcasts a message to all the members of group. In PVM 3.2 and later the broadcast
message is not sent back to the sender. Any PVM task can call pvm bcast(), it need not be a member of the
group. The content of the message can be distinguished by msgtag. If pvm bcast is successful, info will be
0. If some error occurs then info will be < 0.
pvm bcast is asynchronous. Computation on the sending processor resumes as soon as the message is
safely on its way to the receiving processors. This is in contrast to synchronous communication, during
which computation on the sending processor halts until a matching receive is executed by all the receiving
processors.
pvm bcast first determines the tids of the group members by checking a group data base. A multicast is
performed to these tids. If the group is changed during a broadcast the change will not be reflected in the
broadcast. Multicasting is not supported by most multiprocessor vendors. Typically their native calls only
support broadcasting to all the user’s processes on a multiprocessor. Because of this omission, pvm bcast
may not be an efficient communication method on some multiprocessors.
EXAMPLE :

Scilab // Group May 1998 669

pvm config Scilab function

info = pvm_bcast( "worker",[12+%i,4,5;3,4+%i,5],10)

S EE A LSO : pvm_joingroup 675

2.15.6 pvm bufinfo Returns information about a message buffer.

CALLING SEQUENCE :

[bytes, msgtag, tid, info] = pvm_bufinfo(bufid)

PARAMETERS :

bufid : integer, specifying a particular message buffer identifier.

bytes : integer, size of the message in bytes (non very useful inside scilab).
msgtag : integer, label of the message. Useful when the message was received
with a wildcard msgtag.
tid : integer, task ID of the source of the message.
info : integer, status code returned by the routine. Values less than
zero indicate an error.

DESCRIPTION :
pvm bufinfo returns information about the requested message buffer. Typically it is used to determine
facts about the last received message such as its size or source. pvm bufinfo is especially useful when an
application is able to receive any incoming message, and the action taken depends on the source tid and the
msgtag associated with the message that comes in first. If pvm bufinfo is successful, info will be 0. If some
error occurs then info will be < 0.
EXAMPLE :

[bytes, msgtag, tid, info] = pvm_info(bufid)

S EE A LSO : pvm_recv 677

2.15.7 pvm config sends a message

CALLING SEQUENCE :

res = pvm_config()

PARAMETERS :

res, list of 7 elements such that:

res(1): integer returning the number of hosts (pvmds) in the virtual machine.

res(2): integer returning the number of different data formats being used.

res(3): integer returning pvmd task ID for host.

res(4): character string returning name of host.

res(5): character string returning architecture name of host

Scilab // Group May 1998 670

pvm exit Scilab function

res(6): integer returning relative speed of host. Default value is 1000.

res(7): integer status code returned by the routine.

DESCRIPTION :
pvm config returns information about the present virtual machine. The information returned is similar
to that available from the console command conf.
The pvm config function returns information about the entire virtual machine in one call.
If pvm config is successful, info will be 0. If some error occurs then info will be < 0.
EXAMPLE :

res = pvm_config()

S EE A LSO : pvm_tasks ??

2.15.8 pvm delhosts deletes hosts from the virtual machine.

CALLING SEQUENCE :

infos = pvm_delhosts(hosts)

PARAMETERS :

hosts : row of strings, containing the names of the machines to be deleted.

infos : row of integers, contains the status code returned by the routine for the individual hosts.

DESCRIPTION :
pvm delhosts deletes the computers of hosts from the existing configuration of computers making
up the virtual machine. All PVM processes and the pvmd running on these computers are killed as the
computer is deleted. The array infos can be checked to determine the status of each host. Values less than
zero indicate an error, while zero values indicate a success.
If a host fails, the PVM system will continue to function and will automatically delete this host from
the virtual machine. It is the responsibility of the application developer to make his application tolerant of
host failure.
EXAMPLE :

info = pvm_delhosts(["isostar","loop"])

S EE A LSO : pvm_addhosts 669

2.15.9 pvm error Prints message describing an error returned by a PVM call.

CALLING SEQUENCE :

[errmsg] = pvm_error(err)

PARAMETERS :

err : integer, error code returned by a pvm function.

errmsg : string, the error message corresponding to the error code err.

DESCRIPTION :
pvm error returns the error message corresponding to an PVM error code returned by a PVM call.
EXAMPLE :

[a] = pvm_error(0)

Scilab // Group May 1998 671

pvm get timer Scilab function

2.15.10 pvm exit tells the local pvmd that this process is leaving PVM.

CALLING SEQUENCE :
[info] = pvm_exit()
PARAMETERS :
info : integer
DESCRIPTION :
pvm exit tells the local pvmd that this process is leaving PVM. This routine does not kill the process,
which can continue to perform tasks just like any other serial process.
pvm exit should be called by all PVM processes before they stop or exit for good. It must be called by
processes that were not started with pvm spawn.
EXAMPLE :
pvm_exit()
S EE A LSO : pvm 668

2.15.11 pvm sci2f77 Convert a F77 complex into a complex scalar

CALLING SEQUENCE :
[res] = pvm_f772sci(var)
PARAMETERS :
var : local scilab variable. On return, the variable will be overwritten with
the result of conversion operation.
res : if the parameter var is not a variable, the result of the conversion is returned in res.
DESCRIPTION :
pvm f772sci converts all the complex of a scilab variable represented in teh F77 way into in a scilab
representation. May be useful if an application is receiving data from a non scilab application (directly from
a C or F77 program for example).
Note that the parameter is passed by adress. It means that if the parameter is a variable, this variable will
be overwritten with the result of conversion operation. On the other case, if the parameter is not a variable,
the result will be returned in res.
For example:
-->a = [1+%i, 2+2*%i,3+3*%i]
a =

! 1. + i 2. + 2.i 3. + 3.i !

-->pvm_f772sci(a)

-->a
a =

! 1. + 2.i 3. + i 2. + 3.i !

-->b = pvm_f772sci([1+%i, 2+2*%i,3+3*%i])

b =

! 1. + 2.i 3. + i 2. + 3.i !

Scilab // Group January 1998 672

pvm gsize Scilab function

S EE A LSO : pvm_sci2f77 679

2.15.12 pvm get timer Gets the system’s notion of the current time.

CALLING SEQUENCE :

[time] = pvm_get_timer()

PARAMETERS :

time : scalar

DESCRIPTION :
pvm get timer returns the time elapsed since the last call of pvm get timer or the last call of pvm set timer.
The time is expressed in elapsed microseconds. The resolution of the system clock is hardware dependent;
the time may be updated continuously or in clock ticks. timer will be > 0. If some error occurs then timer
will be -1.
EXAMPLE :

B = rand(100,100);
A = rand(100,100);
pvm_set_timer();C=A*B;t=pvm_get_timer()

S EE A LSO : pvm_set_timer 680

2.15.13 pvm getinst returns the instance number in a group of a PVM process.

CALLING SEQUENCE :

[inum] = pvm_getinst(group, tid)

PARAMETERS :

group : string, string group name of an existing group.

tid : integer, task identifier of a PVM process.
inum : integer, instance number returned by the routine.

DESCRIPTION :
pvm getinst takes a group name group and a PVM task identifier tid and returns the unique instance
number that corresponds to the input. It can be called by any task whether in the group or not. If pvm getinst
is successful, inum will be >= 0. If some error occurs then inum will be < 0.
EXAMPLE :

inum = pvm_getinst( "worker", pvm_mytid() )

S EE A LSO : pvm_joingroup 675, pvm_gettid ??

Scilab // Group May 1998 673

pvm joingroup Scilab function

2.15.14 pvm gsize returns the number of members presently in the named
group.

CALLING SEQUENCE :

[nb] = pvm_gsize(group)

PARAMETERS :

group : string, string group name of an existing group.

nb : integer, returning the number of members presently in the group.

DESCRIPTION :
pvm gsize returns the size of the group named group. If there is an error nb will be negative.
Since groups can change dynamically in PVM 3.0, this routine can only guarantee to return the instan-
taneous size of a given group.
EXAMPLE :

nb_worker = pvm_gsize( "worker" )

S EE A LSO : pvm_joingroup 675

2.15.15 pvm halt stops the PVM daemon

CALLING SEQUENCE :

[info] = pvm_halt()

PARAMETERS :

info : integer, status code returned by the routine. Values less than zero indicate an error.

DESCRIPTION :
pvm halt kills all PVM tasks, all the remote daemons, and the local daemon. If the master pvmd is
killed manually it should be sent a SIGTERM signal to allow it to kill the remote pvmds and clean up
various files.
The pvmd can be killed in a manner that leaves the file /tmp/pvmd.uid behind on one or more hosts. Uid
is the numeric user ID (from /etc/passwd) of the user. This will prevent PVM from restarting on that host.
Deletion of this file will fix this problem:
rm ‘( grep $user /etc/passwd jj ypmatch $user passwd ) j awk -F: ’fprint ”/tmp/pvmd.”$3; exitg’‘
For example:
-->pvm_halt()
ans =

0.

-->pvm_halt()
ans =

- 14.

Error -14 means: pvm halt(): Can’t contact local daemon

S EE A LSO : pvm_start 682, pvm_addhosts 669, pvm_config 670

Scilab // Group May 1998 674

pvm lvgroup Scilab function

2.15.16 pvm joingroup enrolls the calling process in a named group.

CALLING SEQUENCE :

[inum] = pvm_joingroup(group)

PARAMETERS :

group : string, string group name of an existing group.

inum : integer, instance number returned by the routine.

DESCRIPTION :
pvm joingroup enrolls the calling task in the group named group and returns the instance number inum
of this task in this group. If there is an error inum will be negative.
Instance numbers start at 0 and count up. When using groups a (group, inum) pair uniquely identifies
a PVM process. This is consistent with the PVM 2.4 naming schemes. If a task leaves a group by calling
pvm lvgroup and later rejoins the same group, the task is not guaranteed to get the same instance number.
PVM attempts to reuse old instance numbers, so when a task joins a group it will get the lowest available
instance number. A task can be a member of multiple groups simultaneously.
EXAMPLE :

inum = pvm_joingroup( "worker" )

S EE A LSO : pvm_lvgroup 676

2.15.17 pvm kill Terminates a specified PVM process.

CALLING SEQUENCE :

[infos] = pvm_kill(tids)

PARAMETERS :

tids : row of integer, task identifier of the PVM process to be killed (not yourself).
infos : row of integer, status code returned by the routine. Values less than zero indicate an error.

DESCRIPTION :
pvm kill sends a terminate (SIGTERM) signal to the PVM process identified by tids. In the case of
multiprocessors the terminate signal is replaced with a host dependent method for killing a process. If
pvm kill is successful,
The array infos can be checked to determine the status for each process. Values less than zero indicate
an error, while zero values indicate a success.
pvm kill is not designed to kill the calling process. To kill yourself in C call pvm exit() followed by
quit().
EXAMPLE :

info = pvm_kill(262153)

S EE A LSO : pvm_exit 672

Scilab // Group May 1998 675

pvm probe Scilab function

2.15.18 pvm lvgroup Unenrolls the calling process from a named group.

CALLING SEQUENCE :

[info] = pvm_lvgroup(group)

PARAMETERS :

group : string, group name of an existing group.

info : integer, status code returned by the routine.

DESCRIPTION :
pvm lvgroup unenrolls the calling process from the group named group. If there is an error info will
be negative.
If a process leaves a group by calling either pvm lvgroup or pvm exit, and later rejoins the same group,
the process may be assigned a new instance number. Old instance numbers are reassigned to processes
calling pvm joingroup.
EXAMPLE :

info = pvm_lvgroup( "worker" )

S EE A LSO : pvm_joingroup 675

2.15.19 pvm mytid returns the tid of the calling process.

CALLING SEQUENCE :

[tid] = pvm_mytid()

PARAMETERS :

tid : integer, the task identifier of the calling PVM process. Values less than zero indicate an error.

DESCRIPTION :
pvm mytid enrolls this process into PVM on its first call. It also generates a unique tid if this process
was not created by pvm spawn. pvm mytid returns the tid of the calling process and can be called multiple
times in an application.
Any PVM system call (not just pvm mytid) will enroll a task in PVM if the task is not enrolled before
the call.
The tid is a 32 bit positive integer created by the local pvmd. The 32 bits are divided into fields that
encode various information about this process such as its location in the virtual machine (i.e. local pvmd
address), the CPU number in the case where the process is on a multiprocessor, and a process ID field.
This information is used by PVM and is not expected to be used by applications. Applications should not
attempt to predict or interpret the tid with the exception of calling tidtohost()
If PVM has not been started before an application calls pvm mytid the returned tid will be < 0.
EXAMPLE :

tid = pvm_mytid()

S EE A LSO : pvm_tidtohost 683, pvm_parent ??

Scilab // Group May 1998 676

pvm recv Scilab function

2.15.20 pvm probe Check if message has arrived.

CALLING SEQUENCE :

[buffid] = pvm_probe(tid, msgtag)

PARAMETERS :

tid : integer, task identifier of sending process supplied by the user.

msgtag : integer, message tag supplied by the user. msgtag should be >=
0.
buffid : integer, returning the value of the new active receive buffer identifier. Values less than zero
indicate an error.

DESCRIPTION :
pvm probe checks to see if a message with label msgtag has arrived from tid. If a matching message
has arrived pvm probe returns a buffer identifier in bufid. This bufid can be used in a pvm bufinfo call to
determine infor- mation about the message such as its source and length.
If the requested message has not arrived, then pvm probe returns with a 0 in bufid. If some error occurs
bufid will be < 0.
A -1 in msgtag or tid matches anything. This allows the user the following options. If tid = -1 and
msgtag is defined by the user, then pvm probe will accept a message from any process which has a matching
msgtag. If msgtag = -1 and tid is defined by the user, then pvm probe will accept any message that is sent
from process tid. If tid = -1 and msgtag = -1, then pvm probe will accept any message from any process.
pvm probe can be called multiple times to check if a given message has arrived yet. After the message
has arrived, pvm recv must be called before the message can be unpacked into the user’s memory using the
unpack routines.
EXAMPLE :

arrived = pvm_probe( tid, msgtag );

if (arrived >= 0) then [bytes, msgtag, tid, info] = pvm_info(arrived); end

S EE A LSO : pvm_recv 677, pvm_info ??

2.15.21 pvm recv receive a message.

CALLING SEQUENCE :

[buff, info, msgtid, tag] = pvm_recv(tid, msgtag)

PARAMETERS :

tid : integer, task identifier of sending process supplied by the user.

msgtag : integer, message tag supplied by the user. msgtag should be >=
0.
buff : scilab variable, where the received message will be stored.
info : integer, status code returned by the routine. Values less than zero indicate an error.
msgtid : integer, returning the source of the message. Useful when the
message was received with a wildcard tid.
tag : integer, returning the message label. Useful when the message was received with a wildcard msgtag.

Scilab // Group May 1998 677

pvm reduce Scilab function

DESCRIPTION :
pvm recv blocks the process until a message with label msgtag has arrived from tid. pvm recv then
places the message in buff.
A -1 in msgtag or tid matches anything. This allows the user the following options. If tid = -1 and
msgtag is defined by the user, then pvm recv will accept a message from any process which has a matching
msgtag. If msgtag = -1 and tid is defined by the user, then pvm recv will accept any message that is sent
from process tid. If tid = -1 and msgtag = -1, then pvm recv will accept any message from any process.
When wildcard are used, the application is able to receive any incoming message. If the action taken
depends on the source tid and the msgtag associated with the message that comes in first, the information
given by msgtid and tag can be very usefull.
The PVM model guarantees the following about message order. If task 1 sends message A to task 2,
then task 1 sends message B to task 2, message A will arrive at task 2 before message B. Moreover, if both
messages arrive before task 2 does a receive, then a wildcard receive will always return message A.
info will be the status code returned by the routine. If some error occurs then info will be < 0.
pvm recv is blocking which means the routine waits until a message matching the user specified tid
and msgtag values arrives at the local pvmd. If the message has already arrived then pvm recv returns
immediately with the message.
Once pvm recv returns, the data in the message can be unpacked into the user’s memory using the
unpack routines.
EXAMPLE :

[b, info, msgtid, tag] = pvm_recv(pvm_parent(),100)

g = pvm_recv(pvm_parent(),200)

S EE A LSO : pvm_send 679, pvm_bcast 669

2.15.22 pvm reduce Performs a reduce operation over members of the specified
group.

CALLING SEQUENCE :

[buff, info] = pvm_reduce(func, buff, msgtag, group, rootginst)

PARAMETERS :

func : string, defines the operation performed on the global data. Should
be : Max, Min, Sum or Pro.
buff : scalar, local scilab variable. On return, the data array on the root
will be overwritten with the result of the reduce operation over the group.
msgtag : integer, message tag supplied by the user. msgtag should be >= 0.
It allows the user’s program to distinguish between different kinds of messages.
group : string, group name of an existing group.
rootginst : integer, instance number of group member who gets the result.
info : integer, status code returned by the routine. Values less than zero
indicate an error.

DESCRIPTION :
pvm reduce performs global operations such as max, min, sum or product over all the tasks in a group.
All group members call pvm reduce with their local data, and the result of the reduction operation appears
on the user specified root task root. The root task is identified by its instance number in the group.
Max and Min are implemented for scalar datatypes (double, complex). For complex values the min-
imum [maximum] is that complex pair with the minimum [maximum] modulus. Sum and Product are
implemented for scalar datatypes.

Scilab // Group May 1998 678

pvm send Scilab function

Note: pvm reduce does not block. If a task calls pvm reduce and then leaves the group before the root
has called pvm reduce an error may occur.
EXAMPLE :

A = rand(5,5);
[buff, info] = pvm_reduce("Max", A, msgtag, "Workers", 0)

S EE A LSO : pvm_bcast 669, pvm_barrier ??, pvm_psend ??, pvm_getinst 673,

pvm_gsize 674, ?? pvm joingroup, pvm lvgroup

2.15.23 pvm sci2f77 Convert complex scalar into F77

CALLING SEQUENCE :

[res] = pvm_sci2f77(var)

PARAMETERS :

var : local scilab variable. On return, the variable will be overwritten with
the result of conversion operation.
res : if the parameter var is not a variable, the result of the conversion is returned in res.

DESCRIPTION :
pvm sci2f77 converts all the complex of a scilab variable (array, list...) in the F77 representation. MAy
be useful if an application is sendind data to a non scilab application (direcvtly to a C or F77 program for
example).
Note that the parameter is passed by adress. It means that if the parameter is a variable, this variable will
be overwritten with the result of conversion operation. On the other case, if the parameter is not a variable,
the result will be returned in res.
For example:
-->a = [1+%i, 2+2*%i,3+3*%i]
a =

! 1. + i 2. + 2.i 3. + 3.i !

-->pvm_sci2f77(a)

-->a
a =

! 1. + 2.i 1. + 3.i 2. + 3.i !

-->b = pvm_sci2f77([1+%i, 2+2*%i,3+3*%i])
b =

! 1. + 2.i 1. + 3.i 2. + 3.i !

S EE A LSO : pvm_f772sci ??

2.15.24 pvm send immediately sends (or multicast) data.

CALLING SEQUENCE :

[info] = pvm_send(tids,buff,msgtag)

Scilab // Group May 1998 679

pvm spawn Scilab function

PARAMETERS :

tids : row of integers, contains the task IDs of the tasks to be sent to.
buff : scilab variable.
msgtag : integer, message tag supplied by the user. msgtag should be >=
0. It allows the user’s program to distinguish between different kinds of messages .
info : integer, status code returned by the routine. Values less than zero indicate an error.

DESCRIPTION :
pvm send sends (or multicasts) a message to the PVM process identified in the tids array. Note that the
message is not sent to the caller even if listed in the array of tids. msgtag is used to label the content of the
message. If pvm send is successful, info will be 0. If some error occurs then info will be < 0.
The pvm send routine is asynchronous. Computation on the sending processor resumes as soon as the
message is safely on its way to the receiving processor. This is in contrast to synchronous communication,
during which computation on the sending processor halts until the matching receive is executed by the
receiving processor.
If a multicast is performed, pvm send first determines which other pvmds contain the specified tasks.
Then passes the message to these pvmds which in turn distribute the message to their local tasks without
further network traffic.
The PVM model guarantees the following about message order. If task 1 sends message A to task 2,
then task 1 sends message B to task 2, message A will arrive at task 2 before message B. Moreover, if both
messages arrive before task 2 does a receive, then a wildcard receive will always return message A.
Terminating a PVM task immediately after sending a message or messages from it may result in those
messages being lost. To be sure, always call pvm exit() before stopping.
EXAMPLE :

A = rand(5,5)*(1+%i);
deff(’[x]=f(y)’,’x = 1/y’)
info = pvm_send([262150, 262152], A(1:2:5,:), 100)
pvm_send(262146,f,200)

S EE A LSO : pvm_recv 677, pvm_bcast 669

2.15.25 pvm set timer Sets the system’s notion of the current time.

CALLING SEQUENCE :

[info] = pvm_set_timer()

PARAMETERS :

info : scalar

DESCRIPTION :
pvm set timer initialized the timer. info will be 0. If some error occurs then info will be -1.
EXAMPLE :

pvm_set_timer()

S EE A LSO : pvm_get_timer 673

Scilab // Group January 1998 680

pvm spawn independent Scilab function

2.15.26 pvm spawn Starts new Scilab processes.

CALLING SEQUENCE :

[tids, numt] = pvm_spawn(task, ntask, [nw], [where])

PARAMETERS :

task : string, which is the file name of the scilab script (see exec) to be
started. The Scilab script must already reside on the host on which it is to be started. The name must
an absolute path.
ntask : integer, specifying the number of copies of the scilab script to start.
win : string (optional). If win is equal to “nw” the Scilab process will be spawned in background with
out any window coming up.
where : string (optional), can be a host name such as “tequila.ens-lyon.fr” or a PVM architecture class
such as “SUN4”.
numt : integer, the actual number of tasks started. Values less than zero indicate a system error. tids : row
of integers, array of the tids of the PVM processes started by this pvm spawn call.

DESCRIPTION :
pvm spawn starts ntask copies of the scilab script task. On systems that support environment, spawn
passes selected variables from parent environment to children tasks. If set, the envar PVM EXPORT is
passed. If PVM EXPORT contains other names (separated by ’:’) they will be passed too. This is useful
for e.g.:

setenv DISPLAY myworkstation:0.0

setenv MYSTERYVAR 13
setenv PVM_EXPORT DISPLAY:MYSTERYVAR

The hosts on which the PVM processes are started are determined by the where arguments. On return
the array tids contains the PVM task identifiers for each process started.
If pvm spawn starts one or more tasks, numt will be the actual number of tasks started. If a system error
occurs then numt will be < 0. If numt is less than ntask then some executables have failed to start and the
user should check the last ntask - numt locations in the tids array which will contain error codes (see below
for meaning). The first numt tids in the array are always valid.
When the argument where is omitted a heuristic (round-robin assignment) is used to distribute the ntask
processes across the virtual machine.
In the special case where a multiprocessor is specified by where, pvm spawn will start all ntask copies
on this single machine using the vendor’s underlying routines.
EXAMPLE :

// create an exec file (script)

write(TMPDIR+’/foo.sce’,[’a=1’;’plot2d()’])
// start a new Scilab on the same host to execute the script
[tids, numt] = pvm_spawn(TMPDIR+’/foo.sce’,1)
pvm_kill(tids) //terminate the new scilab

S EE A LSO : pvm 668, pvm_spawn_independent 681

2.15.27 pvm spawn independent Starts new PVM processes.

CALLING SEQUENCE :

Scilab // Group January 1998 681

pvm start Scilab function

[tids, numt] = pvm_spawn_independent(task, ntask, [where])

PARAMETERS :

task: string, which is the executable file name of the PVM process to be started. The executable must
already reside on the host on which it is to be started. The name may be a file in the PVM search path
or an absolute path. The default PVM search path is $HOME/pvm3/bin/$PVM ARCH/ .
ntask: integer, specifying the number of copies of the executable file to start.
where: string (optional), can be a host name such as “tequila.ens-lyon.fr” or a PVM architecture class
such as “SUN4”.
numt: integer, the actual number of tasks started. Values less than zero indicate a system error. tids:
row of integers, array of the tids of the PVM processes started by this pvm spawn independent call.

DESCRIPTION :
pvm spawn independent starts ntask copies of the executable named task. On systems that support
environment, spawn passes selected variables from parent environment to children tasks. If set, the envar
PVM EXPORT is passed. If PVM EXPORT contains other names (separated by ’:’) they will be passed
too. This is useful for e.g.:

setenv DISPLAY myworkstation:0.0

setenv MYSTERYVAR 13
setenv PVM_EXPORT DISPLAY:MYSTERYVAR
The hosts on which the PVM processes are started are determined by the where arguments. On return
the array tids contains the PVM task identifiers for each process started.
If pvm spawn independent starts one or more tasks, numt will be the actual number of tasks started. If
a system error occurs then numt will be < 0. If numt is less than ntask then some executables have failed
to start and the user should check the last ntask - numt locations in the tids array which will contain error
codes (see below for meaning). The first numt tids in the array are always valid.
When the argument where is omitted a heuristic (round-robin assignment) is used to distribute the ntask
processes across the virtual machine.
In the special case where a multiprocessor is specified by where, pvm spawn independent will start all
ntask copies on this single machine using the vendor’s underlying routines.
EXAMPLE :

[tids, numt] = pvm_spawn_independent("a.out",2)

S EE A LSO : pvm 668, pvm_spawn 681

2.15.28 pvm start Start the PVM daemon

CALLING SEQUENCE :

[info] = pvm_start(["hostfile"])

PARAMETERS :

hostfile : name of the hostfile describing the configuration for each host of the virtual machine.
info : integer, status code returned by the routine. Values less than zero indicate an error.

DESCRIPTION :
pvm start starts the Pvmd3 which is a daemon process which coordinates unix hosts in a virtual ma-
chine. One pvmd3 must run on each host in the group. They provide the communication and process control
functions needed by the user’s PVM processes. The local and remote pvmds can also be started from the
PVM console program pvm.

Scilab // Group May 1998 682

pvmd3 pvm daemon

The optional parameter is the name of a host file. See pvmd3 for more details on the host file format.
If no argument is given to pvm start, but the variable PVM ROOT is set, scilab will try to load the file
$HOME/.pvmd.conf. If this file does not exist, or the variable PVM ROOT is not set, scilab will try to
load the default file $SCI/.pvmd.conf. In all other cases, scilab will supposed that PVM and scilab are in
standard place on your net.
Note that, to be able to start a PVM daemon, scilex must know the place to find both scilex and pvmd.
Normally, scilex will start a new PVM daemon by using rsh. See the help on pvmd3 and pvm for more
detail on how to start/stop pvm.
For example:

pvm_start()
ans =

0.
-->pvm_start()
ans =

- 28.

Error -28 means: pvm start pvmd(): Duplicate host

S EE A LSO : pvmd3 683, pvm_halt 674, pvm_addhosts 669, pvm_config 670

2.15.29 pvm tidtohost returns the host of the specified PVM process.

CALLING SEQUENCE :

[dtid] = pvm_tidtohost(tid)

PARAMETERS :

tid : integer, task identifier of the PVM process in question.

dtid : integer, the tid of the host’s pvmd3 or a negative value if an error.

DESCRIPTION :

pvm tidtohost returns the host id on which the process identified by tid is located.
EXAMPLE :

dtid = pvm_tidtohost(pvm_mytid())

S EE A LSO : pvm_config 670, pvm_tasks ??

2.15.30 pvmd3 PVM daemon

SYNOPSIS :
pvmd3 [ -options ] [ hostfile ] &
DESCRIPTION :
pvmd3 is a daemon process which coordinates hosts in a virtual machine. One pvmd must run on each host
in the group. They provide the communication and process control functions needed by the user’s PVM
processes. The daemon can be started manually with a host file argument that will automatically start the
remote pvmds. The local and remote pvmds can also be started from the PVM console program pvm.
The name of the daemon executable is pvmd3. It is usually started by a shell script, $PVM ROOT/lib/pvmd.

Scilab // Group January 1998 683

pvmd3 pvm daemon

Local daemon may also be started by the scilab instruction pvm start() and remote daemons may also
be started by the scilab function pvm addhosts
OPTIONS :
The following options may be specified on the command line when starting the master pvmd or PVM
console:
- dmask Set pvmd debug mask. Used to debug the pvmd or libpvm (not intended to be used to debug
application programs). Mask is a hexadecimal number which is the sum of the following bits: Bit
Information
1 Packet routing
2 Message routing and entry points
4 Task management
8 Slave pvmd startup
10 Host table updates
20 Select loop (below packet layer)
40 IP network
80 Multiprocessor port debugging
100 Resource manager interface
200 Application (messages with no destination, etc.)
-nname Specify an alternate hostname for the master pvmd to use. Useful when gethostname() returns
a name not assigned to any network interface.
The following options are used by the master pvmd when starting slaves and are only of interest to someone
writing a hoster. Don’t just go using them, now.
-s Start pvmd in slave mode. Hostfile cannot be used, five additional parameters must be supplied:
master pvmd index, master IP, master MTU, slave pvmd index, and slave IP.
-S Same as -s, but slave pvmd doesn’t wait for its stdin to be closed after printing its parameters. Used
for manual startup.
-f Slave doesn’t fork after configuration (useful if the slave is to be controlled or monitored by some
process).
Lines beginning with a splat ( # ), optionally preceded by whitespace, are ignored.
A simple host file might look like:
# my first host file
thud
fred
wilma
barney
betty
This specifies the names of five hosts to be configured in the virtual machine.
The master pvmd for a group is started by hand on the localhost, and it starts slaves on each of the
remaining hosts using the rsh or rexec command. The master host may appear on any line of the
hostfile, but must have an entry.
The simple format above works fine if you have the same login name on all five machines and the name
of the master host in your .rhosts files on the other four.
There are several host file options available:
lo=NAME Specifies an alternate login name (NAME) to use.
so=pw This is necessary when the remote host cannot trust the master. Causes the master pvmd to prompt
for a password for the remote host in the tty of the pvmd (note you can’t start the master using the
console or background it when using this option) you will see: Password (honk.cs.utk.edu:manchek):
you should type your password for the remote host. The startup will then continue as normal.
dx=FILE Specifies the path of the pvmd executable. FILE may be a simple filename, an absolute path-
name, or a path relative to the user’s home directory on the remote host. This is mainly useful to aid
in debugging new versions of PVM, but may have other uses.

Scilab // Group January 1998 684

pvmd3 pvm daemon

ep=PATH Specifies a path for the pvmd to search for executable program components when spawning a
new process. The path may have multiple elements, separated by colons ( : ).
wd=PATH Specifies a working directory in which all spawned tasks on this host
will execute.
sp=VALUE Specifies the relative computational speed of this host compared to other hosts in the config-
uration. VALUE is an integer in the range [1 - 1000000]
bx=PATH Specifies the debugger program path. Note: the environment variable PVM DEBUGGER can
also be set.
so=ms Rarely used. Causes the master pvmd to request user to manually perform the startup of a pvmd
on a slave host when rsh and rexec network services are disabled but IP connectivity exists. See
section ”MANUAL STARTUP”.
A dollar sign ( $ ) in an option introduces a variable name, for example $PVM ARCH. Names are
expanded from environment variables by each pvmd.
Each of the flags above has a default value. These are:
lo The loginname on the master host.
so Nothing
dx $PVM ROOT/lib/pvmd (or environment variable PVM DPATH)
ep pvm3/bin/$PVM ARCH:$PVM ROOT/bin/$PVM ARCH
wd $HOME
sp 1000
bx $PVM ROOT/lib/debugger
You can change these by adding a line with a star ( * ) in the first field followed by the options, for
example:
* lo=afriend so=pw This sets new default values for ‘lo’ and ‘so’ for the remainder of the host file,
or until the next ‘*’ line. Options set on the last ‘*’ line also apply to hosts added dynamically using
pvm addhosts().
Host options can be set without starting the hosts automatically. Information on host file lines beginning
with ‘&’ is stored, but the hosts are not started until added using pvm addhosts().
Example hostfile:
# hostfile for testing on various platforms fonebone
refuge
# installed in /usr/local/here

sigi.cs
dx=/usr/local/pvm3/lib/pvmd # borrowed accts, "guest", don’t trust fonebone

* lo=guest so=pw sn666.jrandom.com cubie.misc.edu # really painful one, must start it b

hand and share a homedir & igor.firewall.com lo=guest2 so=ms ep=bob/pvm3/bin/$PVM ARCH

MANUAL STARTUP :

When adding a host with this option set you will see on the tty of the pvmd:
*** Manual startup ***
Login to ”honk” and type:
$PVM_ROOT/lib/pvmd -S -d0 -nhonk 1 80a9ca95:0cb6 4096 2 80a95c43:0000 Type
response:
after typing the given command on host honk, you should see a line like:
ddpro<2312> arch<ALPHA> ip<80a95c43:0a8e> mtu<4096>
type this line on the tty of the master pvmd. You should then see:

Scilab // Group January 1998 685

DestroyLink Scilab function

Thanks

and the two pvmds should be able to communicate.

Note you can’t start the master using the console or background it when using this option.
STOPPING PVMD3 :

The preferred method of stopping all the pvmds is to give the halt command in the PVM console. This
kills all pvm tasks, all the remote daemons, the local daemon, and finally the console itself. If the master
pvmd is killed manually it should be sent a SIGTERM signal to allow it to kill the remote pvmds and clean
up various files.
The pvmd can be killed in a manner that leaves the file /tmp/pvmd.uid behind on one or more hosts. Uid
is the numeric user ID (from /etc/passwd) of the user. This will prevent PVM from restarting on that host.
Deletion of this file will fix this problem:

rm ‘( grep $user /etc/passwd || ypmatch $user passwd ) | \\

awk -F: ‘{print "/tmp/pvmd."$3; exit}’‘

2.15.31 Communications communications with other applications using GeCi

DESCRIPTION :
This the beta version of the Communications Toolbox.
GeCi manages communications between Scilab and other applications (included Scilab itself) by using
GeCi.
GeCI is an interactive communication manager created in order to manage remote executions of soft-
wares and allow exchanges of messages between those softwares. It offers the possibility to exploit numer-
ous machines on a network, as a virtual computer, by creating a distributed group of independent softwares.
In order to communicate, the other applications must have been prepared for, by including a commu-
nication library in them. The way to do this is described in the Communication Toolbox documentation.

S EE A LSO : CreateLink 686, DestroyLink 687, ExecAppli 687, GetMsg 688, SendMsg
688, WaitMsg 689

2.15.32 CreateLink creates a link between two applications

CALLING SEQUENCE :

CreateLink(appli1,appli2)

PARAMETERS :

appli1, name of an application : string

appli2 : string, name of an application

DESCRIPTION :
CreateLink creates a link from appli1 to appli2. Note that this link is directed. This link being
created, appli1 can send messages to appli2 and appli2 can receive messages from appli1.
If the name of appli1 or appli2 is "SELF", it corresponds to the name of the application where
we execute CreateLink.
If the name of appli1 or appli2 is "XGeCI", it corresponds to the name of the first Scilab appli-
cation started.
S EE A LSO : DestroyLink 687, GetMsg 688, SendMsg 688

Scilab Group March 1997 686

ExecScilab Scilab function

2.15.33 DestroyLink destroys the link between two applications

CALLING SEQUENCE :

DestroyLink(appli1,appli2)

PARAMETERS :

appli1, name of an application : string

appli2 : string, name of an application

DESCRIPTION :
DestroyLink destroys the link from appli1 to appli2.
If the name of appli1 or appli2 is "SELF", it corresponds to the name of the application where
we execute DestroyLink.
If the name of appli1 or appli2 is "XGeCI", it corresponds to the name of the first Scilab appli-
cation started.
S EE A LSO : CreateLink 686

2.15.34 ExecAppli executes an application

CALLING SEQUENCE :

ExecAppli(command,h,appli)

PARAMETERS :

command : string, command of the application

h : string, host name
appli : string, name of the application

DESCRIPTION :
ExecAppli executes the application described by command on the host h and gives it the name
appli. Arguments of the application can be also given in the string command.
After executing ExecAppli, it is necessary to create links with CreateLink to be able to send
messages between applications.
EXAMPLE :

h=unix_g("hostname")
ExecAppli(SCI+"/bin/scilex",h,"Scilab2")
CreateLink("SELF","Scilab2")
ExecAppli(SCI+"/bin/scilex -ns",h,"Scilab3")
DestroyLink("SELF","Scilab2")

S EE A LSO : CreateLink 686, ExecScilab 687, ExeclScilab 688

2.15.35 ExecScilab executes another local Scilab

CALLING SEQUENCE :

ExecScilab(appli)

PARAMETERS :

Scilab Group March 1997 687

WaitMsg Scilab function

appli : string, name of new Scilab

DESCRIPTION :
ExecScilab executes a new Scilab application on the same host.
After executing ExecScilab, it is necessary to create links with CreateLink to be able to send
messages to new Scilab.
Use ExecAppli to execute a new Scilab application on a remote host.
S EE A LSO : CreateLink 686, ExecAppli 687, ExeclScilab 688

2.15.36 ExeclScilab executes another linked local Scilab

CALLING SEQUENCE :
ExeclScilab(appli)
PARAMETERS :
appli : string, name of new Scilab
DESCRIPTION :
ExecScilab executes a new Scilab application on the same host and creates links between them.
Use ExecAppli to execute a new Scilab application on a remote host.
S EE A LSO : CreateLink 686, ExecAppli 687, ExecScilab 687

2.15.37 GetMsg gets a pending message

CALLING SEQUENCE :
[type,msg,appli] = GetMsg()
PARAMETERS :
type : string
msg : string
appli : string, name of an application
DESCRIPTION :
GetMsg gets, in an asynchronous way, a message sent by another application. The type of the message
is string and the message itself is msg. The name of the application which has sent the message is
appli,
S EE A LSO : SendMsg 688, WaitMsg 689

2.15.38 SendMsg sends a message

CALLING SEQUENCE :
SendMsg(type,msg)
PARAMETERS :
type : string
msg : string
DESCRIPTION :
SendMsg sends a message to ALL applications linked to this application.
S EE A LSO : CreateLink 686, SendMsg 688, WaitMsg 689

Scilab Group March 1997 688

WaitMsg Scilab function

2.15.39 WaitMsg waits for a message

CALLING SEQUENCE :

[type,msg] = WaitMsg(appli)

PARAMETERS :

appli : string, name of an application

type : string
msg : string

DESCRIPTION :
WaitMsg waits for a message sent by another application. As long as any message has not been sent,
WaitMsg waits. This is a way to send and get messages in a synchronous way. The type of the message
is string and the message itself is msg.
By default the name of the first application (the one executed by GeCi) is ”XGeCI”.
S EE A LSO : GetMsg 688, SendMsg 688

Scilab Group March 1997 689

Index

Symbols arsimul, 396

%asn, 445 artest, 400
%helps, 296 articul, 544
%k, 445 ascii, 660
%sn, 446 asin, 166
asinh, 166
A asinhm, 167
abcd, 318 asinm, 167
abinv, 318 atan, 167
abort, 26 atanh, 168
abs, 162 atanhm, 169
ABSBLK f, 598 atanm, 169
acos, 162 augment, 373
acosh, 162 auread, 631
acoshm, 163 auwrite, 632
acosm, 163
AdCommunications, 668 B
add edge, 541 backslash, 26
add node, 541 balanc, 502
addcolor, 85 balreal, 322
addf, 164 bandwr, 544
addinter, 265 bdiag, 502
addmenu, 287 besseli, 169
adj2sp, 164 besselj, 170
adj lists, 542 besselk, 170
aff2ab, 501 bessely, 171
AFFICH f, 598 best match, 545
alufunctions, 85 bezout, 484
amell, 165 bifish, 400
analpf, 446 BIGSOM f, 599
analyze, 631 bilin, 323
and, 165 binomial, 171
ANDLOG f, 598 black, 85
ANIMXY f, 599 bloc2exp, 172
ans, 26 bloc2ss, 173
apropos, 26 bode, 86
arc graph, 543 bool2s, 27
arc number, 543 boolean, 27
argn, 265 boucle, 401
arhnk, 321 brackets, 28
arl2, 321 break, 28
arma, 393 bstap, 374
arma2p, 393 buttmag, 447
armac, 394 bvode, 411
armax, 395
armax1, 396 C

690
WaitMsg Scilab function

c link, 297 cmndred, 485

cainv, 323 code2str, 280
calerf, 175 coeff, 485
calfrq, 324 coff, 505
call, 28 coffg, 485
canon, 325 colcomp, 505
casc, 447 colcompr, 486
case, 30 colinout, 375
ccontrg, 374 colnew, 414
cdfbet, 638 colon, 31
cdfbin, 638 colormap, 89
cdfchi, 639 colregul, 326
cdfchn, 639 comma, 32
cdff, 640 comments, 32
cdffnc, 640 Communications, 686
cdfgam, 641 comp, 266
cdfnbn, 642 companion, 506
cdfnor, 642 con nodes, 548
cdfpoi, 643 cond, 506
cdft, 643 conj, 176
ceil, 176 connex, 549
cepstrum, 448 CONST f, 602
chain struct, 546
cont frm, 327
chaintest, 401
cont mat, 327
champ, 87
contour, 90
champ1, 88
contour2d, 91
chart, 88
contour2di, 92
chdir, 297
contourf, 93
cheb1mag, 448
contr, 328
cheb2mag, 449
contract edge, 549
check graph, 547
contrss, 328
chepol, 449
chfact, 503 convex hull, 550
chol, 503 convol, 450
chsolve, 504 convstr, 280
circuit, 548 copfac, 375
classmarkov, 504 corr, 450
clean, 484 cos, 177
clear, 30 COSBLK f, 602
clearfun, 265 cosh, 177
clearglobal, 31 coshm, 178
CLINDUMMY f, 599 cosm, 178
CLKIN f, 600 cotg, 178
CLKINV f, 600 coth, 179
CLKOUT f, 600 cothm, 179
CLKOUTV f, 600 CreateLink, 686
CLKSOM f, 601 csim, 329
CLKSOMV f, 600 cspect, 452
CLKSPLIT f, 601 ctr gram, 330
CLOCK f, 601 cumprod, 179
close, 652 cumsum, 180
CLR f, 601 curblock, 627
cls2dls, 326 CURV f, 602
CLSS f, 602 cycle basis, 551
cmb lin, 176 czt, 453

Scilab Group March 1997 691

WaitMsg Scilab function

D edit curv, 96
dasrt, 414 eigenmarkov, 507
dassl, 416 ell1mag, 455
datafit, 417 else, 33
date, 314 elseif, 33
dbphi, 330 empty, 33
dcf, 375 emptystr, 280
ddp, 331 end, 34
debug, 32 endfunction, 268
dec2hex, 298 eqfir, 455
deff, 266 eqiir, 456
degree, 486 equal, 34
DELAY f, 603 equil, 334
DELAYV f, 603 equil1, 335
delbpt, 267 ereduc, 508
delete arcs, 551 erf, 182
delete nodes, 552 erfc, 183
delip, 180 erfcx, 183
delmenu, 288 errbar, 96
demos, 298 errcatch, 34
DEMUX f, 603 errclear, 35
denom, 486 error, 35
derivat, 487 eval, 184
derivative-, 419 eval3d, 97
des2ss, 376 eval3dp, 98
des2tf, 332 evans, 98
DestroyLink, 687 EVENTSCOPE f, 605
det, 507 evstr, 35
determ, 487 EVTDLY f, 605
detr, 487 EVTGEN f, 605
dft, 454 Example, 668
dhnorm, 376 excel2sci, 660
diag, 181 exec, 36
diary, 233 ExecAppli, 687
diophant, 488 ExeclScilab, 688
disp, 233 ExecScilab, 687
dispbpt, 267 execstr, 37
dispfile, 233 exists, 37
dlgamma, 182 exit, 38
DLR f, 604 exp, 508
DLRADAPT f, 604 EXPBLK f, 606
DLSS f, 604 expm, 509
dot, 32 external, 38
double, 182 extraction, 39
dragrect, 94 eye, 184
drawaxis, 94
driver, 95 F
dscr, 333 fac3d, 99
dsimul, 333 factors, 488
dt ility, 334 faurre, 456
dtsi, 377 fchamp, 99
fcontour, 100
E fcontour2d, 100
edge number, 553 fec, 101
edit, 267 feedback, 335

Scilab Group March 1997 692

WaitMsg Scilab function

feval, 41 gainplot, 104

ffilt, 457 gamitg, 378
fft, 457 gamma, 186
fgrayplot, 102 gammaln, 186
figure, 652 gcare, 379
file, 234 gcd, 489
fileinfo, 235 gcf, 654
filter, 458 gen net, 554
find, 41 GENERAL f, 606
find freq, 458 GENERIC f, 607
find path, 553 genfac3d, 105
findm, 459 genlib, 270
findobj, 653 genmarkov, 511
fit dat, 419 GENSIN f, 607
fix, 184 GENSQR f, 607
floor, 185 geom3d, 105
flts, 336 get, 654
for, 42 get function path, 271
format, 42 getblocklabel, 627
formatman, 660 getcolor, 106
fort, 43 getcwd, 67
fourplan, 377 getd, 271
fplot2d, 102 getdate, 314
fplot3d, 103 getenv, 45
fplot3d1, 103 getf, 272
fprintf, 235 getfield, 45
fprintfMat, 236 getfont, 106
frep2tf, 338 getio, 238
freq, 339 getlinestyle, 106
freson, 339 getmark, 107
frexp, 185 GetMsg, 688
frfit, 459 getpid, 46
frmag, 460 getscicosvars, 627
fscanf, 237 getsymbol, 107
fscanfMat, 237 getvalue, 288
fsfirlin, 460 getversion, 46
fsolve, 420 gfare, 379
fspecg, 377 gfrancis, 340
fstabst, 378 girth, 555
fstair, 509 givens, 511
full, 186 glever, 512
fullrf, 510 glist, 555
fullrfk, 510 global, 46
fun2string, 661 gpeche, 402
funcprot, 268 gr menu, 107
function, 268 graduate, 108
functions, 269 grand, 644
funptr, 45 graph-list, 555
fusee, 402 graph 2 mat, 558
graph center, 558
G graph complement, 559
G make, 296 graph diameter, 560
g margin, 340 graph power, 560
GAIN f, 606 graph simp, 561
GAINBLK f, 606 graph sum, 561

Scilab Group March 1997 693

WaitMsg Scilab function

graph union, 562 ilib gen Make, 302

Graphics, 80 im inv, 515
graycolormap, 108 imag, 188
grayplot, 109 impl, 421
graypolarplot, 109 imrep2ss, 341
grep, 281 IN f, 609
group, 461 input, 238
gschur, 513 insertion, 51
gsort, 187 int, 188
gspec, 514 int16, 188
gstacksize, 47 int2d, 422
gtild, 380 int32, 188
int3d, 423
H int8, 188
h2norm, 381 intc, 425
h cl, 381 intdec, 464
h inf, 381 INTEGRAL f, 608
h inf st, 382 integrate, 189
h norm, 382 interp, 189
halt, 289 interpln, 190
HALT f, 608 intersci, 303
hamilton, 563 intersect, 190
hank, 461 intg, 425
hankelsv, 383 intl, 426
hat, 47 intppty, 53
havewindow, 289 INTRP2BLK f, 608
help, 298 INTRPLBLK f, 608
hermit, 489 intsplin, 191
hess, 514 inttrap, 192
hex2dec, 299 inttype, 54
hilb, 462 inv, 516
hist3d, 110 inv coeff, 54
histplot, 110 INVBLK f, 609
horner, 490 invr, 491
host, 48 invsyslin, 342
hotcolormap, 111 is connex, 563
householder, 515 isdef, 192
hrmt, 490 iserror, 55
htrianr, 491 isglobal, 55
hypermat, 48 isinf, 193
hypermatrices, 49 isnan, 193
isoview, 111
I isreal, 193
iconvert, 49
ieee, 50 J
if, 50 jmat, 464
IFTHEL f, 608
iir, 463 K
iirgroup, 463 kalm, 465
iirlp, 464 karmarkar, 426
ilib build, 299 kernel, 516
ilib compile, 300 keyboard, 290
ilib for link, 301 knapsack, 564
ilib gen gateway, 302 kpure, 342
ilib gen loader, 302 krac2, 343

Scilab Group March 1997 694

WaitMsg Scilab function

kron, 194 lsslist, 57

kroneck, 517 lstcat, 57
ltitr, 347
L lu, 519
lasterror, 55 ludel, 519
lattn, 465 lufact, 520
lattp, 466 luget, 520
lcf, 383 lusolve, 521
lcm, 492 lyap, 522
lcmdiag, 492
ldiv, 493 M
ldivf, 194 m circle, 113
leastsq, 427 macglov, 387
left, 56 macr2lst, 273
legends, 112 macro, 273
length, 281 macrovar, 274
leqr, 383 make graph, 566
less, 56 man, 305
lev, 466 manedit, 239
levin, 466 mapsound, 633
lex sort, 194 markp2ss, 347
lft, 384 mat 2 graph, 566
lgfft, 468 Matplot, 82
lib, 272 Matplot1, 83
lin, 343 matrices, 58
lin2mu, 632 matrix, 58
lindquist, 469 max, 197
line graph, 564 max cap path, 567
lines, 238 max clique, 568
linf, 385 MAX f, 609
linfn, 385 max flow, 568
link, 303 maxi, 198
linpro, 429 mclearerr, 240
linsolve, 518 MCLOCK f, 610
linspace, 195 mclose, 240
list, 57 mean, 198
lmisolver, 430 median, 199
lmitool, 431 meof, 241
load, 239 mese, 469
load graph, 565 mesh2d, 569
loadwave, 632 metanet, 571
locate, 112 metanet sync, 572
log, 195 MFCLCK f, 610
log10, 196 mfft, 470
log2, 196 mfile2sci, 661
LOGBLK f, 609 mfprintf, 245
logm, 196 mfscanf, 241, 248
logspace, 197 mget, 242
LOOKUP f, 609 mgeti, 242
lotest, 403 mgetl, 243
lqe, 344 mgetstr, 244
lqg, 344 milk drop, 114
lqg2stan, 345 min, 199
lqg ltr, 386 MIN f, 610
lqr, 345 min lcost cflow, 572

Scilab Group March 1997 695

WaitMsg Scilab function

min lcost flow1, 573 O

min lcost flow2, 574 obs gram, 349
min qcost flow, 576 obscont, 349
min weight tree, 577 obscont1, 405
mine, 404 observer, 350
mini, 200 obsv mat, 351
minreal, 348 obsvss, 352
minss, 348 ode, 431
minus, 201 ode discrete, 434
mlist, 59 ode root, 435
mode, 59 odedc, 436
modulo, 201 odedi, 397
mopen, 244 odeoptions, 437
mprintf, 245 oldload, 250
mps2linpro, 202 oldsave, 251
mput, 246 ones, 204
mputl, 247 optim, 438
mputstr, 247 or, 205
mrfit, 470 orth, 523
mscanf, 241, 248 OUT f, 611
mseek, 248 overloading, 61
msprintf, 245
msscanf, 241, 248 P
mtell, 249 p margin, 352
mtlb load, 663 param3d, 115
mtlb mode, 60 param3d1, 116
mtlb save, 663 paramfplot2d, 117
mtlb sparse, 202 parents, 63
mu2lin, 633 parrot, 387
mulf, 203 part, 282
MUX f, 610 path 2 nodes, 580
pause, 64
N pbig, 523
names, 61 pdiv, 493
narsimul, 397 pen2ea, 205
NEGTOPOS f, 611 pencan, 524
nehari, 387 penlaur, 524
neighbors, 577 percent, 64
netclose, 578 perfect match, 581
netwindow, 578 pertrans, 206
netwindows, 579 pfss, 353
newest, 250 phasemag, 353
newfun, 274 phc, 471
nf3d, 114 pinv, 525
nlev, 522 pipe network, 582
nnz, 203 playsnd, 634
node number, 579 plot, 118
nodes 2 path, 579 plot2d, 118
nodes degrees, 580 plot2d1, 121
noisegen, 397 plot2d2, 122
norm, 203 plot2d3, 122
not, 204 plot2d4, 123
null, 61 plot3d, 123
numer, 493 plot3d1, 125
nyquist, 115 plot3d2, 126

Scilab Group March 1997 696

WaitMsg Scilab function

plot3d3, 127 pvm send, 679

plot graph, 582 pvm set timer, 680
plotframe, 127 pvm spawn, 681
plotprofile, 274 pvm spawn independent, 681
plus, 64 pvm start, 682
plzr, 128 pvm tidtohost, 683
pmodulo, 201 pvmd3, 683
pol2des, 494 pwd, 67
pol2str, 494
pol2tex, 664 Q
polar, 525 qassign, 584
polarplot, 128 qr, 528
polfact, 495 QUANT f, 612
poly, 65 quapro, 440
portr3d, 405 quaskro, 528
portrait, 406 quit, 67
POSTONEG f, 611 quote, 67
POWBLK f, 611
power, 66 R
ppol, 354 rand, 207
prbs a, 398 RAND f, 612
predecessors, 584 randpencil, 529
predef, 66 range, 530
print, 251 rank, 530
printf, 252 rat, 207
printf conversion, 252 rational, 68
printing, 129 rcond, 531
prod, 206 rdivf, 208
PROD f, 611 read, 254
profile, 275 read4b, 255
proj, 526 readb, 255
projsl, 354 readc , 256
projspec, 526 READC f, 612
psmall, 527 readmps, 256
pspect, 472 real, 208
pvm, 668 recur, 406
pvm addhosts, 669 REGISTER f, 613
pvm bcast, 669 reglin, 398
pvm bufinfo, 670 RELAY f, 613
pvm config, 670 remez, 473
pvm delhosts, 671 remezb, 473
pvm error, 671 repfreq, 355
pvm exit, 672 replot, 130
pvm get timer, 673 residu, 495
pvm getinst, 673 resume, 68
pvm gsize, 674 return, 68
pvm halt, 674 RFILE f, 613
pvm joingroup, 675 ric desc, 388
pvm kill, 675 ricc, 356
pvm lvgroup, 676 riccati, 389
pvm mytid, 676 rlist, 69
pvm probe, 677 roots, 496
pvm recv, 677 rotate, 131
pvm reduce, 678 round, 209
pvm sci2f77, 672, 679 routh t, 496

Scilab Group March 1997 697

WaitMsg Scilab function

rowcomp, 531 Sfgrayplot, 84

rowcompr, 496 Sgrayplot, 84
rowinout, 389 sgrid, 132
rowregul, 357 shortest path, 586
rowshuff, 532 show arcs, 587
rpem, 474 show graph, 587
rref, 532 show nodes, 588
rtitr, 358 showprofile, 276
sign, 209
S signm, 209
salesman, 585 simp, 497
SAMPLEHOLD f, 614 simp mode, 498
SAT f, 614 sin, 210
save, 258 SINBLK f, 616
save graph, 585 sinc, 476
savewave, 634 sincd, 476
SAWTOOTH f, 614 sinh, 210
scaling, 131 sinhm, 210
scanf, 259 sinm, 211
scanf conversion, 259 size, 211
schur, 533 slash, 71
sci2exp, 307 sm2des, 360
sci2for, 664 sm2ss, 360
sci2map, 308 smooth, 212
sciargs, 69 solve, 212
scicos, 595 SOM f, 616
scicos block, 621 sort, 213
scicos cpr, 623 sound, 634
scicos graphics, 621 sp2adj, 213
scicos link, 622 spaninter, 534
scicos main, 620 spanplus, 535
scicos menus, 595 spantwo, 535
scicos model, 622 sparse, 214
scicosim, 626 spchol, 536
scifunc block, 619 spcompack, 215
scilab, 308 spec, 537
ScilabEval, 649 specfact, 360
scilink, 309 speye, 216
SCOPE f, 615 spget, 216
SCOPXY f, 615 splin, 217
sd2sci, 131 split edge, 589
secto3d, 132 SPLIT f, 616
select, 69 spones, 218
SELECT f, 616 sprand, 218
semi, 70 sprintf, 260
semicolumn, 70 spzeros, 218
semidef, 441 sqroot, 537
SendMsg, 688 sqrt, 219
sensi, 390 sqrtm, 219
set, 655 square, 133
setbpt, 276 squarewave, 220
setfield, 70 srfaur, 476
setmenu, 290 srkf, 477
setscicosvars, 628 ss2des, 361
sfact, 497 ss2ss, 362

Scilab Group March 1997 698

WaitMsg Scilab function

ss2tf, 363 TCLSS f, 617

sscanf, 260 tdinit, 409
sskf, 477 testmatrix, 73
ssprint, 220 texprint, 665
ssrand, 220 TEXT f, 618
st deviation, 221 tf2des, 390
st ility, 364 tf2ss, 367
stabil, 364 then, 73
stacksize, 71 tilda, 73
standard define, 624 TIME f, 618
standard draw, 624 time id, 367
standard input, 625 timer, 315
standard origin, 625 titlepage, 134
standard output, 625 TK EvalFile, 649
star, 72 TK EvalStr, 650
startup, 261 TK GetVar, 651
STOP f, 617 TK SetVar, 651
str2code, 282 tlist, 73
strcat, 283 toeplitz, 227
strindex, 283 trace, 539
string, 284 trans, 478
strings, 284 trans closure, 592
stripblanks, 284 translatepaths, 665
strong con nodes, 589 TRASH f, 618
strong connex, 590 trfmod, 228
strsubst, 285 trianfml, 228
subf, 222 tril, 228
subgraph, 590 trisolve, 229
subplot, 133 triu, 229
successors, 591 trzeros, 368
sum, 222 type, 74
SUPER f, 617 typename, 75
supernode, 592 typeof, 229
sva, 538
svd, 538 U
svplot, 365 ui observer, 369
sylm, 499 uicontrol, 655
sylv, 539 uimenu, 657
symbols, 72 uint16, 188
sysconv, 223 uint32, 188
sysdiag, 224 uint8, 188
sysfact-, 366 ulink, 309
syslin, 224 union, 230
syssize, 367 unique, 230
system, 478 unix, 310
systems, 407 unix g, 310
systmat, 499 unix s, 311
unix w, 311
T unix x, 312
tan, 225 unobs, 370
TANBLK f, 617 unsetmenu, 290
tangent, 408 user, 75
tanh, 226
tanhm, 226 V
tanm, 227 varargin, 277

Scilab Group March 1997 699

WaitMsg Scilab function

varargout, 277 xgetfile, 263

varn, 75 xgetmouse, 145
xgraduate, 146
W xgrid, 147
WaitMsg, 689 xinfo, 147
warning, 261 xinit, 147
wavread, 635 xlfont, 148
wavwrite, 635 xload, 148
WFILE f, 618 xname, 149
wfir, 479 xnumb, 149
what, 76 xpause, 149
where, 76 xpoly, 150
whereami, 76 xpolys, 150
whereis, 77 xrect, 151
while, 77 xrects, 151
who, 77 xrpoly, 152
whos, 78 xs2fig, 152
wiener, 479 xsave, 152
wigner, 480 xsegs, 153
window, 480 xselect, 153
winsid, 134 xset, 154
writb, 261 xsetech, 155
write, 262 xsetm, 157
write4b, 262 xstring, 157
WRITEC f, 619 xstringb, 158
xstringl, 158
X xtape, 159
x choices, 291 xtitle, 159
x choose, 291
x dialog, 292 Y
x matrix, 292 yulewalk, 480
x mdialog, 293
x message, 293 Z
x message modeless, 294 ZCROSS f, 619
xarc, 134 zeropen, 371
xarcs, 135 zeros, 231
xarrows, 135 zgrid, 160
xaxis, 136 zpbutt, 481
xbasc, 137 zpch1, 481
xbasimp, 137 zpch2, 482
zpell, 482
xbasr, 138
xchange, 138
xclea, 138
xclear, 139
xclick, 139
xclip, 140
xdel, 140
xend, 141
xfarc, 141
xfarcs, 142
xfpoly, 142
xfpolys, 143
xfrect, 143
xget, 144
xgetech, 145

Scilab Group March 1997 700