| Package | Description |
|---|---|
| mikera.arrayz | |
| mikera.arrayz.impl | |
| mikera.matrixx | |
| mikera.matrixx.impl | |
| mikera.vectorz | |
| mikera.vectorz.impl | |
| mikera.vectorz.ops | |
| mikera.vectorz.util |
| Modifier and Type | Class and Description |
|---|---|
class |
Array
General purpose mutable packed N-dimensional array
This is the general multi-dimensional equivalent of Matrix and Vector, and as such is the
most efficient storage type for 3D+ arrays
|
class |
NDArray
General purpose NDArray class
|
| Modifier and Type | Method and Description |
|---|---|
INDArray |
NDArray.broadcast(int... dimensions) |
INDArray |
INDArray.broadcast(int... shape)
Returns a view of this array broadcasted up to a larger shape
|
INDArray |
INDArray.broadcastCloneLike(INDArray target)
Creates a clone of the array, broadcasted if necessary to match the shape of the target
|
INDArray |
INDArray.broadcastLike(INDArray target)
Broadcasts to match the shape of the target
|
INDArray |
NDArray.clone() |
INDArray |
INDArray.clone()
Returns a clone of the array, as a new array which will be fully mutable
and may be of a different class to the original.
|
INDArray |
Array.clone() |
static INDArray |
Arrayz.create(INDArray a) |
static INDArray |
Arrayz.create(Object... data) |
static INDArray |
Arrayz.create(Object object)
Creates an array from the given data
Handles double arrays, INDArray instances, and lists
|
static INDArray |
Arrayz.createFromVector(AVector a,
int... shape)
Creates a new array using the elements in the specified vector.
|
INDArray |
INDArray.ensureMutable()
Ensures the array is a fully mutable, efficient representation that is not
a view.
|
INDArray |
INDArray.exactClone()
Returns an exact deep clone of an array (i.e.
|
INDArray |
NDArray.getTranspose() |
INDArray |
INDArray.getTranspose()
Returns the transpose of this array.
|
INDArray |
INDArray.getTransposeCopy()
Returns a transposed copy of the array.
|
INDArray |
NDArray.getTransposeView() |
INDArray |
INDArray.getTransposeView()
Returns a transposed view of the array.
|
INDArray |
NDArray.innerProduct(INDArray a) |
INDArray |
INDArray.innerProduct(INDArray a)
Calculates the inner product of this array with another array.
|
static INDArray |
Arrayz.load(Reader reader) |
static INDArray |
Arrayz.newArray(int... shape) |
INDArray |
NDArray.outerProduct(INDArray a) |
INDArray |
INDArray.outerProduct(INDArray a)
Calculates the outer product of this array with another array.
|
static INDArray |
Arrayz.parse(String ednString) |
INDArray |
NDArray.reshape(int... dimensions) |
INDArray |
INDArray.reshape(int... shape)
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
|
INDArray |
NDArray.slice(int majorSlice) |
INDArray |
INDArray.slice(int majorSlice)
Returns the specified major slice of this array as a view (slice along dimension 0)
|
INDArray |
Array.slice(int majorSlice) |
INDArray |
NDArray.slice(int dimension,
int index) |
INDArray |
INDArray.slice(int dimension,
int index)
Returns a slice view of this array along the specified dimension
|
INDArray |
Array.slice(int dimension,
int index) |
static INDArray |
Arrayz.wrap(double[] data,
int[] shape) |
static INDArray |
Array.wrap(double[] data,
int[] shape) |
static INDArray |
NDArray.wrapStrided(double[] data,
int offset,
int[] shape,
int[] strides) |
static INDArray |
Arrayz.wrapStrided(double[] data,
int offset,
int[] shape,
int[] strides) |
| Modifier and Type | Method and Description |
|---|---|
List<INDArray> |
NDArray.getSlices() |
List<INDArray> |
Array.getSlices() |
List<INDArray> |
INDArray.getSliceViews()
Returns a list of slices as mutable INDArray views.
|
| Modifier and Type | Method and Description |
|---|---|
void |
NDArray.add(INDArray a) |
void |
INDArray.add(INDArray a)
Adds all the elements of another array to this array, in an elementwise order.
|
INDArray |
INDArray.broadcastCloneLike(INDArray target)
Creates a clone of the array, broadcasted if necessary to match the shape of the target
|
INDArray |
INDArray.broadcastLike(INDArray target)
Broadcasts to match the shape of the target
|
static INDArray |
Arrayz.create(INDArray a) |
static Array |
Array.create(INDArray a) |
void |
INDArray.divide(INDArray a)
Divides all elements by the equivalent elements in a second array
|
boolean |
INDArray.epsilonEquals(INDArray a)
Tests is this array is approximately equal to another array.
|
boolean |
INDArray.epsilonEquals(INDArray a,
double epsilon)
Tests is this array is approximately equal to another array, up to a given tolerance (epsilon)
The arrays must have the same shape
|
boolean |
NDArray.equals(INDArray a) |
boolean |
INDArray.equals(INDArray a)
Returns true if the two arrays are exactly equal in value and shape
|
boolean |
Array.equals(INDArray a) |
INDArray |
NDArray.innerProduct(INDArray a) |
INDArray |
INDArray.innerProduct(INDArray a)
Calculates the inner product of this array with another array.
|
boolean |
INDArray.isSameShape(INDArray a)
Returns true if this array is the same shape as another array
|
void |
INDArray.multiply(INDArray a)
Multiplies all elements by the equivalent elements in a second array
|
INDArray |
NDArray.outerProduct(INDArray a) |
INDArray |
INDArray.outerProduct(INDArray a)
Calculates the outer product of this array with another array.
|
void |
INDArray.set(INDArray a)
Sets this array to the element values contained in another array
|
void |
NDArray.sub(INDArray a) |
void |
INDArray.sub(INDArray a)
Subtracts all the elements of another array from this array, in an elementwise order.
|
static NDArray |
NDArray.wrap(INDArray a) |
| Modifier and Type | Class and Description |
|---|---|
class |
SliceArray<T extends INDArray>
A general n-dimensional double array implemented as a collection of (n-1) dimensional slices
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
IStridedArray
Interface for arrays that support strided access over underlying data
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractArray<T>
Abstract base class for INDArray implementations
|
class |
SliceArray<T extends INDArray>
A general n-dimensional double array implemented as a collection of (n-1) dimensional slices
|
| Modifier and Type | Method and Description |
|---|---|
static <T extends INDArray> |
SliceArray.create(List<T> slices) |
static <T extends INDArray> |
SliceArray.create(T... slices) |
static <T extends INDArray> |
SliceArray.repeat(T s,
int n) |
| Modifier and Type | Method and Description |
|---|---|
INDArray |
AbstractArray.broadcast(int... targetShape) |
INDArray |
AbstractArray.broadcastCloneLike(INDArray target) |
INDArray |
AbstractArray.broadcastLike(INDArray target) |
INDArray |
AbstractArray.clone() |
INDArray |
AbstractArray.ensureMutable() |
INDArray |
AbstractArray.getTranspose() |
INDArray |
AbstractArray.getTransposeCopy() |
INDArray |
AbstractArray.getTransposeView() |
INDArray |
SliceArray.innerProduct(INDArray a) |
INDArray |
AbstractArray.innerProduct(INDArray a) |
INDArray |
SliceArray.outerProduct(INDArray a) |
INDArray |
AbstractArray.outerProduct(INDArray a) |
INDArray |
SliceArray.reshape(int... dimensions) |
INDArray |
AbstractArray.reshape(int... targetShape) |
INDArray |
SliceArray.slice(int majorSlice) |
INDArray |
SliceArray.slice(int dimension,
int index) |
| Modifier and Type | Method and Description |
|---|---|
List<INDArray> |
AbstractArray.getSliceViews() |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractArray.add(INDArray a) |
INDArray |
AbstractArray.broadcastCloneLike(INDArray target) |
INDArray |
AbstractArray.broadcastLike(INDArray target) |
static <T extends INDArray> |
SliceArray.create(T... slices) |
void |
AbstractArray.divide(INDArray a) |
boolean |
AbstractArray.epsilonEquals(INDArray a) |
boolean |
AbstractArray.epsilonEquals(INDArray a,
double epsilon) |
boolean |
SliceArray.equals(INDArray a) |
boolean |
AbstractArray.equals(INDArray a) |
INDArray |
SliceArray.innerProduct(INDArray a) |
INDArray |
AbstractArray.innerProduct(INDArray a) |
boolean |
AbstractArray.isSameShape(INDArray a) |
void |
AbstractArray.multiply(INDArray a) |
INDArray |
SliceArray.outerProduct(INDArray a) |
INDArray |
AbstractArray.outerProduct(INDArray a) |
void |
AbstractArray.set(INDArray a) |
void |
AbstractArray.sub(INDArray a) |
| Constructor and Description |
|---|
SliceElementIterator(INDArray source) |
SliceElementIterator(INDArray source,
int start,
int length) |
SliceIterator(INDArray source) |
SliceIterator(INDArray source,
int start,
int length) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
IMatrix
Interface for fundamental matrix access operations.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AMatrix
General abstract 2D matrix class.
|
class |
Matrix
Standard MxN matrix class backed by a fully packed double[] array
This is the most efficient Vectorz type for 2D matrices.
|
class |
Matrix22
Specialised 2*2 Matrix for Vector2 maths, using primitive matrix elements
|
class |
Matrix33
Specialised 3*3 Matrix for Vector3 maths, using primitive matrix elements
|
| Modifier and Type | Method and Description |
|---|---|
INDArray |
AMatrix.broadcast(int... targetShape) |
INDArray |
AMatrix.broadcastCloneLike(INDArray target) |
INDArray |
AMatrix.broadcastLike(AMatrix target) |
INDArray |
AMatrix.broadcastLike(INDArray target) |
INDArray |
AMatrix.ensureMutable() |
INDArray |
AMatrix.innerProduct(INDArray a) |
INDArray |
AMatrix.outerProduct(INDArray a) |
INDArray |
AMatrix.reshape(int... dimensions) |
INDArray |
AMatrix.slice(int dimension,
int index) |
| Modifier and Type | Method and Description |
|---|---|
List<INDArray> |
AMatrix.getSliceViews() |
| Modifier and Type | Method and Description |
|---|---|
void |
AMatrix.add(INDArray a) |
INDArray |
AMatrix.broadcastCloneLike(INDArray target) |
INDArray |
AMatrix.broadcastLike(INDArray target) |
static Matrix |
Matrix.create(INDArray m) |
void |
AMatrix.divide(INDArray a) |
boolean |
AMatrix.epsilonEquals(INDArray a) |
boolean |
AMatrix.epsilonEquals(INDArray a,
double epsilon) |
boolean |
AMatrix.equals(INDArray v) |
INDArray |
AMatrix.innerProduct(INDArray a) |
boolean |
AMatrix.isSameShape(INDArray a) |
void |
AMatrix.multiply(INDArray a) |
INDArray |
AMatrix.outerProduct(INDArray a) |
void |
AMatrix.set(INDArray a) |
void |
AMatrix.sub(INDArray a) |
| Modifier and Type | Class and Description |
|---|---|
class |
AArrayMatrix
Abstract class for a Matrix backed with a single double[] data array
Dimensions are fixed, but leaves open the possibility of arbitrary indexing
|
class |
ABandedMatrix
Abstract base class for banded matrices
Banded matrix implementations are assumed to store their data efficiently in diagonal bands,
so functions on banded matrices are designed to exploit this fact.
|
class |
ABlockMatrix
Abstract base class for a large matrix constructed out of regular subMatrix blocks
|
class |
ABooleanMatrix |
class |
ADenseArrayMatrix
Abstract base class for matrices wrapping a dense (rows*cols) subset of a double[] array
|
class |
ADiagonalMatrix
Abstract base class for square diagonal matrices
|
class |
AMatrixSubVector
Abstract class for matrix sub vector views (rows and columns etc.)
|
class |
AStridedMatrix |
class |
AVectorMatrix<T extends AVector>
Abstract base class for matrices that use a collection of Vectors
as storage for the matrix rows.
|
class |
BandedMatrix
Sparse banded matrix implementation.
|
class |
BroadcastVectorMatrix
Specialised class representing the broadcasting of a vector to a matrix shape
|
class |
ColumnMatrix
Matrix class that wraps a vector as a 1-columns matrix
|
class |
DiagonalMatrix
Specialised diagonal matrix class
Not fully mutable - only the diagonal values can be changed
|
class |
IdentityMatrix
Specialised identity matrix class.
|
class |
MatrixColumnView
A class representing a view of a matrix column as a vector
|
class |
MatrixRowView
A class representing a view of a matrix row as a vector
|
class |
PermutationMatrix |
class |
PermutedMatrix
Reference matrix class representing a permutation of a matrix
|
class |
QuadtreeMatrix
A matrix implemented as a quadtree of submatrices.
|
class |
RowMatrix
Matrix class that wraps a vector as a 1-row matrix
|
class |
ScalarMatrix
Scalar matrix class - i.e.
|
class |
StridedMatrix |
class |
SubsetMatrix
Matrix that transforms to a selection of specific elements of the source vector
i.e.
|
class |
TransposedMatrix
Class representing a transposed view of another matrix The transposed matrix
is a reference to the underlying matrix data
|
class |
VectorMatrixM3
Specialised N*3 Matrix with Vector3 row components
|
class |
VectorMatrixMN
A matrix implemented as a composition of M length N vectors
|
class |
ZeroMatrix
Lightweight immutable zero matrix class
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
IScalar
Interface for scalar array objects
|
interface |
IVector
Basic interface for a Vector
Implementations should normally extend AVector directly, which implements IVector plus
a considerable amount of other important functionality.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AScalar
Class to represent a wrapped 0-d scalar value.
|
class |
AVector
Main abstract base class for all types of vector
Contains default implementations for most vector operations which can be
overriden to achieve better performance in derived classes.
|
class |
BitVector
Vector of bits - constrained to 0.0 / 1.0 values
Intended for compact representation/storage of binary vectors
|
class |
GrowableVector
Implements a growable vector, intended for incrementally building vectors
Note that getting the underlying array or a subVector is unsafe, since the
underlying array may be discarded as the vector is grown.
|
class |
Scalar
Basic Scalar class containing a single mutable double value
|
class |
Vector
General purpose vector of arbitrary length, backed by an internal double[] array.
|
class |
Vector1
Specialised 1D vector
|
class |
Vector2
Specialised 2D vector
|
class |
Vector3
Specialised 3D vector
Represents a point in 3D x,y,z space.
|
class |
Vector4
Specialised 4D vector
|
| Modifier and Type | Method and Description |
|---|---|
INDArray |
AVector.broadcast(int... targetShape) |
INDArray |
AScalar.broadcast(int... targetShape) |
INDArray |
AVector.broadcastLike(AMatrix target) |
INDArray |
AVector.broadcastLike(INDArray target) |
INDArray |
AVector.innerProduct(INDArray a) |
INDArray |
AScalar.innerProduct(INDArray a) |
INDArray |
AVector.outerProduct(INDArray a) |
INDArray |
AScalar.outerProduct(INDArray a) |
INDArray |
AVector.reshape(int... dimensions) |
INDArray |
AScalar.reshape(int... dimensions) |
INDArray |
AScalar.slice(int position) |
INDArray |
AScalar.slice(int dimension,
int index) |
| Modifier and Type | Method and Description |
|---|---|
void |
AVector.add(INDArray a) |
void |
AScalar.add(INDArray a) |
void |
Op.applyTo(INDArray a) |
INDArray |
AVector.broadcastLike(INDArray target) |
void |
AVector.divide(INDArray a) |
boolean |
AVector.epsilonEquals(INDArray a) |
boolean |
AScalar.epsilonEquals(INDArray a) |
boolean |
AVector.epsilonEquals(INDArray a,
double tolerance) |
boolean |
AScalar.epsilonEquals(INDArray a,
double epsilon) |
boolean |
AVector.equals(INDArray v) |
boolean |
AScalar.equals(INDArray o) |
static double[] |
Tools.getElements(INDArray a) |
INDArray |
AVector.innerProduct(INDArray a) |
INDArray |
AScalar.innerProduct(INDArray a) |
boolean |
AVector.isSameShape(INDArray a) |
void |
AVector.multiply(INDArray a) |
void |
AScalar.multiply(INDArray a) |
INDArray |
AVector.outerProduct(INDArray a) |
INDArray |
AScalar.outerProduct(INDArray a) |
void |
AVector.set(INDArray a) |
void |
AVector.sub(INDArray a) |
void |
AScalar.sub(INDArray a) |
| Modifier and Type | Class and Description |
|---|---|
class |
AArrayVector
Base class for vectors backed by a double[] array with a fixed stride of 1
The double array can be directly accessed for performance purposes
|
class |
ABitVector
Abstract base class for bit vectors
Bit vectors only support two element values, 0.0 and 1.0
|
class |
AComputedVector
Base class for computed vectors.
|
class |
AConstrainedVector
Abstract base class for vectors that have constrained values.
|
class |
ADerivedVector
Derived vector delegates all calls to an underlying vector
|
class |
AMatrixViewVector
Abstract Vector class representing a view over a matrix
Supports arbitrary indexing into the underlying matrix
|
class |
APrimitiveVector
Abstract base class for specialised primitive vectors
|
class |
ArrayIndexScalar |
class |
ArraySubVector
Vector referring to an offset into a double[] array
|
class |
ASparseVector
Abstract base class for Sparse vector implementations
|
class |
AStridedVector
Abstract base class for vectors backed by a double[] array with a constant stride
The double array can be directly accessed for performance purposes
|
class |
AWrappedVector<T>
Abstract base class for vectors that wrap an underlying object
|
class |
AxisVector
Specialized unit axis vector.
|
class |
DoubleScalar
Deprecated.
|
class |
ImmutableScalar |
class |
ImmutableVector
Immutable array-backed vector.
|
class |
IndexedArrayVector
Vector that addresses elements indexed into double[] array
|
class |
IndexedSubVector
Vector that addresses elements indexed into another source vector
|
class |
IndexVector
A constrained vector implementation wrapping an integer Index
|
class |
JoinedArrayVector
Class representing a join of one or more array subvectors
|
class |
JoinedVector
A vector that represents the concatenation of two vectors.
|
class |
MatrixBandVector
Vector class representing a matrix band
|
class |
RepeatedElementVector
A mutable vector that always has a single repeated component.
|
class |
SingleElementVector
A sparse mutable vector that has a only one element that can be non-zero.
|
class |
SparseIndexedVector
Indexed sparse vector.
|
class |
StridedVector |
class |
UnmodifiableVector |
class |
Vector0
Special singleton zero length vector class.
|
class |
VectorIndexScalar |
class |
WrappedScalarVector
A length 1 vector, as a view wrapping a single AScalar
Main purpose is to provide an efficient view for AScalar.asVector()
|
class |
WrappedSubVector |
class |
ZeroVector
Specialised immuatble vector containing nothing but zeros.
|
| Modifier and Type | Method and Description |
|---|---|
INDArray |
AStridedVector.broadcast(int... shape) |
INDArray |
AStridedVector.broadcastLike(AMatrix target) |
INDArray |
AStridedVector.broadcastLike(INDArray target) |
| Modifier and Type | Method and Description |
|---|---|
INDArray |
AStridedVector.broadcastLike(INDArray target) |
| Modifier and Type | Method and Description |
|---|---|
void |
Sqrt.applyTo(INDArray a) |
void |
Signum.applyTo(INDArray v) |
void |
Reciprocal.applyTo(INDArray a) |
void |
Power.applyTo(INDArray a) |
void |
Offset.applyTo(INDArray v) |
void |
Log.applyTo(INDArray a) |
void |
Linear.applyTo(INDArray v) |
void |
Exp.applyTo(INDArray a) |
void |
Constant.applyTo(INDArray v) |
void |
Clamp.applyTo(INDArray v) |
void |
ALinearOp.applyTo(INDArray a) |
void |
Absolute.applyTo(INDArray v) |
| Modifier and Type | Method and Description |
|---|---|
static INDArray |
Testing.fillRandom(INDArray a,
mikera.util.Random r)
Fills an array with random values in the [0..1) range.
|
| Modifier and Type | Method and Description |
|---|---|
static INDArray |
Testing.fillRandom(INDArray a,
mikera.util.Random r)
Fills an array with random values in the [0..1) range.
|
static String |
ErrorMessages.incompatibleBroadcast(INDArray a,
int... shape)
Returns an error message indicating that a broadcast is not possible
e.g.
|
static String |
ErrorMessages.incompatibleShape(INDArray m) |
static String |
ErrorMessages.incompatibleShapes(INDArray a,
INDArray b)
Returns an error message indicating that two arrays have incompatible shapes.
|
static String |
ErrorMessages.invalidDimension(INDArray a,
int dimension) |
static String |
ErrorMessages.invalidIndex(INDArray a,
int... indexes) |
static String |
ErrorMessages.invalidSlice(INDArray a,
int slice) |
static String |
ErrorMessages.mismatch(INDArray a,
INDArray b)
Returns an error message indicating that two arrays have different sizes
|
static String |
ErrorMessages.noSlices(INDArray a) |
static boolean |
Testing.validateFullyMutable(INDArray m) |
Copyright © 2013. All Rights Reserved.