Apama 10.3 | Apama Documentation | Building and Using Apama Dashboards | Dashboard Function Reference | Tabular Functions | Subtract Columns

Subtract Columns
Returns a table that includes a column reflecting the difference between two specified columns of a specified table, the difference between a specified value and a specified column, or the difference between two specified values.
Usage notes
Case 1: Difference between two specified columns of a specified table. This is the case if First Column Name or Numeric Value and Second Column Name or Numeric Value both specify a column of Table.
Case 2: Difference between a specified value and a specified column. This is the case if one of First Column Name or Numeric Value and Second Column Name or Numeric Value specifies a column of Table and the other specifies a numeric value.
Case 3: Difference between two specified values. This is the case if First Column Name or Numeric Value and Second Column Name or Numeric Value both specify a numeric value.
In case 1, the nth cell in the returned column corresponds to the nth cell of the table specified by the argument Table. Each cell of the returned column contains the result of subtracting the corresponding row's cell in Second Column Name or Numeric Value from the cell in First Column Name or Numeric Value.
In case 2, the nth cell in the returned column corresponds to the nth cell of the table specified by the argument Table. Each cell of the returned column contains the result of subtracting the specified numeric value from the corresponding row's cell in the specified column.
In case 3, each cell of the returned column contains the subtracting the second specified value from the first.
In the returned table, the sum column is preceded by copies of all the columns in Table.
Arguments
The function has the following arguments:
Table: Table that contains the columns to be used in the subtraction operations.
First Column Name or Numeric Value: Text string specifying minuend, the column to be subtracted from, or numerical value to be subtracted from.
Second Column Name or Numeric Value: Text string specifying subtrahend, the column to be subtracted, or numerical value to be subtracted.
Result Column Name: Text string that specifies the name of the column containing the differences. You must supply a value for this argument.
This function returns a table.