Package io.github.hakkelt.ndarrays.internal

Class AbstractNDArrayMaskView<T,T2 extends Number>

java.lang.Object

io.github.hakkelt.ndarrays.internal.AbstractNDArray<T,T2>

io.github.hakkelt.ndarrays.internal.AbstractNDArrayView<T,T2>

io.github.hakkelt.ndarrays.internal.AbstractNDArrayMaskView<T,T2>

All Implemented Interfaces:

NDArray<T>, Iterable<T>

Direct Known Subclasses:

ComplexNDArrayMaskView, RealNDArrayMaskView

public abstract class AbstractNDArrayMaskView<T,T2 extends Number>
extends AbstractNDArrayView<T,T2>

Method Summary

Modifier and Type	Method	Description
NDArray<T>	applyOnSlices(BiFunction<NDArray<T>,int[],NDArray<?>> func, int... iterationDims)	Apply the given function to each slices of the array, and override each entry with the returned slice.
boolean	equals(Object obj)	Compares the specified object with this NDArray for equality.
int	hashCode()	This method is unsupported because NDArrays should not be used as keys in hash-based collections.
NDArray<T>	mapOnSlices(BiFunction<NDArray<T>,int[],NDArray<?>> func, int... iterationDims)	Apply the given function to each slices of the array, and create a new NDArray with the calculated new values.

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

copy, dataTypeAsString, dtype, dtype2, getNamePrefix, getParent, getTopMostParent, linearIndexToViewIndices, similar

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

accumulate, apply, applyWithCartesianIndices, applyWithLinearIndices, contains, contentToString, contentToString, fillUsingCartesianIndices, fillUsingLinearIndices, forEach, forEachWithCartesianIndices, forEachWithLinearIndices, get, get, getImag, getImag, getReal, getReal, iterator, length, maybeParallelStream, ndim, norm, norm, parallelStream, prod, reduceSlices, set, set, setImag, setImag, setReal, setReal, shape, shape, 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, add, addInplace, addInplace, addInplace, addInplace, addInplace, addInplace, addInplace, addInplace, concatenate, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, divide, divide, divide, divide, divide, divide, divide, divide, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, dropDims, fill, fill, inverseMask, map, mapWithCartesianIndices, mapWithLinearIndices, mask, mask, maskWithCartesianIndices, maskWithLinearIndices, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, norm, permuteDims, prod, reshape, selectDims, set, set, slice, squeeze, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, sum

Method Detail

mapOnSlices

public NDArray<T> mapOnSlices(BiFunction<NDArray<T>,int[],NDArray<?>> func,
                              int... iterationDims)

Description copied from interface: NDArray

Apply the given function to each slices of the array, and create a new NDArray with the calculated new values. Please note that slices might not be processed in a sequential order!

Specified by:

mapOnSlices in interface NDArray<T>

Overrides:

mapOnSlices in class AbstractNDArray<T,T2 extends Number>

Parameters:

func - function that receives slice and its Cartesian coordinate along the iteration dimensions, and returns a new array with the same size as the slice

iterationDims - dimensions along which iteration is performed

Returns:

the new NDArray with the calculated new values

applyOnSlices

public NDArray<T> applyOnSlices(BiFunction<NDArray<T>,int[],NDArray<?>> func,
                                int... iterationDims)

Description copied from interface: NDArray

Apply the given function to each slices of the array, and override each entry with the returned slice. Please note that slices might not be processed in a sequential order!

Specified by:

applyOnSlices in interface NDArray<T>

Overrides:

applyOnSlices in class AbstractNDArray<T,T2 extends Number>

Parameters:

func - function that receives the value of the current entry and its Cartesian coordinate, and returns a slice from which values are copied to original array

iterationDims - dimensions along which iteration is performed

Returns:

itself after the update

equals

public boolean equals(Object obj)

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<T>

Overrides:

equals in class AbstractNDArrayView<T,T2 extends Number>

Parameters:

obj - Object to be compared for equality

Returns:

true if the specified object equals with this NDArray

hashCode

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<T>

Overrides:

hashCode in class AbstractNDArrayView<T,T2 extends Number>

Returns:

always throws UnsupportedOperationsException