ColumnVector (nem2-sdk 0.9.0 API)

java.lang.Object
- io.nem.core.math.ColumnVector

public class ColumnVector
extends java.lang.Object

Represents a linear algebra vector.

Constructor Summary

Constructors
Constructor and Description

ColumnVector(double... vector)
Creates a new vector around a raw vector.

ColumnVector(int size)
Creates a new vector of the specified size.

Constructors
Constructor and Description
`ColumnVector(double... vector)` Creates a new vector around a raw vector.
`ColumnVector(int size)` Creates a new vector of the specified size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColumnVector`	`abs()` Creates a new ColumnVector by taking the absolute value of each element in this vector.
`double`	`absSum()` Gets the sum of the absolute value of all the vector's elements.
`ColumnVector`	`add(double scalar)` Creates a new ColumnVector by adding each element of this vector to a scalar.
`ColumnVector`	`addElementWise(ColumnVector vector)` Creates a new ColumnVector by adding the specified vector to this vector.
`boolean`	`align()` Scales this vector so that v[0] is equal to 1.
`double`	`correlation(ColumnVector vector)` Calculates the correlation (pearson r) between the specified vector and this vector.
`boolean`	`equals(java.lang.Object obj)`
`double`	`getAt(int index)` Gets the value at the specified index.
`double`	`getMagnitude()` Gets the magnitude of this vector.
`double[]`	`getRaw()` Gets the underlying, raw array.
`int`	`hashCode()`
`void`	`incrementAt(int index, double val)` Increments at the specified index by a value.
`boolean`	`isZeroVector()` Determines if this vector is a zero vector.
`double`	`l1Distance(ColumnVector vector)` Calculates the Manhattan distance (L1-norm) between the specified vector and this vector.
`double`	`l2Distance(ColumnVector vector)` Calculates the Euclidean distance (L2-norm) between the specified vector and this vector.
`double`	`max()` Gets the maximum value for an individual element in this vector.
`double`	`median()` Gets the median value of all elements in this vector.
`ColumnVector`	`multiply(double scalar)` Creates a new ColumnVector by multiplying this vector by a scalar.
`ColumnVector`	`multiplyElementWise(ColumnVector vector)` Creates a new ColumnVector by multiplying this vector element-wise with another vector.
`void`	`normalize()` Normalizes this vector's elements so that the absolute value of all elements sums to 1.0.
`void`	`removeNegatives()` Sets all negative values to zero.
`ColumnVector`	`roundTo(int numPlaces)` Creates a new ColumnVector by rounding this vector to the specified number of decimal places.
`void`	`scale(double scale)` Scales this vector by dividing all of its elements by the specified factor.
`void`	`setAll(double val)` Sets all the vector's elements to the specified value.
`void`	`setAt(int index, double val)` Sets a value at the specified index.
`int`	`size()` Gets the size of the vector.
`ColumnVector`	`sqrt()` Creates a new ColumnVector by taking the square root of each element in this vector.
`double`	`sum()` Gets the sum of all the vector's elements.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - ColumnVector
```
public ColumnVector(int size)
```
    Creates a new vector of the specified size.
    
    Parameters:
    
    size - The desired size.
  - ColumnVector
```
public ColumnVector(double... vector)
```
    Creates a new vector around a raw vector.
    
    Parameters:
    
    vector - The vector of data.
- Method Detail
  - size
```
public int size()
```
    Gets the size of the vector.
    
    Returns:
    
    The size of the vector.
  - getAt
```
public double getAt(int index)
```
    Gets the value at the specified index.
    
    Parameters:
    
    index - The index.
    
    Returns:
    
    The value.
  - setAt
```
public void setAt(int index,
                  double val)
```
    Sets a value at the specified index.
    
    Parameters:
    
    index - The index.
    
    val - The value.
  - incrementAt
```
public void incrementAt(int index,
                        double val)
```
    Increments at the specified index by a value.
    
    Parameters:
    
    index - The index.
    
    val - The value.
  - normalize
```
public void normalize()
```
    Normalizes this vector's elements so that the absolute value of all elements sums to 1.0.
    This method has the side effect of modifying the implicit context object, so be careful.
  - scale
```
public void scale(double scale)
```
    Scales this vector by dividing all of its elements by the specified factor.
    
    Parameters:
    
    scale - The scale factor.
  - multiplyElementWise
```
public ColumnVector multiplyElementWise(ColumnVector vector)
```
    Creates a new ColumnVector by multiplying this vector element-wise with another vector.
    
    Parameters:
    
    vector - The vector.
    
    Returns:
    
    The new vector.
  - addElementWise
```
public ColumnVector addElementWise(ColumnVector vector)
```
    Creates a new ColumnVector by adding the specified vector to this vector.
    
    Parameters:
    
    vector - The specified vector.
    
    Returns:
    
    The new vector.
  - absSum
```
public double absSum()
```
    Gets the sum of the absolute value of all the vector's elements.
    
    Returns:
    
    The sum of the absolute value of all the vector's elements.
  - sum
```
public double sum()
```
    Gets the sum of all the vector's elements.
    
    Returns:
    
    The sum of all the vectors elements.
  - roundTo
```
public ColumnVector roundTo(int numPlaces)
```
    Creates a new ColumnVector by rounding this vector to the specified number of decimal places.
    
    Parameters:
    
    numPlaces - The number of decimal places.
    
    Returns:
    
    The new vector.
  - add
```
public ColumnVector add(double scalar)
```
    Creates a new ColumnVector by adding each element of this vector to a scalar.
    
    Parameters:
    
    scalar - The scalar.
    
    Returns:
    
    The new vector.
  - multiply
```
public ColumnVector multiply(double scalar)
```
    Creates a new ColumnVector by multiplying this vector by a scalar.
    
    Parameters:
    
    scalar - The scalar.
    
    Returns:
    
    The new vector.
  - sqrt
```
public ColumnVector sqrt()
```
    Creates a new ColumnVector by taking the square root of each element in this vector.
    
    Returns:
    
    The new vector.
  - abs
```
public ColumnVector abs()
```
    Creates a new ColumnVector by taking the absolute value of each element in this vector.
    
    Returns:
    
    The new vector.
  - isZeroVector
```
public final boolean isZeroVector()
```
    Determines if this vector is a zero vector.
    
    Returns:
    
    true if this vector is a zero vector.
  - getRaw
```
public double[] getRaw()
```
    Gets the underlying, raw array.
    
    Returns:
    
    The underlying, raw array.
  - setAll
```
public void setAll(double val)
```
    Sets all the vector's elements to the specified value.
    
    Parameters:
    
    val - The value.
  - align
```
public boolean align()
```
    Scales this vector so that v[0] is equal to 1. This can help PowerIteration converge faster. Alignment will fail if the vector's first element is 0.
    
    Returns:
    
    true if the alignment was successful; false otherwise.
  - max
```
public double max()
```
    Gets the maximum value for an individual element in this vector.
    
    Returns:
    
    The maximum value in of this vector.
  - median
```
public double median()
```
    Gets the median value of all elements in this vector.
    
    Returns:
    
    The median value of all elements in this vector.
  - getMagnitude
```
public double getMagnitude()
```
    Gets the magnitude of this vector.
    
    Returns:
    
    The magnitude of this vector.
  - l1Distance
```
public double l1Distance(ColumnVector vector)
```
    Calculates the Manhattan distance (L1-norm) between the specified vector and this vector.
    
    Parameters:
    
    vector - The specified vector.
    
    Returns:
    
    The Manhattan distance (L1-norm).
  - l2Distance
```
public double l2Distance(ColumnVector vector)
```
    Calculates the Euclidean distance (L2-norm) between the specified vector and this vector.
    
    Parameters:
    
    vector - The specified vector.
    
    Returns:
    
    The Euclidean distance.
  - correlation
```
public double correlation(ColumnVector vector)
```
    Calculates the correlation (pearson r) between the specified vector and this vector.
    
    Parameters:
    
    vector - The specified vector.
    
    Returns:
    
    The correlation.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - removeNegatives
```
public void removeNegatives()
```
    Sets all negative values to zero.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ColumnVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ColumnVector

ColumnVector

Method Detail

size

getAt

setAt

incrementAt

normalize

scale

multiplyElementWise

addElementWise

absSum

sum

roundTo

add

multiply

sqrt

abs

isZeroVector

getRaw

setAll

align

max

median

getMagnitude

l1Distance

l2Distance

correlation

toString

removeNegatives

hashCode

equals