CSRVec

java.lang.Object
- edu.umich.eecs.april.jmat.Vec
- - edu.umich.eecs.april.jmat.CSRVec

```
public class CSRVec
extends Vec
```
Sparse vector implementation using a column-sorted row.

Field Summary

Fields
Modifier and Type	Field and Description
`int[]`	`indices`
`(package private) int`	`lastGetIdx`
`(package private) int`	`lastSetIdx`
`int`	`length`
`(package private) static int`	`MIN_SIZE`
`int`	`nz`
`double[]`	`values`

Constructor Summary

Constructors
Constructor and Description

CSRVec(int length)

CSRVec(int length, int capacity)

Constructors
Constructor and Description
`CSRVec(int length)`
`CSRVec(int length, int capacity)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`add(CSRVec csra, double ascale, CSRVec csrb, int i0, int i1, CSRVec res)`
`void`	`addTo(Vec _r, double scale)` Add this vector (scaled) to another vector.
`void`	`addTo(Vec _r, double scale, int i0, int i1)`
`void`	`clear()` Set all elements to zero.
`Vec`	`copy()` Make a copy of the vector
`CSRVec`	`copy(int i0, int i1)` create a new, smaller vector beginning at element i0, going through i1 (inclusive).
`double[]`	`copyArray()`
`Vec`	`copyPart(int i0, int i1)` create a same-sized vector containing only the spec'd elements.
`Vec`	`copyPermuteColumns(Permutation p)` reorder the columns of this matrix so that they are: X' = [ X(perm[0]) X(perm[1]) X(perm[2])... ]
`double`	`dotProduct(Vec r)` Compute the dot product with vector r
`double`	`dotProduct(Vec r, int i0, int i1)`
`void`	`ensureCapacity(int mincapacity)`
`void`	`filterZeros()` Remove any zeros that have snuck in.
`void`	`filterZeros(double eps)` Remove any values < eps that have snuck in.
`double`	`get(int idx)` Get the element at index idx
`double[]`	`getDoubles()` Return an array corresponding to the vector's elements.
`int`	`getNz()` How many non-zero entries are there?
`double`	`getRef(int idx)`
`(package private) void`	`grow()`
`(package private) void`	`grow(int mincapacity)`
`(package private) void`	`insert(int i, int idx, double v)`
`double`	`normF()` sum of squared elements.
`void`	`plusEquals(int idx, double v)` Add the value v to each element.
`void`	`resize(int newlength)` Resize the vector, truncating or adding zeros as appropriate.
`void`	`set(int idx, double v)` Set the element at index idx to v.
`void`	`setRef(int idx, double v)`
`int`	`size()` How long is the vector?
`(package private) void`	`sort()`
`void`	`timesEquals(double scale)` Multiply all elements in the vector by v
`void`	`timesEquals(double scale, int i0, int i1)` Multiply the elements between indices [i0,i1] (inclusive) by v
`void`	`transposeAsColumn(Matrix A, int col)` Insert this vector as column 'col' in matrix A.
`void`	`transposeAsColumn(Matrix A, int col, int i0, int i1)` Transpose only the elements at indices [i0,i1] inclusive.

Methods inherited from class edu.umich.eecs.april.jmat.Vec
plusEquals

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

- Field Detail
  - length
```
public int length
```
  - indices
```
public int[] indices
```
  - values
```
public double[] values
```
  - nz
```
public int nz
```
  - lastGetIdx
```
int lastGetIdx
```
  - lastSetIdx
```
int lastSetIdx
```
  - MIN_SIZE
```
static final int MIN_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CSRVec
```
public CSRVec(int length)
```
  - CSRVec
```
public CSRVec(int length,
              int capacity)
```
- Method Detail
  - copy
```
public final Vec copy()
```
    Description copied from class: Vec
    
    Make a copy of the vector
    
    Specified by:
    
    copy in class Vec
  - copyArray
```
public final double[] copyArray()
```
    Specified by:
    
    copyArray in class Vec
  - getDoubles
```
public final double[] getDoubles()
```
    Description copied from class: Vec
    
    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.
    
    Specified by:
    
    getDoubles in class Vec
  - filterZeros
```
public final void filterZeros()
```
    Remove any zeros that have snuck in.
  - filterZeros
```
public final void filterZeros(double eps)
```
    Remove any values < eps that have snuck in.
  - insert
```
final void insert(int i,
                  int idx,
                  double v)
```
  - resize
```
public final void resize(int newlength)
```
    Description copied from class: Vec
    
    Resize the vector, truncating or adding zeros as appropriate.
    
    Specified by:
    
    resize in class Vec
  - sort
```
final void sort()
```
  - ensureCapacity
```
public final void ensureCapacity(int mincapacity)
```
  - grow
```
final void grow()
```
  - grow
```
final void grow(int mincapacity)
```
  - copy
```
public final CSRVec copy(int i0,
                         int i1)
```
    Description copied from class: Vec
    
    create a new, smaller vector beginning at element i0, going through i1 (inclusive). The length of this vector will be i1-i0+1.
    
    Specified by:
    
    copy in class Vec
  - copyPart
```
public final Vec copyPart(int i0,
                          int i1)
```
    Description copied from class: Vec
    
    create a same-sized vector containing only the spec'd elements.
    
    Specified by:
    
    copyPart in class Vec
  - size
```
public final int size()
```
    Description copied from class: Vec
    
    How long is the vector?
    
    Specified by:
    
    size in class Vec
  - getNz
```
public final int getNz()
```
    Description copied from class: Vec
    
    How many non-zero entries are there?
    
    Specified by:
    
    getNz in class Vec
  - get
```
public final double get(int idx)
```
    Description copied from class: Vec
    
    Get the element at index idx
    
    Specified by:
    
    get in class Vec
  - getRef
```
public final double getRef(int idx)
```
  - set
```
public final void set(int idx,
                      double v)
```
    Description copied from class: Vec
    
    Set the element at index idx to v.
    
    Specified by:
    
    set in class Vec
  - setRef
```
public final void setRef(int idx,
                         double v)
```
  - dotProduct
```
public final double dotProduct(Vec r)
```
    Description copied from class: Vec
    
    Compute the dot product with vector r
    
    Specified by:
    
    dotProduct in class Vec
  - dotProduct
```
public final double dotProduct(Vec r,
                               int i0,
                               int i1)
```
    Specified by:
    
    dotProduct in class Vec
  - timesEquals
```
public final void timesEquals(double scale)
```
    Description copied from class: Vec
    
    Multiply all elements in the vector by v
    
    Specified by:
    
    timesEquals in class Vec
  - timesEquals
```
public final void timesEquals(double scale,
                              int i0,
                              int i1)
```
    Description copied from class: Vec
    
    Multiply the elements between indices [i0,i1] (inclusive) by v
    
    Specified by:
    
    timesEquals in class Vec
  - transposeAsColumn
```
public final void transposeAsColumn(Matrix A,
                                    int col)
```
    Description copied from class: Vec
    
    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.
    
    Specified by:
    
    transposeAsColumn in class Vec
  - transposeAsColumn
```
public final void transposeAsColumn(Matrix A,
                                    int col,
                                    int i0,
                                    int i1)
```
    Description copied from class: Vec
    
    Transpose only the elements at indices [i0,i1] inclusive.
    
    Specified by:
    
    transposeAsColumn in class Vec
  - add
```
public static final void add(CSRVec csra,
                             double ascale,
                             CSRVec csrb,
                             int i0,
                             int i1,
                             CSRVec res)
```
  - addTo
```
public final void addTo(Vec _r,
                        double scale)
```
    Description copied from class: Vec
    
    Add this vector (scaled) to another vector. This vector is unchanged.
    
    Specified by:
    
    addTo in class Vec
  - addTo
```
public final void addTo(Vec _r,
                        double scale,
                        int i0,
                        int i1)
```
    Specified by:
    
    addTo in class Vec
  - plusEquals
```
public final void plusEquals(int idx,
                             double v)
```
    Description copied from class: Vec
    
    Add the value v to each element.
    
    Overrides:
    
    plusEquals in class Vec
  - clear
```
public final void clear()
```
    Description copied from class: Vec
    
    Set all elements to zero.
    
    Specified by:
    
    clear in class Vec
  - normF
```
public final double normF()
```
    Description copied from class: Vec
    
    sum of squared elements.
    
    Specified by:
    
    normF in class Vec
  - copyPermuteColumns
```
public final Vec copyPermuteColumns(Permutation p)
```
    Description copied from class: Vec
    
    reorder the columns of this matrix so that they are: X' = [ X(perm[0]) X(perm[1]) X(perm[2])... ]
    
    Specified by:
    
    copyPermuteColumns in class Vec

Class CSRVec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class edu.umich.eecs.april.jmat.Vec

Methods inherited from class java.lang.Object

Field Detail

length

indices

values

nz

lastGetIdx

lastSetIdx

MIN_SIZE

Constructor Detail

CSRVec

CSRVec

Method Detail

copy

copyArray

getDoubles

filterZeros

filterZeros

insert

resize

sort

ensureCapacity

grow

grow

copy

copyPart

size

getNz

get

getRef

set

setRef

dotProduct

dotProduct

timesEquals

timesEquals

transposeAsColumn

transposeAsColumn

add

addTo

addTo

plusEquals

clear

normF

copyPermuteColumns