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

Divide Columns
Returns a table that includes a column reflecting the quotient of specified columns of a specified table, the quotient of a specified value and a specified column, or the quotient of two specified values.
Usage notes
Case 1: Quotient of 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: Quotient of 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: Quotient of 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 dividing the corresponding row's cell in First Column Name or Numeric Value by the cell in Second 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 dividing the corresponding row's cell in the specified column by the specified numeric value.
In case 3, each cell of the returned column contains the quotient of the two specified numeric values.
In the returned table, the quotient 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 divided.
First Column Name or Numeric Value: Text string specifying the column to whose values are to be used as dividends, or numerical value to be as dividends.
Second Column Name or Numeric Value: Text string specifying the column to whose values are to be used as divisors, or numerical value to be as divisors.
Result Column Name: Text string that specifies the name of the column containing the quotients. You must supply a value for this argument.
This function returns a table.