ArithmeticOperations (Wrangler Core 4.8.0 API)

java.lang.Object
- io.cdap.wrangler.utils.ArithmeticOperations

public class ArithmeticOperations
extends Object

Cross-column operations for arithmetic

Constructor Summary

Constructors
Constructor and Description

ArithmeticOperations()

Constructors
Constructor and Description
`ArithmeticOperations()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Number`	`add(Number... nums)` Arithmetic operation - Find the sum of any number of columns, of any valid types.
`static Number`	`average(Number... nums)` Arithmetic operation - calculate average of any number of columns.
`static Number`	`divideq(Number x, Number y)` Arithmetic operation - divides one column by another.
`static Number`	`divider(Number x, Number y)` Arithmetic operation - divides one column by another and returns the remainder.
`static Boolean`	`equal(BigDecimal... nums)` Arithmetic operation - Check if all values are equal across any number of BigDecimal columns.
`static Boolean`	`equal(Double... nums)` Arithmetic operation - Check if all values are equal across any number of Double columns.
`static Boolean`	`equal(Float... nums)` Arithmetic operation - Check if all values are equal across any number of Float columns.
`static Boolean`	`equal(Integer... nums)` Arithmetic operation - Check if all values are equal across any number of Integer columns.
`static Boolean`	`equal(Long... nums)` Arithmetic operation - Check if all values are equal across any number of Long columns.
`static Boolean`	`equal(Short... nums)` Arithmetic operation - Check if all values are equal across any number of Short columns.
`static Number`	`lcm(Number x, Number y)` Arithmetic operation - calculates the LCM of two columns.
`static Number`	`max(Number... nums)` Arithmetic operation - Find the maximum of any number of columns, of any valid types.
`static Number`	`min(Number... nums)` Arithmetic operation - Find the minimum of any number of columns, of any valid types.
`static Number`	`minus(Number x, Number y)` Arithmetic operation - subtract a column from another column.
`static Number`	`multiply(Number... nums)` Arithmetic operation - multiply any number of columns, of any types.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArithmeticOperations
```
public ArithmeticOperations()
```
- Method Detail
  - add
```
public static Number add(Number... nums)
                  throws DirectiveExecutionException
```
    Arithmetic operation - Find the sum of any number of columns, of any valid types. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - minus
```
public static Number minus(Number x,
                           Number y)
                    throws DirectiveExecutionException
```
    Arithmetic operation - subtract a column from another column. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - multiply
```
public static Number multiply(Number... nums)
                       throws DirectiveExecutionException
```
    Arithmetic operation - multiply any number of columns, of any types. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - divideq
```
public static Number divideq(Number x,
                             Number y)
                      throws DirectiveExecutionException
```
    Arithmetic operation - divides one column by another. Output type is Double, except when there is an input of type BigDecimal, in which case the output is BigDecimal. Returns null if any input value is null, or if the divisor equals 0.
    
    Throws:
    
    DirectiveExecutionException
  - divider
```
public static Number divider(Number x,
                             Number y)
                      throws DirectiveExecutionException
```
    Arithmetic operation - divides one column by another and returns the remainder. Output type is most general of input types, except 2 Shorts should give an Integer. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - lcm
```
public static Number lcm(Number x,
                         Number y)
                  throws DirectiveExecutionException
```
    Arithmetic operation - calculates the LCM of two columns. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - equal
```
public static Boolean equal(Short... nums)
```
    Arithmetic operation - Check if all values are equal across any number of Short columns.
  - equal
```
public static Boolean equal(Integer... nums)
```
    Arithmetic operation - Check if all values are equal across any number of Integer columns.
  - equal
```
public static Boolean equal(Long... nums)
```
    Arithmetic operation - Check if all values are equal across any number of Long columns.
  - equal
```
public static Boolean equal(Float... nums)
```
    Arithmetic operation - Check if all values are equal across any number of Float columns.
  - equal
```
public static Boolean equal(Double... nums)
```
    Arithmetic operation - Check if all values are equal across any number of Double columns.
  - equal
```
public static Boolean equal(BigDecimal... nums)
```
    Arithmetic operation - Check if all values are equal across any number of BigDecimal columns.
  - max
```
public static Number max(Number... nums)
                  throws DirectiveExecutionException
```
    Arithmetic operation - Find the maximum of any number of columns, of any valid types. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - min
```
public static Number min(Number... nums)
                  throws DirectiveExecutionException
```
    Arithmetic operation - Find the minimum of any number of columns, of any valid types. Output type is most general of input types. Returns null if any input value is null.
    
    Throws:
    
    DirectiveExecutionException
  - average
```
public static Number average(Number... nums)
                      throws DirectiveExecutionException
```
    Arithmetic operation - calculate average of any number of columns. Returns Number - BigDecimal if any column is of type BigDecimal, double otherwise. HALF_EVEN rounding mode chosen for high precision in the long run.
    
    Throws:
    
    DirectiveExecutionException

Class ArithmeticOperations

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArithmeticOperations

Method Detail

add

minus

multiply

divideq

divider

lcm

equal

equal

equal

equal

equal

equal

max

min

average