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

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

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

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

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 special matrices, such as Hilbert, Franck

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

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. Differential Equations, Integration

bvode — boundary value problems for ODE using collocation method — Simplified call to bvode

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

intc — Cauchy integral

integrate — integration of an expression by quadrature

intg — definite integral

intl — Cauchy 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

III. 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 of the elements of an array

& — logical and operator

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.

csgn — Returns the sign of a vector of real of complex values.

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

intersect — returns the vector of common values of two vectors

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

isvector — check if a variable is a vector

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 — symmetric 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 of the elements of an array

| — logical or operator

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 (DEPRECATED see gsort)

sp2adj — converts sparse matrix into adjacency form

speye — sparse identity matrix

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

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

IV. 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.

deff — on-line definition of function

exec — script file execution

execstr — execute Scilab code in strings

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

getf — defining a function from a file

head_comments — display scilab function header comments

lib — library definition

librarieslist — get scilab libraries

library — library datatype description

libraryinfo — get macros and path of a scilab library

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

whereis — name of library containing a function

V. Files : Input/Output functions

basename — strip directory and suffix from filenames

chdir — changes Scilab current directory — changes Scilab current directory

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

fileinfo — Provides information about a file

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.

get_absolute_file_path — Given an absolute pathname of a file opened in scilab.

getdrives — Get the drive letters of all mounted filesystems on the computer.

getlongpathname — get long path name (Only for Windows)

getrelativefilename — Given an absolute directory and an absolute filename, returns a relative file name.

getshortpathname — get short path name (Only for Windows)

%io — variable returns standard input and standard output (file descriptor).

isdir — checks if argument is a directory path

isfile — checks if argument is a file

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

mfprintf — converts, formats, and writes data to a file

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

movefile — Move file or directory

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

newest — returns newest file of a set of files

pathconvert — pathnames convertion between posix and windows.

pathsep — returns path separator for current platform

pwd — print Scilab current directory — get Scilab current directory

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

sscanf — Converts formatted input given by a string

VI. 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

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

Math rendering in Scilab graphics — Display mathematical equations in Scilab graphics through the LaTeX or MathML languages.

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_version — The 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

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.

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.

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

VII. 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 BMP file.

xs2emf — send graphics to an EMF file (Only for Windows).

xs2eps — send graphics to an EPS file.

xs2fig — send graphics to a FIG file.

xs2gif — send graphics to a GIF file.

xs2jpg — send graphics to a JPG file.

xs2pdf — save graphics to a PDF file.

xs2png — send graphics to a PNG file.

xs2ppm — send graphics to a PPM file.

xs2ps — send graphics to a PS file.

xs2svg — save graphics to a SVG file.

VIII. Boolean

bool2s — convert boolean matrix to a zero one matrix.

find — find indices of boolean vector or matrix true elements

IX. 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

X. Data Structures

cell — Create a cell array of empty matrices.

definedfields — return index of list's defined fields

fieldnames — returns the tlist, mlist or struct field names

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.

XI. 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

XII. Console

console — Keyboard Shortcuts in the Console Window

XIII. Completion

completion — returns words that start with the text you pass as parameter.

XIV. 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

XV. GUI

1. Tree

uiConcatTree — Concatenation of Trees

uiCreateNode — Creation of node (for Scilab Tree)

uiCreateTree — Creation of a Tree

uiDeleteNode — Deletion in a Tree

uiDisplayTree — Printing a Tree in GUI mode

uiDumpTree — Printing a Tree in the console (text mode)

uiEqualsTree — Comparing two trees

uiFindNode — Find node in Tree

uiGetChildrenNode — Get Children of a node

uiGetNodePosition — Get the position(s) of a node

uiGetParentNode — Get Parent of a node

uiInsertNode — Insertion in a Tree

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

uiputfile — Open standard dialog box for selecting and saving file.

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 — Dialog for interactive multi-lines input.

x_matrix — Xwindow editing of matrix

x_mdialog — Dialog for interactive vector/matrix input.

x_message_modeless — X window modeless message

XVI. Dynamic/incremental Link

G_make — call make or nmake

VCtoLCCLib — converts Ms VC libs to LCC-Win32 libs.

addinter — new functions interface 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_cleaner — utility for ilib_build: generates a cleaner file

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

ilib_verbose — set level of display used by dynamic link functions.

link — dynamic linker

ulink — unlink a dynamically linked shared object

with_lcc — returns if LCC-Win32 is the default C Compiler.

XVII. 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

XVIII. 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

interp1 — one_dimension interpolation function

interp2d — bicubic spline (2d) 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

splin2d — bicubic spline gridded 2d interpolation

splin3d — spline gridded 3d interpolation

XIX. Input/Output functions

file — file management

getenv — get the value of an environment variable

getio — get Scilab input/output logical units

getpid — get Scilab process identificator

getscilabkeywords — returns a list with all scilab keywords.

halt — stop execution

host — Unix or DOS command execution

input — prompt for user input

load — Load a saved variable or a serie of variables

oldload — load saved variable in 2.4.1 and previous formats (OBSOLETE)

oldsave — saving variables in 2.4.1 and previous format (OBSOLETE)

read — matrices read

read4b — fortran file binary read

readb — fortran file binary read

readc_ — read a character string (obsolete see input)

save — Save a variable or a serie of variables in a binary file

setenv — set the value of an environment variable

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

XX. Output functions

diary — diary of session

disp — displays variables

mprintf — converts, formats, and writes data to the main scilab window

msprintf — converts, formats, and writes data in a string

prettyprint — From any Scilab datatype and provide a representation to the TeX, LaTeX or MathML formats

print — prints variables in a file

printf — Emulator of C language printf function

printf_conversion — printf, sprintf, fprintf conversion specifications

sprintf — Emulator of C language sprintf function

ssprint — pretty print for linear system

XXI. Intersci

intersci — scilab tool to interface C of Fortran functions with scilab

XXII. 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

XXIII. 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 factorization with pivoting

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

XXIV. 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.

XXV. Optimization and Simulation

2. Neldermead

fminsearch — Computes the unconstrained minimimum of given function with the Nelder-Mead algorithm.

neldermead — Provides several direct search optimization algorithms based on the simplex method.

overview — An overview of the Nelder-Mead toolbox.

nmplot — Provides several direct search optimization algorithms based on the simplex method.

optimget — Queries an optimization data structure.

optimplotfunccount — Plot the number of function evaluations of an optimization algorithm

optimplotfval — Plot the function value of an optimization algorithm

optimplotx — Plot the value of the parameters of an optimization algorithm

optimset — Configures and returns an optimization data structure.

3. Optimization base

optimbase — Provides an abstract class for a general optimization component.

4. Optimization simplex

optimsimplex — Manage a simplex with arbitrary number of points.

NDcost — generic external for optim computing gradient using finite differences

aplat — Flattens a list.

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

list2vec — Catenates list entries in a matrix.

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

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)

readmps — reads a file in MPS format

recons — reciprocal function for aplat.

semidef — semidefinite programming

vec2list — list2vec reciprocal function

XXVI. Overloading

overloading — display, functions and operators overloading capabilities

XXVII. 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

XXVIII. Signal Processing

5. How to

How to design an elliptic filter — How to design an elliptic filter (analog and digital)

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)

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 — Recursive Prediction-Error Minimization 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

XXIX. 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

sparse — sparse matrix definition

spchol — sparse cholesky factorization

spcompack — converts a compressed adjacency representation

spget — retrieves entries of sparse matrix

XXX. 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).

XXXI. 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

strncpy — 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

XXXII. Symbolic

addf — symbolic addition

ldivf — left symbolic division

mulf — symbolic multiplication

rdivf — right symbolic division

subf — symbolic subtraction

XXXIII. 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

XXXIV. 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

XXXV. ARnoldi PACKage

dnaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to a few eigenpairs of a real linear operator

dneupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute the converged approximations to eigenvalues of A*z = lambda*B*z approximations to a few eigenpairs of a real linear operator

dsaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to a few eigenpairs of a real and symmetric linear operator

dsaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to the converged approximations to eigenvalues of A*z = lambda*B*z

znaupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute a few eigenpairs of a complex linear operator OP with respect to a semi-inner product defined by a hermitian positive semi-definite real matrix B.

zneupd — Interface for the Implicitly Restarted Arnoldi Iteration, to compute approximations to the converged approximations to eigenvalues of A*z = lambda*B*z

XXXVI. 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_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

XXXVII. 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.SciInteger — Class to use integer object with scilab

javasci.SciIntegerArray — Class to use int 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

javasci FAQ — The frequently asked questions

XXXVIII. Maple Interface

sci2map — Scilab to Maple variable conversion

XXXIX. 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

XL. 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_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

XLI. Texmacs

pol2tex — convert polynomial to TeX format. This function is obsolete and will be removed in Scilab 5.3. Please use prettyprint

texprint — TeX output of Scilab object. This function is obsolete and will be removed in Scilab 5.3. Please use prettyprint

XLII. 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

XLIII. Randlib

grand — Random number generator(s)

XLIV. Development tools

bench_run — Launch benchmark tests

tbx_build_cleaner — Generate a cleaner.sce script (toolbox compilation process)

tbx_build_gateway — Build a gateway (toolbox compilation process)

tbx_build_gateway_clean — Generate a cleaner_gateway.sce script (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

XLV. Spreadsheet

excel2sci — obsolete see read_csv

read_csv — Read comma-separated value file

readxls — reads an Excel file

write_csv — Read comma-separated value file

xls_open — Open an Excel file for reading

xls_read — read a sheet in an Excel file

XLVI. call_scilab API

Boolean management — How to manage Scilab's boolean read and write process using call_scilab and api_scilab

Complex management — How to manage Scilab's complex variable read and write process using call_scilab

DisableInteractiveMode — Disables some features (plotting, gui creation, Tcl/Tk...) and leaves only the computing engine

Double management — How to manage Scilab's variable read and write process using call_scilab and api_scilab

GetLastJob — Returns the latest job sent to Scilab engine

ScilabHaveAGraph — Check if any Scilab graphics have been opened.

SendScilabJob — Send a Scilab task from a C/C++ code (call_scilab)

SendScilabJobs — Send Scilab tasks from a C/C++ code (call_scilab)

StartScilab — Initializes and starts Scilab engine in Call Scilab

String management — How to manage Scilab's String read and write process using call_scilab and api_scilab

TerminateScilab — Stops and terminates Scilab engine in Call Scilab

call_scilab — call_scilab is an interface which provides the ability to call Scilab engine from C/C++ code

Compile and run with Call Scilab — How to compile a native application based on or using Scilab

creadbmat (obsolete) — Read a single boolean or a matrix of boolean from Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Boolean reading for remplacement.

creadchain (obsolete) — Read a single string from Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: String reading for remplacement.

creadcmat (obsolete) — Read a single complex or a matrix of complex from Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Complex double reading for remplacement.

creadmat (obsolete) — Read a single double or a matrix of double from Scilab memory using call_scilab. Note that it is the default datatype in Scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Double reading for remplacement.

cwritebmat (obsolete) — Write a single boolean or a matrix of boolean into Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Boolean writing for remplacement.

cwritechain (obsolete) — Write a single string into Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: String writing for remplacement.

cwritecmat (obsolete) — Write a single complex or a matrix of complex into Scilab memory using call_scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Complex double writing for remplacement.

cwritemat (obsolete) — Write a single double or a matrix of double into Scilab memory using call_scilab. Note that it is the default datatype in Scilab. Starting with Scilab 5.2, this function is obsolete. See API_Scilab: Double writing for remplacement.

fromc — Checks if current Scilab is called from an external C program (by StartScilab).

fromjava — Checks if current Scilab is called from javasci

XLVII. FFTW

fftw — Fast fourier transform based on the 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

XLVIII. 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

XLIX. 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

L. 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

LI. 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

LII. Atoms

Getting started

Functions Summary

atomsAutoloadAdd — Add one or several modules to autoload

atomsAutoloadDel — Remove one or several modules from the autoload system

atomsAutoloadList — Get the list of modules registered to autoload

atomsDepTreeShow — Show the dependency tree of a module

atomsGetInstalled — Get the list of installed external modules

atomsGetLoaded — Get the list of loaded external modules

atomsInstall — Install one or several external modules

atomsIsInstalled — Determines whether the module is installed. Returns true if the module is installed, false otherwise.

atomsIsLoaded — determines whether a module is loaded or not

atomsList — List available external modules

atomsLoad — Install one or several external modules

atomsRemove — Remove one or several modules

atomsRepositoryAdd — Add one or several URLs to the list of managed repositories

atomsRepositoryDel — Remove one or several URLs from the list of managed repositories

atomsRepositoryList — Get the list of managed repositories

atomsSearch — Searches for external modules.

atomsSetConfig — Manage ATOMS system parameters

atomsShow — Show the caracteristics of a module

atomsSystemUpdate — Update the list of available modules

atomsUpdate — Update one or several external modules

LIII. 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)

LIV. xcos

6. Batch functions

lincos — Constructs by linearization a linear state-space model from a general dynamical system described by a xcos diagram

scicos — OBSOLETE - see xcos

scicos_simulate — Function for running xcos simulation in batch mode

scicosim — xcos (batch) simulation function

steadycos — Finds an equilibrium state of a general dynamical system described by a xcos diagram

7. palettes

1. Annotations palette

Annotations_pal — Annotations palette

TEXT_f — Text

2. Commonly used blocks palette

Commonlyusedblocks_pal — Commonly used blocks palette

LOGICAL_OP — Logical operation

RELATIONALOP — Relational operation

3. Continuous time systems palette

Continuous_pal — Continuous time systems palette

CLINDUMMY_f — Dummy

CLR — Continuous transfer function

CLSS — Continuous state-space system

DERIV — Derivative

INTEGRAL_f — Integration

INTEGRAL_m — Integration

PID — PID regulator

TCLSS — Continuous linear system with jump

TIME_DELAY — Time delay

VARIABLE_DELAY — Variable delay

4. Demonstrations blocks palette

Demonstrationsblocks_pal — Demonstrations blocks palette

AUTOMAT — automata (finite state machine)

BOUNCE — Balls coordinates generator

BOUNCEXY — Balls viewer

BPLATFORM — Balls under a platform viewer

PDE — 1D PDE block

5. Discontinuities palette

discontinuities_pal — discontinuities palette

BACKLASH — Backlash

DEADBAND — Deadband

HYSTHERESIS — Hystheresis

RATELIMITER — Rate limiter

SATURATION — Saturation

6. Discrete time systems palette

Discrete_pal — Discrete time systems palette

DELAYV_f — Variable delay

DELAY_f — Discrete time delay

DLR — Discrete transfer function

DLRADAPT_f — Discrete Zero-Pole

DLSS — Discrete state-space system

DOLLAR_f — Delay operator

REGISTER — Shift Register

7. Electrical palette

Electrical_pal — Electrical palette

CCS — Controllable Modelica current source

CVS — Controllable Modelica voltage source

Capacitor — Electrical capacitor

ConstantVoltage — Electrical DC voltage source

CurrentSensor — Electrical current sensor

Diode — Electrical diode

Ground — Ground (zero potential reference)

Gyrator — Modelica Gyrator

IdealTransformer — Ideal Transformer

Inductor — Electrical inductor

NMOS — Simple NMOS Transistor

NPN — NPN transistor

OpAmp — Ideal opamp (norator-nullator pair)

PMOS — Simple PMOS Transistor

PNP — PNP transistor

PotentialSensor — Potential sensor

Resistor — Electrical resistor

SineVoltage — Sine voltage source

Switch — Non-ideal electrical switch

VVsourceAC — Variable AC voltage source

VariableResistor — Electrical variable resistor

VoltageSensor — Electrical voltage sensor

VsourceAC — Electrical AC voltage source

8. Event handling palette

Events_pal — Event handling palette

ANDBLK — Activation and

ANDLOG_f — Logical and

CEVENTSCOPE — Activation scope

CLKFROM — Receives data from a corresponding CLKGOTO

CLKGOTO — Pass block input to CLKFROM block

CLKGotoTagVisibility — Define Scope of CLKGOTO tag visibility

CLKOUTV_f — Output activation port

CLKSOMV_f — Activation union

EDGE_TRIGGER — EDGE_TRIGGER block

ESELECT_f — Synchronous block Event-Select

EVTDLY_c — Event delay

EVTGEN_f — Event generator

EVTVARDLY — Event variable delay

Extract_Activation — Extract_Activation block

HALT_f — Halt

IFTHEL_f — Synchronous block If-Then-Else

MCLOCK_f — MCLOCK_f title

MFCLCK_f — MFCLCK_f title

M_freq — Multiple Frequencies

freq_div — Frequency division

9. Implicit palette

Implicit_pal — Implicit palette

CONSTRAINT_f — Constraint

DIFF_f — Derivative

10. Integer palette

Integer_pal — Integer palette

BITCLEAR — Clear a Bit

BITSET — Set a Bit

CONVERT — Data Type Conversion

DFLIPFLOP — D flip-flop

DLATCH — D latch flip-flop

EXTRACTBITS — EXTRACTBITS

INTMUL — Integer matrix multiplication

JKFLIPFLOP — JK flip-flop

LOGIC — Combinational Logic

SHIFT — Shift Bits

SRFLIPFLOP — SR flip-flop

11. Lookup tables palette

Lookuptables_pal — Lookup tables palette

INTRP2BLK_f — 2D interpolation

INTRPLBLK_f — Interpolation

LOOKUP_f — Lookup table

12. Math operations palette

Mathoperations_pal — Math operations palette

ABS_VALUE — Absolute value

BIGSOM_f — Sum

COSBLK_f — COSBLK

EXPBLK_m — Exponential

GAINBLK_f — Gain

INVBLK — Inverse

LOGBLK_f — Log

MATMAGPHI — Complex to Magnitude and Angle Conversion

MATZREIM — Complex decomposition

MAXMIN — Max and Min

MAX_f — MAX

MIN_f — MIN

POWBLK_f — Power

PRODUCT — Product

PROD_f — Multiplication

SIGNUM — Signum

SINBLK_f — SINBLK

SQRT — Square root

SUMMATION — Matrix Summation

SUM_f — Addition

TANBLK_f — TANBLK

TrigFun — Trigonometric function

13. Matrix operation palette

Matrix_pal — Matrix operation palette

CUMSUM — Cumulative Sum

EXTRACT — Matrix Extractor

EXTTRI — Triangular or Diagonal extraction

MATBKSL — left matrix division

MATCATH — Horizontal Concatenation

MATCATV — Vertical Concatenation

MATDET — Matrix Determinant

MATDIAG — Create Diagonal Matrix

MATDIV — Matrix division

MATEIG — Matrix Eigenvalues

MATEXPM — Matrix Exponential

MATINV — Matrix Inverse

MATLU — LU Factorization

MATMUL — Matrix Multiplication

MATPINV — Matrix PseudoInverse

MATRESH — Matrix Reshape

MATSING — SVD decomposition

MATSUM — Matrix Sum

MATTRAN — Matrix Transpose

MATZCONJ — Matrix Conjugate

RICC — Riccati Equation

ROOTCOEF — Coefficient computation

SUBMAT — Sub-matrix extraction

14. Port & Subsystem palette

Portaction_pal — Port & Subsystem palette

IN_f — Input Port

OUTIMPL_f — Output implicit port

OUT_f — Output Port

15. Signal processing palette

Signalprocessing_pal — Signal processing palette

QUANT_f — Quantization

SAMPHOLD_m — Sample and hold

16. Signal routing palette

Signalrouting_pal — Signal routing palette

DEMUX — Demultiplexer

EXTRACTOR — Extractor

FROM — FROM Receives data from a corresponding GOTO

FROMMO — Receives data from a corresponding GOTOMO

GOTO — GOTO Pass block input to From block

GOTOMO — Pass block input to FROMMO block

GotoTagVisibility — Define Scope of GOTO tag visibility

GotoTagVisibilityMO — Define Scope of GOTOMO tag visibility

ISELECT_m — Iselect

MUX — Multiplexer

M_SWITCH — Multi-port switch

NRMSOM_f — Merge data

RELAY_f — Relay

SELECT_m — Select

SWITCH2_m — Switch2

SWITCH_f — Switch

17. Sinks palette

Sinks_pal — Sinks palette

AFFICH_m — Display

CANIMXY — y=f(x) animated viewer

CANIMXY3D — z=f(x,y) animated viewer

CFSCOPE — Floating point scope

CMAT3D — Matrix z values 3D viewer

CMATVIEW — Matrix Colormapped viewer

CMSCOPE — Multi display scope

CSCOPE — Single Display Scope

CSCOPXY — y=f(x) permanent viewer

CSCOPXY3D — z=f(x,y) permanent viewer

ENDBLK — END block

END_c — END_c block

TOWS_c — Data to Scilab worspace

TRASH_f — Trash block

WFILE_f — Write to file

WRITEAU_f — Write AU sound file

WRITEC_f — Write binary data

18. Sources palette

Sources_pal — Sources palette

CLKINV_f — Input activation port

CLOCK_c — Activation clock

CONST_m — Constant

CURV_f — Curve

Counter — Counter

FROMWSB — Data from Scilab workspace to Xcos

GENSIN_f — Sin generator

GENSQR_f — Square wave generator

INIMPL_f — Input implicit port

Modulo_Count — Modulo counter

RAMP — Ramp

RAND_m — Random generator

READAU_f — Read AU sound file

READC_f — Read binary data

RFILE_f — Read from file

SAWTOOTH_f — Sawtooth generator

STEP_FUNCTION — Step function generator

SampleCLK — Sample Time Clock

Sigbuilder — Signal creator/generator

TIME_f — Time

TKSCALE — Adjust constant value with a tk widget

19. Thermohydraulics palette

ThermoHydraulics_pal — Thermal-Hydraulics toolbox

Bache — Thermal-hydraulic tank (reservoir)

PerteDP — Thermal-hydraulic pipe

PuitsP — Thermal-hydraulic drain (well)

SourceP — Thermal-hydraulic constant pressure source

VanneReglante — Thermal-hydraulic control valve

20. User defined functions palette

Userdefinedfunctions_pal — User defined functions palette

CBLOCK — New C

EXPRESSION — Mathematical expression

MBLOCK — Modelica generic block

SUPER_f — Super block

c_block — C language

fortran_block — Fortran

generic_block3 — Generic block

scifunc_block_m — Scilab function block

21. Zero crossing detection palette

Zerocrossingdetection_pal — Zero crossing detection palette

GENERAL_f — GENERAL_f title

NEGTOPOS_f — Threshold negative to positive

POSTONEG_f — Threshold positive to negative

ZCROSS_f — Threshold detection at zero

8. Programming xcos Blocks

1. C Computational Functions

C_macros — Utilities C macros

C_struct — C Block structure of a computational function

C_utils — Utilities C functions

2. Scilab Computational Functions

sci_struct — Scicos block structure of a scilab computational function

3. Utilities Functions

curblock — Return the current called xcos block during the simulation

getblocklabel — Get the label of a scicos block

getscicosvars — Supervisor utility function

phase_simulation — Get the current simulation phase

pointer_xproperty — Get the type of a continuous time state variable

scicos_time — Returns the current time during simulation

set_blockerror — set the block error number

set_xproperty — Set the type of a continuous time state variable

9. Scilab Data Structures

1. Blocks

scicos_block — Define a block structure

scicos_graphics — Define a graphics structure

scicos_model — Define a model structure

2. Compilation/Simulation

scicos_cpr — Compiled Scicos structure

scicos_sim — Define a sim structure

scicos_state — Define a state structure

3. Diagram

scicos_diagram — Define a scs_m structure

scicos_params — Define a param structure

4. Links

scicos_link — Define a link structure

10. Scilab Utilities Functions

buildouttb — Build of the sublist %cpr.state.outtb

create_palette — Palette generator

get_scicos_version — Get the current Scicos version

scicos_debug — Set the level of the Scicos debugging

var2vec — Transform a scilab variable in a vector of double

vec2var — Transform a vector of double in a scilab variable

xcos — Block diagram editor and GUI for the hybrid simulator

Menu_entries — Editor menu entries

LV. Text editor

edit_error — opens in scilab editor the source of the last recorded error

Editor — Embedded Scilab text editor

LVI. API Scilab

11. Scilab Gateway API

1. How to

Calling a scilab function (macros) from a C gateway — Calling a scilab function (macros) from a C interface

How to access a matrix — How to access a matrix using the C gateway functions

How to check parameters — how to check parameter send to an interface using the C gateway functions

How to create and access a list — How to create and access a list using the C gateway functions

How to deal with optional parameters — how to deal with optional parameters send to an interface using the C gateway functions

CheckColumn — C interface function which checks if a parameter send to the C function is a column vector or not

CheckDimProp — C interface function which checks the comatibility between 2 arguments send to the C function

CheckDims — C interface function which checks if a parameter send to the C function has the required dimensions

CheckLength — C interface function which checks the length of a vector send as a parameter to the C function

CheckLhs — C macro which checks the number of output arguments present in the calling Scilab function.

CheckRhs — C macro which checks the number of input arguments present in the calling Scilab function.

CheckRow — C interface function which checks if a parameter send to the C function is a row vector or not

CheckSameDims — C interface function which checks if two parameters send to the C function have the same size

CheckScalar — C interface function which checks if a parameter send to the C function is a scalar or not

CheckSquare — C interface function which checks if a parameter send to the C function is a square matrix or not

CheckVector — C interface function which checks if a parameter send to the C function is a vector (column or row) or not

CreateListVarFrom — a C interface function which allows to create a new Scilab parameter in a [mt]list

CreateListVarFromPtr — a C interface function which allows to create a new Scilab parameter from a pointer in a [mt]list

CreateVar — a C gateway function which allows to create a new Scilab parameter

FindOpt — C gateway function find the position of an optional argument given its name

FirstOpt — C gateway function which returns the position of the first optional parameter

GetListRhsVar — a C gateway function which allows to access a parameter stored in a [mt]list transmitted to a Scilab function

GetRhsVar — a C gateway function which allows to access an argument transmitted to a Scilab function

GetType — C gateway function which returns the type of a parameter in the Scilab memory

IsOpt — C gateway function which checks if a parameter is optional and returns the name of the parameter

Lhs — A C gateway function which provides the number of output arguments present in the calling Scilab function

LhsVar — a C gateway function which specifies which parameters created inside the C gateway will be returned as an output argument into Scilab.

NumOpt — C gateway function which returns the number of optional parameters sent to a C function

OverLoad — C gateway function which tells Scilab to look for another overloaded function

Rhs — A C gateway function which provides the number of input arguments present in the calling Scilab function

Scierror — C gateway function which displays an error message to the user (same profil as the printf function) and returns an integer value specifying an error level

Scilab C Types — the C types available in a C gateway

get_optionals — C gateway function which initialize the list of optional parameters

istk — Return a pointer to an integer to access data stored at a given position in the Scilab memory

sci_types — a C enumeration which defines the types available for a variable

sciprint — A C gateway function which displays standard messages to the user (same profil as the C printf function)

stk — Return a pointer to a double to access data stored at a given position in the Scilab memory

12. list_management

Boolean reading (Scilab gateway) — How to read matrix of boolean in a list.

Boolean writing (Scilab gateway) — How to add matrix of boolean in a list.

Boolean sparse reading (Scilab gateway) — How to read boolean sparse in a list.

Boolean sparse writing (Scilab gateway) — How to add boolean sparse matrix in a list.

Create List (Scilab gateway) — How to get create a list in Scilab memory.

Double reading (Scilab gateway) — How to read matrix of double in a list.

Double writing (Scilab gateway) — How to add matrix of double in a list.

Get child item (Scilab gateway) — How to get the address of a list child.

Item Number (Scilab gateway) — How to get the number of items in a list (list, mlist, tlist).

Integer reading (Scilab gateway) — How to read matrix of integer in a list.

Integer writing (Scilab gateway) — How to add matrix of integer in a list.

Pointer reading (Scilab gateway) — How to read pointer in a list.

Pointer writing (Scilab gateway) — How to add pointer in a list.

Polynomial reading (Scilab gateway) — How to read matrix of polynomial in a list.

Polynomial writing (Scilab gateway) — How to add matrix of polynomial in a list.

Sparse reading (Scilab gateway) — How to read sparse in a list.

Sparse writing (Scilab gateway) — How to add sparse matrix in a list.

String reading (Scilab gateway) — How to read matrix of string in a list.

String writing (Scilab gateway) — How to add matrix of string in a list.

api_scilab — api_scilab is the Scilab interface to read/write data from/to Scilab memory

Boolean reading (Scilab gateway) — How to read matrix of boolean.

Boolean writing (Scilab gateway) — How to write matrices of boolean.

Boolean sparse reading (Scilab gateway) — How to read boolean sparse in a gateway.

Boolean sparse writing (Scilab gateway) — How to add boolean sparse matrix in a gateway.

Variable Reference (Scilab gateway) — How to get the address of an argument or a variable in a gateway.

Variable dimension (Scilab gateway) — How to get the dimensions of an argument or a variable stored as matrix.

Variable Type (Scilab gateway) — How to get the type of an argument or a variable within a gateway.

Variable Complexity (Scilab gateway) — How to get the argument or variable complexity.

Matrix Type (Scilab gateway) — How to know if an argument or a variable is stored as a matrix.

Double reading (Scilab gateway) — How to read matrices of double in a gateway.

Double writing (Scilab gateway) — How to write matrices of doubles in a gateway.

Integer Precision (Scilab gateway) — How to get precision of an integer matrix.

Integer reading (Scilab gateway) — How to read matrices of integer in a gateway.

Integer writing (Scilab gateway) — How to write matrices of integers in a gateway.

Pointer reading (Scilab gateway) — How to read pointer in a gateway.

Pointer writing (Scilab gateway) — How to write pointer in a gateway.

Polynomial Symbolic Variable (Scilab gateway) — How to get the symbolic variable name.

Polynomial reading (Scilab gateway) — How to read matrices of polynomials in a gateway.

Polynomial writing (Scilab gateway) — How to write matrices of polynomials in a gateway.

Sparse matrix reading (Scilab gateway) — How to read sparse matric in a gateway.

Sparse writing (Scilab gateway) — How to write sparse matrix in a gateway.

String reading (Scilab gateway) — How to read matrices of strings in a gateway.

String writing (Scilab gateway) — How to write matrices of string in a gateway.

LVII. Online help management

add_help_chapter — Add an entry in the helps list

apropos — searches keywords in Scilab help

del_help_chapter — Delete an entry in the helps list

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

man — on line help XML file description format

manedit — editing a manual item

%helps — Variable defining the path of help directories

xmltochm — converts xml Scilab help files to Microsoft Compressed HTML format (Windows)

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