- MATRIX_SPEC
- The function accepts two matrices. The matrices are not required to have the same dimensions meaning that they are not required to have the same number of matrix rows and same number of matrix columns. The first matrix referenced in the function call is referred to as the primary matrix. The second matrix referenced is the secondary matrix. The result matrix always inherits the identifiers, and MATRIX_ID() from the primary matrix.
It does not matter which input contains the filters and which contains the matrices to be filtered. The matrices can be in any order.
- INPUT_FMT
- Mandatory specification. The INPUT_MODE parameter has the following options:
- ONE2ONE: Both the primary and secondary matrix specifications include a WHERE filter clause identifying one matrix instance to serve as the input matrix for the mathematical operation.
- MANY2ONE: The primary input MATRIX_SPEC references MANY matrix instances. The secondary input MATRIX_SPEC includes a WHERE filter clause identifying a single series instance. When applying the mathematical operation, the secondary input single matrix is reused as many times as necessary to match the number of series instances found in the primary input.
- MATCH: A matrix instance residing in the primary input whose MATRIX_ID matches the MATRIX_ID of a matrix instance in the secondary input, has the mathematical operation applied to produce a result matrix. For those instances in one input who have no corresponding MATRIX_ID partner in the other input, the matrix is skipped over.
- OUTPUT_FMT
- No OUTPUT_FMT options are available for this function.