cern.colt.matrix.tlong

Class LongFactory1D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.tlong.LongFactory1D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LongFactory1D
extends PersistentObject

Factory for convenient construction of 1-d matrices holding int cells. Use idioms like LongFactory1D.dense.make(1000) to construct dense matrices, LongFactory1D.sparse.make(1000) to construct sparse matrices. If the factory is used frequently it might be useful to streamline the notation. For example by aliasing:

LongFactory1D F = LongFactory1D.dense; F.make(1000); F.descending(10); F.random(3); ...

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LongFactory1D	dense A factory producing dense matrices.
static LongFactory1D	sparse A factory producing sparse matrices.

Method Summary

Modifier and Type	Method and Description
LongMatrix1D	append(LongMatrix1D A, LongMatrix1D B) C = A||B; Constructs a new matrix which is the concatenation of two other matrices.
LongMatrix1D	ascending(int size) Constructs a matrix with cells having ascending values.
LongMatrix1D	descending(int size) Constructs a matrix with cells having descending values.
LongMatrix1D	make(AbstractLongList values) Constructs a matrix from the values of the given list.
LongMatrix1D	make(int size) Constructs a matrix with the given shape, each cell initialized with zero.
LongMatrix1D	make(int size, long initialValue) Constructs a matrix with the given shape, each cell initialized with the given value.
LongMatrix1D	make(long[] values) Constructs a matrix with the given cell values.
LongMatrix1D	make(LongMatrix1D[] parts) Constructs a matrix which is the concatenation of all given parts.
LongMatrix1D	random(int size) Constructs a matrix with uniformly distributed values in (0,1) (exclusive).
LongMatrix1D	repeat(LongMatrix1D A, int repeat) C = A||A||..||A; Constructs a new matrix which is concatenated repeat times.
LongMatrix1D	sample(int size, int value, int nonZeroFraction) Constructs a randomly sampled matrix with the given shape.
LongArrayList	toList(LongMatrix1D values) Constructs a list from the given matrix.

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

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

Field Detail

dense

public static final LongFactory1D dense

A factory producing dense matrices.

sparse

public static final LongFactory1D sparse

A factory producing sparse matrices.

Method Detail

append

public LongMatrix1D append(LongMatrix1D A,
                           LongMatrix1D B)

C = A||B; Constructs a new matrix which is the concatenation of two other matrices. Example: 0 1 append 3 4 --> 0 1 3 4.

ascending

public LongMatrix1D ascending(int size)

Constructs a matrix with cells having ascending values. For debugging purposes. Example: 0 1 2

descending

public LongMatrix1D descending(int size)

Constructs a matrix with cells having descending values. For debugging purposes. Example: 2 1 0

make

public LongMatrix1D make(long[] values)

Constructs a matrix with the given cell values. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

make

public LongMatrix1D make(LongMatrix1D[] parts)

Constructs a matrix which is the concatenation of all given parts. Cells are copied.

make

public LongMatrix1D make(int size)

Constructs a matrix with the given shape, each cell initialized with zero.

make

public LongMatrix1D make(int size,
                         long initialValue)

Constructs a matrix with the given shape, each cell initialized with the given value.

make

public LongMatrix1D make(AbstractLongList values)

Constructs a matrix from the values of the given list. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

Returns:

a new matrix.

random

public LongMatrix1D random(int size)

Constructs a matrix with uniformly distributed values in (0,1) (exclusive).

repeat

public LongMatrix1D repeat(LongMatrix1D A,
                           int repeat)

C = A||A||..||A; Constructs a new matrix which is concatenated repeat times. Example:

   0 1
   repeat(3) -->
   0 1 0 1 0 1
 
 

sample

public LongMatrix1D sample(int size,
                           int value,
                           int nonZeroFraction)

Constructs a randomly sampled matrix with the given shape. Randomly picks exactly Math.round(size*nonZeroFraction) cells and initializes them to value, all the rest will be initialized to zero. Note that this is not the same as setting each cell with probability nonZeroFraction to value.

Throws:

java.lang.IllegalArgumentException - if nonZeroFraction < 0 || nonZeroFraction > 1.

See Also:

DoubleRandomSamplingAssistant

toList

public LongArrayList toList(LongMatrix1D values)

Constructs a list from the given matrix. The values are copied. So subsequent changes in values are not reflected in the list, and vice-versa.

Parameters:

values - The values to be filled into the new list.

Returns:

a new list.