ArrayRealVector (Commons Math 3.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.math3.linear
Class ArrayRealVector

java.lang.Object
  org.apache.commons.math3.linear.RealVector
      org.apache.commons.math3.linear.ArrayRealVector

All Implemented Interfaces:: Serializable

public class ArrayRealVector
extends RealVector
implements Serializable
extends RealVector
implements Serializable

This class implements the RealVector interface with a double array.

Since:: 2.0
Version:: $Id: ArrayRealVector.java 1416643 2012-12-03 19:37:14Z tn $
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.math3.linear.RealVector
`RealVector.Entry, RealVector.SparseEntryIterator`

Constructor Summary
`ArrayRealVector()` Build a 0-length vector.
`ArrayRealVector(ArrayRealVector v)` Construct a vector from another vector, using a deep copy.
`ArrayRealVector(ArrayRealVector v1, ArrayRealVector v2)` Construct a vector by appending one vector to another vector.
`ArrayRealVector(ArrayRealVector v, boolean deep)` Construct a vector from another vector.
`ArrayRealVector(ArrayRealVector v1, double[] v2)` Construct a vector by appending one vector to another vector.
`ArrayRealVector(ArrayRealVector v1, RealVector v2)` Construct a vector by appending one vector to another vector.
`ArrayRealVector(double[] d)` Construct a vector from an array, copying the input array.
`ArrayRealVector(Double[] d)` Construct a vector from an array.
`ArrayRealVector(double[] v1, ArrayRealVector v2)` Construct a vector by appending one vector to another vector.
`ArrayRealVector(double[] d, boolean copyArray)` Create a new ArrayRealVector using the input array as the underlying data array.
`ArrayRealVector(double[] v1, double[] v2)` Construct a vector by appending one vector to another vector.
`ArrayRealVector(double[] d, int pos, int size)` Construct a vector from part of a array.
`ArrayRealVector(Double[] d, int pos, int size)` Construct a vector from part of an array.
`ArrayRealVector(int size)` Construct a vector of zeroes.
`ArrayRealVector(int size, double preset)` Construct a vector with preset values.
`ArrayRealVector(RealVector v)` Construct a vector from another vector, using a deep copy.
`ArrayRealVector(RealVector v1, ArrayRealVector v2)` Construct a vector by appending one vector to another vector.

Method Summary
`ArrayRealVector`	`add(RealVector v)` Compute the sum of this vector and `v`.
`void`	`addToEntry(int index, double increment)` Change an entry at the specified index.
`ArrayRealVector`	`append(ArrayRealVector v)` Construct a vector by appending a vector to this vector.
`RealVector`	`append(double in)` Construct a new vector by appending a double to this vector.
`RealVector`	`append(RealVector v)` Construct a new vector by appending a vector to this vector.
`protected void`	`checkVectorDimensions(int n)` Check if instance dimension is equal to some expected value.
`protected void`	`checkVectorDimensions(RealVector v)` Check if instance and specified vectors have the same dimension.
`ArrayRealVector`	`combine(double a, double b, RealVector y)` Returns a new vector representing `a * this + b * y`, the linear combination of `this` and `y`.
`ArrayRealVector`	`combineToSelf(double a, double b, RealVector y)` Updates `this` with the linear combination of `this` and `y`.
`ArrayRealVector`	`copy()` Returns a (deep) copy of this vector.
`double`	`dotProduct(RealVector v)` Compute the dot product of this vector with `v`.
`ArrayRealVector`	`ebeDivide(RealVector v)` Element-by-element division.
`ArrayRealVector`	`ebeMultiply(RealVector v)` Element-by-element multiplication.
`boolean`	`equals(Object other)` Test for the equality of two real vectors.
`double[]`	`getDataRef()` Get a reference to the underlying data array.
`int`	`getDimension()` Returns the size of the vector.
`double`	`getDistance(RealVector v)` Distance between two vectors.
`double`	`getEntry(int index)` Return the entry at the specified index.
`double`	`getL1Distance(RealVector v)` Distance between two vectors.
`double`	`getL1Norm()` Returns the L₁ norm of the vector.
`double`	`getLInfDistance(RealVector v)` Distance between two vectors.
`double`	`getLInfNorm()` Returns the L_∞ norm of the vector.
`double`	`getNorm()` Returns the L₂ norm of the vector.
`RealVector`	`getSubVector(int index, int n)` Get a subvector from consecutive elements.
`int`	`hashCode()` .
`boolean`	`isInfinite()` Check whether any coordinate of this vector is infinite and none are `NaN`.
`boolean`	`isNaN()` Check if any coordinate of this vector is `NaN`.
`ArrayRealVector`	`map(UnivariateFunction function)` Acts as if implemented as: return copy().mapToSelf(function); Returns a new vector.
`RealVector`	`mapAddToSelf(double d)` Add a value to each entry.
`RealVector`	`mapDivideToSelf(double d)` Divide each entry by the argument.
`RealVector`	`mapMultiplyToSelf(double d)` Multiply each entry.
`RealVector`	`mapSubtractToSelf(double d)` Subtract a value from each entry.
`ArrayRealVector`	`mapToSelf(UnivariateFunction function)` Acts as if it is implemented as: Entry e = null; for(Iterator it = iterator(); it.hasNext(); e = it.next()) { e.setValue(function.value(e.getValue())); } Entries of this vector are modified in-place by this method.
`RealMatrix`	`outerProduct(RealVector v)` Compute the outer product.
`void`	`set(double value)` Set all elements to a single value.
`void`	`setEntry(int index, double value)` Set a single element.
`void`	`setSubVector(int index, double[] v)` Set a set of consecutive elements.
`void`	`setSubVector(int index, RealVector v)` Set a sequence of consecutive elements.
`ArrayRealVector`	`subtract(RealVector v)` Subtract `v` from this vector.
`double[]`	`toArray()` Convert the vector to an array of `double`s.
`String`	`toString()`
`double`	`walkInDefaultOrder(RealVectorChangingVisitor visitor)` Visits (and possibly alters) all entries of this vector in default order (increasing index).
`double`	`walkInDefaultOrder(RealVectorChangingVisitor visitor, int start, int end)` Visits (and possibly alters) some entries of this vector in default order (increasing index).
`double`	`walkInDefaultOrder(RealVectorPreservingVisitor visitor)` Visits (but does not alter) all entries of this vector in default order (increasing index).
`double`	`walkInDefaultOrder(RealVectorPreservingVisitor visitor, int start, int end)` Visits (but does not alter) some entries of this vector in default order (increasing index).
`double`	`walkInOptimizedOrder(RealVectorChangingVisitor visitor)` Visits (and possibly alters) all entries of this vector in optimized order.
`double`	`walkInOptimizedOrder(RealVectorChangingVisitor visitor, int start, int end)` Visits (and possibly change) some entries of this vector in optimized order.
`double`	`walkInOptimizedOrder(RealVectorPreservingVisitor visitor)` Visits (but does not alter) all entries of this vector in optimized order.
`double`	`walkInOptimizedOrder(RealVectorPreservingVisitor visitor, int start, int end)` Visits (but does not alter) some entries of this vector in optimized order.

Methods inherited from class org.apache.commons.math3.linear.RealVector
`checkIndex, checkIndices, cosine, getMaxIndex, getMaxValue, getMinIndex, getMinValue, iterator, mapAdd, mapDivide, mapMultiply, mapSubtract, projection, sparseIterator, unitize, unitVector, unmodifiableRealVector`

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

Constructor Detail

ArrayRealVector

public ArrayRealVector()

Build a 0-length vector. Zero-length vectors may be used to initialized construction of vectors by data gathering. We start with zero-length and use either the ArrayRealVector(ArrayRealVector, ArrayRealVector) constructor or one of the append method (append(double), append(ArrayRealVector)) to gather data into this vector.

ArrayRealVector

public ArrayRealVector(int size)

Construct a vector of zeroes.

Parameters:: size - Size of the vector.

ArrayRealVector

public ArrayRealVector(int size,
                       double preset)

Construct a vector with preset values.

Parameters:: size - Size of the vector; preset - All entries will be set with this value.

ArrayRealVector

public ArrayRealVector(double[] d)

Construct a vector from an array, copying the input array.

Parameters:: d - Array.

ArrayRealVector

public ArrayRealVector(double[] d,
                       boolean copyArray)
                throws NullArgumentException

Create a new ArrayRealVector using the input array as the underlying data array. If an array is built specially in order to be embedded in a ArrayRealVector and not used directly, the copyArray may be set to false. This will prevent the copying and improve performance as no new array will be built and no data will be copied.

Parameters:: d - Data for the new vector.; copyArray - if true, the input array will be copied, otherwise it will be referenced.
Throws:: NullArgumentException - if d is null.
See Also:: ArrayRealVector(double[])

ArrayRealVector

public ArrayRealVector(double[] d,
                       int pos,
                       int size)
                throws NullArgumentException,
                       NumberIsTooLargeException

Construct a vector from part of a array.

Parameters:: d - Array.; pos - Position of first entry.; size - Number of entries to copy.
Throws:: NullArgumentException - if d is null.; NumberIsTooLargeException - if the size of d is less than pos + size.

ArrayRealVector

public ArrayRealVector(Double[] d)

Construct a vector from an array.

Parameters:: d - Array of Doubles.

ArrayRealVector

public ArrayRealVector(Double[] d,
                       int pos,
                       int size)
                throws NullArgumentException,
                       NumberIsTooLargeException

Construct a vector from part of an array.

Parameters:: d - Array.; pos - Position of first entry.; size - Number of entries to copy.
Throws:: NullArgumentException - if d is null.; NumberIsTooLargeException - if the size of d is less than pos + size.

ArrayRealVector

public ArrayRealVector(RealVector v)
                throws NullArgumentException

Construct a vector from another vector, using a deep copy.

Parameters:: v - vector to copy.
Throws:: NullArgumentException - if v is null.

ArrayRealVector

public ArrayRealVector(ArrayRealVector v)
                throws NullArgumentException

Construct a vector from another vector, using a deep copy.

Parameters:: v - Vector to copy.
Throws:: NullArgumentException - if v is null.

ArrayRealVector

public ArrayRealVector(ArrayRealVector v,
                       boolean deep)

Construct a vector from another vector.

Parameters:: v - Vector to copy.; deep - If true perform a deep copy, otherwise perform a shallow copy.