Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
2023.0.0 - English


function

opens a function definition

endfunction

closes a function definition

Description

function <lhs_arguments>=<function_name><rhs_arguments>
  <statements>
endfunction

Where

<function_name>

stands for the name of the function

<rhs_arguments>

stands for the input argument list. It may be

  • a comma separated sequence of variable names enclosed in parenthesis, like (x1,...,xm). Last variable name can be the key word varargin (see varargin)

  • the sequence () or nothing, if the function has no input argument.

<lhs_arguments>

stands for the output argument list. It may be

  • a comma separated sequence of variable names enclosed in brackets, like [y1,...,yn]. Last variable name can be the key word varargout (see varargout)

  • the sequence [], if the function has no output argument. In this case the syntax may also be: function <function_name><rhs_arguments>

<statements>

stands for a set of Scilab instructions (statements). 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 exec function.

The function <lhs_arguments>=<function_name><rhs_arguments> sequence cannot be split over several lines. This sequence can be followed by statements in the same line if a comma or a semicolon is added at its end.

Note that <function_name> must respect some syntax rules (see names).

Function definitions can be nested.

Examples

//inline definition (see function)
function [x, y]=myfct(a, b)
x=a+b
y=a-b
endfunction

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

//an 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 a script file (see exec)
exec SCI/modules/elementary_functions/macros/asinh.sci;

See also

  • functions — Scilab procedures and Scilab objects
  • exec — script file execution
  • names — Naming rules for variables and functions

History

VersionDescription
6.0.0 function and endfunction are now protected: Assignments like function=1 or endfunction=2 are no longer possible.
Report an issue
<< funcprot Advanced functions getd >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Mon Mar 27 11:52:51 GMT 2023