Engee documentation

For Each

A control unit for For-each type subsystems.

blockType: ForEach

Path in the library:

/Basic/Ports & Subsystems/For Each

Description

Block For Each — control unit for For Each Subsystem. In particular, the block For Each allows the blocks inside For Each Subsystem to process parts of the input signals. Each block within this subsystem maintains a separate set of states for each element or subarray that it processes. As a set of subsystem blocks processes elements or subarrays, the subsystem combines the results to form output signals.

Ports

Output

# 0:N-1 — index of the current element
scalar

Details

The index of the current element (starting from zero) in the form of a scalar.

Dependencies

To use this port, check the box Show partition index output port (zero-based indexing).

Data types

Int32, Float64

Complex numbers support

No

Parameters

Main

# Show partition index output port (zero-based indexing) — control of the output port display
Logical

Details

Controlling the display of the output port for the partition index.

  • if this option is unchecked, the output port is hidden.

  • if this option is selected, the output port is displayed on the block.

Default value

false (switched off)

Program usage name

ShowIterationIndex

Tunable

No

Evaluatable

No

# Partition index output data type — specify the data type of the section index
Int32 | Float64

Details

Specify the partition index data type for the output port:

  • Int32 — A 32-bit signed integer.

  • Float64 — A 64-bit real number.

Dependencies

To use this option, check the box Show partition index output port (zero-based indexing).

Values

Int32 | Float64

Default value

Int32

Program usage name

IterationIndexDataType

Tunable

No

Evaluatable

No

# Number of iterations — specify the number of partitions to process
Int64 integer

Details

To process a subset of the data, specify the number of fragments of the input signal or an array of mask parameters that need to be processed, otherwise specify −1 to process all the fragments. The number must not exceed the total number of available slices.

  • −1 — process all the fragments.

  • an integer — the number of processed fragments. For example, Number of iterations equal 3 means that only the first ones are processed. 3 a slice.

Default value

-1

Program usage name

SpecifiedNumIters

Tunable

No

Evaluatable

Yes

Examples