Scilab manual


Table of Contents

I. Scilab
abort — interrupt evaluation.
add_demo — Add an entry in the demos list
ans — answer
argn — Returns the number of input/output arguments in a function call
backslash (\) — left matrix division.
banner — show scilab banner (Windows)
boolean — Scilab Objects, boolean variables and operators & | ~
brackets — ([,]) left and right brackets
break — keyword to interrupt loops
case — keyword used in select
chdir — changes Scilab current directory — changes Scilab current directory
clear — kills variables
clearfun — remove primitive.
clearglobal — kills global variables
colon — (:) colon operator
comma — (,) column, instruction, argument separator
comments — comments
comp — scilab function compilation
comparison — comparison, relational operators
continue — keyword to pass control to the next iteration of a loop
debug — debugging level
delbpt — delete breakpoints
dispbpt — display breakpoints
do — language keyword for loops
dot — (.) symbol
edit — function editing
else — keyword in if-then-else
elseif — keyword in if-then-else
empty — ([]) empty matrix
end — end keyword
equal — (=) assignment , comparison, equal sign
errcatch — error trapping
errclear — error clearing
error — error messages
error_table — table of error messages
evstr — evaluation of expressions
exec — script file execution
exists — checks variable existence
exit — Ends the current Scilab session
external — Scilab Object, external function or routine
extraction — matrix and list entry extraction
for — language keyword for loops
format — number printing and display format
funcprot — switch scilab functions protection mode
funptr — coding of primitives ( wizard stuff )
getdebuginfo — get information about Scilab to debug
getmd5 — get md5 checksum
getmemory — returns free and total system memory
getmodules — returns list of modules installed in Scilab
getos — return Operating System name and version
getscilabmode — returns scilab mode
getshell — returns current command interpreter.
getvariablesonstack — get variable names on stack of scilab
getversion — get scilab and modules version information
global — Define global variable
gstacksize — set/get scilab global stack size
hat — (^) exponentiation
ieee — set floating point exception mode
if then else — conditional execution
insertion — partial variable assignation or modification — partial variable assignation
intppty — set interface argument passing properties
inv_coeff — build a polynomial matrix from its coefficients
iserror — error occurence test
isglobal — check if a variable is global
lasterror — get last recorded error message
left — ([) left bracket
less — (<) lower than comparison — (<) greater than comparison
librarieslist — get scilab libraries
libraryinfo — get macros and path of a scilab library
macr2lst — function to list conversion
macr2tree — function to tree conversion
matrices — Scilab object, matrices in Scilab
matrix — reshape a vector or a matrix to a different size matrix
mode — select a mode in exec file
mtlb_mode — switch Matlab like operations
names — scilab names syntax
newfun — add a name in the table of functions
null — delete an element in a list
parents — ( ) left and right parenthesis
pause — pause mode, invoke keyboard
percent — (%) special character
perl — Call Perl script using appropriate operating system executable
plus — (+) addition operator
poly — polynomial definition
power — power operation (^,.^)
predef — variable protection
pwd — print Scilab current directory — get Scilab current directory
quit — Terminates Scilab or decreases the pause level
quote — (') transpose operator, string delimiter
rational — Scilab objects, rational in Scilab
readgateway — get primitives list of a module
resume — return or resume execution and copy some local variables
return — return or resume execution and copy some local variables
sciargs — scilab command line arguments
scilab — Major unix script to execute Scilab and miscellaneous tools
select — select keyword
semicolon (;) — ending expression and row separator
setbpt — set breakpoints
sethomedirectory — Set Scilab home directory
slash — (/) right division and feed back
stacksize — set scilab stack size
star — (*) multiplication operator
startup — startup file
symbols — scilab operator names
testmatrix — generate some particular matrices
then — keyword in if-then-else
tilda — (~) logical not
try — beginning of try block in try-catch control instruction — beginning of catch block in try-catch control instruction
type — Returns the type of a variable
typename — associates a name to variable type
user — interfacing a Fortran or C routine
varn — symbolic variable of a polynomial
ver — Version information for Scilab
warning — warning messages
what — list the Scilab primitives
where — get current instruction calling tree
whereami — display current instruction calling tree
whereis — name of library containing a function
while — while keyword
who — listing of variables
who_user — listing of user's variables
whos — listing of variables in long form
with_atlas — Checks if Scilab has been built with Atlas Library
with_gtk — Checks if Scilab has been built with the "GIMP Toolkit" library
with_javasci — Checks if Scilab has been built with the java interface
with_macros_source — Checks if macros source are installed
with_module — Checks if a Scilab module is installed
with_pvm — Checks if Scilab has been built with the "Parallel Virtual Machine" interface
with_texmacs — Checks if Scilab has been called by texmacs
with_tk — Checks if Scilab has been built with TCL/TK
II. ARnoldi PACKage
dnaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to a few eigenpairs of a real linear operator
dneupd — ARnoldi Package (not documented 5)
dsaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to a few eigenpairs of a real and symmetric linear operator
dseupd — ARnoldi Package (not documented 4)
znaupd — ARnoldi Package (not documented 3)
zneupd — ARnoldi Package (not documented 6)
III. Boolean
bool2s — convert boolean matrix to a zero one matrix.
find — find indices of boolean vector or matrix true elements
IV. CACSD
abcd — state-space matrices
abinv — AB invariant subspace
arhnk — Hankel norm approximant
arl2 — SISO model realization by L2 transfer approximation
arma — Scilab arma library
arma2p — extract polynomial matrices from ar representation
armac — Scilab description of an armax process
armax — armax identification
armax1 — armax identification
arsimul — armax simulation
augment — augmented plant
balreal — balanced realization
bilin — general bilinear transform
black — Black's diagram (Nichols chart)
bode — Bode plot
bstap — hankel approximant
cainv — Dual of abinv
calfrq — frequency response discretization
canon — canonical controllable form
ccontrg — central H-infinity controller
chart — Nichols chart
cls2dls — bilinear transform
colinout — inner-outer factorization
colregul — removing poles and zeros at infinity
cont_frm — transfer to controllable state-space
cont_mat — controllability matrix
contr — controllability, controllable subspace, staircase
contrss — controllable part
copfac — right coprime factorization
csim — simulation (time response) of linear system
ctr_gram — controllability gramian
dbphi — frequency response to phase and magnitude representation
dcf — double coprime factorization
ddp — disturbance decoupling
des2ss — descriptor to state-space
des2tf — descriptor to transfer function conversion
dhinf — H_infinity design of discrete-time systems
dhnorm — discrete H-infinity norm
dscr — discretization of linear system
dsimul — state space discrete time simulation
dt_ility — detectability test
dtsi — stable anti-stable decomposition
equil — balancing of pair of symmetric matrices
equil1 — balancing (nonnegative) pair of matrices
evans — Evans root locus
feedback — feedback operation
findABCD — discrete-time system subspace identification
findAC — discrete-time system subspace identification
findBD — initial state and system matrices B and D of a discrete-time system
findBDK — Kalman gain and B D system matrices of a discrete-time system
findR — Preprocessor for estimating the matrices of a linear time-invariant dynamical system
findx0BD — Estimates state and B and D matrices of a discrete-time linear system
flts — time response (discrete time, sampled system)
fourplan — augmented plant to four plants
frep2tf — transfer function realization from frequency response
freq — frequency response
freson — peak frequencies
fspecg — stable factorization
fstabst — Youla's parametrization
g_margin — gain margin and associated crossover frequency
gainplot — magnitude plot
gamitg — H-infinity gamma iterations
gcare — control Riccati equation
gfare — filter Riccati equation
gfrancis — Francis equations for tracking
gtild — tilde operation
h2norm — H2 norm
h_cl — closed loop matrix
h_inf — H-infinity (central) controller
h_inf_st — static H_infinity problem
h_norm — H-infinity norm
hankelsv — Hankel singular values
hinf — H_infinity design of continuous-time systems
imrep2ss — state-space realization of an impulse response
inistate — Estimates the initial state of a discrete-time system
invsyslin — system inversion
kpure — continuous SISO system limit feedback gain
krac2 — continuous SISO system limit feedback gain
lcf — normalized coprime factorization
leqr — H-infinity LQ gain (full state)
lft — linear fractional transformation
lin — linearization
linf — infinity norm
linfn — infinity norm
linmeq — Sylvester and Lyapunov equations solver
lqe — linear quadratic estimator (Kalman Filter)
lqg — LQG compensator
lqg2stan — LQG to standard problem
lqg_ltr — LQG with loop transform recovery
lqr — LQ compensator (full state)
ltitr — discrete time response (state space)
m_circle — plots the complex plane iso-gain contours of y/(1+y)
macglov — Mac Farlane Glover problem
markp2ss — Markov parameters to state-space
minreal — minimal balanced realization
minss — minimal realization
mucomp — mu (structured singular value) calculation
narsimul — armax simulation ( using rtitr)
nehari — Nehari approximant
noisegen — noise generation
nyquist — nyquist plot
obs_gram — observability gramian
obscont — observer based controller
observer — observer design
obsv_mat — observability matrix
obsvss — observable part
p_margin — phase margin and associated crossover frequency
parrot — Parrot's problem
pfss — partial fraction decomposition
phasemag — phase and magnitude computation
ppol — pole placement
prbs_a — pseudo random binary sequences generation
projsl — linear system projection
reglin — Linear regression
repfreq — frequency response
ric_desc — Riccati equation
ricc — Riccati equation
riccati — Riccati equation
routh_t — Routh's table
rowinout — inner-outer factorization
rowregul — removing poles and zeros at infinity
rtitr — discrete time response (transfer matrix)
sensi — sensitivity functions
sgrid — s-plane grid lines.
show_margins — display gain and phase margin and associated crossover frequencies
sident — discrete-time state-space realization and Kalman gain
sm2des — system matrix to descriptor
sm2ss — system matrix to state-space
sorder — computing the order of a discrete-time system
specfact — spectral factor
ss2des — (polynomial) state-space to descriptor form
ss2ss — state-space to state-space conversion, feedback, injection
ss2tf — conversion from state-space to transfer function
st_ility — stabilizability test
stabil — stabilization
svplot — singular-value sigma-plot
sysfact — system factorization
syssize — size of state-space system
tf2des — transfer function to descriptor
tf2ss — transfer to state-space
time_id — SISO least square identification
trzeros — transmission zeros and normal rank
ui_observer — unknown input observer
unobs — unobservable subspace
zeropen — zero pencil
zgrid — zgrid plot
V. Compatibility Functions
asciimat — string matrix ascii conversions
firstnonsingleton — Finds first dimension which is not 1
makecell — Creates a cell array.
mstr2sci — character string matrix to character matrix conversion
mtlb_0 — Matlab non-conjugate transposition emulation function
mtlb_a — Matlab addition emulation function
mtlb_all — Matlab all emulation function
mtlb_any — Matlab any emulation function
mtlb_axis — Matlab axis emulation function
mtlb_beta — Matlab beta emulation function
mtlb_box — Matlab box emulation function
mtlb_close — Matlab close emulation function
mtlb_colordef — Matlab colordef emulation function
mtlb_conv — Matlab conv emulation function
mtlb_cumprod — Matlab cumprod emulation function
mtlb_cumsum — Matlab cumsum emulation function
mtlb_dec2hex — Matlab dec2hex emulation function
mtlb_delete — Matlab delete emulation function
mtlb_diag — Matlab diag emulation function
mtlb_diff — Matlab diff emulation function
mtlb_dir — Matlab dir emulation function
mtlb_double — Matlab double emulation function
mtlb_e — Matlab extraction emulation function
mtlb_echo — Matlab echo emulation function
mtlb_eig — Matlab eig emulation function
mtlb_eval — Matlab eval emulation function
mtlb_exist — Matlab exist emulation function
mtlb_eye — Matlab eye emulation function
mtlb_false — Matlab false emulation function
mtlb_fft — Matlab fft emulation function
mtlb_fftshift — Matlab fftshift emulation function
mtlb_find — Matlab find emulation function
mtlb_findstr — Matlab findstr emulation function
mtlb_fliplr — Matlab fliplr emulation function
mtlb_fopen — Matlab fopen emulation function
mtlb_format — Matlab format emulation function
mtlb_fprintf — Matlab fprintf emulation function
mtlb_fread — Matlab fread emulation function
mtlb_fscanf — Matlab fscanf emulation function
mtlb_full — Matlab full emulation function
mtlb_fwrite — Matlab fwrite emulation function
mtlb_grid — Matlab grid emulation function
mtlb_hold — Matlab hold emulation function
mtlb_i — Matlab insertion emulation function
mtlb_ifft — Matlab ifft emulation function
mtlb_imp — Matlab colon emulation function
mtlb_int16 — Matlab int16 emulation function
mtlb_int32 — Matlab int32 emulation function
mtlb_int8 — Matlab int8 emulation function
mtlb_is — Matlab string insertion emulation function
mtlb_isa — Matlab isa emulation function
mtlb_isfield — Matlab isfield emulation function
mtlb_isletter — Matlab isletter emulation function
mtlb_isspace — Matlab isspace emulation function
mtlb_l — Matlab left division emulation function
mtlb_legendre — Matlab legendre emulation function
mtlb_linspace — Matlab linspace emulation function
mtlb_logic — Matlab logical operators emulation function
mtlb_logical — Matlab logical emulation function
mtlb_lower — Matlab lower emulation function
mtlb_max — Matlab max emulation function
mtlb_min — Matlab min emulation function
mtlb_more — Matlab more emulation function
mtlb_num2str — Matlab num2str emulation function
mtlb_ones — Matlab ones emulation function
mtlb_plot — Matlab plot emulation function
mtlb_prod — Matlab prod emulation function
mtlb_rand — Matlab rand emulation function
mtlb_randn — Matlab randn emulation function
mtlb_rcond — Matlab rcond emulation function
mtlb_realmax — Matlab realmax emulation function
mtlb_realmin — Matlab realmin emulation function
mtlb_repmat — Matlab repmat emulation function
mtlb_s — Matlab substraction emulation function
mtlb_setstr — Matlab setstr emulation function
mtlb_size — Matlab size emulation function
mtlb_sort — Matlab sort emulation function
mtlb_strcmp — Matlab strcmp emulation function
mtlb_strcmpi — Matlab strcmpi emulation function
mtlb_strfind — Matlab strfind emulation function
mtlb_strrep — Matlab strrep emulation function
mtlb_sum — Matlab sum emulation function
mtlb_t — Matlab transposition emulation function
mtlb_toeplitz — Matlab toeplitz emulation function
mtlb_tril — Matlab tril emulation function
mtlb_triu — Matlab triu emulation function
mtlb_true — Matlab true emulation function
mtlb_uint16 — Matlab uint16 emulation function
mtlb_uint32 — Matlab uint32 emulation function
mtlb_uint8 — Matlab uint8 emulation function
mtlb_upper — Matlab upper emulation function
mtlb_var — Matlab var emulation function
mtlb_zeros — Matlab zeros emulation function
VI. Completion
completion — returns words that start with the text you pass as parameter.
VII. Console
console — Keyboard Shortcuts in the Console Window
VIII. Data Structures
cell — Create a cell array of empty matrices.
definedfields — return index of list's defined fields
getfield — list field extraction
hypermat — initialize an N dimensional matrices
hypermatrices — Scilab object, N dimensional matrices in Scilab
iscell — Check if a variable is a cell array
iscellstr — Check if a variable is a cell array of strings
isfield — Checks if the given fieldname exists in the structure
isstruct — Check if a variable is a structure array
list — Scilab object and list function definition
lsslist — Scilab linear state space function definition
lstcat — list concatenation
mlist — Scilab object, matrix oriented typed list definition.
rlist — Scilab rational fraction function definition
setfield — list field insertion
struct — create a struct
tlist — Scilab object and typed list definition.
IX. Demo Tools
demo_begin — begin a demonstration
demo_choose — create a dialog box for the choice of options
demo_compiler — test the presence of a compileur
demo_end — completes a demonstration
demo_file_choice — choose and executes an item within a list
demo_function_choice — choose and execute an item within a list
demo_mdialog — create a dialog box
demo_message — display a message
demo_run — script file execution
X. Development tools
tbx_build_gateway — Build a gateway (toolbox compilation process)
tbx_build_gateway_loader — Generate a loader_gateway.sce script (toolbox compilation process)
tbx_build_help — Generate help files (toolbox compilation process)
tbx_build_help_loader — Generate a addchapter.sce script (toolbox compilation process)
tbx_build_loader — Generate a loader.sce script (toolbox compilation process)
tbx_build_macros — Compile macros (toolbox compilation process)
tbx_build_src — Build sources (toolbox compilation process)
tbx_builder_gateway — Run builder_gateway.sce script if it exists (toolbox compilation process)
tbx_builder_gateway_lang — Run builder_gateway_(language).sce script if it exists (toolbox compilation process)
tbx_builder_help — Run builder_help.sce script if it exists (toolbox compilation process)
tbx_builder_help_lang — Run build_help.sce script if it exists (toolbox compilation process)
tbx_builder_macros — Run buildmacros.sce script if it exists (toolbox compilation process)
tbx_builder_src — Run builder_src.sce script if it exists (toolbox compilation process)
tbx_builder_src_lang — Run builder_(language).sce script if it exists (toolbox compilation process)
test_run — Launch tests
XI. Differential Equations
dae — Differential algebraic equations solver
daeoptions — set options for dae solver
dasrt — DAE solver with zero crossing
dassl — differential algebraic equation
feval — multiple evaluation
impl — differential algebraic equation
int2d — definite 2D integral by quadrature and cubature method
int3d — definite 3D integral by quadrature and cubature method
intg — definite integral
ode — ordinary differential equation solver
ode_discrete — ordinary differential equation solver, discrete time simulation
ode_optional_output — ode solvers optional outputs description
ode_root — ordinary differential equation solver with root finding
odedc — discrete/continuous ode solver
odeoptions — set options for ode solvers
XII. Dynamic/incremental Link
G_make — call make or nmake
VCtoLCCLib — converts Ms VC libs to LCC-Win32 libs.
addinter — new functions interface incremental/dynamic link at run time
c_link — check incremental/dynamic link
call — Fortran or C user routines call
chooselcccompiler — choose LCC-Win32 as the default C Compiler.
configure_lcc — set environments variables for LCC-Win32 C Compiler.
configure_ifort — set environments variables for Intel Fortran Compiler (Windows).
configure_msvc — set environments variables for Microsoft C Compiler.
dllinfo — provides information about the format and symbols provided in executable and DLL files (Windows).
findlcccompiler — detects LCC-Win32 C Compiler
findmsifortcompiler — detects Intel fortran Compiler
findmsvccompiler — detects Microsoft C Compiler
fort — Fortran or C user routines call
getdynlibext — get the extension of dynamic libraries on your operating system.
haveacompiler — detect if you have a C compiler.
ilib_build — utility for shared library management
ilib_compile — ilib_build utility: executes the Makefile produced by ilib_gen_Make
ilib_for_link — utility for shared library management with link
ilib_gen_Make — utility for ilib_build: produces a Makefile for building shared libraries
ilib_gen_gateway — utility for ilib_build, generates a gateway file.
ilib_gen_loader — utility for ilib_build: generates a loader file
ilib_mex_build — utility for mex library management
link — dynamic linker
ulink — unlink a dynamically linked shared object
with_lcc — returns if LCC-Win32 is the default C Compiler.
XIII. Elementary Functions
abs — absolute value, magnitude
acos — element wise cosine inverse
acosd — element wise cosine inverse, result in degree.
acosh — hyperbolic cosine inverse
acoshm — matrix hyperbolic inverse cosine
acosm — matrix wise cosine inverse
acot — computes the element-wise inverse cotangeant of the argument.
acotd — computes the element-wise inverse cotangeant of the argument result in degree.
acoth — element wise hyperbolic cotangeant inverse.
acsc — computes the element-wise inverse cosecant of the argument.
acscd — computes the element-wise inverse cosecant of the argument, results in degree.
acsch — computes the element-wise inverse hyperbolic cosecant of the argument.
adj2sp — converts adjacency form into sparse matrix.
amell — Jacobi's am function
and — (&) logical and
asec — computes the element-wise inverse secant of the argument.
asecd — computes the element-wise inverse secant of the argument, results in degree.
asech — computes the element-wise inverse hyperbolic secant of the argument.
asin — sine inverse
asind — sine inverse, results in degree
asinh — hyperbolic sine inverse
asinhm — matrix hyperbolic inverse sine
asinm — matrix wise sine inverse
atan — 2-quadrant and 4-quadrant inverse tangent
atand — 2-quadrant and 4-quadrant element-wise inverse tangent, result in degree.
atanh — hyperbolic tangent inverse
atanhm — matrix hyperbolic tangent inverse
atanm — square matrix tangent inverse
base2dec — conversion from base b representation to integers
bin2dec — integer corresponding to a binary form
binomial — binomial distribution probabilities
bitand — AND applied to binary representation of input arguments
bitor — OR applied to binary representation of input arguments
bloc2exp — block-diagram to symbolic expression
bloc2ss — block-diagram to state-space conversion
cat — concatenate several arrays
ceil — rounding up
cell2mat — convert a cell array into a matrix
cellstr — convert strings vector (or strings matrix) into a cell of strings
char — char function
conj — conjugate
cos — cosine function
cosd — element-wise cosine function, argument in degree
cosh — hyperbolic cosine
coshm — matrix hyperbolic cosine
cosm — matrix cosine function
cotd — cotangent
cotg — cotangent
coth — hyperbolic cotangent
cothm — matrix hyperbolic cotangent
csc — Computes the element-wise cosecant of the argument.
cscd — Computes the element-wise cosecant of the argument given in degree.
csch — Computes the element-wise hyperbolic cosecant of the argument.
cumprod — cumulative product
cumsum — cumulative sum
dec2bin — binary representation
dec2hex — hexadecimal representation of integers
dec2oct — octal representation of integers
delip — complete and incomplete elliptic integral of first kind
diag — diagonal including or extracting
diff — Difference and discrete derivative
double — conversion from integer to double precision representation
dsearch — binary search (aka dichotomous search in french)
eval — evaluation of a matrix of strings
exp — element-wise exponential
eye — identity matrix
factor — factor function
fix — rounding towards zero
flipdim — flip x components along a given dimension
floor — rounding down
frexp — dissect floating-point numbers into base 2 exponent and mantissa
gsort — sorting by quick sort agorithm
hex2dec — conversion from hexadecimal representation to integers
imag — imaginary part
imult — multiplication by i the imaginary unitary
ind2sub — linear index to matrix subscript values
int — integer part
intc — Cauchy integral
integrate — integration of an expression by quadrature
interp1 — one_dimension interpolation function
interp2d — bicubic spline (2d) evaluation function
intersect — returns the vector of common values of two vectors
intl — Cauchy integral
inttrap — integration of experimental data by trapezoidal interpolation
isdef — checks variable existence
isempty — check if a variable is an empty matrix or an empty list
isequal — objects comparison
isequalbitwise — bitwise comparison of variables
isinf — check for infinite entries
isnan — check for "Not a Number" entries
isreal — check if a variable as real or complex entries
kron — Kronecker product (.*.)
lex_sort — lexicographic matrix rows sorting
linspace — linearly spaced vector
log — natural logarithm
log10 — logarithm
log1p — computes with accuracy the natural logarithm of its argument added by one
log2 — base 2 logarithm
logm — square matrix logarithm
logspace — logarithmically spaced vector
lstsize — list, tlist, mlist numbers of entries
max — maximum
maxi — maximum
meshgrid — create matrices or 3-D arrays
min — minimum
mini — minimum
minus — (-) substraction operator, sign changes
modulo — symetric arithmetic remainder modulo m — positive arithmetic remainder modulo m
ndgrid — arrays for multidimensional function evaluation on grid
ndims — number of dimensions of an array
nearfloat — get previous or next floating-point number
nextpow2 — next higher power of 2.
norm — matrix norms
not — (~) logical not
number_properties — determine floating-point parameters
oct2dec — conversion from octal representation to integers
ones — matrix made of ones
or — (|) logical or
pen2ea — pencil to E,A conversion
perms — all permutations of vector components
permute — permute the dimensions of an array
pertrans — pertranspose
primes — primes function
prod — product
rand — random number generator
rat — Floating point rational approximation
real — real part
resize_matrix — create a new matrix with a different size
round — rounding
sec — Compute the element-wise secant of the argument.
secd — Compute the element-wise secant of the argument given in degree.
sech — Compute the element-wise hyperbolic secant of the argument.
setdiff — returns components of a vector which do not belong to another one
sign — sign function
signm — matrix sign function
sin — sine function
sinc — sinc function
sind — sine function, argument in degree.
sinh — hyperbolic sine
sinhm — matrix hyperbolic sine
sinm — matrix sine function
size — size of objects
solve — symbolic linear system solver
sort — stable sorting by "quick sort" algorithm
sp2adj — converts sparse matrix into adjacency form
speye — sparse identity matrix
splin2d — bicubic spline gridded 2d interpolation
spones — sparse matrix
sprand — sparse random matrix
spzeros — sparse zero matrix
sqrt — square root
sqrtm — matrix square root
squarewave — generates a square wave with period 2*%pi
ssprint — pretty print for linear system
ssrand — random system generator
sub2ind — matrix subscript values to linear index
sum — sum (row sum, column sum) of vector/matrix entries
sysconv — system conversion
sysdiag — block diagonal system connection
syslin — linear system definition
tan — tangent
tand — tangent, argument in degree.
tanh — hyperbolic tangent
tanhm — matrix hyperbolic tangent
tanm — matrix tangent
toeplitz — toeplitz matrix
trfmod — poles and zeros display
trianfml — symbolic triangularization
tril — lower triangular part of matrix
trisolve — symbolic linear system solver
triu — upper triangle
typeof — object type
union — extract union components of a vector
unique — extract unique components of a vector or matrices
vectorfind — finds in a matrix rows or columns matching a vector
zeros — matrix made of zeros
XIV. FFTW
fftw — fast fourier transform that use fftw library
fftw_flags — set computation method of fast fourier transform of the fftw function
fftw_forget_wisdom — Reset fftw wisdom
get_fftw_wisdom — return fftw wisdom
set_fftw_wisdom — set fftw wisdom
XV. Files : Input/Output functions
basename — strip directory and suffix from filenames
copyfile — Copy file
createdir — Make new directory
deletefile — delete a file
dir — get file list
dirname — get directory from filenames
dispfiles — display opened files properties
fileext — returns extension for a file path
fileparts — returns the path, filename and extension for a file path
filesep — returns directory separator for current platform
findfiles — Finding all files with a given filespec
fprintf — Emulator of C language fprintf function
fprintfMat — Write a matrix in a file.
fscanf — Converts formatted input read on a file
fscanfMat — Reads a Matrix from a text file.
fullfile — Build a full filename from parts
fullpath — Creates an full path name for the specified relative path name.
getdrives — Get the drive letters of all mounted filesystems on the computer.
getlongpathname — get long path name (Only for Windows)
getshortpathname — get short path name (Only for Windows)
isdir — checks if argument is a directory path
listfiles — list files
listvarinfile — list the contents of a saved data file
ls — show files
maxfiles — sets the limit for the number of files a scilab is allowed to have open simultaneously.
mclearerr — reset binary file access errors
mclose — close an opened file
mdelete — Delete file(s)
meof — check if end of file has been reached
merror — tests the file access errors indicator
mscanf — reads input from the standard input (interface to the C scanf function) — reads input from the stream pointer stream (interface to the C fscanf function) — reads its input from the character string (interface to the C sscanf function)
mget — reads byte or word in a given binary format and convert to double — reads byte or word in a given binary format return an int type
mgetl — read lines from an ascii file
mgetstr — read a character string
mkdir — Make new directory
mopen — open a file
mfprintf — converts, formats, and writes data to a file — converts, formats, and writes data to the main scilab window — converts, formats, and writes data in a string
mput — writes byte or word in a given binary format
mputl — writes strings in an ascii file
mputstr — write a character string in a file
mseek — set current position in binary file.
mtell — binary file management
pathconvert — pathnames convertion between posix and windows.
pathsep — returns path separator for current platform
removedir — Remove a directory
rmdir — Remove a directory
save_format — format of files produced by "save"
scanf — Converts formatted input on standard input
scanf_conversion — scanf, sscanf, fscanf conversion specifications
XVI. Functions
add_profiling — Adds profiling instructions to a function.
bytecode — given a function returns the "bytecode" of a function in a Scilab array and conversely.
bytecodewalk — walk in function bytecode applying transformation.
fun2string — generates ascii definition of a scilab function
function — opens a function definition — closes a function definition
functions — Scilab procedures and Scilab objects
genlib — build library from functions in given directory
get_function_path — get source file path of a library function
getd — getting all functions defined in a directory
head_comments — display scilab function header comments
library — library datatype description
listfunctions — properties of all functions in the workspace
macro — Scilab procedure and Scilab object
macrovar — variables of function
plotprofile — extracts and displays execution profiles of a Scilab function
profile — extract execution profiles of a Scilab function
recompilefunction — recompiles a scilab function, changing its type
remove_profiling — Removes profiling instructions toout of a function.
reset_profiling — Resets profiling counters of a function.
showprofile — extracts and displays execution profiles of a Scilab function
varargin — variable numbers of arguments in an input argument list
varargout — variable numbers of arguments in an output argument list
XVII. GUI
about — show "about scilab" dialog box
addmenu — interactive button or menu definition
clipboard — Copy and paste strings to and from the system clipboard.
close — close a figure
delmenu — interactive button or menu deletion
exportUI — Call the file export graphical interface
figure — create a figure
findobj — find an object with specified property
gcbo — Handle of the object whose callback is executing.
getcallbackobject — Return the handle of the object whose callback is executing.
getinstalledlookandfeels — returns a string matrix with all Look and Feels.
getlookandfeel — gets the current default look and feel.
getvalue — xwindow dialog for data acquisition
messagebox — Open a message box.
printfigure — Opens a printing dialog and prints a figure.
printsetupbox — Display print dialog box.
progressionbar — Draw a progression bar
root_properties — description of the root object properties.
setlookandfeel — sets the current default look and feel.
setmenu — interactive button or menu activation
toolbar — show or hide a toolbar
toprint — Send text or figure to the printer.
uicontrol — create a Graphic User Interface object
uigetcolor — Opens a dialog for selecting a color.
uigetdir — dialog for selecting a directory
uigetfile — dialog window to get a file(s) name(s), path and filter index
uigetfont — Opens a dialog for selecting a font.
uimenu — Create a menu or a submenu in a figure
unsetmenu — interactive button or menu or submenu de-activation
usecanvas — Get/Set the main component used for Scilab graphics.
waitbar — Draw a waitbar
x_choices — interactive Xwindow choices through toggle buttons
x_choose — interactive window choice (modal dialog)
x_choose_modeless — interactive window choice (not modal dialog)
x_dialog — Xwindow dialog
x_matrix — Xwindow editing of matrix
x_mdialog — Xwindow dialog
x_message — X window message
x_message_modeless — X window modeless message
xgetfile — dialog to get a file path
XVIII. Genetic Algorithms
coding_ga_binary — A function which performs conversion between binary and continuous representation
coding_ga_identity — A "no-operation" conversion function
crossover_ga_binary — A crossover function for binary code
crossover_ga_default — A crossover function for continuous variable functions
init_ga_default — A function a initialize a population
mutation_ga_binary — A function which performs binary mutation
mutation_ga_default — A continuous variable mutation function
optim_ga — A flexible genetic algorithm
optim_moga — multi-objective genetic algorithm
optim_nsga — A multi-objective Niched Sharing Genetic Algorithm
optim_nsga2 — A multi-objective Niched Sharing Genetic Algorithm version 2
pareto_filter — A function which extracts non dominated solution from a set
selection_ga_elitist — An 'elitist' selection function
selection_ga_random — A function which performs a random selection of individuals
XIX. Graphics : exporting and printing
driver — select a graphics driver
xend — close a graphics session
xinit — Initialization of a graphics driver
xs2bmp — send graphics to a file in BMP syntax
xs2emf — send graphics to a file in EMF syntax (Only for Windows)
xs2eps — save graphics to a Postscript file.
xs2fig — send graphics to a file in FIG syntax
xs2gif — send graphics to a file in GIF syntax
xs2jpg — send graphics to a file in JPG syntax
xs2pdf — save graphics to a PDF file.
xs2png — send graphics to a file in PNG syntax
xs2ppm — send graphics to a file in PPM syntax
xs2ps — send graphics to a file in PS syntax
xs2svg — save graphics to a SVG file.
XX. Graphics Library
GlobalProperty — to customize the objects appearance (curves, surfaces...) in a plot or surf command.
Graphics — graphics library overview
LineSpec — to quickly customize the lines appearance in a plot
Matplot — 2D plot of a matrix using colors
Matplot1 — 2D plot of a matrix using colors
Matplot_properties — description of the Matplot entities properties
Sfgrayplot — smooth 2D plot of a surface defined by a function using colors
Sgrayplot — smooth 2D plot of a surface using colors
addcolor — add new colors to the current colormap
alufunctions — pixel drawing functions
arc_properties — description of the Arc entity properties
autumncolormap — red through orange to yellow colormap
axes_properties — description of the axes entity properties
axis_properties — description of the axis entity properties
bar — bar histogram
barh — horizontal display of bar histogram
barhomogenize — homogenize all the bars included in the current working axes
bonecolormap — gray colormap with a light blue tone
captions — draw graph captions
champ — 2D vector field plot
champ1 — 2D vector field plot with colored arrows
champ_properties — description of the 2D vector field entity properties
clear_pixmap — erase the pixmap buffer
clf — clear or reset the current graphic figure (window) to default values
color — returns the color id of a color
color_list — list of named colors
colorbar — draw a colorbar
colordef — Set default color values to display different color schemes
colormap — using colormaps
Compound_properties — description of the Compound entity properties
contour — level curves on a 3D surface
contour2d — level curves of a surface on a 2D plot
contour2di — compute level curves of a surface on a 2D plot
contourf — filled level curves of a surface on a 2D plot
coolcolormap — cyan to magenta colormap
coppercolormap — black to a light copper tone colormap
copy — copy a graphics entity.
delete — delete a graphic entity and its children.
dragrect — Drag rectangle(s) with mouse
draw — draw an entity.
drawaxis — draw an axis
drawlater — makes axes children invisible.
drawnow — draw hidden graphics entities.
edit_curv — interactive graphic curve editor
errbar — add vertical error bars on a 2D plot
eval3d — values of a function on a grid
eval3dp — compute facets of a 3D parametric surface
event handler functions — Prototype of functions which may be used as event handler.
fac3d — 3D plot of a surface (obsolete)
fchamp — direction field of a 2D first order ODE
fcontour — level curves on a 3D surface defined by a function
fcontour2d — level curves of a surface defined by a function on a 2D plot
fec — pseudo-color plot of a function defined on a triangular mesh
fec_properties — description of the fec entities properties
fgrayplot — 2D plot of a surface defined by a function using colors
figure_properties — description of the graphics figure entity properties
fplot2d — 2D plot of a curve defined by a function
fplot3d — 3D plot of a surface defined by a function
fplot3d1 — 3D gray or color level plot of a surface defined by a function
gca — Return handle of current axes.
gce — Get current entity handle.
gcf — Return handle of current graphic window.
gda — Return handle of default axes.
gdf — Return handle of default figure.
ged — Scilab Graphic Editor
genfac3d — compute facets of a 3D surface
geom3d — projection from 3D on 2D after a 3D plot
get — Retrieve a property value from a graphics entity or an User Interface object.
get_figure_handle — get a figure handle from its id
getcolor — opens a dialog to show colors in the current colormap
getfont — dialog to select font . Obsolete function.
getlinestyle — dialog to select linestyle. Obsolete function.
getmark — dialog to select mark (symbol). Obsolete function
getsymbol — dialog to select a symbol and its size. Obsolete function
glue — glue a set of graphics entities into an Compound.
graduate — pretty axis graduations
graphics_entities — description of the graphics entities data structures — description of the graphics entities data structures
graphics_fonts — description of fonts used in graphic figures
graycolormap — linear gray colormap
grayplot — 2D plot of a surface using colors
grayplot_properties — description of the grayplot entities properties
graypolarplot — Polar 2D plot of a surface using colors
havewindow — return scilab window mode
hist3d — 3D representation of a histogram
histplot — plot a histogram
hotcolormap — red to yellow colormap
hsv2rgb — Converts HSV colors to RGB
hsvcolormap — Hue-saturation-value colormap
is_handle_valid — Check wether a set of graphic handles is still valid.
isoview — set scales for isometric plot (do not change the size of the window)
jetcolormap — blue to red colormap
label_properties — description of the Label entity properties
legend — draw graph legend
legend_properties — description of the Legend entity properties.
legends — draw graph legend
locate — mouse selection of a set of points
mesh — 3D mesh plot
milk_drop — milk drop 3D function
move — move, translate, a graphic entity and its children.
name2rgb — returns the RGB values of a named color
newaxes — Creates a new Axes entity
nf3d — rectangular facets to plot3d parameters
object_editor — description of the graphic object editor capacities — description of the graphic object editor capacities — description of the graphic object editor capacities
oceancolormap — linear blue colormap
oldplot — simple plot (old version)
param3d — 3D plot of a parametric curve
param3d1 — 3D plot of parametric curves
paramfplot2d — animated 2D plot, curve defined by a function
pie — draw a pie
pinkcolormap — sepia tone colorization on black and white images
plot — 2D plot
plot2d — 2D plot
plot2d1 — 2D plot (logarithmic axes) (obsolete)
plot2d2 — 2D plot (step function)
plot2d3 — 2D plot (vertical bars)
plot2d4 — 2D plot (arrows style)
plot2d_old_versionThe syntaxes described below are obsolete
plot3d — 3D plot of a surface
plot3d1 — 3D gray or color level plot of a surface
plot3d2 — plot surface defined by rectangular facets
plot3d3 — mesh plot surface defined by rectangular facets
plot3d_old_version — 3D plot of a surface
plotframe — plot a frame with scaling and grids. This function is obsolete.
plzr — pole-zero plot
polarplot — Plot polar coordinates
polyline_properties — description of the Polyline entity properties
rainbowcolormap — red through orange, yellow, green,blue to violet colormap
rectangle_properties — description of the Rectangle entity properties
relocate_handle — Move handles inside the graphic hierarchy.
replot — redraw the current graphics window with new boundaries
rgb2name — returns the name of a color
rotate — rotation of a set of points
rotate_axes — Interactive rotation of an Axes handle.
rubberbox — Rubberband box for rectangle selection
sca — set the current axes entity
scaling — affine transformation of a set of points
scf — set the current graphic figure (window)
sd2sci — gr_menu structure to scilab instruction convertor
sda — Set default axes.
sdf — Set default figure.
secto3d — 3D surfaces conversion
segs_properties — description of the Segments entity properties
set — set a property value of a graphic entity object or of a User Interface object.
set_posfig_dim — change defaut transformation for exporting in postscript
seteventhandler — set an event handler for the current graphic window
show_pixmap — send the pixmap buffer to the screen
show_window — raises a graphics window
springcolormap — magenta to yellow colormap
square — set scales for isometric plot (change the size of the window)
stringbox — Compute the bounding rectangle of a text or a label.
subplot — divide a graphics window into a matrix of sub-windows
summercolormap — green to yellow colormap
surf — 3D surface plot
surface_properties — description of the 3D entities properties
swap_handles — Permute two handles in the graphic Hierarchy.
text_properties — description of the Text entity properties
title — display a title on a graphic window
titlepage — add a title in the middle of a graphics window
twinkle — is used to have a graphics entity twinkle
unglue — unglue a coumpound object and replace it by individual children.
unzoom — unzoom graphics
whitecolormap — completely white colormap
winsid — return the list of graphics windows
wintercolormap — blue to green colormap
xarc — draw a part of an ellipse
xarcs — draw parts of a set of ellipses
xarrows — draw a set of arrows
xbasc — clears a graphics window.
xbasr — redraw a graphics window
xchange — transform real to pixel coordinates
xclear — clears a graphics window
xclick — Wait for a mouse click.
xclip — (obsolete) set a clipping zone
xdel — delete a graphics window
xfarc — fill a part of an ellipse
xfarcs — fill parts of a set of ellipses
xfpoly — fill a polygon
xfpolys — fill a set of polygons
xfrect — fill a rectangle
xget — get current values of the graphics context. This function is obsolete.
xgetech — get the current graphics scale
xgetmouse — get the mouse events and current position
xgraduate — axis graduation
xgrid — add a grid on a 2D plot
xinfo — draw an info string in the message subwindow
xlfont — load a font in the graphic context or query loaded font
xload — load a saved graphics
xname — change the name of the current graphics window
xnumb — draw numbers
xpause — suspend Scilab
xpoly — draw a polyline or a polygon
xpolys — draw a set of polylines or polygons
xrect — draw a rectangle
xrects — draw or fill a set of rectangles
xrpoly — draw a regular polygon
xsave — save graphics into a file
xsegs — draw unconnected segments
xselect — raise the current graphics window
xset — set values of the graphics context. This function is obsolete.
xsetech — set the sub-window of a graphics window for plotting
xsetm — dialog to set values of the graphics context. Obsolete function.
xstring — draw strings
xstringb — draw strings into a box
xstringl — compute a box which surrounds strings
xtitle — add titles on a graphics window
zoom_rect — zoom a selection of the current graphic figure
XXI. History manager
addhistory — add lines to current history.
displayhistory — displays current scilab history
gethistory — returns current scilab history in a string matrix
gethistoryfile — get filename used for scilab's history
historymanager — enable or disable history manager
historysize — get number of lines in history
loadhistory — load a history file
removelinehistory — remove the Nth line in history.
resethistory — Deletes all entries in the scilab history.
saveafterncommands — Save the history file after n statements are added to the file.
saveconsecutivecommands — Save consecutive duplicate commands.
savehistory — save the current history in a file
sethistoryfile — set filename for scilab history
XXII. Input/Output functions
deff — on-line definition of function
diary — diary of session
disp — displays variables
execstr — execute Scilab code in strings
file — file management
fileinfo — Provides information about a file
get_absolute_file_path — Given an absolute pathname of a file opened in scilab.
getenv — get the value of an environment variable
getf — defining a function from a file
getio — get Scilab input/output logical units
getpid — get Scilab process identificator
getrelativefilename — Given an absolute directory and an absolute filename, returns a relative file name.
getscilabkeywords — returns a list with all scilab keywords.
halt — stop execution
host — Unix or DOS command execution
input — prompt for user input
lib — library definition
load — load saved variable
newest — returns newest file of a set of files
oldload — load saved variable in 2.4.1 and previous formats
oldsave — saving variables in 2.4.1 and previous format
print — prints variables in a file
printf — Emulator of C language printf function
printf_conversion — printf, sprintf, fprintf conversion specifications
read — matrices read
read4b — fortran file binary read
readb — fortran file binary read
readc_ — read a character string
save — saving variables in binary files
setenv — set the value of an environment variable
sprintf — Emulator of C language sprintf function
sscanf — Converts formatted input given by a string
unix — shell (sh) command execution
unix_g — shell (sh) command execution, output redirected to a variable
unix_s — shell (sh) command execution, no output
unix_w — shell (sh) command execution, output redirected to scilab window
unix_x — shell (sh) command execution, output redirected to a window
writb — fortran file binary write
write — write in a formatted file
write4b — fortran file binary write
XXIII. Integers
iconvert — conversion to 1 or 4 byte integer representation
int8 — conversion to one byte integer representation — conversion to 2 bytes integer representation — conversion to 4 bytes integer representation — conversion to one byte unsigned integer representation — conversion to 2 bytes unsigned integer representation — conversion to 4 bytes unsigned integer representation
inttype — type integers used in integer data types
XXIV. Interpolation
bsplin3val — 3d spline arbitrary derivative evaluation function
cshep2d — bidimensional cubic shepard (scattered) interpolation
eval_cshep2d — bidimensional cubic shepard interpolation evaluation
interp — cubic spline evaluation function
interp3d — 3d spline evaluation function
interpln — linear interpolation
intsplin — integration of experimental data by spline interpolation
linear_interpn — n dimensional linear interpolation
lsq_splin — weighted least squares cubic spline fitting
smooth — smoothing by spline functions
splin — cubic spline interpolation
splin3d — spline gridded 3d interpolation
XXV. Intersci
intersci — scilab tool to interface C of Fortran functions with scilab
XXVI. JVM
javaclasspath — set and get dynamic Java class path
javalibrarypath — set and get dynamic java.library.path
jre_path — returns Java Runtime Environment used by Scilab
system_getproperty — gets the system property indicated by a specified key.
system_setproperty — set a system property indicated by a specified key and value.
with_embedded_jre — checks if scilab uses a embedded JRE
XXVII. Java Interface
javasci.SciBoolean — Class to use boolean object with scilab
javasci.SciBooleanArray — Class to use boolean matrix in Scilab.
javasci.SciComplex — Class to use complex object with scilab
javasci.SciComplexArray — Class to use complex matrix in Scilab.
javasci.SciDouble — Class to use double object with scilab
javasci.SciDoubleArray — Class to use real matrix in Scilab.
javasci.SciString — Map a Java String into a Scilab string.
javasci.SciStringArray — Classe to use String matrix in Scilab.
javasci.Scilab — This class provides the basic methods to execute Scilab code and scripts.
Compile and run with javasci — How to compile a Java application using Javasci
javasci — Call Scilab engine from a Java application
XXVIII. Linear Algebra
aff2ab — linear (affine) function to A,b conversion
balanc — matrix or pencil balancing
bdiag — block diagonalization, generalized eigenvectors
chfact — sparse Cholesky factorization
chol — Cholesky factorization
chsolve — sparse Cholesky solver
classmarkov — recurrent and transient classes of Markov matrix
cmb_lin — symbolic linear combination
coff — resolvent (cofactor method)
colcomp — column compression, kernel, nullspace
companion — companion matrix
cond — condition number
det — determinant
eigenmarkov — normalized left and right Markov eigenvectors
ereduc — computes matrix column echelon form by qz transformations
expm — square matrix exponential
fstair — computes pencil column echelon form by qz transformations
fullrf — full rank factorization
fullrfk — full rank factorization of A^k
genmarkov — generates random markov matrix with recurrent and transient classes
givens — Givens transformation
glever — inverse of matrix pencil
gschur — generalized Schur form (obsolete).
gspec — eigenvalues of matrix pencil (obsolete)
hess — Hessenberg form
householder — Householder orthogonal reflexion matrix
im_inv — inverse image
inv — matrix inverse
kernel — kernel, nullspace
kroneck — Kronecker form of matrix pencil
linsolve — linear equation solver
lsq — linear least square problems.
lu — LU factors of Gaussian elimination
lyap — Lyapunov equation
nlev — Leverrier's algorithm
orth — orthogonal basis
pbig — eigen-projection
pencan — canonical form of matrix pencil
penlaur — Laurent coefficients of matrix pencil
pinv — pseudoinverse
polar — polar form
proj — projection
projspec — spectral operators
psmall — spectral projection
qr — QR decomposition
quaskro — quasi-Kronecker form
randpencil — random pencil
range — range (span) of A^k
rank — rank
rankqr — rank revealing QR factorization
rcond — inverse condition number
rowcomp — row compression, range
rowshuff — shuffle algorithm
rref — computes matrix row echelon form by lu transformations
schur — [ordered] Schur decomposition of matrix and pencils
spaninter — subspace intersection
spanplus — sum of subspaces
spantwo — sum and intersection of subspaces
spec — eigenvalues of matrices and pencils
sqroot — W*W' hermitian factorization
squeeze — squeeze
sva — singular value approximation
svd — singular value decomposition
sylv — Sylvester equation.
trace — trace
XXIX. Localization
dgettext — get text translated into the current locale and a specific domain domain.
getdefaultlanguage — getdefaultlanguage() returns the default language used by Scilab.
getlanguage — getlanguage() returns current language used by Scilab.
gettext — get text translated into the current locale and domain.
LANGUAGE — Variable defining the language (OBSOLETE)
setdefaultlanguage — sets and saves the internal LANGUAGE value.
setlanguage — Sets the internal LANGUAGE value.
XXX. Maple Interface
sci2map — Scilab to Maple variable conversion
XXXI. Matlab binary files I/O
loadmatfile — loads a Matlab V6 MAT-file (binary or ASCII) into Scilab
matfile_close — Closes a Matlab V5 binary MAT-file.
matfile_listvar — Lists variables of a Matlab V5 binary MAT-file.
matfile_open — Opens a Matlab V5 binary MAT-file.
matfile_varreadnext — Reads next variable in a Matlab V5 binary MAT-file.
matfile_varwrite — Write a variable in a Matlab V5 binary MAT-file.
savematfile — write a Matlab MAT-file (binary or ASCII)
XXXII. Matlab to Scilab Conversion Tips
About_M2SCI_tools — Generally speaking about tools to convert Matlab files to Scilab...
Contents — Create a tree containing contents inference data
Cste — Create a tree representing a constant
Equal — Create a tree representing an instruction
Funcall — Create a tree representing a function call
Infer — Create a tree containing inference data
Matlab-Scilab_character_strings — Generally speaking about...
Operation — Create a tree representing an operation
Type — Create a tree containing type inference data
Variable — Create a tree representing a variable
get_contents_infer — Search for information in a "M2SCi tlist" contents
m2scideclare — Giving tips to help M2SCI...
matfile2sci — converts a Matlab 5 MAT-file into a Scilab binary file
mfile2sci — Matlab M-file to Scilab conversion function
sci_files — How to write conversion functions
translatepaths — convert a set of Matlab M-files directories to Scilab
XXXIII. Metanet : Graph and Network toolbox
add_edge — adds an edge or an arc between two nodes
add_edge_data — associates new data fields to the edges data structure of a graph
add_node — adds disconnected nodes to a graph
add_node_data — associates new data fields to the nodes data structure of a graph
adj_lists — computes adjacency lists
arc_graph — graph with nodes corresponding to arcs
arc_number — number of arcs of a graph
articul — finds one or more articulation points
bandwr — bandwidth reduction for a sparse matrix
best_match — maximum matching of a graph
chain_struct — chained structure from adjacency lists of a graph
check_graph — checks a Scilab graph data structure
circuit — finds a circuit or the rank function in a directed graph
con_nodes — set of nodes of a connected component
connex — connected components
contract_edge — contracts edges between two nodes
convex_hull — convex hull of a set of points in the plane
cycle_basis — basis of cycle of a simple undirected graph
delete_arcs — deletes all the arcs or edges between a set of nodes
delete_edges — deletes all the arcs or edges between a set of nodes
delete_nodes — deletes nodes
edge_number — number of edges of a graph
edgedatafields — returns the vector of edge data fields names
edges_data_structure — description of the data structure representing the edges of a graph
edit_graph — graph and network graphical editor
edit_graph_menus — edit_graph menus description
egraphic_data_structure — data structure representing the graphic properties used for edges graphical display
find_path — finds a path between two nodes
gen_net — interactive or random generation of a network
girth — girth of a directed graph
glist — Scilab-4.x graph list creation
graph-list — description of graph list (obsolete)
graph_2_mat — node-arc or node-node incidence matrix of a graph
graph_center — center of a graph
graph_complement — complement of a graph
graph_data_structure — description of the main graph data structure
graph_diameter — diameter of a graph
graph_power — kth power of a directed 1-graph
graph_simp — converts a graph to a simple undirected graph
graph_sum — sum of two graphs
graph_union — union of two graphs
hamilton — hamiltonian circuit of a graph
hilite_edges — highlights a set of edges — unhighlights a set of edges
hilite_nodes — highlights a set of nodes — unhighlights a set of nodes
index_from_tail_head — Computes the index of edges given by (tail,head) pairs
is_connex — connectivity test
knapsack — solves a 0-1 multiple knapsack problem
line_graph — graph with nodes corresponding to edges
load_graph — loads a graph from a file
make_graph — makes a graph list
mat_2_graph — graph from node-arc or node-node incidence matrix
max_cap_path — maximum capacity path
max_clique — maximum clique of a graph
max_flow — maximum flow between two nodes
mesh2d — triangulation of n points in the plane
metanet_module_path — Returns the path of the metanet module
min_lcost_cflow — minimum linear cost constrained flow
min_lcost_flow1 — minimum linear cost flow
min_lcost_flow2 — minimum linear cost flow
min_qcost_flow — minimum quadratic cost flow
min_weight_tree — minimum weight spanning tree
neighbors — nodes connected to a node
netclose — closes an edit_graph window
netwindow — selects the current edit_graph window
netwindows — gets the numbers of edit_graph windows
ngraphic_data_structure — data structure representing the graphic properties used for nodes graphical display
node_number — number of nodes of a graph
nodedatafields — returns the vector of node data fields names
nodes_2_path — path from a set of nodes
nodes_data_structure — description of the data structure representing the nodes of a graph
nodes_degrees — degrees of the nodes of a graph
path_2_nodes — set of nodes from a path
perfect_match — min-cost perfect matching
pipe_network — solves the pipe network problem
plot_graph — general plot of a graph (obsolete)
predecessors — tail nodes of incoming arcs of a node
qassign — solves a quadratic assignment problem
salesman — solves the travelling salesman problem
save_graph — saves a graph in a file
set_nodes_id — displays labels near selected nodes in a graph display.
shortest_path — shortest path
show_arcs — highlights a set of arcs
show_edges — highlights a set of edges
show_graph — displays a graph
show_nodes — highlights a set of nodes
split_edge — splits an edge by inserting a node
strong_con_nodes — set of nodes of a strong connected component
strong_connex — strong connected components
subgraph — subgraph of a graph
successors — head nodes of outgoing arcs of a node
supernode — replaces a group of nodes with a single node
trans_closure — transitive closure
update_graph — converts an old graph data structure to the current one.
XXXIV. Online help management
add_help_chapter — Add an entry in the helps list
apropos — searches keywords in Scilab help
foo — foo short description
help — on-line help command
help_from_sci — Generate help files and demo files from the head comments section of a .sci source file.
help_skeleton — build the skeleton of the xml help file associated to a Scilab function
make_index — creates a new index file for on-line help
man — on line help XML file description format
manedit — editing a manual item
%helps — Variable defining the path of help directories
xmltohtml — converts xml Scilab help files to HTML format
xmltojar — converts xml Scilab help files to javaHelp format
xmltopdf — converts xml Scilab help files to pdf format
xmltops — converts xml Scilab help files to postscript format
XXXV. Optimization and Simulation
NDcost — generic external for optim computing gradient using finite differences
bvode — boundary value problems for ODE
bvodeS — simplified call of bvode
datafit — Parameter identification based on measured data
derivative — approximate derivatives of a function
fit_dat — Parameter identification based on measured data
fsolve — find a zero of a system of n nonlinear functions
karmarkar — karmarkar algorithm
leastsq — Solves non-linear least squares problems
linpro — linear programming solver (obsolete)
lmisolver — linear matrix inequation solver
lmitool — tool for solving linear matrix inequations
lsqrsolve — minimize the sum of the squares of nonlinear functions, levenberg-marquardt algorithm
mps2linpro — convert lp problem given in MPS format to linpro format (obsolete)
numdiff — numerical gradient estimation
optim — non-linear optimization routine
qld — linear quadratic programming solver
qp_solve — linear quadratic programming solver builtin
qpsolve — linear quadratic programming solver
quapro — linear quadratic programming solver (obsolete)
semidef — semidefinite programming
XXXVI. Overloading
overloading — display, functions and operators overloading capabilities
XXXVII. Parameters
add_param — Add a parameter to a list of parameters
get_param — Get the value of a parameter in a parameter list
init_param — Initialize the structure which will handles the parameters list
is_param — Check if a parameter is present in a parameter list
list_param — List all the parameters name in a list of parameters
remove_param — Remove a parameter and its associated value from a list of parameters
set_param — Set the value of a parameter in a parameter list
XXXVIII. Polynomials
bezout — Bezout equation for polynomials or integers
clean — cleans matrices (round to zero small entries)
cmndred — common denominator form
coeff — coefficients of matrix polynomial
coffg — inverse of polynomial matrix
colcompr — column compression of polynomial matrix
degree — degree of polynomial matrix
denom — denominator
derivat — rational matrix derivative
determ — determinant of polynomial matrix
detr — polynomial determinant
diophant — diophantine (Bezout) equation
factors — numeric real factorization
gcd — gcd calculation
hermit — Hermite form
horner — polynomial/rational evaluation
hrmt — gcd of polynomials
htrianr — triangularization of polynomial matrix
invr — inversion of (rational) matrix
lcm — least common multiple
lcmdiag — least common multiple diagonal factorization
ldiv — polynomial matrix long division
numer — numerator
pdiv — polynomial division
pol2des — polynomial matrix to descriptor form
pol2str — polynomial to string conversion
polfact — minimal factors
residu — residue
roots — roots of polynomials
rowcompr — row compression of polynomial matrix
sfact — discrete time spectral factorization
simp — rational simplification
simp_mode — toggle rational simplification
sylm — Sylvester matrix
systmat — system matrix
XXXIX. Randlib
grand — Random number generator(s)
XL. Scilab to Fortran
sci2for — scilab function to Fortran routine conversion
XLI. Scipad
edit_error — opens in SciPad the source of the last recorded error
scipad — Embedded Scilab text editor
XLII. Shell
clc — Clear Command Window
lines — rows and columns used for display
prompt — Get/Set current prompt
tohome — Move the cursor to the upper left corner of the Command Window
XLIII. Signal Processing
Signal — Signal manual description
analpf — create analog low-pass filter
bilt — bilinear or biquadratic transform SISO system given by a zero/poles representation
buttmag — response of Butterworth filter
casc — cascade realization of filter from coefficients
cepstrum — cepstrum calculation
cheb1mag — response of Chebyshev type 1 filter
cheb2mag — response of type 2 Chebyshev filter
chepol — Chebychev polynomial
convol — convolution
corr — correlation, covariance
cspect — two sided cross-spectral estimate between 2 discrete time signals using the correlation method
czt — chirp z-transform algorithm
detrend — remove constant, linear or piecewise linear trend from a vector
dft — discrete Fourier transform
ell1mag — magnitude of elliptic filter
eqfir — minimax approximation of FIR filter
eqiir — Design of iir filters
faurre — filter computation by simple Faurre algorithm
ffilt — coefficients of FIR low-pass
fft — fast Fourier transform. — fast Fourier transform.
fft2 — two-dimension fast Fourier transform
fftshift — rearranges the fft output, moving the zero frequency to the center of the spectrum
filt_sinc — samples of sinc function
filter — filters a data sequence using a digital filter
find_freq — parameter compatibility for elliptic filter design
findm — for elliptic filter design
frfit — frequency response fit
frmag — magnitude of FIR and IIR filters
fsfirlin — design of FIR, linear phase filters, frequency sampling technique
group — group delay for digital filter
hank — covariance to hankel matrix
hilb — FIR approximation to a Hilbert transform filter
hilbert — Discrete-time analytic signal computation of a real signal using Hilbert transform
iir — iir digital filter
iirgroup — group delay Lp IIR filter optimization
iirlp — Lp IIR filter optimization
intdec — Changes sampling rate of a signal
jmat — row or column block permutation
kalm — Kalman update
lattn — recursive solution of normal equations
lattp — lattp
lev — Yule-Walker equations (Levinson's algorithm)
levin — Toeplitz system solver by Levinson algorithm (multidimensional)
lgfft — utility for fft
lindquist — Lindquist's algorithm
mese — maximum entropy spectral estimation
mfft — multi-dimensional fft
mrfit — frequency response fit
%asn — elliptic integral
%k — Jacobi's complete elliptic integral
%sn — Jacobi 's elliptic function
phc — Markovian representation
pspect — two sided cross-spectral estimate between 2 discrete time signals using the Welch's average periodogram method.
remez — Remez exchange algorithm for the weighted chebyshev approximation of a continuous function with a sum of cosines.
remezb — Minimax approximation of magnitude response
rpem — RPEM estimation
sincd — digital sinc function or Direchlet kernel
srfaur — square-root algorithm
srkf — square root Kalman filter
sskf — steady-state Kalman filter
syredi — Design of iir filters, syredi code interface
system — observation update
trans — low-pass to other filter transform
wfir — linear-phase FIR filters
wiener — Wiener estimate
wigner — 'time-frequency' wigner spectrum
window — compute symmetric window of various type
yulewalk — least-square filter design
zpbutt — Butterworth analog filter
zpch1 — Chebyshev analog filter
zpch2 — Chebyshev analog filter
zpell — lowpass elliptic filter
XLIV. Simulated Annealing
compute_initial_temp — A SA function which allows to compute the initial temperature of the simulated annealing
neigh_func_csa — The classical neighborhood relationship for the simulated annealing
neigh_func_default — A SA function which computes a neighbor of a given point
neigh_func_fsa — The Fast Simulated Annealing neghborhood relationship
neigh_func_vfsa — The Very Fast Simulated Annealing neighborhood relationship
optim_sa — A Simulated Annealing optimization method
temp_law_csa — The classical temperature decrease law
temp_law_default — A SA function which computed the temperature of the next temperature stage
temp_law_fsa — The Szu and Hartley Fast simulated annealing
temp_law_huang — The Huang temperature decrease law for the simulated annealing
temp_law_vfsa — This function implements the Very Fast Simulated Annealing from L. Ingber
XLV. Sound file handling
analyze — frequency plot of a sound signal
auread — load .au sound file
auwrite — writes .au sound file
beep — Produce a beep sound
lin2mu — linear signal to mu-law encoding
loadwave — load a sound wav file into scilab
mapsound — Plots a sound map
mu2lin — mu-law encoding to linear signal
playsnd — sound player facility
savewave — save data into a sound wav file.
sound — sound player facility
soundsec — generates n sampled seconds of time parameter
wavread — load .wav sound file
wavwrite — writes .wav sound file
XLVI. Sparses Matrix
full — sparse to full matrix conversion
gmres — Generalized Minimum RESidual method
ludel — utility function used with lufact
lufact — sparse lu factorization
luget — extraction of sparse LU factors
lusolve — sparse linear system solver
mtlb_sparse — convert sparse matrix
nnz — number of non zero entries in a matrix
pcg — precondioned conjugate gradient
qmr — quasi minimal resiqual method with preconditioning
readmps — reads a file in MPS format
sparse — sparse matrix definition
spchol — sparse cholesky factorization
spcompack — converts a compressed adjacency representation
spget — retrieves entries of sparse matrix
XLVII. Special Functions
besseli — Modified Bessel functions of the first kind (I sub alpha). — Bessel functions of the first kind (J sub alpha). — Modified Bessel functions of the second kind (K sub alpha). — Bessel functions of the second kind (Y sub alpha). — Bessel functions of the third kind (aka Hankel functions)
beta — beta function
calerf — computes error functions.
dlgamma — derivative of gammaln function, psi function
erf — The error function.
erfc — The complementary error function.
erfcx — scaled complementary error function.
erfinv — The inverse of the error function.
gamma — The gamma function.
gammaln — The logarithm of gamma function.
legendre — associated Legendre functions
oldbesseli — Modified Bessel functions of the first kind (I sub alpha). — Bessel functions of the first kind (J sub alpha). — Modified Bessel functions of the second kind (K sub alpha). — Bessel functions of the second kind (Y sub alpha).
XLVIII. Spreadsheet
excel2sci — reads ascii Excel files
readxls — reads an Excel file
xls_open — Open an Excel file for reading
xls_read — read a sheet in an Excel file
XLIX. Statistics
cdfbet — cumulative distribution function Beta distribution
cdfbin — cumulative distribution function Binomial distribution
cdfchi — cumulative distribution function chi-square distribution
cdfchn — cumulative distribution function non-central chi-square distribution
cdff — cumulative distribution function F distribution
cdffnc — cumulative distribution function non-central f-distribution
cdfgam — cumulative distribution function gamma distribution
cdfnbn — cumulative distribution function negative binomial distribution
cdfnor — cumulative distribution function normal distribution
cdfpoi — cumulative distribution function poisson distribution
cdft — cumulative distribution function Student's T distribution
center — center
wcenter — center and weight
cmoment — central moments of all orders
correl — correlation of two variables
covar — covariance of two variables
ftest — Fischer ratio
ftuneq — Fischer ratio for samples of unequal size.
geomean — geometric mean
harmean — harmonic mean
iqr — interquartile range
labostat — Statistical toolbox for Scilab
mad — mean absolute deviation
mean — mean (row mean, column mean) of vector/matrix entries
meanf — weighted mean of a vector or a matrix
median — median (row median, column median,...) of vector/matrix/array entries
moment — non central moments of all orders
msd — mean squared deviation
mvvacov — computes variance-covariance matrix
nancumsum — Thos function returns the cumulative sum of the values of a matrix
nand2mean — difference of the means of two independent samples
nanmax — max (ignoring Nan's)
nanmean — mean (ignoring Nan's)
nanmeanf — mean (ignoring Nan's) with a given frequency.
nanmedian — median of the values of a numerical vector or matrix
nanmin — min (ignoring Nan's)
nanstdev — standard deviation (ignoring the NANs).
nansum — Sum of values ignoring NAN's
nfreq — frequence of the values in a vector or matrix
pca — Computes principal components analysis with standardized variables
perctl — computation of percentils
princomp — Principal components analysis
quart — computation of quartiles
regress — regression coefficients of two variables
sample — Sampling with replacement
samplef — sample with replacement from a population and frequences of his values.
samwr — Sampling without replacement
show_pca — Visualization of principal components analysis results
st_deviation — standard deviation (row or column-wise) of vector/matrix entries — standard deviation (row or column-wise) of vector/matrix entries
stdevf — standard deviation
strange — range
tabul — frequency of values of a matrix or vector
thrownan — eliminates nan values
trimmean — trimmed mean of a vector or a matrix
variance — variance of the values of a vector or matrix
variancef — standard deviation of the values of a vector or matrix
L. Strings
ascii — string ascii conversions
blanks — Create string of blank characters
code2str — returns character string associated with Scilab integer codes.
convstr — case conversion
emptystr — zero length string
grep — find matches of a string in a vector of strings
isalphanum — check that characters of a string are alphanumerics
isascii — tests if character is a 7-bit US-ASCII character
isdigit — check that characters of a string are digits between 0 and 9
isletter — check that characters of a string are alphabetics letters
isnum — tests if a string represents a number
justify — Justify character array.
length — length of object
part — extraction of strings
regexp — find a substring that matches the regular expression string
sci2exp — converts an expression to a string
str2code — return scilab integer codes associated with a character string
strcat — concatenate character strings
strchr — Find the first occurrence of a character in a string
strcmp — compare character strings
strcmpi — compare character strings (case independent)
strcspn — Get span until character in string
strindex — search position of a character string in an other string.
string — conversion to string
strings — Scilab Object, character strings
stripblanks — strips leading and trailing blanks (and tabs) of strings
strncmp — Copy characters from strings
strrchr — Find the last occurrence of a character in a string
strrev — returns string reversed
strsplit — split a string into a vector of strings
strspn — Get span of character set in string
strstr — Locate substring
strsubst — substitute a character string by another in a character string.
strtod — Convert string to double.
strtok — Split string into tokens
tokenpos — returns the tokens positions in a character string.
tokens — returns the tokens of a character string.
tree2code — generates ascii definition of a Scilab function
LI. Symbolic
addf — symbolic addition
ldivf — left symbolic division
mulf — symbolic multiplication
rdivf — right symbolic division
subf — symbolic subtraction
LII. Tcl/Tk Interface
ScilabEval — tcl instruction : Evaluate a string with scilab interpreter
TCL_CreateSlave — Create a TCL slave interpreter
TCL_DeleteInterp — delete TCL interpreter
TCL_EvalFile — Reads and evaluate a tcl/tk file
TCL_EvalStr — Evaluate a string whithin the Tcl/Tk interpreter
TCL_ExistArray — Return %T if a tcl array exists
TCL_ExistInterp — Return %T if a tcl slave interperter exists
TCL_ExistVar — Return %T if a tcl variable exists
TCL_GetVar — Get a tcl/tk variable value
TCL_GetVersion — get the version of the TCL/TK library at runtime.
TCL_SetVar — Set a tcl/tk variable value
TCL_UnsetVar — Remove a tcl variable
TCL_UpVar — Make a link from a tcl source variable to a tcl destination variable
browsevar — Scilab variable browser
config — Scilab general configuration.
editvar — Scilab variable editor
tk_getdir — dialog to get a directory path
tk_getfile — dialog to get one or more file paths (obsolete)
tk_savefile — dialog to get a file path for writing
winclose — close windows created by sciGUI
winlist — Return the winId of current window created by sciGUI
LIII. Texmacs
pol2tex — convert polynomial to TeX format
texprint — TeX output of Scilab object
LIV. Time and Date
calendar — Calendar
clock — Return current time as date vector
date — Current date as date string
datenum — Convert to serial date number
datevec — Date components
eomday — Return last day of month
etime — Elapsed time
getdate — get date and time information
now — Return current date and time
realtimeinit — set time unit — set dates origin or waits until date
sleep — suspend Scilab
tic — start a stopwatch timer
timer — cpu time
toc — Read the stopwatch timer
weekday — Return day of week
LV. UMFPACK Interface
PlotSparse — plot the pattern of non nul elements of a sparse matrix
ReadHBSparse — read a Harwell-Boeing sparse format file
cond2sp — computes an approximation of the 2-norm condition number of a s.p.d. sparse matrix
condestsp — estimate the condition number of a sparse matrix
rafiter — (obsolete) iterative refinement for a s.p.d. linear system
res_with_prec — computes the residual r = Ax-b with precision
taucs_chdel — utility function used with taucs_chfact
taucs_chfact — cholesky factorisation of a sparse s.p.d. matrix
taucs_chget — retrieve the Cholesky factorization at the scilab level
taucs_chinfo — get information on Cholesky factors
taucs_chsolve — solve a linear sparse (s.p.d.) system given the Cholesky factors
taucs_license — display the taucs license
umf_license — display the umfpack license
umf_ludel — utility function used with umf_lufact
umf_lufact — lu factorisation of a sparse matrix
umf_luget — retrieve lu factors at the scilab level
umf_luinfo — get information on LU factors
umf_lusolve — solve a linear sparse system given the LU factors
umfpack — solve sparse linear system