SliceArray

Documentation of 'mikera.arrayz.impl.SliceArray' Java class SliceArray

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- mikera.arrayz.impl.AbstractArray<INDArray>
- - mikera.arrayz.impl.BaseShapedArray
  - - mikera.arrayz.impl.SliceArray<T>

Type Parameters:

T -

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<INDArray>, INDArray
```
public final class SliceArray<T extends INDArray>
extends BaseShapedArray
```
A general N-dimensional double array implemented as a collection of (n-1) dimensional slices Must have dimensionality 1 or above, and contain at least one slice

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyOp(IOperator op)` Applies a unary operator to all elements of the array (in-place)
`void`	`applyOp(Op op)` Applies a unary operator to all elements of the array (in-place)
`AVector`	`asVector()` Constructs a view of all elements in the array as a single vector in row-major order.
`int`	`componentCount()` Returns the number of components of this array.
`static <T extends INDArray> SliceArray<T>`	`create(INDArray a)`
`static SliceArray<INDArray>`	`create(java.util.List<INDArray> slices)`
`static SliceArray<INDArray>`	`create(java.util.List<INDArray> slices, int[] shape)`
`int`	`dimensionality()` Returns the dimensionality of the array (i.e.
`long`	`elementCount()` Returns the total number of elements in this array.
`boolean`	`equals(INDArray a)` Checks if two arrays are equal exactly in terms of both value and shape Element equality checks are consistent with compareTo
`boolean`	`equalsArray(double[] values, int offset)` Returns true if the elements in this array exactly match the elements in the given array, in row-major order
`SliceArray<T>`	`exactClone()` Creates a deep clone of an array, using the same class implementation as the original array
`void`	`fill(double value)` Fills this array with a single double value.
`double`	`get()` Returns the double value of a scalar array
`double`	`get(int... indexes)` Returns the double value at the specified index position in an array
`double`	`get(int x)` Returns the double value at the specified position in a 1D vector
`double`	`get(int x, int y)` Returns the double value at the specified position in a 2D matrix
`T`	`getComponent(int k)` Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
`INDArray[]`	`getComponents()` Gets all components in a new array, with length componentCount();
`long[]`	`getLongShape()` Returns the shape of the array as an array of longs.
`java.util.List<?>`	`getSlices()` Returns a list of all major slices of this array.
`INDArray`	`innerProduct(INDArray a)` Calculates the inner product of this array with another array.
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`boolean`	`isElementConstrained()` Returns true if this array has some constraints on element values
`boolean`	`isFullyMutable()` If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
`boolean`	`isMutable()` Returns true if the INDArray is mutable (at least partially)
`boolean`	`isView()` Return true if this array is considered as a view type.
`boolean`	`isZero()` Returns true if the array is zero (all elements equal to zero)
`void`	`multiply(double d)` Multiplies all elements of the array in place by a given double value
`static <T extends INDArray> SliceArray<T>`	`of(T... slices)` Create a SliceArray by wrapping a set of slices.
`INDArray`	`outerProduct(INDArray a)` Calculates the outer product of this array with another array.
`static SliceArray<INDArray>`	`repeat(INDArray slice, int n)` Create a SliceArray by repeating the same slice instance a given number of times
`INDArray`	`reshape(int... dimensions)` Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
`void`	`set(double value)` Sets all elements of an array to a specific double value
`void`	`set(int[] indexes, double value)` Sets the element at the given indexed position in a mutable array
`T`	`slice(int majorSlice)` Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.
`INDArray`	`slice(int dimension, int index)` Returns a slice view of this array along the specified dimension
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`INDArray[]`	`toSliceArray()` Copies the slices of this array to a new INDArray[] Throws an error if the array has no slices (i.e.
`void`	`validate()` Validates the internal data structure of the INDArray.

Methods inherited from class mikera.arrayz.impl.BaseShapedArray
getElement, getShape, getShape, getShapeClone, reduce, reduce, sliceCount

Methods inherited from class mikera.arrayz.impl.AbstractArray
abs, absCopy, absDiff, absDiffCopy, add, add, add, addApplyOp, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clamp, clone, compareTo, copy, dense, denseClone, density, divide, divide, divideCopy, divideCopy, elementAbsPowSum, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equals, equalsArray, exp, get, get, get, get, get, getElements, getElements, getElements, getElements, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, isDense, isSameShape, isSparse, iterator, join, join, log, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, pow, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, sliceValue, sparse, sparseClone, sqrt, square, squareCopy, sub, sub, sub, subArray, subCopy, toDoubleBuffer, toString, toStringFull, toVector, withComponents

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - create
```
public static <T extends INDArray> SliceArray<T> create(INDArray a)
```
  - of
```
@SafeVarargs
public static <T extends INDArray> SliceArray<T> of(T... slices)
```
    Create a SliceArray by wrapping a set of slices.
    
    Parameters:
    
    slices -
    
    Returns:
  - repeat
```
public static SliceArray<INDArray> repeat(INDArray slice,
                                          int n)
```
    Create a SliceArray by repeating the same slice instance a given number of times
    
    Parameters:
    
    slice -
    
    n -
    
    Returns:
  - create
```
public static SliceArray<INDArray> create(java.util.List<INDArray> slices)
```
  - create
```
public static SliceArray<INDArray> create(java.util.List<INDArray> slices,
                                          int[] shape)
```
  - dimensionality
```
public int dimensionality()
```
    Description copied from interface: INDArray
    
    Returns the dimensionality of the array (i.e. the number of dimensions in the array shape) e.g. 0 for a scalar, 1 for a vector, 2 for a matrix etc.
    
    Specified by:
    
    dimensionality in interface INDArray
    
    Overrides:
    
    dimensionality in class BaseShapedArray
  - getLongShape
```
public long[] getLongShape()
```
    Description copied from interface: INDArray
    
    Returns the shape of the array as an array of longs.
    
    Specified by:
    
    getLongShape in interface INDArray
    
    Overrides:
    
    getLongShape in class AbstractArray<INDArray>
  - get
```
public double get(int... indexes)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified index position in an array
  - set
```
public void set(double value)
```
    Description copied from interface: INDArray
    
    Sets all elements of an array to a specific double value
    
    Specified by:
    
    set in interface INDArray
    
    Overrides:
    
    set in class AbstractArray<INDArray>
  - fill
```
public void fill(double value)
```
    Description copied from interface: INDArray
    
    Fills this array with a single double value. Requires the array to be mutable.
    
    Specified by:
    
    fill in interface INDArray
    
    Overrides:
    
    fill in class AbstractArray<INDArray>
  - set
```
public void set(int[] indexes,
                double value)
```
    Description copied from interface: INDArray
    
    Sets the element at the given indexed position in a mutable array
  - asVector
```
public AVector asVector()
```
    Description copied from interface: INDArray
    
    Constructs a view of all elements in the array as a single vector in row-major order.
    
    Specified by:
    
    asVector in interface INDArray
    
    Overrides:
    
    asVector in class AbstractArray<INDArray>
  - reshape
```
public INDArray reshape(int... dimensions)
```
    Description copied from interface: INDArray
    
    Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
    
    Specified by:
    
    reshape in interface INDArray
    
    Overrides:
    
    reshape in class AbstractArray<INDArray>
  - slice
```
public T slice(int majorSlice)
```
    Description copied from interface: INDArray
    
    Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.
  - componentCount
```
public int componentCount()
```
    Description copied from interface: INDArray
    
    Returns the number of components of this array. May return 0 if components are not supported
    
    Specified by:
    
    componentCount in interface INDArray
    
    Overrides:
    
    componentCount in class AbstractArray<INDArray>
    
    Returns:
  - getComponent
```
public T getComponent(int k)
```
    Description copied from interface: INDArray
    
    Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
    
    Specified by:
    
    getComponent in interface INDArray
    
    Overrides:
    
    getComponent in class AbstractArray<INDArray>
    
    Returns:
  - slice
```
public INDArray slice(int dimension,
                      int index)
```
    Description copied from interface: INDArray
    
    Returns a slice view of this array along the specified dimension
  - elementCount
```
public long elementCount()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in this array. Equivalent to the product of all dimension sizes.
    
    Specified by:
    
    elementCount in interface INDArray
    
    Overrides:
    
    elementCount in class BaseShapedArray
  - innerProduct
```
public INDArray innerProduct(INDArray a)
```
    Description copied from interface: INDArray
    
    Calculates the inner product of this array with another array.
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Overrides:
    
    innerProduct in class AbstractArray<INDArray>
  - outerProduct
```
public INDArray outerProduct(INDArray a)
```
    Description copied from interface: INDArray
    
    Calculates the outer product of this array with another array.
    
    Specified by:
    
    outerProduct in interface INDArray
    
    Overrides:
    
    outerProduct in class AbstractArray<INDArray>
  - isMutable
```
public boolean isMutable()
```
    Description copied from interface: INDArray
    
    Returns true if the INDArray is mutable (at least partially)
    
    Specified by:
    
    isMutable in interface INDArray
    
    Overrides:
    
    isMutable in class AbstractArray<INDArray>
  - isFullyMutable
```
public boolean isFullyMutable()
```
    Description copied from interface: INDArray
    
    If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e. every position can store any valid double value
    
    Specified by:
    
    isFullyMutable in interface INDArray
    
    Overrides:
    
    isFullyMutable in class AbstractArray<INDArray>
  - isZero
```
public boolean isZero()
```
    Description copied from interface: INDArray
    
    Returns true if the array is zero (all elements equal to zero)
    
    Specified by:
    
    isZero in interface INDArray
    
    Overrides:
    
    isZero in class BaseShapedArray
  - isBoolean
```
public boolean isBoolean()
```
    Description copied from interface: INDArray
    
    Returns true if the array is boolean (contains only 0.0 or 1.0 values)
    
    Specified by:
    
    isBoolean in interface INDArray
    
    Overrides:
    
    isBoolean in class AbstractArray<INDArray>
  - isElementConstrained
```
public boolean isElementConstrained()
```
    Description copied from interface: INDArray
    
    Returns true if this array has some constraints on element values
    
    Specified by:
    
    isElementConstrained in interface INDArray
    
    Overrides:
    
    isElementConstrained in class AbstractArray<INDArray>
  - isView
```
public boolean isView()
```
    Description copied from interface: INDArray
    
    Return true if this array is considered as a view type. This indicates (but does not guarantee): a) Data is *likely* to be shared with other arrays, so mutation of one may affect others b) It is *unlikely* to be in the most efficient general purpose format isView is intended to be used as for heuristics. It should *not* be used where the outcome might affect correctness.
  - applyOp
```
public void applyOp(Op op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<INDArray>
  - applyOp
```
public void applyOp(IOperator op)
```
    Description copied from interface: INDArray
    
    Applies a unary operator to all elements of the array (in-place)
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AbstractArray<INDArray>
    
    Parameters:
    
    op - The operator to apply to the array
  - multiply
```
public void multiply(double d)
```
    Description copied from interface: INDArray
    
    Multiplies all elements of the array in place by a given double value
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AbstractArray<INDArray>
  - equals
```
public boolean equals(INDArray a)
```
    Description copied from interface: INDArray
    
    Checks if two arrays are equal exactly in terms of both value and shape Element equality checks are consistent with compareTo
    
    Specified by:
    
    equals in interface INDArray
    
    Overrides:
    
    equals in class AbstractArray<INDArray>
  - exactClone
```
public SliceArray<T> exactClone()
```
    Description copied from interface: INDArray
    
    Creates a deep clone of an array, using the same class implementation as the original array
    
    Returns:
    
    A clone of the original array
  - getSlices
```
public java.util.List<?> getSlices()
```
    Description copied from interface: INDArray
    
    Returns a list of all major slices of this array. Returns a list of Double values if a 1-dimensional array is sliced, otherwise a list of INDArray instances
    
    Specified by:
    
    getSlices in interface INDArray
    
    Overrides:
    
    getSlices in class AbstractArray<INDArray>
  - toSliceArray
```
public INDArray[] toSliceArray()
```
    Description copied from interface: INDArray
    
    Copies the slices of this array to a new INDArray[] Throws an error if the array has no slices (i.e. is zero-dimensional)
    
    Specified by:
    
    toSliceArray in interface INDArray
    
    Overrides:
    
    toSliceArray in class AbstractArray<INDArray>
  - getComponents
```
public INDArray[] getComponents()
```
    Description copied from interface: INDArray
    
    Gets all components in a new array, with length componentCount();
    
    Specified by:
    
    getComponents in interface INDArray
    
    Overrides:
    
    getComponents in class AbstractArray<INDArray>
    
    Returns:
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this array to a new double[] array.
    
    Specified by:
    
    toDoubleArray in interface INDArray
    
    Overrides:
    
    toDoubleArray in class AbstractArray<INDArray>
  - equalsArray
```
public boolean equalsArray(double[] values,
                           int offset)
```
    Description copied from interface: INDArray
    
    Returns true if the elements in this array exactly match the elements in the given array, in row-major order
    
    Specified by:
    
    equalsArray in interface INDArray
    
    Overrides:
    
    equalsArray in class AbstractArray<INDArray>
    
    Parameters:
    
    values - Array of double element values to check for equality
    
    offset - Offset into the data array
    
    Returns:
  - validate
```
public void validate()
```
    Description copied from interface: INDArray
    
    Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.
    
    Specified by:
    
    validate in interface INDArray
    
    Overrides:
    
    validate in class AbstractArray<INDArray>
  - get
```
public double get()
```
    Description copied from interface: INDArray
    
    Returns the double value of a scalar array
    
    Specified by:
    
    get in interface INDArray
    
    Specified by:
    
    get in class AbstractArray<INDArray>
  - get
```
public double get(int x)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified position in a 1D vector
    
    Specified by:
    
    get in interface INDArray
    
    Specified by:
    
    get in class AbstractArray<INDArray>
  - get
```
public double get(int x,
                  int y)
```
    Description copied from interface: INDArray
    
    Returns the double value at the specified position in a 2D matrix
    
    Specified by:
    
    get in interface INDArray
    
    Specified by:
    
    get in class AbstractArray<INDArray>

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class SliceArray<T extends INDArray>

Method Summary

Methods inherited from class mikera.arrayz.impl.BaseShapedArray

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

create

of

repeat

create

create

dimensionality

getLongShape

get

set

fill

set

asVector

reshape

slice

componentCount

getComponent

slice

elementCount

innerProduct

outerProduct

isMutable

isFullyMutable

isZero

isBoolean

isElementConstrained

isView

applyOp

applyOp

multiply

equals

exactClone

getSlices

toSliceArray

getComponents

toDoubleArray

equalsArray

validate

get

get

get