Vectors (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.vector.Vectors

```
public class Vectors
extends Object
```
A collection of static methods that operate on or return Vector instances, following a format similar to that of Collections.

Unless otherwise noted, all returned Vector instances implement Serializable.

Author:

Keith Stevens, David Jurgens

Method Summary

Methods
Modifier and Type	Method and Description
`static SparseDoubleVector`	`asDouble(SparseIntegerVector v)`
`static DoubleVector`	`asDouble(Vector v)` Returns a view over the given `Vector` as a `DoubleVector`.
`static DoubleVector`	`asVector(double[] array)` Returns a vector backed by the specified array.
`static IntegerVector`	`asVector(int[] array)` Returns a vector backed by the specified array.
`static DoubleVector`	`atomic(DoubleVector vector)` Returns a thread-safe version of a `DoubleVector` that guarantees atomic access to all operations.
`static Vector`	`copy(Vector dest, Vector source)` Copies all of the values from one `Vector` into another.
`static DoubleVector`	`copyOf(DoubleVector source)` Creates a copy of a given `DoubleVector` with the same type as the original.
`static IntegerVector`	`copyOf(IntegerVector source)` Creates a copy of a given `IntegerVector` with the same type as the original.
`static Vector`	`copyOf(Vector source)` Creates a copy of a given `Vector`.
`static boolean`	`equals(DoubleVector v1, DoubleVector v2)` Returns `true` if the two vectors are equal to one another.
`static boolean`	`equals(IntegerVector v1, IntegerVector v2)` Returns `true` if the two integer vectors are equal to one another.
`static boolean`	`equals(Vector v1, Vector v2)` Returns `true` if the two vectors are equal to one another.
`static DoubleVector`	`immutable(DoubleVector vector)` Returns an immutable view of the given `DoubleVector`.
`static IntegerVector`	`immutable(IntegerVector vector)` Returns an immutable view of the given `IntegerVector`.
`static SparseDoubleVector`	`immutable(SparseDoubleVector vector)` Returns an immutable view of the given `SparseDoubleVector`.
`static SparseIntegerVector`	`immutable(SparseIntegerVector vector)` Returns an immutable view of the given `SparseIntegerVector`.
`static Vector`	`immutable(Vector vector)` Returns an immutable view of the given `Vector`.
`static <T extends Vector> T`	`instanceOf(T vector)` Creates a `Vector` instance of the same type and length of the provided vector.
`static DoubleVector`	`scaleByMagnitude(DoubleVector vector)`
`static DoubleVector`	`scaleByMagnitude(SparseDoubleVector vector)`
`static DoubleVector`	`subview(DoubleVector vector, int offset, int length)` Returns a subview for the given `DoubleVector` with a specified offset and length.
`static IntegerVector`	`subview(IntegerVector vector, int offset, int length)` Returns a subview for the given `IntegerVector` with a specified offset and length.
`static SparseDoubleVector`	`subview(SparseDoubleVector vector, int offset, int length)` Returns a subview for the given `SparseDoubleVector` with a specified offset and length.
`static SparseIntegerVector`	`subview(SparseIntegerVector vector, int offset, int length)` Returns a subview for the given `IntegerVector` with a specified offset and length.
`static DoubleVector`	`synchronizedVector(DoubleVector vector)` Returns a syncrhonized view of a given `DoubleVector`.

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

- Method Detail
  - asDouble
```
public static DoubleVector asDouble(Vector v)
```
    Returns a view over the given Vector as a DoubleVector. The returned vector is mutable but any changes will be converted into its internal data-type, e.g. int, which may result in information loss.
    
    Parameters:
    v - The Vector to return as a DoubleVector.
    
    Returns:
    a mutable DoubleVector view of v
  - asDouble
```
public static SparseDoubleVector asDouble(SparseIntegerVector v)
```
  - asVector
```
public static DoubleVector asVector(double[] array)
```
    Returns a vector backed by the specified array. Any changes to the vector are written through to the array. This method acts a bridge between array-based and Vector-based computation.
    
    Parameters:
    array - the array backing the vector
    
    Returns:
    a Vector view of the array
  - asVector
```
public static IntegerVector asVector(int[] array)
```
    Returns a vector backed by the specified array. Any changes to the vector are written through to the array. This method acts a bridge between array-based and Vector-based computation.
    
    Parameters:
    array - the array backing the vector
    
    Returns:
    a Vector view of the array
  - equals
```
public static boolean equals(DoubleVector v1,
             DoubleVector v2)
```
    Returns true if the two vectors are equal to one another. Two Vector insances are considered equal if they contain the same number of elements and all corresponding pairs of double values are equal.
  - equals
```
public static boolean equals(IntegerVector v1,
             IntegerVector v2)
```
    Returns true if the two integer vectors are equal to one another. Two Vector insances are considered equal if they contain the same number of elements and all corresponding pairs of int values are equal.
  - equals
```
public static boolean equals(Vector v1,
             Vector v2)
```
    Returns true if the two vectors are equal to one another. Two Vector insances are considered equal if they contain the same number of elements and all corresponding pairs of Number values are equal. Two values n1 and n2 are considered equal if n1.equals(n2).
  - immutable
```
public static DoubleVector immutable(DoubleVector vector)
```
    Returns an immutable view of the given DoubleVector.
    
    Parameters:
    vector - The DoubleVector to decorate as immutable.
    
    Returns:
    An immutable version of vector.
  - immutable
```
public static SparseDoubleVector immutable(SparseDoubleVector vector)
```
    Returns an immutable view of the given SparseDoubleVector.
    
    Parameters:
    vector - The DoubleVector to decorate as immutable.
    
    Returns:
    An immutable version of vector.
  - immutable
```
public static IntegerVector immutable(IntegerVector vector)
```
    Returns an immutable view of the given IntegerVector.
    
    Parameters:
    vector - The IntegerVector to decorate as immutable.
    
    Returns:
    An immutable version of vector.
  - immutable
```
public static SparseIntegerVector immutable(SparseIntegerVector vector)
```
    Returns an immutable view of the given SparseIntegerVector.
    
    Parameters:
    vector - The IntegerVector to decorate as immutable.
    
    Returns:
    An immutable version of vector.
  - immutable
```
public static Vector immutable(Vector vector)
```
    Returns an immutable view of the given Vector.
    
    Parameters:
    vector - The DoubleVector to decorate as immutable.
    
    Returns:
    An immutable version of vector.
  - atomic
```
public static DoubleVector atomic(DoubleVector vector)
```
    Returns a thread-safe version of a DoubleVector that guarantees atomic access to all operations. The returned vector allows concurrent read access.
    
    Parameters:
    vector - The DoubleVector to decorate as atomic.
    
    Returns:
    An atomic version of vector.
  - synchronizedVector
```
public static DoubleVector synchronizedVector(DoubleVector vector)
```
    Returns a syncrhonized view of a given DoubleVector. This may show slightly better performance than using an AtomicVector in some use cases.
    
    Parameters:
    vector - The DoubleVector to decorate as synchronized.
    
    Returns:
    An atomic version of vector.
  - scaleByMagnitude
```
public static DoubleVector scaleByMagnitude(DoubleVector vector)
```
  - scaleByMagnitude
```
public static DoubleVector scaleByMagnitude(SparseDoubleVector vector)
```
  - subview
```
public static DoubleVector subview(DoubleVector vector,
                   int offset,
                   int length)
```
    Returns a subview for the given DoubleVector with a specified offset and length.
    Parameters:
    vector - the Vector whose values will be shown in the view
    offset - the index of v at which the first index of this view starts
    length - the length of this view.
    
    Throws:
    IllegalArgumentException - if
    offset is negative
    length is less than zero
    the sum of offset plus length is greater than the length of vector
  - subview
```
public static SparseDoubleVector subview(SparseDoubleVector vector,
                         int offset,
                         int length)
```
    Returns a subview for the given SparseDoubleVector with a specified offset and length.
    Parameters:
    vector - the Vector whose values will be shown in the view
    offset - the index of v at which the first index of this view starts
    length - the length of this view.
    
    Throws:
    IllegalArgumentException - if
    offset is negative
    length is less than zero
    the sum of offset plus length is greater than the length of vector
  - subview
```
public static IntegerVector subview(IntegerVector vector,
                    int offset,
                    int length)
```
    Returns a subview for the given IntegerVector with a specified offset and length.
    Parameters:
    vector - the Vector whose values will be shown in the view
    offset - the index of v at which the first index of this view starts
    length - the length of this view.
    
    Throws:
    IllegalArgumentException - if
    offset is negative
    length is less than zero
    the sum of offset plus length is greater than the length of vector
  - subview
```
public static SparseIntegerVector subview(SparseIntegerVector vector,
                          int offset,
                          int length)
```
    Returns a subview for the given IntegerVector with a specified offset and length.
    Parameters:
    vector - the Vector whose values will be shown in the view
    offset - the index of v at which the first index of this view starts
    length - the length of this view.
    
    Throws:
    IllegalArgumentException - if
    offset is negative
    length is less than zero
    the sum of offset plus length is greater than the length of vector
  - copy
```
public static Vector copy(Vector dest,
          Vector source)
```
    Copies all of the values from one Vector into another. After the operation, all of the values in dest will be the same as that of source. The legnth of dest must be as long as the length of source. Once completed dest is returned.
    
    Parameters:
    dest - The Vector to copy values into.
    source - The Vector to copy values from.
    
    Returns:
    dest after being copied from source.
    
    Throws:
    
    IllegalArgumentException - if the length of dest is less than that of source.
  - copyOf
```
public static DoubleVector copyOf(DoubleVector source)
```
    Creates a copy of a given DoubleVector with the same type as the original.
    
    Parameters:
    source - The Vector to copy.
    
    Returns:
    A copy of source with the same type.
  - copyOf
```
public static Vector copyOf(Vector source)
```
    Creates a copy of a given Vector.
    
    Parameters:
    source - The Vector to copy.
    
    Returns:
    A copy of source with the same type.
  - copyOf
```
public static IntegerVector copyOf(IntegerVector source)
```
    Creates a copy of a given IntegerVector with the same type as the original.
    
    Parameters:
    source - The Vector to copy.
    
    Returns:
    A copy of source with the same type.
  - instanceOf
```
public static <T extends Vector> T instanceOf(T vector)
```
    Creates a Vector instance of the same type and length of the provided vector.
    
    Parameters:
    vector - a vector whose type and length should be used when creating a new vector with the same properties
    
    Returns:
    a vector with the same type and length as the provided vector

Class Vectors

Method Summary

Methods inherited from class java.lang.Object

Method Detail

asDouble

asDouble

asVector

asVector

equals

equals

equals

immutable

immutable

immutable

immutable

immutable

atomic

synchronizedVector

scaleByMagnitude

scaleByMagnitude

subview

subview

subview

subview

copy

copyOf

copyOf

copyOf

instanceOf