RealVector (Commons Math 2.2 API)

The various mapXxx and mapXxxToSelf methods operate on vectors element-wise, i.e. they perform the same operation (adding a scalar, applying a function ...) on each element in turn. The mapXxx versions create a new vector to hold the result and do not change the instance. The mapXxxToSelf versions use the instance itself to store the results, so the instance is changed by these methods. In both cases, the result vector is returned by the methods, this allows to use the fluent API style, like this:

   RealVector result = v.mapAddToSelf(3.0).mapTanToSelf().mapSquareToSelf();

Remark on the deprecated mapXxx and mapXxxToSelf methods: In Commons-Math v3.0, the same functionality will be achieved by directly using the map(UnivariateRealFunction) and mapToSelf(UnivariateRealFunction) together with new function objects (not available in v2.2).

Since:: 2.0
Version:: $Revision: 1070725 $ $Date: 2011-02-15 02:31:12 +0100 (mar. 15 fÃ©vr. 2011) $

Nested Class Summary
`static class`	`RealVector.Entry` Class representing a modifiable entry in the vector.

Method Summary
`RealVector`	`add(double[] v)` Compute the sum of this vector and `v`.
`RealVector`	`add(RealVector v)` Compute the sum of this vector and `v`.
`RealVector`	`append(double d)` Construct a vector by appending a double to this vector.
`RealVector`	`append(double[] a)` Construct a vector by appending a double array to this vector.
`RealVector`	`append(RealVector v)` Construct a vector by appending a vector to this vector.
`RealVector`	`copy()` Returns a (deep) copy of this vector.
`double`	`dotProduct(double[] v)` Compute the dot product.
`double`	`dotProduct(RealVector v)` Compute the dot product.
`RealVector`	`ebeDivide(double[] v)` Element-by-element division.
`RealVector`	`ebeDivide(RealVector v)` Element-by-element division.
`RealVector`	`ebeMultiply(double[] v)` Element-by-element multiplication.
`RealVector`	`ebeMultiply(RealVector v)` Element-by-element multiplication.
`double[]`	`getData()` Returns vector entries as a double array.
`int`	`getDimension()` Returns the size of the vector.
`double`	`getDistance(double[] v)` Distance between two vectors.
`double`	`getDistance(RealVector v)` Distance between two vectors.
`double`	`getEntry(int index)` Returns the entry in the specified index.
`double`	`getL1Distance(double[] v)` Distance between two vectors.
`double`	`getL1Distance(RealVector v)` Distance between two vectors.
`double`	`getL1Norm()` Returns the L₁ norm of the vector.
`double`	`getLInfDistance(double[] v)` Distance between two vectors.
`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.
`boolean`	`isInfinite()` Check whether any coordinate of this vector is infinite and none are `NaN`.
`boolean`	`isNaN()` Check whether any coordinate of this vector is `NaN`.
`Iterator<RealVector.Entry>`	`iterator()` Generic dense iterator.
`RealVector`	`map(UnivariateRealFunction function)` Acts as if implemented as:
`RealVector`	`mapAbs()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAbsToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAcos()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAcosToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAdd(double d)` Add a value to each entry.
`RealVector`	`mapAddToSelf(double d)` Add a value to each entry.
`RealVector`	`mapAsin()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAsinToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAtan()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapAtanToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCbrt()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCbrtToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCeil()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCeilToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCos()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCosh()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCoshToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapCosToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapDivide(double d)` Divide each entry.
`RealVector`	`mapDivideToSelf(double d)` Divide each entry.
`RealVector`	`mapExp()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapExpm1()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapExpm1ToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapExpToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapFloor()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapFloorToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapInv()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapInvToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLog()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLog10()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLog10ToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLog1p()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLog1pToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapLogToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapMultiply(double d)` Multiply each entry.
`RealVector`	`mapMultiplyToSelf(double d)` Multiply each entry.
`RealVector`	`mapPow(double d)` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapPowToSelf(double d)` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapRint()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapRintToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSignum()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSignumToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSin()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSinh()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSinhToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSinToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSqrt()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSqrtToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapSubtract(double d)` Subtract a value from each entry.
`RealVector`	`mapSubtractToSelf(double d)` Subtract a value from each entry.
`RealVector`	`mapTan()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapTanh()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapTanhToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapTanToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapToSelf(UnivariateRealFunction function)` Acts as if it is implemented as:
`RealVector`	`mapUlp()` Deprecated. in 2.2 (to be removed in 3.0).
`RealVector`	`mapUlpToSelf()` Deprecated. in 2.2 (to be removed in 3.0).
`RealMatrix`	`outerProduct(double[] v)` Compute the outer product.
`RealMatrix`	`outerProduct(RealVector v)` Compute the outer product.
`RealVector`	`projection(double[] v)` Find the orthogonal projection of this vector onto another vector.
`RealVector`	`projection(RealVector v)` Find the orthogonal projection of this vector onto another vector.
`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 set of consecutive elements.
`Iterator<RealVector.Entry>`	`sparseIterator()` Specialized implementations may choose to not iterate over all dimensions, either because those values are unset, or are equal to defaultValue(), or are small enough to be ignored for the purposes of iteration.
`RealVector`	`subtract(double[] v)` Subtract `v` from this vector.
`RealVector`	`subtract(RealVector v)` Subtract `v` from this vector.
`double[]`	`toArray()` Convert the vector to a double array.
`void`	`unitize()` Converts this vector into a unit vector.
`RealVector`	`unitVector()` Creates a unit vector pointing in the direction of this vector.

Method Detail

mapToSelf

RealVector mapToSelf(UnivariateRealFunction function)
                     throws FunctionEvaluationException

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

Parameters:: function - Function to apply to each entry.
Returns:: this vector.
Throws:: FunctionEvaluationException - if the function throws it.

map

RealVector map(UnivariateRealFunction function)
               throws FunctionEvaluationException

Acts as if implemented as:

  return copy().map(function);

Parameters:: function - Function to apply to each entry.
Returns:: a new vector.
Throws:: FunctionEvaluationException - if the function throws it.

iterator

Iterator<RealVector.Entry> iterator()

Generic dense iterator. It iterates in increasing order of the vector index.

Returns:: a dense iterator

sparseIterator

Iterator<RealVector.Entry> sparseIterator()

Specialized implementations may choose to not iterate over all dimensions, either because those values are unset, or are equal to defaultValue(), or are small enough to be ignored for the purposes of iteration. No guarantees are made about order of iteration. In dense implementations, this method will often delegate to iterator().

Returns:: a sparse iterator

copy

RealVector copy()

Returns a (deep) copy of this vector.

Returns:: a vector copy.

add

RealVector add(RealVector v)

Compute the sum of this vector and v.

Parameters:: v - Vector to be added.
Returns:: this + v.
Throws:: DimensionMismatchException - if v is not the same size as this vector.

add

RealVector add(double[] v)

Compute the sum of this vector and v.

Parameters:: v - Vector to be added.
Returns:: this + v.
Throws:: DimensionMismatchException - if v is not the same size as this vector.

subtract

RealVector subtract(RealVector v)

Subtract v from this vector.

Parameters:: v - Vector to be subtracted.
Returns:: this - v.
Throws:: DimensionMismatchException - if v is not the same size as this vector.

subtract

RealVector subtract(double[] v)

Subtract v from this vector.

Parameters:: v - Vector to be subtracted.
Returns:: this - v.
Throws:: DimensionMismatchException - if v is not the same size as this vector.

mapAdd

RealVector mapAdd(double d)

Add a value to each entry.

Parameters:: d - Value to be added to each entry.
Returns:: this + d.

mapAddToSelf

RealVector mapAddToSelf(double d)

Add a value to each entry. The instance is changed in-place.

Parameters:: d - Value to be added to each entry.
Returns:: this.

mapSubtract

RealVector mapSubtract(double d)

Subtract a value from each entry.

Parameters:: d - Value to be subtracted.
Returns:: this - d.

mapSubtractToSelf

RealVector mapSubtractToSelf(double d)

Subtract a value from each entry. The instance is changed in-place.

Parameters:: d - Value to be subtracted.
Returns:: this.

mapMultiply

RealVector mapMultiply(double d)

Multiply each entry.

Parameters:: d - Multiplication factor.
Returns:: this * d.

mapMultiplyToSelf

RealVector mapMultiplyToSelf(double d)

Multiply each entry. The instance is changed in-place.

Parameters:: d - Multiplication factor.
Returns:: this.

mapDivide

RealVector mapDivide(double d)

Divide each entry.

Parameters:: d - Value to divide by.
Returns:: this / d.

mapDivideToSelf

RealVector mapDivideToSelf(double d)

Divide each entry. The instance is changed in-place.

Parameters:: d - Value to divide by.
Returns:: this.