File: function.man

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (93 lines) | stat: -rw-r--r-- 2,115 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
.TH function 1 "April 1993" "Scilab Group" "Scilab keyword"
.so ../sci.an
.SH NAME
function - opens a function definition
endfunction - closes a function definition
.SH SYNTAX
.nf
function <lhs_arguments>=<function_name><rhs_arguments>
<statements>
endfunction
.fi
Where
.TP 15
<function_name>
stands for the name of the function
.TP
<rhs_arguments>
stands for the input argument list. It may be
.RS
.TP 
-
a comma separated sequence of variable names enclosed in parenthesis, like 
\fV(x1,...,xm)\fR. Last variable name can be the key word
\fVvarargin\fR (see varargin)
.TP
-
the sequence \fV()\fR or nothing,if the function has no input
argument.
.RE
.TP
<lhs_arguments>
stands for the output argument list. It may be
.RS
.TP 
-
a comma separated sequence of variable names enclosed in brackets, like 
\fV[y1,...,yn]\fR. Last variable name can be the key word
\fVvarargout\fR (see varargout)
.TP
-
the sequence \fV[]\fR ,if the function has no input
argument. In this case the syntax may also be:  \fVfunction <function_name><rhs_arguments>\fR
.RE
.TP
<statements>
stands for a set of scilab instructions (statements)
.SH DESCRIPTION
This syntax may be used to define function (see functions) inline or
in a script file (see exec). For compatibility with old Scilab versions,
functions defined in a script file containing only function
definitions can be "loaded" into Scilab using the \fVgetf\fR function.
.LP
The \fVfunction <lhs_arguments>=<function_name><rhs_arguments>\fR
sequence cannot be split over several lines. This sequence can be
followed by statements in the same line if a comma of semi column is
added at its end.
.LP
function definitions can be nested
.SH EXAMPLE
.nf
//inline definition (see function)
function [x,y]=myfct(a,b)
x=a+b
y=a-b
endfunction

[x,y]=myfct(3,2)

//a one line function definition
function y=sq(x),y=x^2,endfunction

sq(3)

//nested functions definition
function y=foo(x)
a=sin(x)
function y=sq(x), y=x^2,endfunction
y=sq(a)+1
endfunction

foo(%pi/3)


// definition in an script file (see exec)
exec SCI/macros/elem/asin.sci;


.fi
.SH SEE ALSO
functions,  exec, getf