Scicos Block
fr - eng

##
Gain

### Contents

- Gain
  - Palette
  - Description
  - Dialog box
  - Default properties
  - Interfacing function
  - Computational function
  - See also
  - Authors

### Palette

- Linear - Linear palette

### Description

The GAINBLK computes the product of a square matrix A by the input matrix U, where the number of rows/cols of A is equal to the number of rows of U. The input/output datatype is defined by the type of the Gain matrix A. It can take all the datatype. 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

- Gain
  This parameter defined the square matrix A. That parameter can support all Data types.
  Properties : Type 'mat' of size [-1,-1].

- Do on Overflow (0=Nothing 1=Saturate 2=Error)
  When this parameter is set to zero the result is similar to a normal multiplication 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.
  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
- 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: gainblk

### Interfacing function

- SCI/macros/scicos_blocks/Linear/GAINBLK.sci [view code]

### Computational function

- SCI/routines/scicos/gainblk.c [view code]
- SCI/routines/scicos/gainblk_i32n.c [view code]
- SCI/routines/scicos/gainblk_i16n.c [view code]
- SCI/routines/scicos/gainblk_i8n.c [view code]
- SCI/routines/scicos/gainblk_ui32n.c [view code]
- SCI/routines/scicos/gainblk_ui16n.c [view code]
- SCI/routines/scicos/gainblk_ui8n.c [view code]
- SCI/routines/scicos/gainblk_i32s.c [view code]
- SCI/routines/scicos/gainblk_i16s.c [view code]
- SCI/routines/scicos/gainblk_i8s.c [view code]
- SCI/routines/scicos/gainblk_ui32s.c [view code]
- SCI/routines/scicos/gainblk_ui16s.c [view code]
- SCI/routines/scicos/gainblk_ui8s.c [view code]
- SCI/routines/scicos/gainblk_i32e.c [view code]
- SCI/routines/scicos/gainblk_i16e.c [view code]
- SCI/routines/scicos/gainblk_i8e.c [view code]
- SCI/routines/scicos/gainblk_ui32e.c [view code]
- SCI/routines/scicos/gainblk_ui16e.c [view code]
- SCI/routines/scicos/gainblk_ui8e.c [view code]

### See also

- INTMUL - INTMUL integer matrix multiplication (Scicos Block)
- MATMUL - MATMUL Matrix Multiplication (Scicos Block)

### Authors

- Fady NASSIF INRIA
- Alan Layec INRIA
- Ramine Nikoukhah INRIA