DenseVector (REEF 0.16.0 API)

java.lang.Object
- org.apache.reef.examples.group.utils.math.AbstractVector
- - org.apache.reef.examples.group.utils.math.DenseVector

All Implemented Interfaces:

Serializable, ImmutableVector, Vector
```
public class DenseVector
extends AbstractVector
implements Serializable
```
A dense Vector implementation backed by a double[].

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DenseVector(DenseVector other)`
`DenseVector(double[] values)`
`DenseVector(ImmutableVector other)` Instantiates a new DenseVector by copying the given other vector.
`DenseVector(int size)` Creates a dense vector of the given size.

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`dot(Vector that)` Computes the inner product with another Vector.
`double`	`get(int i)` Access the value of the Vector at dimension i.
`double[]`	`getValues()` Access the underlying storage.
`Tuple<Integer,Double>`	`min()` Computes the min of all entries in the Vector.
`Vector`	`newInstance()` Create a new instance of the current type.
`double`	`norm2()` Computes the L2 norm of this Vector.
`double`	`norm2Sqr()` Computes the square of the L2 norm of this Vector.
`static DenseVector`	`rand(int size)` Creates a random Vector of size 'size' where each element is individually.
`static DenseVector`	`rand(int size, Random random)` Creates a random Vector of size 'size' where each element is individually.
`void`	`set(int i, double v)` Set dimension i of the Vector to value v.
`int`	`size()` The size (dimensionality) of the Vector.
`double`	`sum()` Computes the computeSum of all entries in the Vector.
`String`	`toString()`

Methods inherited from class org.apache.reef.examples.group.utils.math.AbstractVector
add, multAdd, normalize, scale

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

Methods inherited from interface org.apache.reef.examples.group.utils.math.ImmutableVector
dot, min, norm2, norm2Sqr, sum

- Constructor Detail
  - DenseVector
```
public DenseVector(int size)
```
    Creates a dense vector of the given size.
  - DenseVector
```
public DenseVector(double[] values)
```
  - DenseVector
```
public DenseVector(ImmutableVector other)
```
    Instantiates a new DenseVector by copying the given other vector.
  - DenseVector
```
public DenseVector(DenseVector other)
```
- Method Detail
  - set
```
public void set(int i,
       double v)
```
    Description copied from interface: Vector
    
    Set dimension i of the Vector to value v.
    
    Specified by:
    
    set in interface Vector
    
    Specified by:
    
    set in class AbstractVector
    
    Parameters:
    i - the index
    v - value
  - get
```
public double get(int i)
```
    Description copied from interface: ImmutableVector
    
    Access the value of the Vector at dimension i.
    
    Specified by:
    
    get in interface ImmutableVector
    
    Parameters:
    i - index
    
    Returns:
    the value at index i
  - size
```
public int size()
```
    Description copied from interface: ImmutableVector
    
    The size (dimensionality) of the Vector.
    
    Specified by:
    
    size in interface ImmutableVector
    
    Returns:
    the size of the Vector.
  - getValues
```
public double[] getValues()
```
    Access the underlying storage. This is unsafe.
  - rand
```
public static DenseVector rand(int size)
```
    Creates a random Vector of size 'size' where each element is individually. drawn from Math.random()
    
    Returns:
    a random Vector of the given size where each element is individually drawn from Math.random()
  - rand
```
public static DenseVector rand(int size,
               Random random)
```
    Creates a random Vector of size 'size' where each element is individually. drawn from Math.random()
    
    Parameters:
    random - the random number generator to use.
    
    Returns:
    a random Vector of the given size where each element is individually drawn from Math.random()
  - newInstance
```
public Vector newInstance()
```
    Description copied from interface: Vector
    
    Create a new instance of the current type. with elements being zero
    
    Specified by:
    
    newInstance in interface Vector
    
    Returns:
    zero vector of current dimensionality
  - dot
```
public double dot(Vector that)
```
    Description copied from interface: ImmutableVector
    
    Computes the inner product with another Vector.
    
    Specified by:
    
    dot in interface ImmutableVector
    
    Returns:
    the inner product between two Vectors.
  - sum
```
public double sum()
```
    Description copied from interface: ImmutableVector
    
    Computes the computeSum of all entries in the Vector.
    
    Specified by:
    
    sum in interface ImmutableVector
    
    Returns:
    the computeSum of all entries in this Vector
  - norm2
```
public double norm2()
```
    Description copied from interface: ImmutableVector
    
    Computes the L2 norm of this Vector.
    
    Specified by:
    
    norm2 in interface ImmutableVector
    
    Returns:
    the L2 norm of this Vector.
  - norm2Sqr
```
public double norm2Sqr()
```
    Description copied from interface: ImmutableVector
    
    Computes the square of the L2 norm of this Vector.
    
    Specified by:
    
    norm2Sqr in interface ImmutableVector
    
    Returns:
    the square of the L2 norm of this Vector.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - min
```
public Tuple<Integer,Double> min()
```
    Description copied from interface: ImmutableVector
    
    Computes the min of all entries in the Vector.
    
    Specified by:
    
    min in interface ImmutableVector
    
    Returns:
    the min of all entries in this Vector

Class DenseVector

Constructor Summary

Method Summary

Methods inherited from class org.apache.reef.examples.group.utils.math.AbstractVector

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.reef.examples.group.utils.math.ImmutableVector

Constructor Detail

DenseVector

DenseVector

DenseVector

DenseVector

Method Detail

set

get

size

getValues

rand

rand

newInstance

dot

sum

norm2

norm2Sqr

toString

min