AbstractVectorSpace (Cognitive Foundry)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.sandia.cognition.math.matrix
Class AbstractVectorSpace<VectorType extends VectorSpace<VectorType,? extends EntryType>,EntryType extends VectorSpace.Entry>

java.lang.Object
  gov.sandia.cognition.util.AbstractCloneableSerializable
      gov.sandia.cognition.math.AbstractRing<VectorType>
          gov.sandia.cognition.math.matrix.AbstractVectorSpace<VectorType,EntryType>


Type Parameters:: VectorType - Type of VectorSpace; EntryType - Type of Entry in the VectorSpace

All Implemented Interfaces:: VectorSpace<VectorType,EntryType>, Ring<VectorType>, CloneableSerializable, Serializable, Cloneable, Iterable<EntryType>

Direct Known Subclasses:: AbstractVector

public abstract class AbstractVectorSpace<VectorType extends VectorSpace<VectorType,? extends EntryType>,EntryType extends VectorSpace.Entry>
extends AbstractRing<VectorType>
implements VectorSpace<VectorType,EntryType>
extends AbstractRing<VectorType>
implements VectorSpace<VectorType,EntryType>

Partial implementation of VectorSpace

Since:: 3.3.1
Author:: Kevin R. Dixon
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface gov.sandia.cognition.math.matrix.VectorSpace
`VectorSpace.Entry`

Constructor Summary
`AbstractVectorSpace()` Creates a new instance of AbstractVectorSpace

Method Summary
`double`	`angle(VectorType other)` Computes the angle between two Vectors.
`double`	`cosine(VectorType other)` Computes the cosine between two Vectors
`boolean`	`equals(Object other)` Determines if two RingType objects are equal
`boolean`	`equals(VectorType other, double effectiveZero)` Determines if two RingType objects are effectively equal
`double`	`euclideanDistance(VectorType other)` Euclidean distance between `this` and `other`, which is the 2-norm between the difference of the Vectors
`boolean`	`isUnitVector()` Determines if this vector is a unit vector (norm2 = 1.0).
`boolean`	`isUnitVector(double tolerance)` Determines if this vector is a unit vector within some tolerance for the 2-norm.
`boolean`	`isZero(double effectiveZero)` Determines if this ring is equal to zero using the element-wise effective zero value.
`double`	`norm(double power)` Returns the p-norm of the Vector with the given power.
`double`	`norm1()` 1-norm of the vector (sum of absolute values in the vector)
`double`	`norm2()` 2-norm of the vector (aka Euclidean distance of the vector)
`double`	`norm2Squared()` Squared 2-norm of the vector (aka squared Euclidean distance of the vector)
`double`	`normInfinity()` Returns the infinity norm of the Vector, which is the maximum absolute value of an element in the Vector.
`void`	`scaleEquals(double scaleFactor)` Inline element-wise scaling of `this` by `scaleFactor`
`double`	`sum()` Computes the sum of the elements in the vector.
`VectorType`	`unitVector()` Returns the unit vector of this vector.
`void`	`unitVectorEquals()` Modifies this vector to be a the unit vector.

Methods inherited from class gov.sandia.cognition.math.AbstractRing
`clone, dotTimes, isZero, minus, negative, negativeEquals, plus, scale, scaledMinus, scaledMinusEquals, scaledPlus, zero`

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

Methods inherited from interface gov.sandia.cognition.math.matrix.VectorSpace
`dotProduct, euclideanDistanceSquared`

Methods inherited from interface gov.sandia.cognition.math.Ring
`clone, dotTimes, dotTimesEquals, isZero, minus, minusEquals, negative, negativeEquals, plus, plusEquals, scale, scaledMinus, scaledMinusEquals, scaledPlus, scaledPlusEquals, zero`

Methods inherited from interface java.lang.Iterable
`iterator`

Constructor Detail

AbstractVectorSpace

public AbstractVectorSpace()

Creates a new instance of AbstractVectorSpace

Method Detail

equals

public boolean equals(Object other)

Description copied from interface: Ring

Determines if two RingType objects are equal

Specified by:: equals in interface Ring<VectorType extends VectorSpace<VectorType,? extends EntryType>>
Overrides:: equals in class Object

Parameters:: other - RingType to compare against this
Returns:: True if the two objects are equal, false otherwise