jsat.linear

Class ConcatenatedVec

java.lang.Object

jsat.linear.Vec

jsat.linear.ConcatenatedVec

All Implemented Interfaces:

Serializable, Cloneable, Iterable<IndexValue>

public class ConcatenatedVec
extends Vec

ConcatenatedVec provides a light wrapper around a list of vectors to provide a view of one single vector that's length is the sum of the lengths of the inputs.

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConcatenatedVec(List<Vec> vecs) Creates a new Vector that is the concatenation of the given vectors in the given order.
ConcatenatedVec(Vec... vecs) Creates a new Vector that is the concatenation of the given vectors in the given order.

Method Summary

Modifier and Type	Method and Description
ConcatenatedVec	clone()
double	get(int index) Gets the value stored at a specific index in the vector
Iterator<IndexValue>	getNonZeroIterator(int start) Returns an iterator that will go over the non zero values starting from the specified index in the given vector.
void	increment(int index, double val) Increments the value stored at a specified index in the vector
boolean	isSparse() Indicates whether or not this vector is optimized for sparce computation, meaning that most values in the vector are zero - and considered implicit.
int	length() Returns the length of this vector
void	mutableAdd(double c, Vec b) Alters this vector such that this = this + c * b This method should be overloaded for a serious implementation.
int	nnz() Computes the number of non zero values in this vector
void	set(int index, double val) Sets the value stored at a specified index in the vector

Methods inherited from class jsat.linear.Vec

add, add, applyFunction, applyIndexFunction, arrayCopy, canBeMutated, copyTo, copyToCol, copyToRow, countNaNs, divide, dot, equals, equals, getNonZeroIterator, hashCode, iterator, kurtosis, max, mean, median, min, multiply, multiply, multiply, multiply, mutableAdd, mutableAdd, mutableDivide, mutableMultiply, mutablePairwiseDivide, mutablePairwiseMultiply, mutableSubtract, mutableSubtract, mutableSubtract, normalize, normalized, pairwiseDivide, pairwiseMultiply, pNorm, pNormDist, random, random, skewness, sortedCopy, standardDeviation, subtract, subtract, sum, toString, variance, zeroOut, zeros

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ConcatenatedVec

public ConcatenatedVec(List<Vec> vecs)

Creates a new Vector that is the concatenation of the given vectors in the given order. The vector created is backed by the ones provided, and any mutation to one is visible in the others.

Parameters:

vecs - the list of vectors to concatenate

ConcatenatedVec

public ConcatenatedVec(Vec... vecs)

Creates a new Vector that is the concatenation of the given vectors in the given order. The vector created is backed by the ones provided, and any mutation to one is visible in the others.

Parameters:

vecs - the array of vectors to concatenate

Method Detail

length

public int length()

Description copied from class: Vec

Returns the length of this vector

Specified by:

length in class Vec

Returns:

the length of this vector

get

public double get(int index)

Description copied from class: Vec

Gets the value stored at a specific index in the vector

Specified by:

get in class Vec

Parameters:

index - the index to access

Returns:

the double value in the vector

set

public void set(int index,
                double val)

Description copied from class: Vec

Sets the value stored at a specified index in the vector

Specified by:

set in class Vec

Parameters:

index - the index to access

val - the value to store in the index

increment

public void increment(int index,
                      double val)

Description copied from class: Vec

Increments the value stored at a specified index in the vector

Overrides:

increment in class Vec

Parameters:

index - the index to access

val - the value to store in the index

nnz

public int nnz()

Description copied from class: Vec

Computes the number of non zero values in this vector

Overrides:

nnz in class Vec

Returns:

the number of non zero values stored

mutableAdd

public void mutableAdd(double c,
                       Vec b)

Description copied from class: Vec

Alters this vector such that this = this + c * b

This method should be overloaded for a serious implementation.

Overrides:

mutableAdd in class Vec

Parameters:

c - a scalar constant

b - the vector to add to this

getNonZeroIterator

public Iterator<IndexValue> getNonZeroIterator(int start)

Description copied from class: Vec

Returns an iterator that will go over the non zero values starting from the specified index in the given vector. The iterator does not support the Iterator.remove() method.

This method should be overloaded for a serious implementation.

Overrides:

getNonZeroIterator in class Vec

Parameters:

start - the first index (inclusive) to start returning non-zero values from

Returns:

an iterator for the non zero index value pairs

isSparse

public boolean isSparse()

Description copied from class: Vec

Indicates whether or not this vector is optimized for sparce computation, meaning that most values in the vector are zero - and considered implicit. Only non-zero values are stored.

Specified by:

isSparse in class Vec

Returns:

true if the vector is sparce, false otherwise.

clone

public ConcatenatedVec clone()

Specified by:

clone in class Vec