java.lang.Object
- io.github.hakkelt.ndarrays.internal.AbstractNDArray<T,T>
- - io.github.hakkelt.ndarrays.internal.AbstractRealNDArray<Float>
  - - io.github.hakkelt.ndarrays.AbstractFloatNDArray
    - - io.github.hakkelt.ndarrays.basic.BasicFloatNDArray

All Implemented Interfaces:

RealNDArray<Float>, NDArray<Float>, Iterable<Float>
```
public class BasicFloatNDArray
extends AbstractFloatNDArray
```
Reference implementation for the NDArray of float (single precision, 32 bit floating-point) values.

Constructor Summary

Constructors
Constructor	Description
`BasicFloatNDArray(int... shape)`	Simple constructor that defines only the shape of the NDArray and fills it with zeros.
`BasicFloatNDArray(NDArray<? extends Number> array)`	Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`NDArray<Float>`	`copyFrom(NDArray<?> array)`	Updates this NDArray with the elements of the NDArray given as parameter.
`boolean`	`equals(Object other)`	Compares the specified object with this NDArray for equality.
`static Collector<Object,List<Object>,NDArray<Float>>`	`getCollector(int... shape)`
`String`	`getNamePrefix()`	Returns a string that identifies the implementation behind this current object.
`int`	`hashCode()`	This method is unsupported because NDArrays should not be used as keys in hash-based collections.
`static NDArray<Float>`	`of(byte... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(double... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(float... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(int... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(long... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(short... array)`	Factory method that creates an NDArray from a list or 1D array of float values.
`static NDArray<Float>`	`of(Object[] array)`	Factory method that creates an NDArray from a multi-dimensional array of numeric values.
`static BasicFloatNDArray`	`readFromFile(File file)`	Load the content of the given file into a new BasicFloatNDArray.

Methods inherited from class io.github.hakkelt.ndarrays.AbstractFloatNDArray
dtype, set, set

Methods inherited from class io.github.hakkelt.ndarrays.internal.AbstractRealNDArray
dataTypeAsString

Methods inherited from class io.github.hakkelt.ndarrays.internal.AbstractNDArray
accumulate, apply, applyOnSlices, applyWithCartesianIndices, applyWithLinearIndices, contains, contentToString, contentToString, copy, fillUsingCartesianIndices, fillUsingLinearIndices, forEach, forEachWithCartesianIndices, forEachWithLinearIndices, get, get, getImag, getImag, getReal, getReal, iterator, length, mapOnSlices, maybeParallelStream, ndim, norm, norm, parallelStream, prod, reduceSlices, set, set, setImag, setImag, setReal, setReal, shape, shape, similar, spliterator, stream, streamCartesianIndices, streamLinearIndices, sum, toArray, toArray, toArray, toString, writeToFile

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.hakkelt.ndarrays.NDArray
accumulate, add, add, add, add, add, add, add, addInplace, addInplace, addInplace, addInplace, addInplace, addInplace, addInplace, apply, applyOnSlices, applyWithCartesianIndices, applyWithLinearIndices, contains, contentToString, contentToString, copy, divide, divide, divide, divide, divide, divide, divide, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, fillUsingCartesianIndices, fillUsingLinearIndices, forEach, forEachWithCartesianIndices, forEachWithLinearIndices, get, get, iterator, length, mapOnSlices, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, ndim, norm, norm, norm, parallelStream, prod, reduceSlices, set, set, shape, shape, similar, spliterator, stream, streamCartesianIndices, streamLinearIndices, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, sum, toArray, toArray, toArray, toString, writeToFile

Methods inherited from interface io.github.hakkelt.ndarrays.internal.RealNDArray
accumulate, add, addInplace, concatenate, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, divide, divideInplace, dropDims, fill, fill, inverseMask, map, mapWithCartesianIndices, mapWithLinearIndices, mask, mask, maskWithCartesianIndices, maskWithLinearIndices, multiply, multiplyInplace, permuteDims, prod, reshape, selectDims, slice, squeeze, subtract, subtractInplace, sum

- Constructor Detail
  - BasicFloatNDArray
```
public BasicFloatNDArray(int... shape)
```
    Simple constructor that defines only the shape of the NDArray and fills it with zeros.
    
    Parameters:
    
    shape - dimensions / shape of the NDArray
  - BasicFloatNDArray
```
public BasicFloatNDArray(NDArray<? extends Number> array)
```
    Copy constructor.
    
    Parameters:
    
    array - NDArray from which entries are copied from.
- Method Detail
  - of
```
public static NDArray<Float> of(float... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - of
```
public static NDArray<Float> of(double... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - of
```
public static NDArray<Float> of(byte... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - of
```
public static NDArray<Float> of(short... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - of
```
public static NDArray<Float> of(int... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - of
```
public static NDArray<Float> of(long... array)
```
    Factory method that creates an NDArray from a list or 1D array of float values.
    
    Parameters:
    
    array - a list or 1D array of float values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a list or 1D array of float values
  - readFromFile
```
public static BasicFloatNDArray readFromFile(File file)
                                      throws IOException
```
    Load the content of the given file into a new BasicFloatNDArray.
    Only the files written by function writeToFile can be loaded by this function.
    Example:
    
    NDArray<Float> array = new BasicFloatNDArray(128, 128).fill(5); array.writeToFile(new File("array.nda")); NDArray<Float> array2 = BasicFloatNDArray.readFromFile(new File("array.nda")); assertEquals(array, array2);
    Parameters:
    
    file - file from which the content of the NDArray is read (the extension of the file can be arbitrary, but .nda is recommended)
    
    Returns:
    
    a new BasicFloatNDArray whose shape and content is loaded from the given file
    
    Throws:
    
    IOException - when the given file cannot be opened for read
  - of
```
public static NDArray<Float> of(Object[] array)
```
    Factory method that creates an NDArray from a multi-dimensional array of numeric values.
    
    Parameters:
    
    array - a multi-dimensional array of numeric values from which a BasicFloatNDArray is created.
    
    Returns:
    
    an NDArray created from a multi-dimensional array of numeric values
  - copyFrom
```
public NDArray<Float> copyFrom(NDArray<?> array)
```
    Description copied from interface: NDArray
    
    Updates this NDArray with the elements of the NDArray given as parameter.
    Note: the parameter NDArray must have the same shape and this NDArray!
    
    Specified by:
    
    copyFrom in interface NDArray<Float>
    
    Overrides:
    
    copyFrom in class AbstractRealNDArray<Float>
    
    Parameters:
    
    array - NDArray from which values are copied to this NDArray
    
    Returns:
    
    this NDArray
  - getNamePrefix
```
public String getNamePrefix()
```
    Description copied from interface: NDArray
    
    Returns a string that identifies the implementation behind this current object. The output of the toString() function starts with this string.
    
    Returns:
    
    a string that identifies the implementation
  - getCollector
```
public static Collector<Object,List<Object>,NDArray<Float>> getCollector(int... shape)
```
  - equals
```
public boolean equals(Object other)
```
    Description copied from interface: NDArray
    
    Compares the specified object with this NDArray for equality. Two arrays are equal, if they are both real or both complex, and they are element-wise equal. If the specified object is not NDArray then the function returns false.
    
    Specified by:
    
    equals in interface NDArray<Float>
    
    Overrides:
    
    equals in class AbstractNDArray<Float,Float>
    
    Parameters:
    
    other - Object to be compared for equality
    
    Returns:
    
    true if the specified object equals with this NDArray
  - hashCode
```
@Generated
public int hashCode()
```
    Description copied from interface: NDArray
    
    This method is unsupported because NDArrays should not be used as keys in hash-based collections.
    
    Specified by:
    
    hashCode in interface NDArray<Float>
    
    Overrides:
    
    hashCode in class AbstractNDArray<Float,Float>
    
    Returns:
    
    always throws UnsupportedOperationsException

Class BasicFloatNDArray

Constructor Summary

Method Summary

Methods inherited from class io.github.hakkelt.ndarrays.AbstractFloatNDArray

Methods inherited from class io.github.hakkelt.ndarrays.internal.AbstractRealNDArray

Methods inherited from class io.github.hakkelt.ndarrays.internal.AbstractNDArray

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.hakkelt.ndarrays.NDArray

Methods inherited from interface io.github.hakkelt.ndarrays.internal.RealNDArray

Constructor Detail

BasicFloatNDArray

BasicFloatNDArray

Method Detail

of

of

of

of

of

of

readFromFile

of

copyFrom

getNamePrefix

getCollector

equals

hashCode