AVector (vectorz 0.1.1 API)

java.lang.Object
- mikera.vectorz.AVector

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AVector>

Direct Known Subclasses:

APrimitiveVector, ArrayVector, IndexedArrayVector, IndexedSubVector, JoinedVector, MatrixSubVector, WrappedSubVector
```
public abstract class AVector
extends Object
implements Cloneable, Comparable<AVector>, Serializable
```
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.

Author:

Mike

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

AVector()

Constructors
Constructor and Description
`AVector()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`absolute()`
`void`	`add(AVector v)` Adds another vector to this one
`void`	`addMultiple(AVector v, double factor)` Adds a scaled multiple of another vector to this one
`double`	`angle(AVector v)` Returns the euclidean angle between this vector and another vector
`void`	`clamp(double min, double max)` Clamps all values in the vector to a given range
`void`	`clampMax(double max)`
`void`	`clampMin(double min)`
`AVector`	`clone()` Clones the vector, creating a new copy of all data.
`int`	`compareTo(AVector a)`
`void`	`copy(int start, int length, AVector dest, int destOffset)` Copies a suset of this vector to a vector at the specified offset
`void`	`copyTo(AVector dest, int offset)` Copies a the contents of a vector to a vector at the specified offset
`void`	`copyTo(double[] data, int offset)` Copies a the contents of a vector to a double array at the specified offset
`double`	`distance(AVector v)`
`double`	`distanceL1(AVector v)`
`double`	`distanceLinf(AVector v)`
`double`	`distanceSquared(AVector v)`
`double`	`dotProduct(AVector v)`
`boolean`	`epsilonEquals(AVector v)`
`boolean`	`epsilonEquals(AVector v, double tolerance)`
`boolean`	`equals(Object o)` Test for equality on vectors.
`void`	`fill(double value)` Fills a vector with a given value
`abstract double`	`get(int i)`
`int`	`hashCode()`
`void`	`interpolate(AVector a, AVector b, double alpha)`
`void`	`interpolate(AVector v, double alpha)`
`boolean`	`isMutable()` Returns true if this vector is mutable.
`boolean`	`isReference()` Returns true if this vector is of a type that references other vectors / data.
`boolean`	`isUnitLengthVector()` Returns true if the vector has unit length
`boolean`	`isZeroVector()` Returns true if this vector is a zero vector (all components zero)
`AVector`	`join(AVector second)` Returns a new vector that refers to this vector joined to a second vector
`abstract int`	`length()`
`double`	`magnitude()` Returns the magnitude (Euclidean length) of the vector
`double`	`magnitudeSquared()`
`void`	`multiply(double factor)` Multiplies the vector by a constant factor
`void`	`negate()`
`void`	`normalise()`
`void`	`projectToPlane(AVector normal, double distance)`
`void`	`scale(double factor)`
`void`	`scaleAdd(double factor, AVector v)`
`void`	`set(AVector a)` Sets the vector to equal the value of another vector
`abstract void`	`set(int i, double value)`
`void`	`setValues(double... values)`
`void`	`sub(AVector v)` Subtracts a vector from this vector
`void`	`subMultiple(AVector v, double factor)` Subtracts a scaled multiple of another vector from this vector
`AVector`	`subVector(int offset, int length)` Obtains a sub-vector that refers to this vector.
`double[]`	`toArray()`
`List<Double>`	`toList()`
`String`	`toString()`

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

- Constructor Detail
  - AVector
```
public AVector()
```
- Method Detail
  - length
```
public abstract int length()
```
  - get
```
public abstract double get(int i)
```
  - set
```
public abstract void set(int i,
       double value)
```
  - subVector
```
public AVector subVector(int offset,
                int length)
```
    Obtains a sub-vector that refers to this vector. Changes to the sub-vector will be reflected in this vector
  - join
```
public AVector join(AVector second)
```
    Returns a new vector that refers to this vector joined to a second vector
    
    Parameters:
    second -
    
    Returns:
  - compareTo
```
public int compareTo(AVector a)
```
    Specified by:
    
    compareTo in interface Comparable<AVector>
  - equals
```
public boolean equals(Object o)
```
    Test for equality on vectors. Returns true iff all values in the vector are identical
    
    Overrides:
    
    equals in class Object
  - toList
```
public List<Double> toList()
```
  - epsilonEquals
```
public boolean epsilonEquals(AVector v)
```
  - epsilonEquals
```
public boolean epsilonEquals(AVector v,
                    double tolerance)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - copyTo
```
public void copyTo(double[] data,
          int offset)
```
    Copies a the contents of a vector to a double array at the specified offset
  - toArray
```
public double[] toArray()
```
  - copyTo
```
public void copyTo(AVector dest,
          int offset)
```
    Copies a the contents of a vector to a vector at the specified offset
  - copy
```
public void copy(int start,
        int length,
        AVector dest,
        int destOffset)
```
    Copies a suset of this vector to a vector at the specified offset
  - fill
```
public void fill(double value)
```
    Fills a vector with a given value
    
    Parameters:
    value -
  - clamp
```
public void clamp(double min,
         double max)
```
    Clamps all values in the vector to a given range
    
    Parameters:
    value -
  - clampMax
```
public void clampMax(double max)
```
  - clampMin
```
public void clampMin(double min)
```
  - multiply
```
public void multiply(double factor)
```
    Multiplies the vector by a constant factor
    
    Parameters:
    factor - Factor by which to multiply each component of the vector
  - absolute
```
public void absolute()
```
  - scale
```
public void scale(double factor)
```
  - scaleAdd
```
public void scaleAdd(double factor,
            AVector v)
```
  - interpolate
```
public void interpolate(AVector v,
               double alpha)
```
  - interpolate
```
public void interpolate(AVector a,
               AVector b,
               double alpha)
```
  - magnitudeSquared
```
public double magnitudeSquared()
```
  - dotProduct
```
public double dotProduct(AVector v)
```
  - magnitude
```
public double magnitude()
```
    Returns the magnitude (Euclidean length) of the vector
    
    Returns:
  - distanceSquared
```
public double distanceSquared(AVector v)
```
  - distance
```
public double distance(AVector v)
```
  - distanceL1
```
public double distanceL1(AVector v)
```
  - distanceLinf
```
public double distanceLinf(AVector v)
```
  - angle
```
public double angle(AVector v)
```
    Returns the euclidean angle between this vector and another vector
    
    Returns:
    angle in radians
  - normalise
```
public void normalise()
```
  - negate
```
public void negate()
```
  - set
```
public void set(AVector a)
```
    Sets the vector to equal the value of another vector
  - setValues
```
public void setValues(double... values)
```
  - clone
```
public AVector clone()
```
    Clones the vector, creating a new copy of all data. The clone is: - not guaranteed to be of the same type. - guaranteed to be fully mutable - guaranteed not to contain a reference (i.e. is a full deep copy)
    
    Overrides:
    
    clone in class Object
  - isReference
```
public boolean isReference()
```
    Returns true if this vector is of a type that references other vectors / data.
    
    Returns:
  - isMutable
```
public boolean isMutable()
```
    Returns true if this vector is mutable.
    
    Returns:
  - add
```
public void add(AVector v)
```
    Adds another vector to this one
    
    Parameters:
    v -
  - addMultiple
```
public void addMultiple(AVector v,
               double factor)
```
    Adds a scaled multiple of another vector to this one
    
    Parameters:
    v -
  - sub
```
public void sub(AVector v)
```
    Subtracts a vector from this vector
    
    Parameters:
    v -
  - isZeroVector
```
public boolean isZeroVector()
```
    Returns true if this vector is a zero vector (all components zero)
    
    Returns:
  - isUnitLengthVector
```
public boolean isUnitLengthVector()
```
    Returns true if the vector has unit length
    
    Returns:
  - projectToPlane
```
public void projectToPlane(AVector normal,
                  double distance)
```
  - subMultiple
```
public void subMultiple(AVector v,
               double factor)
```
    Subtracts a scaled multiple of another vector from this vector
    
    Parameters:
    v -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AVector

Method Detail

length

get

set

subVector

join

compareTo

equals

toList

epsilonEquals

epsilonEquals

hashCode

copyTo

toArray

copyTo

copy

fill

clamp

clampMax

clampMin

multiply

absolute

scale

scaleAdd

interpolate

interpolate

magnitudeSquared

dotProduct

magnitude

distanceSquared

distance

distanceL1

distanceLinf

angle

normalise

negate

set

setValues

clone

isReference

isMutable

add

addMultiple

sub

isZeroVector

isUnitLengthVector

projectToPlane

subMultiple

toString