org.nd4j.autodiff.samediff.ops

Class SDBitwise

java.lang.Object

org.nd4j.autodiff.samediff.ops.SDOps

org.nd4j.autodiff.samediff.ops.SDBitwise

public class SDBitwise
extends SDOps

Field Summary

Fields inherited from class org.nd4j.autodiff.samediff.ops.SDOps

sd

Constructor Summary

Constructors

Constructor and Description
SDBitwise(SameDiff sameDiff)

Method Summary

Modifier and Type	Method and Description
SDVariable	and(SDVariable x, SDVariable y) See and(String, SDVariable, SDVariable)
SDVariable	and(String name, SDVariable x, SDVariable y) Bitwise AND operation.
SDVariable	bitsHammingDistance(SDVariable x, SDVariable y) See bitsHammingDistance(String, SDVariable, SDVariable)
SDVariable	bitsHammingDistance(String name, SDVariable x, SDVariable y) Bitwise Hamming distance reduction over all elements of both input arrays. For example, if x=01100000 and y=1010000 then the bitwise Hamming distance is 2 (due to differences at positions 0 and 1)
SDVariable	leftShift(SDVariable x, SDVariable y) See leftShift(String, SDVariable, SDVariable)
SDVariable	leftShift(String name, SDVariable x, SDVariable y) Bitwise left shift operation.
SDVariable	leftShiftCyclic(SDVariable x, SDVariable y) See leftShiftCyclic(String, SDVariable, SDVariable)
SDVariable	leftShiftCyclic(String name, SDVariable x, SDVariable y) Bitwise left cyclical shift operation.
SDVariable	or(SDVariable x, SDVariable y) See or(String, SDVariable, SDVariable)
SDVariable	or(String name, SDVariable x, SDVariable y) Bitwise OR operation.
SDVariable	rightShift(SDVariable x, SDVariable y) See rightShift(String, SDVariable, SDVariable)
SDVariable	rightShift(String name, SDVariable x, SDVariable y) Bitwise right shift operation.
SDVariable	rightShiftCyclic(SDVariable x, SDVariable y) See rightShiftCyclic(String, SDVariable, SDVariable)
SDVariable	rightShiftCyclic(String name, SDVariable x, SDVariable y) Bitwise right cyclical shift operation.
SDVariable	xor(SDVariable x, SDVariable y) See xor(String, SDVariable, SDVariable)
SDVariable	xor(String name, SDVariable x, SDVariable y) Bitwise XOR operation (exclusive OR).

Methods inherited from class org.nd4j.autodiff.samediff.ops.SDOps

f, updateVariableNameAndReference

Methods inherited from class java.lang.Object

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

Constructor Detail

SDBitwise

public SDBitwise(SameDiff sameDiff)

Method Detail

leftShift

public SDVariable leftShift(@NonNull
                            SDVariable x,
                            @NonNull
                            SDVariable y)

See leftShift(String, SDVariable, SDVariable)

leftShift

public SDVariable leftShift(String name,
                            SDVariable x,
                            SDVariable y)

Bitwise left shift operation. Supports broadcasting.

Parameters:

name - Name of the output variable. May be null.

x - Input to be bit shifted (must be an integer type)

y - Amount to shift elements of x array (must be an integer type)

Returns:

Bitwise shifted input x

rightShift

public SDVariable rightShift(SDVariable x,
                             SDVariable y)

See rightShift(String, SDVariable, SDVariable)

rightShift

public SDVariable rightShift(String name,
                             SDVariable x,
                             SDVariable y)

Bitwise right shift operation. Supports broadcasting.

Parameters:

name - Name of the output variable. May be null.

x - Input to be bit shifted (must be an integer type)

y - Amount to shift elements of x array (must be an integer type)

Returns:

Bitwise shifted input x

leftShiftCyclic

public SDVariable leftShiftCyclic(SDVariable x,
                                  SDVariable y)

See leftShiftCyclic(String, SDVariable, SDVariable)

leftShiftCyclic

public SDVariable leftShiftCyclic(String name,
                                  SDVariable x,
                                  SDVariable y)

Bitwise left cyclical shift operation. Supports broadcasting. Unlike leftShift(String, SDVariable, SDVariable) the bits will "wrap around": leftShiftCyclic(01110000, 2) -> 11000001

Parameters:

name - Name of the output variable. May be null.

x - Input to be bit shifted (must be an integer type)

y - Amount to shift elements of x array (must be an integer type)

Returns:

Bitwise cyclic shifted input x

rightShiftCyclic

public SDVariable rightShiftCyclic(SDVariable x,
                                   SDVariable y)

See rightShiftCyclic(String, SDVariable, SDVariable)

rightShiftCyclic

public SDVariable rightShiftCyclic(String name,
                                   SDVariable x,
                                   SDVariable y)

Bitwise right cyclical shift operation. Supports broadcasting. Unlike rightShift(String, SDVariable, SDVariable) the bits will "wrap around": rightShiftCyclic(00001110, 2) -> 10000011

Parameters:

name - Name of the output variable. May be null.

x - Input to be bit shifted (must be an integer type)

y - Amount to shift elements of x array (must be an integer type)

Returns:

Bitwise cyclic shifted input x

bitsHammingDistance

public SDVariable bitsHammingDistance(SDVariable x,
                                      SDVariable y)

See bitsHammingDistance(String, SDVariable, SDVariable)

bitsHammingDistance

public SDVariable bitsHammingDistance(String name,
                                      SDVariable x,
                                      SDVariable y)

Bitwise Hamming distance reduction over all elements of both input arrays.
For example, if x=01100000 and y=1010000 then the bitwise Hamming distance is 2 (due to differences at positions 0 and 1)

Parameters:

name - Name of the output variable. May be null.

x - First input array. Must be integer type.

y - First input array. Must be integer type, same type as x

Returns:

and

public SDVariable and(SDVariable x,
                      SDVariable y)

See and(String, SDVariable, SDVariable)

and

public SDVariable and(String name,
                      SDVariable x,
                      SDVariable y)

Bitwise AND operation. Supports broadcasting.

Parameters:

name - Name of the output variable. May be null.

x - First input array. Must be integer type.

y - First input array. Must be integer type, same type as x

Returns:

Bitwise AND array

or

public SDVariable or(SDVariable x,
                     SDVariable y)

See or(String, SDVariable, SDVariable)

or

public SDVariable or(String name,
                     SDVariable x,
                     SDVariable y)

Bitwise OR operation. Supports broadcasting.

Parameters:

name - Name of the output variable. May be null.

x - First input array. Must be integer type.

y - First input array. Must be integer type, same type as x

Returns:

Bitwise OR array

xor

public SDVariable xor(SDVariable x,
                      SDVariable y)

See xor(String, SDVariable, SDVariable)

xor

public SDVariable xor(String name,
                      SDVariable x,
                      SDVariable y)

Bitwise XOR operation (exclusive OR). Supports broadcasting.

Parameters:

name - Name of the output variable. May be null.

x - First input array. Must be integer type.

y - First input array. Must be integer type, same type as x

Returns:

Bitwise XOR array