edu.umich.eecs.april.jmat

Class Vec

java.lang.Object

edu.umich.eecs.april.jmat.Vec

Direct Known Subclasses:

CSRVec, DenseVec

public abstract class Vec
extends java.lang.Object

Base type of all vectors (both sparse and dense).

Constructor Summary

Constructors

Constructor and Description
Vec()

Method Summary

Modifier and Type	Method and Description
abstract void	addTo(Vec r, double scale) Add this vector (scaled) to another vector.
abstract void	addTo(Vec r, double scale, int i0, int i1)
abstract void	clear() Set all elements to zero.
abstract Vec	copy() Make a copy of the vector
abstract Vec	copy(int i0, int i1) create a new, smaller vector beginning at element i0, going through i1 (inclusive).
abstract double[]	copyArray()
abstract Vec	copyPart(int i0, int i1) create a same-sized vector containing only the spec'd elements.
abstract Vec	copyPermuteColumns(Permutation p) reorder the columns of this matrix so that they are: X' = [ X(perm[0]) X(perm[1]) X(perm[2])... ]
abstract double	dotProduct(Vec r) Compute the dot product with vector r
abstract double	dotProduct(Vec r, int i0, int i1)
abstract double	get(int idx) Get the element at index idx
abstract double[]	getDoubles() Return an array corresponding to the vector's elements.
abstract int	getNz() How many non-zero entries are there?
abstract double	normF() sum of squared elements.
void	plusEquals(int idx, double v) Add the value v to each element.
void	plusEquals(int idx, double[] v) Add the vector v to the elements beginning at index idx
abstract void	resize(int newlength) Resize the vector, truncating or adding zeros as appropriate.
abstract void	set(int idx, double v) Set the element at index idx to v.
abstract int	size() How long is the vector?
abstract void	timesEquals(double v) Multiply all elements in the vector by v
abstract void	timesEquals(double v, int i0, int i1) Multiply the elements between indices [i0,i1] (inclusive) by v
abstract void	transposeAsColumn(Matrix A, int col) Insert this vector as column 'col' in matrix A.
abstract void	transposeAsColumn(Matrix A, int col, int i0, int i1) Transpose only the elements at indices [i0,i1] inclusive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Vec

public Vec()

Method Detail

getDoubles

public abstract double[] getDoubles()

Return an array corresponding to the vector's elements. This may or may not be the internal representation of the vector, so callers should not modify this array.

size

public abstract int size()

How long is the vector?

getNz

public abstract int getNz()

How many non-zero entries are there?

get

public abstract double get(int idx)

Get the element at index idx

set

public abstract void set(int idx,
                         double v)

Set the element at index idx to v.

dotProduct

public abstract double dotProduct(Vec r)

Compute the dot product with vector r

dotProduct

public abstract double dotProduct(Vec r,
                                  int i0,
                                  int i1)

copy

public abstract Vec copy()

Make a copy of the vector

copyArray

public abstract double[] copyArray()

resize

public abstract void resize(int newlength)

Resize the vector, truncating or adding zeros as appropriate.

copy

public abstract Vec copy(int i0,
                         int i1)

create a new, smaller vector beginning at element i0, going through i1 (inclusive). The length of this vector will be i1-i0+1.

copyPart

public abstract Vec copyPart(int i0,
                             int i1)

create a same-sized vector containing only the spec'd elements.

timesEquals

public abstract void timesEquals(double v)

Multiply all elements in the vector by v

timesEquals

public abstract void timesEquals(double v,
                                 int i0,
                                 int i1)

Multiply the elements between indices [i0,i1] (inclusive) by v

clear

public abstract void clear()

Set all elements to zero.

plusEquals

public void plusEquals(int idx,
                       double v)

Add the value v to each element.

plusEquals

public void plusEquals(int idx,
                       double[] v)

Add the vector v to the elements beginning at index idx

normF

public abstract double normF()

sum of squared elements.

transposeAsColumn

public abstract void transposeAsColumn(Matrix A,
                                       int col)

Insert this vector as column 'col' in matrix A. The column is initially all zero. The vector should iterate through its elements, calling the matrix's set method.

transposeAsColumn

public abstract void transposeAsColumn(Matrix A,
                                       int col,
                                       int i0,
                                       int i1)

Transpose only the elements at indices [i0,i1] inclusive.

addTo

public abstract void addTo(Vec r,
                           double scale)

Add this vector (scaled) to another vector. This vector is unchanged.

addTo

public abstract void addTo(Vec r,
                           double scale,
                           int i0,
                           int i1)

copyPermuteColumns

public abstract Vec copyPermuteColumns(Permutation p)

reorder the columns of this matrix so that they are: X' = [ X(perm[0]) X(perm[1]) X(perm[2])... ]