| Modifier and Type | Method and Description |
|---|---|
FloatNdArray |
copyTo(NdArray<Float> dst)
Copy the content of this array to the destination array.
|
NdArraySequence<FloatNdArray> |
elements(int dimensionIdx)
Returns a sequence of all elements at a given dimension.
|
FloatNdArray |
get(long... coordinates)
Returns the N-dimensional element of this array at the given coordinates.
|
float |
getFloat(long... coordinates)
Returns the float value of the scalar found at the given coordinates.
|
default Float |
getObject(long... coordinates)
Returns the value of the scalar found at the given coordinates.
|
FloatNdArray |
read(DataBuffer<Float> dst)
Read the content of this N-dimensional array into the destination buffer.
|
FloatNdArray |
read(FloatDataBuffer dst) |
NdArraySequence<FloatNdArray> |
scalars()
Returns a sequence of all scalars in this array.
|
FloatNdArray |
set(NdArray<Float> src,
long... coordinates)
Assigns the value of the N-dimensional element found at the given coordinates.
|
FloatNdArray |
setFloat(float value,
long... coordinates)
Assigns the float value of the scalar found at the given coordinates.
|
default FloatNdArray |
setObject(Float value,
long... coordinates)
Assigns the value of the scalar found at the given coordinates.
|
FloatNdArray |
slice(Index... coordinates)
Creates a multi-dimensional view (or slice) of this array by mapping one or more dimensions
to the given index selectors.
|
FloatNdArray |
write(DataBuffer<Float> src)
Write the content of this N-dimensional array from the source buffer.
|
FloatNdArray |
write(FloatDataBuffer src) |
float getFloat(long... coordinates)
To access the scalar element, the number of coordinates provided must be equal to the number of dimensions of this array (i.e. its rank). For example:
FloatNdArray matrix = NdArrays.ofFloats(shape(2, 2)); // matrix rank = 2
matrix.getFloat(0, 1); // succeeds, returns 0.0f
matrix.getFloat(0); // throws IllegalRankException
FloatNdArray scalar = matrix.get(0, 1); // scalar rank = 0
scalar.getFloat(); // succeeds, returns 0.0f
coordinates - coordinates of the scalar to resolveIndexOutOfBoundsException - if some coordinates are outside the limits of their respective dimensionIllegalRankException - if number of coordinates is not sufficient to access a scalar elementFloatNdArray setFloat(float value, long... coordinates)
To access the scalar element, the number of coordinates provided must be equal to the number of dimensions of this array (i.e. its rank). For example:
FloatNdArray matrix = NdArrays.ofFloats(shape(2, 2)); // matrix rank = 2
matrix.setFloat(10.0f, 0, 1); // succeeds
matrix.setFloat(10.0f, 0); // throws IllegalRankException
FloatNdArray scalar = matrix.get(0, 1); // scalar rank = 0
scalar.setFloat(10.0f); // succeeds
value - value to assigncoordinates - coordinates of the scalar to assignIndexOutOfBoundsException - if some coordinates are outside the limits of their respective dimensionIllegalRankException - if number of coordinates is not sufficient to access a scalar elementFloatNdArray slice(Index... coordinates)
NdArraySlices allow to traverse an N-dimensional array in any of its axis and/or to filter only
elements of interest. For example, for a given matrix on the [x, y] axes, it is
possible to iterate elements at y=0 for all x.
Any changes applied to the returned slice affect the data of this array as well, as there is no copy involved.
Example of usage:
FloatNdArray matrix3d = NdArrays.ofFloats(shape(3, 2, 4)); // with [x, y, z] axes
// Iterates elements on the x axis by preserving only the 3rd value on the z axis,
// (i.e. [x, y, 2])
matrix3d.slice(all(), all(), at(2)).elements(0).forEach(m -> {
assertEquals(shape(2), m); // y=2, z=0 (scalar)
});
// Creates a slice that contains only the last element of the y axis and elements with an
// odd `z` coordinate.
FloatNdArray slice = matrix3d.slice(all(), at(1), odd());
assertEquals(shape(3, 2), slice.shape()); // x=3, y=0 (scalar), z=2 (odd coordinates)
// Iterates backward the elements on the x axis
matrix3d.slice(flip()).elements(0).forEach(m -> {
assertEquals(shape(2, 4), m); // y=2, z=4
});
FloatNdArray get(long... coordinates)
NdArrayElements of any of the dimensions of this array can be retrieved. For example, if the number of coordinates is equal to the number of dimensions of this array, then a rank-0 (scalar) array is returned, which value can then be obtained by calling `array.getObject()`.
Any changes applied to the returned elements affect the data of this array as well, as there is no copy involved.
Note that invoking this method is an equivalent and more efficient way to slice this array
on single scalar, i.e. array.get(x, y, z) is equal to
array.slice(at(x), at(y), at(z))
FloatNdArray set(NdArray<Float> src, long... coordinates)
NdArrayThe number of coordinates provided can be anywhere between 0 and rank - 1. For example:
FloatNdArray matrix = NdArrays.ofFloats(shape(2, 2)); // matrix rank = 2
matrix.set(vector(10.0f, 20.0f), 0); // success
matrix.set(scalar(10.0f), 1, 0); // success
default Float getObject(long... coordinates)
NdArrayTo access the scalar element, the number of coordinates provided must be equal to the number of dimensions of this array (i.e. its rank). For example:
FloatNdArray matrix = NdArrays.ofFloats(shape(2, 2)); // matrix rank = 2
matrix.getObject(0, 1); // succeeds, returns 0.0f
matrix.getObject(0); // throws IllegalRankException
FloatNdArray scalar = matrix.get(0, 1); // scalar rank = 0
scalar.getObject(); // succeeds, returns 0.0f
floatArray.getFloat(0); .default FloatNdArray setObject(Float value, long... coordinates)
NdArrayTo access the scalar element, the number of coordinates provided must be equal to the number of dimensions of this array (i.e. its rank). For example:
FloatNdArray matrix = NdArrays.ofFloats(shape(2, 2)); // matrix rank = 2
matrix.setObject(10.0f, 0, 1); // succeeds
matrix.setObject(10.0f, 0); // throws IllegalRankException
FloatNdArray scalar = matrix.get(0, 1); // scalar rank = 0
scalar.setObject(10.0f); // succeeds
floatArray.setFloat(10.0f, 0); NdArraySequence<FloatNdArray> elements(int dimensionIdx)
NdArrayLogically, the N-dimensional array can be flatten in a single vector, where the scalars of
the (n - 1)th element precedes those of the (n)th element, for a total of
NdArray.size() values.
For example, given a n x m matrix on the [x, y] axes, elements are iterated in
the following order:
x0y0, x0y1, ..., x0ym-1, x1y0, x1y1, ..., xn-1ym-1
The returned sequence can then be iterated to visit each elements, either by calling
Iterable.forEach(Consumer) or NdArraySequence.forEachIndexed(BiConsumer).
// Iterate matrix for initializing each of its vectors
matrixOfFloats.elements(0).forEach(v -> {
v.set(vector(1.0f, 2.0f, 3.0f));
});
// Iterate a vector for reading each of its scalar
vectorOfFloats.scalars().forEachIdx((coords, s) -> {
System.out.println("Value " + s.getFloat() + " found at " + coords);
});
NdArraySequence<FloatNdArray> scalars()
NdArrayThis is equivalent to call elements(shape().numDimensions() - 1)
FloatNdArray copyTo(NdArray<Float> dst)
NdArrayThe NdArray.shape() of the destination array must be equal to the shape of this array, or
an exception is thrown. After the copy, the content of both arrays can be altered
independently, without affecting each other.
FloatNdArray read(DataBuffer<Float> dst)
NdArrayThe size of the buffer must be equal or greater to the NdArray.size() of this
array, or an exception is thrown. After the copy, content of the buffer and of the array can be
altered independently, without affecting each other.
read in interface NdArray<Float>dst - the destination bufferDataBuffer.size()FloatNdArray read(FloatDataBuffer dst)
FloatNdArray write(DataBuffer<Float> src)
NdArrayThe size of the buffer must be equal or greater to the NdArray.size() of this
array, or an exception is thrown. After the copy, content of the buffer and of the array can be
altered independently, without affecting each other.
write in interface NdArray<Float>src - the source bufferDataBuffer.size()FloatNdArray write(FloatDataBuffer src)
Copyright © 2015–2020. All rights reserved.