Array
Array - Accumulate
Accumulates a given value into an array at each iteration.The accumulation depends on the actual 'Run scope', which means that the accumulation is resetted at each run of the main thread
IN
| Name | Type | Description |
|---|---|---|
| InValue | T | The value to be accumulated in the array |
| InCondition | Bool | Sets if the input value has to be accumulated into the array or not |
| InReset | Bool | Resets the accumulation state.If true, the array is cleared before new value is accumulated |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The out array |
| Error | ErrorState | Gets the execution error message |
Array - Append
Appends a value to the input array
IN
| Name | Type | Description |
|---|---|---|
| InValue | T | The value to append |
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The edited array |
| Error | ErrorState | Gets the execution error message |
Array - Concat
Concatenates two arrays of specific type into a single array, so that OutArray = { InArray1 , InArray2 }
IN
| Name | Type | Description |
|---|---|---|
| InArray1 | < T > | The first array |
| InArray2 | < T > | The second array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The concatenated array |
| Error | ErrorState | Gets the execution error message |
Array - Difference
Returns an array of elements which are contained in the first array but not in the second one (without duplicates).
IN
| Name | Type | Description |
|---|---|---|
| InArray1 | < T > | The first array |
| InArray2 | < T > | The second array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - FindAll
Finds all locations of a given value in the input array and return their zero based indices
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InValue | T | The value to look for |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIndices | IntArray | Indices of the value occurrences in the collection |
| OutFound | Bool | True if the value has been found at least once |
| Error | ErrorState | Gets the execution error message |
Array - FindFirst
Finds the first location of a value in the given array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InValue | T | The value to look for |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIndex | Int | Zero based index of the found item.If not found, the value is -1 |
| OutFound | Bool | True if the value has been found,otherwise false |
| Error | ErrorState | Gets the execution error message |
Array - FindLast
Finds last location of a given value in the input array.
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InValue | T | The value to look for |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutIndex | Int | Zero based index of the found item.If not found, the value is -1 |
| OutFound | Bool | True if the value has been found,otherwise false |
| Error | ErrorState | Gets the execution error message |
Array - FlattenVectorization
Reduces a vectorized array into its equivalent type without the vectorization effect. This tool is usually used to merge multiple outputs that are generated during a vectorized process, i.e. a tool which is executed on an array of its input type.
IN
| Name | Type | Description |
|---|---|---|
| InArray | T | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | T | The flatten array |
| Error | ErrorState | Gets the execution error message |
Array - Flatten_ToSingleArray
Reduces an n-dimensional array into a single-dimensional array.
IN
| Name | Type | Description |
|---|---|---|
| InArray | T | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The flatten array |
| Error | ErrorState | Gets the execution error message |
Array - GetSize
Get the size of the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Int | The array size |
| Error | ErrorState | Gets the execution error message |
Array - Intersection
Returns an array of elements that are contained both InArray1 and InArray2 (without duplicates).
IN
| Name | Type | Description |
|---|---|---|
| InArray1 | < T > | The first array |
| InArray2 | < T > | The second array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - MakeConstant
Create an array where the input value is repeated n times
IN
| Name | Type | Description |
|---|---|---|
| InValue | T | The constant value |
| InSize | Int | The array size |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - MakeFromItems
Creates an array of N items that can be added manually
IN
| Name | Type | Description |
|---|---|---|
| InSize | Int | The array size |
| InValue | RegisterParamCollection | The collection of values |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - MakeSequence
Creates an array that contains a sequence of values from/to specified values and step.The array type must be numeric,i.e double,int,float etc.The average value is returned with the same type of the input elements
IN
| Name | Type | Description |
|---|---|---|
| InFrom | T | The starting value |
| InTo | T | The final value |
| InStep | T | The step between consecutive values |
| InIncludeLast | Bool | Sets if the last value has to be included in the sequence |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - MakeSequenceOLD
Creates an array that contains a sequence of values from/to specified values and step.The array type must be numeric,i.e double,int,float etc.The average value is returned with the same type of the input elements
IN
| Name | Type | Description |
|---|---|---|
| InFrom | T | The starting value |
| InTo | T | The final value |
| InStep | T | The step between consecutive values |
| InIncludeLast | Bool | Sets if the last value has to be included in the sequence |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - RemoveAt
Remove the element at given position from the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndex | Int | The index where the element has to be removed |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - RemoveAtMultiple
Removes multiple elements at given positions from the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndices | IntArray | The indices where elements have to be to removed |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - RemoveNull
Removes all null values from the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | T | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | T | The result array |
| OutMask | < T > | Boolean mask indicating the positions of the null values in the input array |
| Error | ErrorState | Gets the execution error message |
Array - RemoveRange
Removes multiple elements in the given range
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InStart | Int | The index of the first element in the range to remove |
| InLength | Int | The number of elements to remove |
| InInverse | Bool | If true the range is inverted and the elements to remove are located before the first one |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - RemoveValue
Removes the first or all occurences of a specific value in the given array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InValue | T | Input value to be removed |
| InRemoveAll | Bool | If true removes all the occurences,otherwise only the first one |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - Replace
Replaces the all occurences of a specific value in the array with a new one
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InOldValue | T | Value to be replaced |
| InNewValue | T | Value to be set |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - ReplaceAt
Replaces the element at given position from the input array with a new one
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndex | Int | The index where the element has to be replaced |
| InNewValue | T | Value to be set |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - ReplaceAtMultiple
Replaces multiple elements at given positions from the input array with a new one
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndices | IntArray | The indices where elements have to be to replaced |
| InNewValue | T | Value to be set |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - ReplaceAtRange
Replaces multiple elements in the given range of the input array with a new one
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InStart | Int | The index of the first element in the range to remove |
| InLength | Int | The number of elements to remove |
| InInverse | Bool | If true the range is inverted and the elements to remove are located before the first one |
| InNewValue | T | Value to be set |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - Reset
Resets the array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The resetted collection |
| Error | ErrorState | Gets the execution error message |
Array - Reverse
Reverses the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |
Array - SelectAt
Selects the element in the array at given index
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndex | Int | The index to select |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected element |
| Error | ErrorState | Gets the execution error message |
Array - SelectAtMultiple
Selectes multiple elements in the input array by given array of indices
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InIndices | IntArray | The indices to select |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The array of selected items |
| Error | ErrorState | Gets the execution error message |
Array - SelectByMask
Selects multiple items in the given array by using a selection mask and returns the selected and discarded elements in two separated arrays.The mask must have the same size of the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InSelectionMask | BoolArray | The selection mask as array of boolean |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArraySelected | < T > | The array of selected elements |
| OutArrayDiscarded | < T > | The array of discarded items |
| Error | ErrorState | Gets the execution error message |
Array - SelectFirst
Selects the first element in the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected element |
| Error | ErrorState | Gets the execution error message |
Array - SelectRange
Selects multiple elements in the input array in the specific range
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InStart | Int | The index of the first element in the range to remove |
| InLength | Int | The number of elements to remove |
| InInverse | Bool | If true the range is inverted and the elements to remove are located before the first one |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The selected elements |
| Error | ErrorState | Gets the execution error message |
Array - SelectLast
Selects the last element in the input array
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSelected | T | The selected item |
| Error | ErrorState | Gets the execution error message |
Array - Sort
Sorts the elements in the input array according to an ascending/descending order based on values in InValues..
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array |
| InValues | FloatArray | The values used to sort the input array |
| InAscending | Bool | Defines the ascending order during sorting |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSorted | < T > | The sorted array |
| OutSortedValues | FloatArray | The sorted array values |
| Error | ErrorState | Gets the execution error message |
Array - Transpose
Transposes the input array.When the rank of the input array is 2 the dimensions are swapped so that a n x m array becomes m x n. In case of single array (1 x n) it becomes n x 1
IN
| Name | Type | Description |
|---|---|---|
| InArray | < T > | The input array to transpose |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArrayTransposed | < T > | The transposed array |
| Error | ErrorState | Gets the execution error message |
Array - Union
Creates a new array where elements are contained in one of the input arrays or both (without duplicates).
IN
| Name | Type | Description |
|---|---|---|
| InArray1 | < T > | The first array |
| InArray2 | < T > | The second array |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArray | < T > | The result array |
| Error | ErrorState | Gets the execution error message |