CUMSUM

Scicos Block
fr - eng

##
CUMSUM: Cumulative Sum

### Contents

- CUMSUM: Cumulative Sum
  - Palette
  - Description
  - Dialog box
  - Example
  - Default properties
  - Interfacing function
  - Computational function
  - See also
  - Authors

### Palette

- Matrix - Matrix operation palette

### 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/macros/scicos_blocks/MatrixOp/CUMSUM.sci [view code]

### Computational function

- SCI/routines/scicos/cumsum_m.c [view code]
- SCI/routines/scicos/cumsum_r.c [view code]
- SCI/routines/scicos/cumsum_c.c [view code]
- SCI/routines/scicos/cumsumz_m.c [view code]
- SCI/routines/scicos/cumsumz_r.c [view code]
- SCI/routines/scicos/cumsumz_c.c [view code]

### See also

- MATSUM - Matrix Sum (Scicos Block)

### Authors

Fady NASSIF INRIA