math:- (fields container)
Version: 0.0.0
Description
Computes the difference of two fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | field_or_fields_container_A | field, fields_container, double, vector<double> | field or fields container with only one field is expected |
| Pin 1 Required | field_or_fields_container_B | field, fields_container, double, vector<double> | field or fields container with only one field is expected |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | fields_container | fields_container |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| binary_operation | binary_operation_enum, int32 | 1 | This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. |
| inplace | bool | false | The output is written over the input to save memory if this config is set to true. |
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
| num_threads | int32 | 0 | Number of threads to use to run in parallel |
| permissive | bool | false | If this option is set to true, warning checks (like unit or data sizes) won't be done. |
| run_in_parallel | bool | true | Loops are allowed to run in parallel if the value of this config is set to true. |
| use_cache | bool | true | Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. |
| work_by_index | bool | false | If this option is set to true, loops and comparisons by entity will be done by index instead of ids. |
Scripting
Category: math
Plugin: core
Scripting name: None
Full name: None
Internal name: minus_fc
License: None
Changelog
- Version 0.0.0: Initial release.