mikera.vectorz.impl

Class MatrixViewVector

java.lang.Object

mikera.arrayz.impl.AbstractArray<java.lang.Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ASizedVector

mikera.vectorz.impl.AMatrixViewVector

mikera.vectorz.impl.MatrixViewVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<java.lang.Double>, INDArray, IVector

public class MatrixViewVector
extends AMatrixViewVector

Specialised class for viewing a matrix as a flattened vector

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MatrixViewVector(AMatrix a)

Method Summary

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	addToArray(double[] data, int offset) Adds this vector to a double[] array, starting at the specified offset.
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
java.util.List<java.lang.Double>	asElementList() Returns a List containing all elements of this array
void	clamp(double min, double max) Clamps all values in the vector to a given range
double	dotProduct(double[] data, int offset) Fast dot product with a double[] array.
double	elementSquaredSum() Returns the sum of squared elements in this array.
double	elementSum() Returns the sum of all elements in a vector
boolean	equalsArray(double[] data, int offset) Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset
AVector	exactClone() Returns an exact clone of this vector, i.e.
void	exp() Computes the function e^x (in-place) for all array elements
void	fill(double value) Fills the entire vector with a given value
double	get(int i) Returns the double value at the specified position in a 1D vector
void	getElements(double[] data, int offset) Copies all elements of this array a double array at the specified offset
boolean	isFullyMutable() Returns true if this vector is fully mutable, i.e.
boolean	isMutable() Returns true if this vector is mutable.
boolean	isSparse() Returns true if the array is in a sparse format
boolean	isView() Returns true if this vector is of a view type that references other vectors / data.
boolean	isZero() Returns true if this vector is a zero vector (all components zero)
void	log() Computes the natural logarithm (in-place) for all array elements
void	negate() Negates all emlements of this vector in place.
void	pow(double exponent) Raises all elements of the array to a specified power in place
void	set(int i, double value) Sets a value at a given position in a mutable 1D array
void	signum() Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
void	sqrt() Computes the square root of all elements in the array
void	square() Squares all elements of the array in place
AVector	subVector(int start, int length) Obtains a sub-vector view that refers to this vector.
double	unsafeGet(int i) Like get, but performs no bounds checking.
void	unsafeSet(int i, double value) Like set, but performs no bounds checking.

Methods inherited from class mikera.vectorz.impl.AMatrixViewVector

addAt, dotProduct, equals, slice

Methods inherited from class mikera.vectorz.impl.ASizedVector

checkIndex, checkLength, checkRange, elementCount, equalsArray, get, getShape, getShapeClone, isSameShape, length, sliceCount, visitNonZero

Methods inherited from class mikera.vectorz.AVector

absCopy, absDiff, absDiff, absDiff, absDiffCopy, add, add, add, add, add, add, add, add, add, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleCopy, addMultipleSparse, addMultipleSparse, addMultipleToArray, addMultipleToArray, addPower, addPower, addProduct, addProduct, addProduct, addProductCopy, addProductCopy, addProductToArray, addProductToArray, addSparse, addSparse, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asVector, broadcast, broadcastLike, broadcastLike, broadcastLike, clampMax, clampMin, clone, compareTo, compareTo, copy, copyTo, copyTo, copyTo, copyTo, copyTo, crossProduct, crossProduct, dense, denseClone, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divide, divideCopy, divideCopy, divideCopy, divideTo, dotProduct, dotProduct, dotProduct, elementAbsPowSum, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, fillRange, get, get, get, get, get, getElement, getElements, getElements, getLongShape, getShape, getSlices, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, interpolate, isElementConstrained, isRangeZero, isSameShape, isUnitLengthVector, isUnitLengthVector, iterator, join, join, join, logistic, magnitude, magnitudeSquared, maxAbsElement, maxAbsElementIndex, maxElement, maxElementIndex, minElement, minElementIndex, multiply, multiply, multiply, multiply, multiply, multiplyCopy, multiplyCopy, multiplyCopy, multiplyTo, mutable, negateCopy, nonSparseIndex, nonZeroCount, nonZeroIndices, nonZeroValues, normalise, normaliseCopy, normaliseMaxAbsElement, outerProduct, outerProduct, projectToPlane, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateCopy, rotateView, rotateView, scale, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleCopy, scaleToMagnitude, select, selectClone, selectView, set, set, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setApplyOp, setElements, setElements, setElements, setInnerProduct, setInnerProduct, setInnerProduct, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, setSparse, shiftCopy, slice, sliceValue, softmax, softmaxCopy, sparse, sparseClone, sqrtCopy, squareCopy, sub, sub, subArray, subAt, subCopy, subCopy, subMultiple, tanh, toDoubleArray, toDoubleBuffer, toList, toNormal, toSliceArray, toString, toStringFull, toVector, tryEfficientJoin, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, addApplyOp, addCopy, addInnerProduct, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, density, ensureMutable, epsilonEquals, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, scale, set, set, signumCopy, sub, sub, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

addApplyOp, addInnerProduct, addOuterProduct, addOuterProductSparse, addSparse, broadcastCloneLike, broadcastCopyLike, componentCount, ensureMutable, epsilonEquals, get, get, getComponent, getComponents, getElements, getElements, getSlices, getSliceViews, isBoolean, isDense, scale, set, set, signumCopy, sub, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MatrixViewVector

public MatrixViewVector(AMatrix a)

Method Detail

get

public double get(int i)

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 interface IVector

Overrides:

get in class AMatrixViewVector

set

public void set(int i,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 1D array

Specified by:

set in interface INDArray

Specified by:

set in interface IVector

Overrides:

set in class AMatrixViewVector

unsafeGet

public double unsafeGet(int i)

Description copied from class: AVector

Like get, but performs no bounds checking. Results are undefined if the index is out of range

Overrides:

unsafeGet in class AMatrixViewVector

unsafeSet

public void unsafeSet(int i,
                      double value)

Description copied from class: AVector

Like set, but performs no bounds checking. Results are undefined if the index is out of range

Overrides:

unsafeSet in class AMatrixViewVector

exactClone

public AVector exactClone()

Description copied from class: AVector

Returns an exact clone of this vector, i.e. of the same type

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AVector

Returns:

A clone of the original array

isFullyMutable

public boolean isFullyMutable()

Description copied from class: AVector

Returns true if this vector is fully mutable, i.e. can contain any unconstrained double values

Specified by:

isFullyMutable in interface INDArray

Overrides:

isFullyMutable in class AVector

isMutable

public boolean isMutable()

Description copied from class: AVector

Returns true if this vector is mutable.

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AVector

isView

public boolean isView()

Description copied from class: AVector

Returns true if this vector is of a view type that references other vectors / data.

Specified by:

isView in interface INDArray

Overrides:

isView in class AVector

fill

public void fill(double value)

Description copied from class: AVector

Fills the entire vector with a given value

Specified by:

fill in interface INDArray

Overrides:

fill in class AVector

isSparse

public boolean isSparse()

Description copied from interface: INDArray

Returns true if the array is in a sparse format

Specified by:

isSparse in interface INDArray

Overrides:

isSparse in class AbstractArray<java.lang.Double>

isZero

public boolean isZero()

Description copied from class: AVector

Returns true if this vector is a zero vector (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AVector

getElements

public void getElements(double[] data,
                        int offset)

Description copied from interface: INDArray

Copies all elements of this array a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AMatrixViewVector

asElementList

public java.util.List<java.lang.Double> asElementList()

Description copied from interface: INDArray

Returns a List containing all elements of this array

Specified by:

asElementList in interface INDArray

Overrides:

asElementList in class AVector

addToArray

public void addToArray(double[] data,
                       int offset)

Description copied from class: AVector

Adds this vector to a double[] array, starting at the specified offset.

Specified by:

addToArray in interface INDArray

Overrides:

addToArray in class AVector

clamp

public void clamp(double min,
                  double max)

Description copied from class: AVector

Clamps all values in the vector to a given range

Specified by:

clamp in interface INDArray

Overrides:

clamp in class AVector

equalsArray

public boolean equalsArray(double[] data,
                           int offset)

Description copied from class: AVector

Returns true if this vector exactly matches the elements in double[] array, starting from the specified offset

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class ASizedVector

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns:

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AVector

elementSquaredSum

public double elementSquaredSum()

Description copied from interface: INDArray

Returns the sum of squared elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AVector

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 AVector

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AVector

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AVector

negate

public void negate()

Description copied from class: AVector

Negates all emlements of this vector in place.

Specified by:

negate in interface INDArray

Overrides:

negate in class AVector

exp

public void exp()

Description copied from interface: INDArray

Computes the function e^x (in-place) for all array elements

Specified by:

exp in interface INDArray

Overrides:

exp in class AbstractArray<java.lang.Double>

log

public void log()

Description copied from interface: INDArray

Computes the natural logarithm (in-place) for all array elements

Specified by:

log in interface INDArray

Overrides:

log in class AVector

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array in place

Specified by:

square in interface INDArray

Overrides:

square in class AVector

sqrt

public void sqrt()

Description copied from interface: INDArray

Computes the square root of all elements in the array

Specified by:

sqrt in interface INDArray

Overrides:

sqrt in class AbstractArray<java.lang.Double>

pow

public void pow(double exponent)

Description copied from interface: INDArray

Raises all elements of the array to a specified power in place

Specified by:

pow in interface INDArray

Overrides:

pow in class AVector

subVector

public AVector subVector(int start,
                         int length)

Description copied from class: AVector

Obtains a sub-vector view that refers to this vector. Changes to the sub-vector will be reflected in this vector

Overrides:

subVector in class AVector

dotProduct

public double dotProduct(double[] data,
                         int offset)

Description copied from class: AVector

Fast dot product with a double[] array. Performs no bounds checking. Likely to be faster than most other dot product operations

Specified by:

dotProduct in class AVector