BinaryOperable (cudfjni 0.9.1 API)

All Known Implementing Classes:

ColumnVector, Scalar
```
public interface BinaryOperable
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ColumnVector`	`add(BinaryOperable rhs)` Add + operator.
`default ColumnVector`	`add(BinaryOperable rhs, DType outType)` Add + operator.
`default ColumnVector`	`and(BinaryOperable rhs)` Logical and (&&).
`default ColumnVector`	`and(BinaryOperable rhs, DType outType)` Logical and (&&) with the given output type.
`ColumnVector`	`binaryOp(BinaryOp op, BinaryOperable rhs, DType outType)` Multiple different binary operations.
`default ColumnVector`	`bitAnd(BinaryOperable rhs)` Bit wise and (&).
`default ColumnVector`	`bitAnd(BinaryOperable rhs, DType outType)` Bit wise and (&) with the given output type.
`default ColumnVector`	`bitOr(BinaryOperable rhs)` Bit wise or (\|).
`default ColumnVector`	`bitOr(BinaryOperable rhs, DType outType)` Bit wise or (\|) with the given output type.
`default ColumnVector`	`bitXor(BinaryOperable rhs)` Bit wise xor (^).
`default ColumnVector`	`bitXor(BinaryOperable rhs, DType outType)` Bit wise xor (^) with the given output type.
`default ColumnVector`	`div(BinaryOperable rhs)` Divide one vector by another.
`default ColumnVector`	`div(BinaryOperable rhs, DType outType)` Divide one vector by another with the given output type.
`default ColumnVector`	`equalTo(BinaryOperable rhs)` this == rhs 1 is true 0 is false.
`default ColumnVector`	`equalTo(BinaryOperable rhs, DType outType)` this == rhs 1 is true 0 is false with the output cast to the given type.
`default ColumnVector`	`floorDiv(BinaryOperable rhs)` Divide one vector by another and calculate the floor of the result.
`default ColumnVector`	`floorDiv(BinaryOperable rhs, DType outType)` Divide one vector by another and calculate the floor of the result with the given output type.
`DType`	`getType()` Get the type of this data.
`default ColumnVector`	`greaterOrEqualTo(BinaryOperable rhs)` this >= rhs 1 is true 0 is false.
`default ColumnVector`	`greaterOrEqualTo(BinaryOperable rhs, DType outType)` this >= rhs 1 is true 0 is false with the output cast to the given type.
`default ColumnVector`	`greaterThan(BinaryOperable rhs)` this > rhs 1 is true 0 is false.
`default ColumnVector`	`greaterThan(BinaryOperable rhs, DType outType)` this > rhs 1 is true 0 is false with the output cast to the given type.
`static DType`	`implicitConversion(BinaryOperable lhs, BinaryOperable rhs)` Finds the proper DType for an implicit output.
`default ColumnVector`	`lessOrEqualTo(BinaryOperable rhs)` this <= rhs 1 is true 0 is false.
`default ColumnVector`	`lessOrEqualTo(BinaryOperable rhs, DType outType)` this <= rhs 1 is true 0 is false with the output cast to the given type.
`default ColumnVector`	`lessThan(BinaryOperable rhs)` this < rhs 1 is true 0 is false.
`default ColumnVector`	`lessThan(BinaryOperable rhs, DType outType)` this < rhs 1 is true 0 is false with the output cast to the given type.
`default ColumnVector`	`mod(BinaryOperable rhs)` Compute the modulus.
`default ColumnVector`	`mod(BinaryOperable rhs, DType outType)` Compute the modulus with the given output type.
`default ColumnVector`	`mul(BinaryOperable rhs)` Multiply two vectors together.
`default ColumnVector`	`mul(BinaryOperable rhs, DType outType)` Multiply two vectors together with the given output type.
`default ColumnVector`	`notEqualTo(BinaryOperable rhs)` this != rhs 1 is true 0 is false.
`default ColumnVector`	`notEqualTo(BinaryOperable rhs, DType outType)` this != rhs 1 is true 0 is false with the output cast to the given type.
`default ColumnVector`	`or(BinaryOperable rhs)` Logical or (\|\|).
`default ColumnVector`	`or(BinaryOperable rhs, DType outType)` Logical or (\|\|) with the given output type.
`default ColumnVector`	`pow(BinaryOperable rhs)` Compute the power.
`default ColumnVector`	`pow(BinaryOperable rhs, DType outType)` Compute the power with the given output type.
`default ColumnVector`	`sub(BinaryOperable rhs)` Subtract one vector from another.
`default ColumnVector`	`sub(BinaryOperable rhs, DType outType)` Subtract one vector from another with the given output type.
`default ColumnVector`	`trueDiv(BinaryOperable rhs)` Divide one vector by another converting to FLOAT64 in between.
`default ColumnVector`	`trueDiv(BinaryOperable rhs, DType outType)` Divide one vector by another converting to FLOAT64 in between with the given output type.

Method Detail

implicitConversion
```
static DType implicitConversion(BinaryOperable lhs,
                                BinaryOperable rhs)
```
Finds the proper DType for an implicit output. This follows the typical rules of C++, Java, and most SQL implementations. FLOAT64/double > FLOAT32/float > INT64/long > INT32/int > INT16/short > INT8/byte/char
Currently TIMESTAMP and DATE64 are treated the same as INT64. DATE32 is treated the same as INT32. TimeUnit conversion is not taken into account when doing operations on these objects. This may change in the future, but for now the types returned will be stripped of time units. You can still get the desired behavior by casting the things involved to the same time units doing the math, and casting it to a result with the desired time units.
BOOL8 is treated like an INT8. Math on boolean operations makes little sense. If you want to to stay as a BOOL8 you will need to explicitly specify the output type.

getType
```
DType getType()
```
Get the type of this data.

binaryOp

ColumnVector binaryOp(BinaryOp op,
                      BinaryOperable rhs,
                      DType outType)

Multiple different binary operations.

Parameters:: op - the operation to perform; rhs - the rhs of the operation; outType - the type of output you want.
Returns:: the result

add

default ColumnVector add(BinaryOperable rhs,
                         DType outType)

Add + operator. this + rhs

add

default ColumnVector add(BinaryOperable rhs)

Add + operator. this + rhs

sub

default ColumnVector sub(BinaryOperable rhs,
                         DType outType)

Subtract one vector from another with the given output type. this - rhs

sub

default ColumnVector sub(BinaryOperable rhs)

Subtract one vector from another. this - rhs

mul

default ColumnVector mul(BinaryOperable rhs,
                         DType outType)

Multiply two vectors together with the given output type. this * rhs

mul

default ColumnVector mul(BinaryOperable rhs)

Multiply two vectors together. this * rhs

div

default ColumnVector div(BinaryOperable rhs,
                         DType outType)

Divide one vector by another with the given output type. this / rhs

div

default ColumnVector div(BinaryOperable rhs)

Divide one vector by another. this / rhs

trueDiv

default ColumnVector trueDiv(BinaryOperable rhs,
                             DType outType)

Divide one vector by another converting to FLOAT64 in between with the given output type. (double)this / (double)rhs

trueDiv
```
default ColumnVector trueDiv(BinaryOperable rhs)
```
Divide one vector by another converting to FLOAT64 in between. (double)this / (double)rhs

floorDiv

default ColumnVector floorDiv(BinaryOperable rhs,
                              DType outType)

Divide one vector by another and calculate the floor of the result with the given output type. Math.floor(this/rhs)

floorDiv
```
default ColumnVector floorDiv(BinaryOperable rhs)
```
Divide one vector by another and calculate the floor of the result. Math.floor(this/rhs)

mod

default ColumnVector mod(BinaryOperable rhs,
                         DType outType)

Compute the modulus with the given output type. this % rhs

mod

default ColumnVector mod(BinaryOperable rhs)

Compute the modulus. this % rhs

pow

default ColumnVector pow(BinaryOperable rhs,
                         DType outType)

Compute the power with the given output type. Math.pow(this, rhs)

pow

default ColumnVector pow(BinaryOperable rhs)

Compute the power. Math.pow(this, rhs)

equalTo

default ColumnVector equalTo(BinaryOperable rhs,
                             DType outType)

this == rhs 1 is true 0 is false with the output cast to the given type.

equalTo
```
default ColumnVector equalTo(BinaryOperable rhs)
```
this == rhs 1 is true 0 is false. The output type is BOOL8.

notEqualTo

default ColumnVector notEqualTo(BinaryOperable rhs,
                                DType outType)

this != rhs 1 is true 0 is false with the output cast to the given type.

notEqualTo
```
default ColumnVector notEqualTo(BinaryOperable rhs)
```
this != rhs 1 is true 0 is false. The output type is BOOL8.

lessThan

default ColumnVector lessThan(BinaryOperable rhs,
                              DType outType)

this < rhs 1 is true 0 is false with the output cast to the given type.

lessThan
```
default ColumnVector lessThan(BinaryOperable rhs)
```
this < rhs 1 is true 0 is false. The output type is BOOL8.

greaterThan

default ColumnVector greaterThan(BinaryOperable rhs,
                                 DType outType)

this > rhs 1 is true 0 is false with the output cast to the given type.

greaterThan
```
default ColumnVector greaterThan(BinaryOperable rhs)
```
this > rhs 1 is true 0 is false. The output type is BOOL8.

lessOrEqualTo

default ColumnVector lessOrEqualTo(BinaryOperable rhs,
                                   DType outType)

this <= rhs 1 is true 0 is false with the output cast to the given type.

lessOrEqualTo
```
default ColumnVector lessOrEqualTo(BinaryOperable rhs)
```
this <= rhs 1 is true 0 is false. The output type is BOOL8.

greaterOrEqualTo

default ColumnVector greaterOrEqualTo(BinaryOperable rhs,
                                      DType outType)

this >= rhs 1 is true 0 is false with the output cast to the given type.

greaterOrEqualTo
```
default ColumnVector greaterOrEqualTo(BinaryOperable rhs)
```
this >= rhs 1 is true 0 is false. The output type is BOOL8.

bitAnd

default ColumnVector bitAnd(BinaryOperable rhs,
                            DType outType)

Bit wise and (&) with the given output type. this & rhs

bitAnd

default ColumnVector bitAnd(BinaryOperable rhs)

Bit wise and (&). this & rhs

bitOr

default ColumnVector bitOr(BinaryOperable rhs,
                           DType outType)

Bit wise or (|) with the given output type. this | rhs

bitOr

default ColumnVector bitOr(BinaryOperable rhs)

Bit wise or (|). this | rhs

bitXor

default ColumnVector bitXor(BinaryOperable rhs,
                            DType outType)

Bit wise xor (^) with the given output type. this ^ rhs

bitXor

default ColumnVector bitXor(BinaryOperable rhs)

Bit wise xor (^). this ^ rhs

and

default ColumnVector and(BinaryOperable rhs,
                         DType outType)

Logical and (&&) with the given output type. this && rhs

and

default ColumnVector and(BinaryOperable rhs)

Logical and (&&). this && rhs

or

default ColumnVector or(BinaryOperable rhs,
                        DType outType)

Logical or (||) with the given output type. this || rhs

or

default ColumnVector or(BinaryOperable rhs)

Logical or (||). this || rhs

Interface BinaryOperable

Method Summary

Method Detail

implicitConversion

getType

binaryOp

add

add

sub

sub

mul

mul

div

div

trueDiv

trueDiv

floorDiv

floorDiv

mod

mod

pow

pow

equalTo

equalTo

notEqualTo

notEqualTo

lessThan

lessThan

greaterThan

greaterThan

lessOrEqualTo

lessOrEqualTo

greaterOrEqualTo

greaterOrEqualTo

bitAnd

bitAnd

bitOr

bitOr

bitXor

bitXor

and

and

or

or