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

Change language to:
Français - 日本語 - Português

Please note that the recommended version of Scilab is 2024.0.0. This page might be outdated.
See the recommended documentation of this function

Scilab manual >> xcos > palettes > Math operations palette > SUMMATION

SUMMATION

Matrix Summation

Block Screenshot

Description

The Sum block performs addition or subtraction on its inputs. This block can add or subtract scalar, vector, or matrix inputs. It can also collapse the elements of a single input vector.

The number of inputs is given by the second parameter. This parameter can be a vector of +1 and -1 or it can be a positive value. In the first case the size of the vector indicates the number of inputs and the signs indicates whether it is a summation or a subtraction. In the second case, the block is a summation block and the value indicates the number of inputs.

On overflow, the result can take different forms:

1- A normal non saturated result.

2- A saturated result.

3- An error message warning the user about the overflow.

The user can select one of these three forms by setting the "DO ON OVERFLOW" field to 0,1 or 2.

Dialog box

  • Datatype (1=real double 2=complex 3=int32 ...)

    It indicates the type of the input/output data. It support all datatype, number must be between 1 and 8.

    Properties : Type 'vec' of size 1.

  • Number of inputs or sign vector (of +1, -1)

    It indicates the number of inputs and the operation see the description for more detail.

    Properties : Type 'vec' of size -1.

  • Do on Overflow(0=Nothing 1=Saturate 2=Error)

    When this parameter is set to zero the result is similar to a normal summation of two integer matrix. When it is set to 1, on overflow the block saturate the result. When it is set to 2, on overflow an error message box appears. If the Data type is double or complex this parameter is not used.

    Properties : Type 'vec' of size 1.

Default properties

  • always active: no

  • direct-feedthrough: yes

  • zero-crossing: no

  • mode: no

  • regular inputs:

    - port 1 : size [-1,-2] / type 1

    - port 2 : size [-1,-2] / type 1

  • regular outputs:

    - port 1 : size [-1,-2] / type 1

  • number/sizes of activation inputs: 0

  • number/sizes of activation outputs: 0

  • continuous-time state: no

  • discrete-time state: no

  • object discrete-time state: no

  • name of computational function: summation

Interfacing function

  • SCI/modules/scicos_blocks/macros/Linear/SUMMATION.sci

Computational function

  • SCI/modules/scicos_blocks/src/c/summation.c

  • SCI/modules/scicos_blocks/src/c/summation_z.c

  • SCI/modules/scicos_blocks/src/c/summation_i32n.c

  • SCI/modules/scicos_blocks/src/c/summation_i16n.c

  • SCI/modules/scicos_blocks/src/c/summation_i8n.c

  • SCI/modules/scicos_blocks/src/c/summation_ui32n.c

  • SCI/modules/scicos_blocks/src/c/summation_ui16n.c

  • SCI/modules/scicos_blocks/src/c/summation_ui8n.c

  • SCI/modules/scicos_blocks/src/c/summation_i32s.c

  • SCI/modules/scicos_blocks/src/c/summation_i16s.c

  • SCI/modules/scicos_blocks/src/c/summation_i8s.c

  • SCI/modules/scicos_blocks/src/c/summation_ui32s.c

  • SCI/modules/scicos_blocks/src/c/summation_ui16s.c

  • SCI/modules/scicos_blocks/src/c/summation_ui8s.c

  • SCI/modules/scicos_blocks/src/c/summation_i32e.c

  • SCI/modules/scicos_blocks/src/c/summation_i16e.c

  • SCI/modules/scicos_blocks/src/c/summation_i8e.c

  • SCI/modules/scicos_blocks/src/c/summation_ui32e.c

  • SCI/modules/scicos_blocks/src/c/summation_ui16e.c

  • SCI/modules/scicos_blocks/src/c/summation_ui8e.c

Authors

  • Fady NASSIF INRIA

  • Alan Layec INRIA

  • Ramine Nikoukhah INRIA

<< SQRT Math operations palette SUM_f >>

Copyright (c) 2022-2023 (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:
Wed Jan 26 16:23:47 CET 2011