org.nd4j.linalg.ops.transforms

Class Transforms

java.lang.Object

org.nd4j.linalg.ops.transforms.Transforms

public class Transforms
extends Object

Functional interface for the different op classes

Author:

Adam Gibson

Method Summary

Modifier and Type	Method and Description
static INDArray	abs(INDArray ndArray) Abs funciton
static INDArray	abs(INDArray ndArray, boolean dup) Abs function
static INDArray	acos(INDArray arr)
static INDArray	acos(INDArray in, boolean copy)
static INDArray	allCosineDistances(INDArray d1, INDArray d2, int... dimensions)
static INDArray	allCosineSimilarities(INDArray d1, INDArray d2, int... dimensions)
static INDArray	allEuclideanDistances(INDArray d1, INDArray d2, int... dimensions)
static INDArray	allManhattanDistances(INDArray d1, INDArray d2, int... dimensions)
static INDArray	and(INDArray x, INDArray y)
static INDArray	asin(INDArray arr)
static INDArray	asin(INDArray in, boolean copy)
static INDArray	atan(INDArray arr)
static INDArray	atan(INDArray in, boolean copy)
static INDArray	atan2(INDArray x, INDArray y) Atan2 operation, new INDArray instance will be returned
static INDArray	atanh(INDArray in) Sin function
static INDArray	atanh(INDArray in, boolean copy) Sin function
static INDArray	ceil(INDArray arr)
static INDArray	ceil(INDArray in, boolean copy)
static INDArray	ceiling(INDArray ndArray) Binary matrix of whether the number at a given index is greater than
static INDArray	ceiling(INDArray ndArray, boolean copyOnOps) Ceiling function
static INDArray	cos(INDArray in)
static INDArray	cos(INDArray in, boolean copy)
static INDArray	cosh(INDArray in)
static INDArray	cosh(INDArray in, boolean copy)
static double	cosineDistance(INDArray d1, INDArray d2)
static double	cosineSim(INDArray d1, INDArray d2) Cosine similarity
static INDArray	elu(INDArray arr)
static INDArray	elu(INDArray in, boolean copy)
static INDArray	eluDerivative(INDArray arr)
static INDArray	eluDerivative(INDArray in, boolean copy)
static INDArray	eps(INDArray ndArray)
static INDArray	eps(INDArray ndArray, boolean dup) Eps function
static double	euclideanDistance(INDArray d1, INDArray d2)
static INDArray	exp(INDArray ndArray)
static INDArray	exp(INDArray ndArray, boolean dup) Exp function
static INDArray	floor(INDArray ndArray) Binary matrix of whether the number at a given index is greater than
static INDArray	floor(INDArray ndArray, boolean dup) Floor function
static INDArray	greaterThanOrEqual(INDArray first, INDArray ndArray) 1 if greater than or equal to 0 otherwise (at each element)
static INDArray	greaterThanOrEqual(INDArray first, INDArray ndArray, boolean dup) Eps function
static double	hammingDistance(INDArray d1, INDArray d2)
static INDArray	hardTanh(INDArray ndArray)
static INDArray	hardTanh(INDArray ndArray, boolean dup) Hard tanh
static INDArray	hardTanhDerivative(INDArray ndArray)
static INDArray	hardTanhDerivative(INDArray ndArray, boolean dup) Hard tanh
static INDArray	identity(INDArray ndArray)
static INDArray	identity(INDArray ndArray, boolean dup) Identity function
static double	jaccardDistance(INDArray d1, INDArray d2)
static INDArray	leakyRelu(INDArray arr)
static INDArray	leakyRelu(INDArray in, boolean copy)
static INDArray	leakyRelu(INDArray arr, double cutoff)
static INDArray	leakyRelu(INDArray in, double cutoff, boolean copy)
static INDArray	leakyReluDerivative(INDArray arr, double cutoff)
static INDArray	leakyReluDerivative(INDArray in, double cutoff, boolean copy)
static INDArray	lessThanOrEqual(INDArray first, INDArray ndArray) 1 if less than or equal to 0 otherwise (at each element)
static INDArray	lessThanOrEqual(INDArray first, INDArray ndArray, boolean dup) Eps function
static INDArray	log(INDArray ndArray)
static INDArray	log(INDArray ndArray, boolean dup) Log function
static INDArray	log(INDArray ndArray, double base) Log on arbitrary base
static INDArray	log(INDArray ndArray, double base, boolean duplicate) Log on arbitrary base
static double	manhattanDistance(INDArray d1, INDArray d2)
static INDArray	max(INDArray ndArray, double k) Maximum function with a scalar
static INDArray	max(INDArray ndArray, double k, boolean dup) Maximum function with a scalar
static INDArray	max(INDArray first, INDArray second) Element wise maximum function between 2 INDArrays
static INDArray	max(INDArray first, INDArray second, boolean dup) Element wise maximum function between 2 INDArrays
static INDArray	min(INDArray ndArray, double k) Maximum function with a scalar
static INDArray	min(INDArray ndArray, double k, boolean dup) Minimum function with a scalar
static INDArray	min(INDArray first, INDArray second) Element wise minimum function between 2 INDArrays
static INDArray	min(INDArray first, INDArray second, boolean dup) Element wise minimum function between 2 INDArrays
static INDArray	mpow(INDArray in, int n, boolean dup) Raises a square matrix to a power n, which can be positive, negative, or zero.
static INDArray	neg(INDArray ndArray) Returns the negative of an ndarray
static INDArray	neg(INDArray ndArray, boolean dup) Negative
static INDArray	normalizeZeroMeanAndUnitVariance(INDArray toNormalize) Normalize data to zero mean and unit variance substract by the mean and divide by the standard deviation
static INDArray	not(INDArray x)
static INDArray	or(INDArray x, INDArray y)
static INDArray	pow(INDArray ndArray, INDArray power) Pow function
static INDArray	pow(INDArray ndArray, Number power) Pow function
static INDArray	pow(INDArray ndArray, Number power, boolean dup) Pow function
static INDArray	relu(INDArray arr)
static INDArray	relu(INDArray in, boolean copy)
static INDArray	reverse(INDArray x, boolean dup)
static INDArray	round(INDArray ndArray) Rounding function
static INDArray	round(INDArray ndArray, boolean dup) Rounding function
static INDArray	sigmoid(INDArray ndArray) Sigmoid function
static INDArray	sigmoid(INDArray ndArray, boolean dup) Sigmoid function
static INDArray	sigmoidDerivative(INDArray ndArray) Sigmoid function
static INDArray	sigmoidDerivative(INDArray ndArray, boolean dup) Sigmoid function
static INDArray	sign(INDArray toSign) Signum function of this ndarray
static INDArray	sign(INDArray toSign, boolean dup) Signum function of this ndarray
static INDArray	sin(INDArray in) Sin function
static INDArray	sin(INDArray in, boolean copy) Sin function
static INDArray	sinh(INDArray in) Sinh function
static INDArray	sinh(INDArray in, boolean copy) Sinh function
static INDArray	softmax(INDArray arr)
static INDArray	softmax(INDArray in, boolean copy)
static INDArray	softPlus(INDArray arr)
static INDArray	softPlus(INDArray in, boolean copy)
static INDArray	softsign(INDArray arr)
static INDArray	softsign(INDArray in, boolean copy)
static INDArray	softsignDerivative(INDArray arr)
static INDArray	softsignDerivative(INDArray in, boolean copy)
static INDArray	sqrt(INDArray ndArray) Sqrt function
static INDArray	sqrt(INDArray ndArray, boolean dup) Sqrt function
static INDArray	stabilize(INDArray ndArray, double k)
static INDArray	stabilize(INDArray ndArray, double k, boolean dup) Stabilize to be within a range of k
static INDArray	step(INDArray arr)
static INDArray	step(INDArray in, boolean copy)
static INDArray	tanh(INDArray ndArray) Tanh function
static INDArray	tanh(INDArray ndArray, boolean dup) Tanh function
static INDArray	unitVec(INDArray toScale) Scale by 1 / norm2 of the matrix
static INDArray	xor(INDArray x, INDArray y)

Methods inherited from class java.lang.Object

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

Method Detail

cosineSim

public static double cosineSim(@NonNull
                               INDArray d1,
                               @NonNull
                               INDArray d2)

Cosine similarity

Parameters:

d1 - the first vector

d2 - the second vector

Returns:

the cosine similarities between the 2 arrays

cosineDistance

public static double cosineDistance(@NonNull
                                    INDArray d1,
                                    @NonNull
                                    INDArray d2)

hammingDistance

public static double hammingDistance(@NonNull
                                     INDArray d1,
                                     @NonNull
                                     INDArray d2)

jaccardDistance

public static double jaccardDistance(@NonNull
                                     INDArray d1,
                                     @NonNull
                                     INDArray d2)

allCosineSimilarities

public static INDArray allCosineSimilarities(@NonNull
                                             INDArray d1,
                                             @NonNull
                                             INDArray d2,
                                             int... dimensions)

allCosineDistances

public static INDArray allCosineDistances(@NonNull
                                          INDArray d1,
                                          @NonNull
                                          INDArray d2,
                                          int... dimensions)

allEuclideanDistances

public static INDArray allEuclideanDistances(@NonNull
                                             INDArray d1,
                                             @NonNull
                                             INDArray d2,
                                             int... dimensions)

allManhattanDistances

public static INDArray allManhattanDistances(@NonNull
                                             INDArray d1,
                                             @NonNull
                                             INDArray d2,
                                             int... dimensions)

reverse

public static INDArray reverse(INDArray x,
                               boolean dup)

manhattanDistance

public static double manhattanDistance(@NonNull
                                       INDArray d1,
                                       @NonNull
                                       INDArray d2)

Parameters:

d1 -

d2 -

Returns:

atan2

public static INDArray atan2(@NonNull
                             INDArray x,
                             @NonNull
                             INDArray y)

Atan2 operation, new INDArray instance will be returned

Parameters:

x -

y -

Returns:

euclideanDistance

public static double euclideanDistance(@NonNull
                                       INDArray d1,
                                       @NonNull
                                       INDArray d2)

Parameters:

d1 -

d2 -

Returns:

normalizeZeroMeanAndUnitVariance

public static INDArray normalizeZeroMeanAndUnitVariance(INDArray toNormalize)

Normalize data to zero mean and unit variance substract by the mean and divide by the standard deviation

Parameters:

toNormalize - the ndarray to normalize

Returns:

the normalized ndarray

unitVec

public static INDArray unitVec(INDArray toScale)

Scale by 1 / norm2 of the matrix

Parameters:

toScale - the ndarray to scale

Returns:

the scaled ndarray

neg

public static INDArray neg(INDArray ndArray)

Returns the negative of an ndarray

Parameters:

ndArray - the ndarray to take the negative of

Returns:

the negative of the ndarray

floor

public static INDArray floor(INDArray ndArray)

Binary matrix of whether the number at a given index is greater than

Parameters:

ndArray -

Returns:

ceiling

public static INDArray ceiling(INDArray ndArray)

Binary matrix of whether the number at a given index is greater than

Parameters:

ndArray -

Returns:

ceiling

public static INDArray ceiling(INDArray ndArray,
                               boolean copyOnOps)

Ceiling function

Parameters:

ndArray -

copyOnOps -

Returns:

sign

public static INDArray sign(INDArray toSign)

Signum function of this ndarray

Parameters:

toSign -

Returns:

stabilize

public static INDArray stabilize(INDArray ndArray,
                                 double k)

Parameters:

ndArray -

k -

Returns:

sin

public static INDArray sin(INDArray in)

Sin function

Parameters:

in -

Returns:

sin

public static INDArray sin(INDArray in,
                           boolean copy)

Sin function

Parameters:

in -

copy -

Returns:

atanh

public static INDArray atanh(INDArray in)

Sin function

Parameters:

in -

Returns:

atanh

public static INDArray atanh(INDArray in,
                             boolean copy)

Sin function

Parameters:

in -

copy -

Returns:

sinh

public static INDArray sinh(INDArray in)

Sinh function

Parameters:

in -

Returns:

sinh

public static INDArray sinh(INDArray in,
                            boolean copy)

Sinh function

Parameters:

in -

copy -

Returns:

cos

public static INDArray cos(INDArray in)

Parameters:

in -

Returns:

cosh

public static INDArray cosh(INDArray in,
                            boolean copy)

Parameters:

in -

copy -

Returns:

cosh

public static INDArray cosh(INDArray in)

Parameters:

in -

Returns:

cos

public static INDArray cos(INDArray in,
                           boolean copy)

Parameters:

in -

copy -

Returns:

acos

public static INDArray acos(INDArray arr)

acos

public static INDArray acos(INDArray in,
                            boolean copy)

asin

public static INDArray asin(INDArray arr)

asin

public static INDArray asin(INDArray in,
                            boolean copy)

atan

public static INDArray atan(INDArray arr)

atan

public static INDArray atan(INDArray in,
                            boolean copy)

ceil

public static INDArray ceil(INDArray arr)

ceil

public static INDArray ceil(INDArray in,
                            boolean copy)

relu

public static INDArray relu(INDArray arr)

relu

public static INDArray relu(INDArray in,
                            boolean copy)

leakyRelu

public static INDArray leakyRelu(INDArray arr)

leakyRelu

public static INDArray leakyRelu(INDArray in,
                                 boolean copy)

elu

public static INDArray elu(INDArray arr)

elu

public static INDArray elu(INDArray in,
                           boolean copy)

eluDerivative

public static INDArray eluDerivative(INDArray arr)

eluDerivative

public static INDArray eluDerivative(INDArray in,
                                     boolean copy)

leakyRelu

public static INDArray leakyRelu(INDArray arr,
                                 double cutoff)

leakyRelu

public static INDArray leakyRelu(INDArray in,
                                 double cutoff,
                                 boolean copy)

leakyReluDerivative

public static INDArray leakyReluDerivative(INDArray arr,
                                           double cutoff)

leakyReluDerivative

public static INDArray leakyReluDerivative(INDArray in,
                                           double cutoff,
                                           boolean copy)

softPlus

public static INDArray softPlus(INDArray arr)

softPlus

public static INDArray softPlus(INDArray in,
                                boolean copy)

step

public static INDArray step(INDArray arr)

step

public static INDArray step(INDArray in,
                            boolean copy)

softsign

public static INDArray softsign(INDArray arr)

softsign

public static INDArray softsign(INDArray in,
                                boolean copy)

softsignDerivative

public static INDArray softsignDerivative(INDArray arr)

softsignDerivative

public static INDArray softsignDerivative(INDArray in,
                                          boolean copy)

softmax

public static INDArray softmax(INDArray arr)

softmax

public static INDArray softmax(INDArray in,
                               boolean copy)

abs

public static INDArray abs(INDArray ndArray)

Abs funciton

Parameters:

ndArray -

Returns:

exp

public static INDArray exp(INDArray ndArray)

hardTanh

public static INDArray hardTanh(INDArray ndArray)

hardTanh

public static INDArray hardTanh(INDArray ndArray,
                                boolean dup)

Hard tanh

Parameters:

ndArray - the input

dup - whether to duplicate the ndarray and return it as the result

Returns:

the output

hardTanhDerivative

public static INDArray hardTanhDerivative(INDArray ndArray)

hardTanhDerivative

public static INDArray hardTanhDerivative(INDArray ndArray,
                                          boolean dup)

Hard tanh

Parameters:

ndArray - the input

dup - whether to duplicate the ndarray and return it as the result

Returns:

the output

identity

public static INDArray identity(INDArray ndArray)

Parameters:

ndArray -

Returns:

pow

public static INDArray pow(INDArray ndArray,
                           Number power)

Pow function

Parameters:

ndArray - the ndarray to raise hte power of

power - the power to raise by

Returns:

the ndarray raised to this power

pow

public static INDArray pow(INDArray ndArray,
                           INDArray power)

Pow function

Parameters:

ndArray - the ndarray to raise hte power of

power - the power to raise by

Returns:

the ndarray raised to this power

round

public static INDArray round(INDArray ndArray)

Rounding function

Parameters:

ndArray -

Returns:

sigmoid

public static INDArray sigmoid(INDArray ndArray)

Sigmoid function

Parameters:

ndArray -

Returns:

sigmoid

public static INDArray sigmoid(INDArray ndArray,
                               boolean dup)

Sigmoid function

Parameters:

ndArray -

dup -

Returns:

sigmoidDerivative

public static INDArray sigmoidDerivative(INDArray ndArray)

Sigmoid function

Parameters:

ndArray -

Returns:

sigmoidDerivative

public static INDArray sigmoidDerivative(INDArray ndArray,
                                         boolean dup)

Sigmoid function

Parameters:

ndArray -

dup -

Returns:

sqrt

public static INDArray sqrt(INDArray ndArray)

Sqrt function

Parameters:

ndArray -

Returns:

tanh

public static INDArray tanh(INDArray ndArray)

Tanh function

Parameters:

ndArray -

Returns:

log

public static INDArray log(INDArray ndArray,
                           double base)

Log on arbitrary base

Parameters:

ndArray -

base -

Returns:

log

public static INDArray log(INDArray ndArray,
                           double base,
                           boolean duplicate)

Log on arbitrary base

Parameters:

ndArray -

base -

Returns:

log

public static INDArray log(INDArray ndArray)

eps

public static INDArray eps(INDArray ndArray)

greaterThanOrEqual

public static INDArray greaterThanOrEqual(INDArray first,
                                          INDArray ndArray)

1 if greater than or equal to 0 otherwise (at each element)

Parameters:

first -

ndArray -

Returns:

lessThanOrEqual

public static INDArray lessThanOrEqual(INDArray first,
                                       INDArray ndArray)

1 if less than or equal to 0 otherwise (at each element)

Parameters:

first -

ndArray -

Returns:

lessThanOrEqual

public static INDArray lessThanOrEqual(INDArray first,
                                       INDArray ndArray,
                                       boolean dup)

Eps function

Parameters:

ndArray -

Returns:

greaterThanOrEqual

public static INDArray greaterThanOrEqual(INDArray first,
                                          INDArray ndArray,
                                          boolean dup)

Eps function

Parameters:

ndArray -

Returns:

eps

public static INDArray eps(INDArray ndArray,
                           boolean dup)

Eps function

Parameters:

ndArray -

Returns:

floor

public static INDArray floor(INDArray ndArray,
                             boolean dup)

Floor function

Parameters:

ndArray -

Returns:

sign

public static INDArray sign(INDArray toSign,
                            boolean dup)

Signum function of this ndarray

Parameters:

toSign -

Returns:

max

public static INDArray max(INDArray ndArray,
                           double k,
                           boolean dup)

Maximum function with a scalar

Parameters:

ndArray - tbe ndarray

k -

dup -

Returns:

max

public static INDArray max(INDArray ndArray,
                           double k)

Maximum function with a scalar

Parameters:

ndArray - tbe ndarray

k -

Returns:

max

public static INDArray max(INDArray first,
                           INDArray second,
                           boolean dup)

Element wise maximum function between 2 INDArrays

Parameters:

first -

second -

dup -

Returns:

max

public static INDArray max(INDArray first,
                           INDArray second)

Element wise maximum function between 2 INDArrays

Parameters:

first -

second -

Returns:

min

public static INDArray min(INDArray ndArray,
                           double k,
                           boolean dup)

Minimum function with a scalar

Parameters:

ndArray - tbe ndarray

k -

dup -

Returns:

min

public static INDArray min(INDArray ndArray,
                           double k)

Maximum function with a scalar

Parameters:

ndArray - tbe ndarray

k -

Returns:

min

public static INDArray min(INDArray first,
                           INDArray second,
                           boolean dup)

Element wise minimum function between 2 INDArrays

Parameters:

first -

second -

dup -

Returns:

min

public static INDArray min(INDArray first,
                           INDArray second)

Element wise minimum function between 2 INDArrays

Parameters:

first -

second -

Returns:

stabilize

public static INDArray stabilize(INDArray ndArray,
                                 double k,
                                 boolean dup)

Stabilize to be within a range of k

Parameters:

ndArray - tbe ndarray

k -

dup -

Returns:

abs

public static INDArray abs(INDArray ndArray,
                           boolean dup)

Abs function

Parameters:

ndArray -

dup -

Returns:

exp

public static INDArray exp(INDArray ndArray,
                           boolean dup)

Exp function

Parameters:

ndArray -

dup -

Returns:

identity

public static INDArray identity(INDArray ndArray,
                                boolean dup)

Identity function

Parameters:

ndArray -

dup -

Returns:

pow

public static INDArray pow(INDArray ndArray,
                           Number power,
                           boolean dup)

Pow function

Parameters:

ndArray -

power -

dup -

Returns:

round

public static INDArray round(INDArray ndArray,
                             boolean dup)

Rounding function

Parameters:

ndArray - the ndarray

dup -

Returns:

sqrt

public static INDArray sqrt(INDArray ndArray,
                            boolean dup)

Sqrt function

Parameters:

ndArray -

dup -

Returns:

tanh

public static INDArray tanh(INDArray ndArray,
                            boolean dup)

Tanh function

Parameters:

ndArray -

dup -

Returns:

log

public static INDArray log(INDArray ndArray,
                           boolean dup)

Log function

Parameters:

ndArray -

dup -

Returns:

neg

public static INDArray neg(INDArray ndArray,
                           boolean dup)

Negative

Parameters:

ndArray -

dup -

Returns:

and

public static INDArray and(INDArray x,
                           INDArray y)

or

public static INDArray or(INDArray x,
                          INDArray y)

xor

public static INDArray xor(INDArray x,
                           INDArray y)

not

public static INDArray not(INDArray x)

mpow

public static INDArray mpow(INDArray in,
                            int n,
                            boolean dup)

Raises a square matrix to a power n, which can be positive, negative, or zero. The behavior is similar to the numpy matrix_power() function. The algorithm uses repeated squarings to minimize the number of mmul() operations needed

If n is zero, the identity matrix is returned.

If n is negative, the matrix is inverted and raised to the abs(n) power.

Parameters:

in - A square matrix to raise to an integer power, which will be changed if dup is false.

n - The integer power to raise the matrix to.

dup - If dup is true, the original input is unchanged.

Returns:

The result of raising in to the nth power.