Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes

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

Please note that the recommended version of Scilab is 6.1.1. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab manual >> xcos > palettes > Matrix operation palette > CUMSUM

CUMSUM

Cumulative Sum

Block Screenshot

Description

The CUMSUM block sums the element of an input m*n matrix u along either the rows, the columns or the first non singleton dimension. When the "Sum along" parameter is set to "1", the block sums across the elements of each row. The result will be displayed as a m*1 matrix.

When the "Sum along" parameter is set to "2", the block sums across the elements of each column. The result will be display as a 1*n matrix.

When the "Sum along" parameter is set to "0", the block sums across the first non singleton dimension. The result will be displayed as one element. This block is equivalent to cumsum in scilab.

Dialog box

  • Datatype(1=real double 2=Complex)

    It indicates the type of the output. It support only the two types double (1) and complex (2). If we input another entry in this label Scicos will print the message "Datatype is not supported".

    Properties : Type 'vec' of size 1.

  • Sum along (0=the first non singleton dimension 1=Rows 2=Columns)

    Indicate whether to sum across the rows, the columns or the first non singleton dimension.

    Properties : Type 'vec' of size 1.

Example

A=[1 2 3;4 5 6;7 8 9]
If the sum is along the row the result will be
B=[12;15;18]

Default properties

  • always active: no

  • direct-feedthrough: yes

  • zero-crossing: no

  • mode: no

  • regular inputs:

    - port 1 : 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: cumsum_m

Interfacing function

  • SCI/modules/scicos_blocks/macros/MatrixOp/CUMSUM.sci

Computational function

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

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

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

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

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

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

Authors

Fady NASSIF - INRIA

<< Matrix_pal Matrix operation palette EXTRACT >>

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