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
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)
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()
double	normalise()
void	square()
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

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

Methods inherited from class mikera.arrayz.AbstractArray

get, get, scale, set, set, setElements

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

get, get, scale, set, set, setElements

Constructor Detail

AxisVector

public AxisVector(int axisIndex,
          int length)

Method Detail

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()

Overrides:

normalise in class AVector

square

public void square()

Overrides:

square in class AVector

elementSum

public double elementSum()

Description copied from class: AVector

Returns the sum of all elements in a vector

Overrides:

elementSum 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)

Specified by:

get in interface INDArray

Specified by:

get in interface IVector

Specified by:

get in class ComputedVector

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