io.cdap.functions

Class Logical

java.lang.Object

io.cdap.functions.Logical

public final class Logical
extends Object

The collection of logical functions that operate on bit.

Method Summary

Modifier and Type	Method and Description
static int	BitAnd(int num1, int num2) Bitwise 'AND' operation of two numbers.
static long	BitAnd(long num1, long num2) Bitwise 'AND' operation of two numbers.
static long	BitCompress(String value) Returns the long made from the string argument, which contains a binary representation of "1"s and "0"s.
static String	BitExpand(long value) Returns a string containing the binary representation in "1"s and "0"s of the given long.
static int	BitOr(int num1, int num2) Bitwise 'OR' operation of two numbers.
static long	BitOr(long num1, long num2) Bitwise 'OR' operation of two numbers.
static int	BitXor(int num1, int num2) Bitwise 'XOR' operation of two numbers.
static long	BitXor(long num1, long num2) Bitwise 'XOR' operation of two numbers.
static int	Not(double val) Returns the complement of the logical value of an expression.
static int	Not(float val) Returns the complement of the logical value of an expression.
static int	Not(int val) Returns the complement of the logical value of an expression.
static int	Not(long val) Returns the complement of the logical value of an expression.
static int	Not(String val) Returns the complement of the logical value of the given string.
static long	SetBit(long value, int[] positions, int bit) Returns a long with specific bits set to a specific state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

BitAnd

public static long BitAnd(long num1,
                          long num2)

Bitwise 'AND' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'AND'.

BitAnd

public static int BitAnd(int num1,
                         int num2)

Bitwise 'AND' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'AND'.

BitOr

public static long BitOr(long num1,
                         long num2)

Bitwise 'OR' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'OR'

BitOr

public static int BitOr(int num1,
                        int num2)

Bitwise 'OR' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'OR'

BitXor

public static long BitXor(long num1,
                          long num2)

Bitwise 'XOR' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'XOR'

BitXor

public static int BitXor(int num1,
                         int num2)

Bitwise 'XOR' operation of two numbers. The inputs must be non-null.

Parameters:

num1 - first number.

num2 - second number.

Returns:

a result of bitwise 'XOR'

Not

public static int Not(double val)

Returns the complement of the logical value of an expression. A numeric expression that evaluates to 0 is a logical value of false. A numeric expression that evaluates to anything else is a logical true. If the value of expression is true, the Not function returns a value of false (0). If the value of expression is false, the Not function returns a value of true (1).

Parameters:

val - expression result.

Returns:

1 or 0.

Not

public static int Not(String val)

Returns the complement of the logical value of the given string. An empty string is logically false. All other string expressions, including strings that include an empty string, spaces, or the number 0 and spaces, are logically true. If the logical value of the string is true, the Not function returns a value of false (0). If the logical value of the string is false, the Not function returns a value of true (1).

Parameters:

val - string value.

Returns:

1 or 0.

Not

public static int Not(float val)

Returns the complement of the logical value of an expression. A numeric expression that evaluates to 0 is a logical value of false. A numeric expression that evaluates to anything else is a logical true. If the value of expression is true, the Not function returns a value of false (0). If the value of expression is false, the Not function returns a value of true (1).

Parameters:

val - string value.

Returns:

1 or 0.

Not

public static int Not(int val)

Returns the complement of the logical value of an expression. A numeric expression that evaluates to 0 is a logical value of false. A numeric expression that evaluates to anything else is a logical true. If the value of expression is true, the Not function returns a value of false (0). If the value of expression is false, the Not function returns a value of true (1).

Parameters:

val - string value.

Returns:

1 or 0.

Not

public static int Not(long val)

Returns the complement of the logical value of an expression. A numeric expression that evaluates to 0 is a logical value of false. A numeric expression that evaluates to anything else is a logical true. If the value of expression is true, the Not function returns a value of false (0). If the value of expression is false, the Not function returns a value of true (1).

Parameters:

val - string value.

Returns:

1 or 0.

BitCompress

public static long BitCompress(String value)

Returns the long made from the string argument, which contains a binary representation of "1"s and "0"s.

Parameters:

value - to be compressed.

Returns:

long value of compressed binary string.

BitExpand

public static String BitExpand(long value)

Returns a string containing the binary representation in "1"s and "0"s of the given long.

Parameters:

value - to be expanded into '1' and '0' binary representation.

Returns:

a binary string representation of value.

SetBit

public static long SetBit(long value,
                          int[] positions,
                          int bit)

Returns a long with specific bits set to a specific state.

Parameters:

value - to perform action on.

positions - array of positions.

bit - to be set. Either 1 or 0.

Returns:

a long represents the bit set based on positions specified.