org.tensorflow.ndarray

Class NdArrays

java.lang.Object

org.tensorflow.ndarray.NdArrays

public final class NdArrays
extends Object

Utility class for instantiating NdArray objects.

Constructor Summary

Constructors

Constructor and Description
NdArrays()

Method Summary

Modifier and Type	Method and Description
static BooleanNdArray	ofBooleans(Shape shape) Creates an N-dimensional array of booleans of the given shape.
static ByteNdArray	ofBytes(Shape shape) Creates an N-dimensional array of bytes of the given shape.
static DoubleNdArray	ofDoubles(Shape shape) Creates an N-dimensional array of doubles of the given shape.
static FloatNdArray	ofFloats(Shape shape) Creates an N-dimensional array of floats of the given shape.
static IntNdArray	ofInts(Shape shape) Creates an N-dimensional array of ints of the given shape.
static LongNdArray	ofLongs(Shape shape) Creates an N-dimensional array of longs of the given shape.
static <T> NdArray<T>	ofObjects(Class<T> clazz, Shape shape) Creates an N-dimensional array of the given shape.
static ShortNdArray	ofShorts(Shape shape) Creates an N-dimensional array of shorts of the given shape.
static BooleanNdArray	scalarOf(boolean value) Creates boolean scalar (rank 0) initialized with the given value.
static ByteNdArray	scalarOf(byte value) Creates byte scalar (rank 0) initialized with the given value.
static DoubleNdArray	scalarOf(double value) Creates double scalar (rank 0) initialized with the given value.
static FloatNdArray	scalarOf(float value) Creates float scalar (rank 0) initialized with the given value.
static IntNdArray	scalarOf(int value) Creates long scalar (rank 0) initialized with the given value.
static LongNdArray	scalarOf(long value) Creates long scalar (rank 0) initialized with the given value.
static ShortNdArray	scalarOf(short value) Creates short scalar (rank 0) initialized with the given value.
static <T> NdArray<T>	scalarOfObject(T value) Creates scalar (rank 0) initialized with the given value.
static BooleanNdArray	vectorOf(boolean... values) Creates a boolean vector (rank 1) initialized with the given values.
static ByteNdArray	vectorOf(byte... values) Creates a byte vector (rank 1) initialized with the given values.
static DoubleNdArray	vectorOf(double... values) Creates a double vector (rank 1) initialized with the given values.
static FloatNdArray	vectorOf(float... values) Creates a float vector (rank 1) initialized with the given values.
static IntNdArray	vectorOf(int... values) Creates a int vector (rank 1) initialized with the given values.
static LongNdArray	vectorOf(long... values) Creates a long vector (rank 1) initialized with the given values.
static ShortNdArray	vectorOf(short... values) Creates a short vector (rank 1) initialized with the given values.
static <T> NdArray<T>	vectorOfObjects(T... values) Creates a vector (rank 1) initialized with the given values.
static ByteNdArray	wrap(ByteDataBuffer buffer, Shape shape) Wraps a buffer in a byte N-dimensional array of a given shape.
static BooleanNdArray	wrap(Shape shape, BooleanDataBuffer buffer) Wraps a buffer in a boolean N-dimensional array of a given shape.
static <T> NdArray<T>	wrap(Shape shape, DataBuffer<T> buffer) Wraps a buffer in an N-dimensional array of a given shape.
static DoubleNdArray	wrap(Shape shape, DoubleDataBuffer buffer) Wraps a buffer in a double N-dimensional array of a given shape.
static FloatNdArray	wrap(Shape shape, FloatDataBuffer buffer) Wraps a buffer in a float N-dimensional array of a given shape.
static IntNdArray	wrap(Shape shape, IntDataBuffer buffer) Wraps a buffer in an int N-dimensional array of a given shape.
static LongNdArray	wrap(Shape shape, LongDataBuffer buffer) Wraps a buffer in a long N-dimensional array of a given shape.
static ShortNdArray	wrap(Shape shape, ShortDataBuffer buffer) Wraps a buffer in a short N-dimensional array of a given shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

NdArrays

public NdArrays()

Method Detail

scalarOf

public static ByteNdArray scalarOf(byte value)

Creates byte scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new byte scalar

vectorOf

public static ByteNdArray vectorOf(byte... values)

Creates a byte vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new byte vector

Throws:

IllegalArgumentException - if values is null

ofBytes

public static ByteNdArray ofBytes(Shape shape)

Creates an N-dimensional array of bytes of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new byte N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static ByteNdArray wrap(ByteDataBuffer buffer,
                               Shape shape)

Wraps a buffer in a byte N-dimensional array of a given shape.

Parameters:

buffer - buffer to wrap

shape - shape of the array

Returns:

new byte N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static LongNdArray scalarOf(long value)

Creates long scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new long scalar

vectorOf

public static LongNdArray vectorOf(long... values)

Creates a long vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new long vector

Throws:

IllegalArgumentException - if values is null

ofLongs

public static LongNdArray ofLongs(Shape shape)

Creates an N-dimensional array of longs of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new long N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static LongNdArray wrap(Shape shape,
                               LongDataBuffer buffer)

Wraps a buffer in a long N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new long N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static IntNdArray scalarOf(int value)

Creates long scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new long scalar

vectorOf

public static IntNdArray vectorOf(int... values)

Creates a int vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new int vector

Throws:

IllegalArgumentException - if values is null

ofInts

public static IntNdArray ofInts(Shape shape)

Creates an N-dimensional array of ints of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new int N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static IntNdArray wrap(Shape shape,
                              IntDataBuffer buffer)

Wraps a buffer in an int N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new int N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static ShortNdArray scalarOf(short value)

Creates short scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new short scalar

vectorOf

public static ShortNdArray vectorOf(short... values)

Creates a short vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new short vector

Throws:

IllegalArgumentException - if values is null

ofShorts

public static ShortNdArray ofShorts(Shape shape)

Creates an N-dimensional array of shorts of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new short N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static ShortNdArray wrap(Shape shape,
                                ShortDataBuffer buffer)

Wraps a buffer in a short N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new short N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static FloatNdArray scalarOf(float value)

Creates float scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new float scalar

vectorOf

public static FloatNdArray vectorOf(float... values)

Creates a float vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new float vector

Throws:

IllegalArgumentException - if values is null

ofFloats

public static FloatNdArray ofFloats(Shape shape)

Creates an N-dimensional array of floats of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new float N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static FloatNdArray wrap(Shape shape,
                                FloatDataBuffer buffer)

Wraps a buffer in a float N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new float N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static DoubleNdArray scalarOf(double value)

Creates double scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new double scalar

vectorOf

public static DoubleNdArray vectorOf(double... values)

Creates a double vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new double vector

Throws:

IllegalArgumentException - if values is null

ofDoubles

public static DoubleNdArray ofDoubles(Shape shape)

Creates an N-dimensional array of doubles of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new double N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static DoubleNdArray wrap(Shape shape,
                                 DoubleDataBuffer buffer)

Wraps a buffer in a double N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new double N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOf

public static BooleanNdArray scalarOf(boolean value)

Creates boolean scalar (rank 0) initialized with the given value.

Parameters:

value - scalar value

Returns:

new boolean scalar

vectorOf

public static BooleanNdArray vectorOf(boolean... values)

Creates a boolean vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Parameters:

values - vector values

Returns:

new boolean vector

Throws:

IllegalArgumentException - if values is null

ofBooleans

public static BooleanNdArray ofBooleans(Shape shape)

Creates an N-dimensional array of booleans of the given shape.

All values are initialized to zeros.

Parameters:

shape - shape of the array

Returns:

new boolean N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static BooleanNdArray wrap(Shape shape,
                                  BooleanDataBuffer buffer)

Wraps a buffer in a boolean N-dimensional array of a given shape.

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new boolean N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size

scalarOfObject

public static <T> NdArray<T> scalarOfObject(T value)

Creates scalar (rank 0) initialized with the given value.

Type Parameters:

T - the data type

Parameters:

value - scalar value

Returns:

new scalar

vectorOfObjects

@SafeVarargs
public static <T> NdArray<T> vectorOfObjects(T... values)

Creates a vector (rank 1) initialized with the given values.

Modifying the data of the returned vector will also impact the values in the array passed in parameter.

Type Parameters:

T - the data type

Parameters:

values - vector values

Returns:

new vector

Throws:

IllegalArgumentException - if values is null

ofObjects

public static <T> NdArray<T> ofObjects(Class<T> clazz,
                                       Shape shape)

Creates an N-dimensional array of the given shape.

All values are initialized to zeros.

Type Parameters:

T - the data type

Parameters:

clazz - class of the data to be stored in this array

shape - shape of the array

Returns:

new N-dimensional array

Throws:

IllegalArgumentException - if shape is null or has unknown dimensions

wrap

public static <T> NdArray<T> wrap(Shape shape,
                                  DataBuffer<T> buffer)

Wraps a buffer in an N-dimensional array of a given shape.

Type Parameters:

T - the data type

Parameters:

shape - shape of the array

buffer - buffer to wrap

Returns:

new N-dimensional array

Throws:

IllegalArgumentException - if shape is null, has unknown dimensions or has size bigger in the buffer size