ZeroArray (Vectorz 0.62.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, Iterable<INDArray>, INDArray, ISparse
```
public final class ZeroArray
extends BaseShapedArray
implements ISparse
```
Class representing an immutable array filled entirely with zeros.

Author:

Mike

See Also:

Serialized Form

Field Summary
- Fields inherited from class mikera.arrayz.impl.BaseShapedArray
  shape

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`INDArray`	`addCopy(INDArray a)` Creates a new array equal to the sum of this array with another array.
`void`	`addToArray(double[] data, int offset)` Adds all the elements of this array to a double array, in row-major order
`AVector`	`asVector()` Constructs a view of all elements in the array as a single vector in row-major order.
`INDArray`	`clone()` Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
`static ZeroArray`	`create(int... shape)`
`double`	`elementAbsPowSum(double p)` Returns the sum of the absolute values of all the elements raised to a specified power
`double`	`elementPowSum(double p)` Returns the sum of all the elements raised to a specified power
`boolean`	`equals(INDArray a)` Checks if two arrays are equal exactly in terms of both value and shape
`boolean`	`equalsArray(double[] data, int offset)` Returns true if the elements in this array exactly match the elements in the given array, in row-major order
`ZeroArray`	`exactClone()` Creates a deep clone of an array, using the same class implementation as the original array
`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
`List<INDArray>`	`getSlices()` Returns a list of all major slices of this array.
`ZeroArray`	`getTranspose()` Returns the transpose of this array.
`boolean`	`hasUncountable()` Returns true if any element is this array is NaN or infinite
`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)
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`void`	`set(int[] indexes, double value)` Sets the element at the given indexed position in a mutable array
`INDArray`	`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
`INDArray`	`sparseClone()` Creates a fully mutable clone of this array.
`static ZeroArray`	`wrap(int... shape)`

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

Methods inherited from class mikera.arrayz.impl.AbstractArray
abs, absCopy, add, add, add, addAt, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkDimension, checkMutable, clamp, componentCount, copy, dense, denseClone, density, divide, divide, divideCopy, elementIterator, elementMax, elementMin, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equals, equalsArray, exp, fill, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getElements, getLongShape, getSlices, getSliceViews, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isSameShape, isSparse, iterator, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, outerProduct, pow, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, sliceValue, sparse, sqrt, square, squareCopy, sub, sub, sub, subArray, subCopy, toArray, toDoubleArray, toDoubleBuffer, toSliceArray, toString, toStringFull, toVector, validate, withComponents

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

Methods inherited from interface mikera.arrayz.ISparse
density

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

- Method Detail
  - wrap
```
public static ZeroArray wrap(int... shape)
```
  - create
```
public static ZeroArray create(int... shape)
```
  - nonZeroCount
```
public long nonZeroCount()
```
    Description copied from interface: INDArray
    
    Returns the number of non-zero elements in the array.
    
    Specified by:
    
    nonZeroCount in interface INDArray
    
    Overrides:
    
    nonZeroCount 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
    
    Specified by:
    
    get in interface 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>
  - 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
    
    Specified by:
    
    set in interface INDArray
  - slice
```
public INDArray 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.
    
    Specified by:
    
    slice in interface INDArray
  - slice
```
public INDArray slice(int dimension,
                      int index)
```
    Description copied from interface: INDArray
    
    Returns a slice view of this array along the specified dimension
    
    Specified by:
    
    slice in interface INDArray
  - getSlices
```
public List<INDArray> 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>
  - 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.
    
    Specified by:
    
    isView in interface 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>
  - 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
  - getTranspose
```
public ZeroArray getTranspose()
```
    Description copied from interface: INDArray
    
    Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.
    
    Specified by:
    
    getTranspose in interface INDArray
    
    Overrides:
    
    getTranspose in class AbstractArray<INDArray>
  - addToArray
```
public void addToArray(double[] data,
                       int offset)
```
    Description copied from interface: INDArray
    
    Adds all the elements of this array to a double array, in row-major order
    
    Specified by:
    
    addToArray in interface INDArray
    
    Overrides:
    
    addToArray in class AbstractArray<INDArray>
  - addCopy
```
public INDArray addCopy(INDArray a)
```
    Description copied from interface: INDArray
    
    Creates a new array equal to the sum of this array with another array.
    
    Specified by:
    
    addCopy in interface INDArray
    
    Overrides:
    
    addCopy in class AbstractArray<INDArray>
    
    Returns:
  - equalsArray
```
public boolean equalsArray(double[] data,
                           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:
    
    data - Array of double element values to check for equality
    
    offset - Offset into the data array
    
    Returns:
  - 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
    
    Specified by:
    
    equals in interface INDArray
    
    Overrides:
    
    equals in class AbstractArray<INDArray>
  - 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>
  - clone
```
public INDArray clone()
```
    Description copied from interface: INDArray
    
    Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type. Clone should preserve sparsity property where possible, but this is not guaranteed.
    
    Specified by:
    
    clone in interface INDArray
    
    Overrides:
    
    clone in class AbstractArray<INDArray>
  - sparseClone
```
public INDArray sparseClone()
```
    Description copied from interface: INDArray
    
    Creates a fully mutable clone of this array. Will use a sparse format if possible.
    
    Specified by:
    
    sparseClone in interface INDArray
    
    Overrides:
    
    sparseClone in class AbstractArray<INDArray>
  - exactClone
```
public ZeroArray exactClone()
```
    Description copied from interface: INDArray
    
    Creates a deep clone of an array, using the same class implementation as the original array
    
    Specified by:
    
    exactClone in interface INDArray
    
    Returns:
    
    A clone of the original array
  - hasUncountable
```
public boolean hasUncountable()
```
    Description copied from class: AbstractArray
    
    Returns true if any element is this array is NaN or infinite
    
    Specified by:
    
    hasUncountable in interface INDArray
    
    Overrides:
    
    hasUncountable in class AbstractArray<INDArray>
    
    Returns:
    
    True if any element is this array is NaN or infinite, false otherwise
  - elementPowSum
```
public double elementPowSum(double p)
```
    Returns the sum of all the elements raised to a specified power
    
    Specified by:
    
    elementPowSum in interface INDArray
    
    Overrides:
    
    elementPowSum in class AbstractArray<INDArray>
    
    Returns:
  - elementAbsPowSum
```
public double elementAbsPowSum(double p)
```
    Returns the sum of the absolute values of all the elements raised to a specified power
    
    Specified by:
    
    elementAbsPowSum in interface INDArray
    
    Overrides:
    
    elementAbsPowSum in class AbstractArray<INDArray>
    
    Returns:

Class ZeroArray

Field Summary

Fields inherited from class mikera.arrayz.impl.BaseShapedArray

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 mikera.arrayz.ISparse

Methods inherited from interface java.lang.Iterable

Method Detail

wrap

create

nonZeroCount

get

get

get

get

set

slice

slice

getSlices

isView

isMutable

isZero

getTranspose

addToArray

addCopy

equalsArray

equals

asVector

clone

sparseClone

exactClone

hasUncountable

elementPowSum

elementAbsPowSum