mikera.vectorz.impl

Class AxisVector

java.lang.Object

mikera.arrayz.AbstractArray<Double>

mikera.vectorz.AVector

mikera.vectorz.impl.ComputedVector

mikera.vectorz.impl.AxisVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>, Iterable<Double>, INDArray, ISparse, IVector

public class AxisVector
extends ComputedVector
implements ISparse

Specialized unit axis vector. Has a 1.0 in one element, 0.0 everywhere else.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AxisVector(int axisIndex, int length)

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Sets each component of the vector to its absolute value
static AxisVector	create(int axisIndex, int dimensions)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	dotProduct(AVector v)
double	dotProduct(Vector2 v)
double	dotProduct(Vector3 v)
double	elementSum() Returns the sum of all elements in a vector
AxisVector	exactClone() Returns an exact clone of this vector, i.e.
double	get(int i) Returns the double value at the specified position in a 1D vector
boolean	isMutable() Returns true if this vector is mutable.
boolean	isUnitLengthVector() Returns true if the vector has unit length
boolean	isZeroVector() Returns true if this vector is a zero vector (all components zero)
int	length()
double	magnitude() Returns the magnitude (Euclidean length) of the vector
double	magnitudeSquared()
long	nonZeroCount() Returns the number of non-zero elements in the array.
double	normalise() Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e.
void	signum() Sets each component of the vector 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 vector
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.vectorz.impl.ComputedVector

set

Methods inherited from class mikera.vectorz.AVector

add, add, add, add, add, add, addAt, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultiple, addMultipleToArray, addProduct, addProduct, addProduct, addProductToArray, addProductToArray, addToArray, addToArray, addWeighted, angle, applyOp, applyOp, asElementList, asVector, broadcast, clamp, clampMax, clampMin, clone, compareTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, countZeros, crossProduct, dimensionality, distance, distanceL1, distanceLinf, distanceSquared, divide, divide, divide, divideTo, dotProduct, elementCount, elementSquaredSum, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, fill, fillRange, get, getElements, getLongShape, getShape, getShape, getSlices, getTranspose, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, interpolate, interpolate, isElementConstrained, isFullyMutable, isView, iterator, join, log, maxAbsElement, multiply, multiply, multiply, multiply, multiplyTo, negate, normaliseMaxAbsElement, outerProduct, outerProduct, pow, projectToPlane, reshape, scale, scaleAdd, scaleAdd, scaleToMagnitude, set, set, set, set, set, set, set, set, set, setElements, setElements, setValues, slice, slice, sliceCount, sub, sub, sub, subMultiple, subVector, toArray, toDoubleBuffer, toList, toString, toVector

Methods inherited from class mikera.arrayz.AbstractArray

epsilonEquals, epsilonEquals, exp, get, get, getSliceViews, reciprocal, scale, set, set

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

epsilonEquals, epsilonEquals, exp, get, get, getSliceViews, reciprocal, scale, set, set

Constructor Detail

AxisVector

public AxisVector(int axisIndex,
          int length)

Method Detail

create

public static AxisVector create(int axisIndex,
                int dimensions)

length

public int length()

Specified by:

length in interface IVector

Specified by:

length in class ComputedVector

magnitude

public double magnitude()

Description copied from class: AVector

Returns the magnitude (Euclidean length) of the vector

Overrides:

magnitude in class AVector

Returns:

magnitudeSquared

public double magnitudeSquared()

Overrides:

magnitudeSquared in class AVector

normalise

public double normalise()

Description copied from class: AVector

Normalises this vector to a magnitude of 1.0 Has no effect on a zero-length vector (i.e. it will remain zero)

Overrides:

normalise in class AVector

Returns:

square

public void square()

Description copied from class: AVector

Squares all elements of the vector

Specified by:

square in interface INDArray

Overrides:

square in class AVector

abs

public void abs()

Description copied from class: AVector

Sets each component of the vector to its absolute value

Specified by:

abs in interface INDArray

Overrides:

abs 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<Double>

signum

public void signum()

Description copied from class: AVector

Sets each component of the vector to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AVector

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

Returns:

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 AVector

Returns:

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 ComputedVector

Returns:

isZeroVector

public boolean isZeroVector()

Description copied from class: AVector

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

Overrides:

isZeroVector in class AVector

Returns:

isUnitLengthVector

public boolean isUnitLengthVector()

Description copied from class: AVector

Returns true if the vector has unit length

Overrides:

isUnitLengthVector in class AVector

Returns:

dotProduct

public double dotProduct(AVector v)

Overrides:

dotProduct in class AVector

dotProduct

public double dotProduct(Vector3 v)

dotProduct

public double dotProduct(Vector2 v)

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

Specified by:

get in class ComputedVector

Returns:

exactClone

public AxisVector 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

Overrides:

exactClone in class ComputedVector

Returns:

density

public double density()

Description copied from interface: ISparse

Computes the density ratio of this sparse array (proportion of non-zero elements)

Specified by:

density in interface ISparse

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 AVector