Package org.la4j.vector.dense

Class BasicVector

java.lang.Object

org.la4j.Vector

org.la4j.vector.DenseVector

org.la4j.vector.dense.BasicVector

All Implemented Interfaces:

java.lang.Iterable<java.lang.Double>

public class BasicVector
extends DenseVector

A basic dense vector implementation using an array. A dense data structure stores data in an underlying array. Even zero elements take up memory space. If you want a data structure that will not have zero elements take up memory space, try a sparse structure. However, fetch/store operations on dense data structures only take O(1) time, instead of the O(log n) time on sparse structures. BasicVector stores the underlying data in a standard array.

Field Summary

Fields

Modifier and Type	Field	Description
private double[]	self
private static byte	VECTOR_TAG

Fields inherited from class org.la4j.Vector

length

Constructor Summary

Constructors

Constructor	Description
BasicVector()
BasicVector(double[] array)
BasicVector(int length)

Method Summary

Modifier and Type	Method	Description
Vector	blankOfLength(int length)	Creates a blank (an empty vector) copy of this vector with the given length.
static BasicVector	constant(int length, double value)	Creates a constant BasicVector of the given length with the given value.
Vector	copyOfLength(int length)	Copies this vector into the new vector with specified length.
static BasicVector	fromArray(double[] array)	Creates a new BasicVector from the given array w/o copying the underlying array.
static BasicVector	fromBinary(byte[] array)	Decodes BasicVector from the given byte array.
static BasicVector	fromCollection(java.util.Collection<? extends java.lang.Number> list)	Creates new BasicVector from
static BasicVector	fromCSV(java.lang.String csv)	Parses BasicVector from the given CSV string.
static BasicVector	fromMap(java.util.Map<java.lang.Integer,? extends java.lang.Number> map, int length)	Creates new BasicVector from index-value map
static BasicVector	fromMatrixMarket(java.lang.String mm)	Parses BasicVector from the given Matrix Market string.
double	get(int i)	Gets the specified element of this vector.
static BasicVector	random(int length, java.util.Random random)	Creates a random BasicVector of the given length with the given Random.
void	set(int i, double value)	Sets the specified element of this matrix to given value.
void	swapElements(int i, int j)	Swaps the specified elements of this vector.
<T extends Vector> T	to(VectorFactory<T> factory)	Converts this vector using the given factory.
double[]	toArray()	Converts this dense vector to a double array.
byte[]	toBinary()	Encodes this vector into a byte array.
static BasicVector	unit(int length)	Creates an unit BasicVector of the given length.
static BasicVector	zero(int length)	Creates a zero BasicVector of the given length.

Methods inherited from class org.la4j.vector.DenseVector

apply, apply, apply, toColumnMatrix, toDiagonalMatrix, toMatrixMarket, toRowMatrix

Methods inherited from class org.la4j.Vector

add, add, blank, copy, divide, each, ensureLengthIsCorrect, equals, equals, euclideanNorm, fail, fold, hadamardProduct, hashCode, infinityNorm, innerProduct, is, iterator, length, manhattanNorm, max, min, mkString, mkString, multiply, multiply, non, norm, outerProduct, product, select, setAll, shuffle, slice, sliceLeft, sliceRight, subtract, subtract, sum, toCSV, toCSV, toDenseVector, toMatrixMarket, toSparseVector, toString, transform, update, updateAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

VECTOR_TAG

private static final byte VECTOR_TAG

See Also:

Constant Field Values

self

private double[] self

Constructor Detail

BasicVector

public BasicVector()

BasicVector

public BasicVector(int length)

BasicVector

public BasicVector(double[] array)

Method Detail

zero

public static BasicVector zero(int length)

Creates a zero BasicVector of the given length.

constant

public static BasicVector constant(int length,
                                   double value)

Creates a constant BasicVector of the given length with the given value.

unit

public static BasicVector unit(int length)

Creates an unit BasicVector of the given length.

random

public static BasicVector random(int length,
                                 java.util.Random random)

Creates a random BasicVector of the given length with the given Random.

fromArray

public static BasicVector fromArray(double[] array)

Creates a new BasicVector from the given array w/o copying the underlying array.

fromBinary

public static BasicVector fromBinary(byte[] array)

Decodes BasicVector from the given byte array.

Parameters:

array - the byte array representing a vector

Returns:

a decoded vector

fromCSV

public static BasicVector fromCSV(java.lang.String csv)

Parses BasicVector from the given CSV string.

Parameters:

csv - the CSV string representing a vector

Returns:

a parsed vector

fromMatrixMarket

public static BasicVector fromMatrixMarket(java.lang.String mm)

Parses BasicVector from the given Matrix Market string.

Parameters:

mm - the string in Matrix Market format

Returns:

a parsed vector

fromCollection

public static BasicVector fromCollection(java.util.Collection<? extends java.lang.Number> list)

Creates new BasicVector from

Parameters:

list - list containing doubles

Returns:

new vector from given double list

fromMap

public static BasicVector fromMap(java.util.Map<java.lang.Integer,? extends java.lang.Number> map,
                                  int length)

Creates new BasicVector from index-value map

Parameters:

map - index-value map

length - vector length

Returns:

created vector

get

public double get(int i)

Description copied from class: Vector

Gets the specified element of this vector.

Specified by:

get in class Vector

Parameters:

i - element's index

Returns:

the element of this vector

set

public void set(int i,
                double value)

Description copied from class: Vector

Sets the specified element of this matrix to given value.

Specified by:

set in class Vector

Parameters:

i - element's index

value - element's new value

swapElements

public void swapElements(int i,
                         int j)

Description copied from class: Vector

Swaps the specified elements of this vector.

Overrides:

swapElements in class Vector

Parameters:

i - element's index

j - element's index

copyOfLength

public Vector copyOfLength(int length)

Description copied from class: Vector

Copies this vector into the new vector with specified length.

Specified by:

copyOfLength in class Vector

Parameters:

length - the length of new vector

Returns:

the copy of this vector with new length

toArray

public double[] toArray()

Description copied from class: DenseVector

Converts this dense vector to a double array.

Specified by:

toArray in class DenseVector

Returns:

an array representation of this vector

to

public <T extends Vector> T to(VectorFactory<T> factory)

Description copied from class: Vector

Converts this vector using the given factory.

Overrides:

to in class Vector

Type Parameters:

T - type of the result vector

Parameters:

factory - the factory that creates an output vector

Returns:

a converted vector

blankOfLength

public Vector blankOfLength(int length)

Description copied from class: Vector

Creates a blank (an empty vector) copy of this vector with the given length.

Specified by:

blankOfLength in class Vector

Parameters:

length - the length of the blank vector

Returns:

blank vector

toBinary

public byte[] toBinary()

Description copied from class: Vector

Encodes this vector into a byte array.

Specified by:

toBinary in class Vector

Returns:

a byte array representing this vector