Package mklab.JGNN.core.matrix

Class WrapRows

java.lang.Object

mklab.JGNN.core.Tensor

mklab.JGNN.core.Matrix

mklab.JGNN.core.matrix.WrapRows

All Implemented Interfaces:

Iterable<Long>

public class WrapRows
extends Matrix

Wraps a list of tensors into a matrix with the tensors as rows. Does not allocate additional elements. Editing the matrix edits the original tensors and conversely.

Author:

Emmanouil Krasanakis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	WrapRows.Wrap1DIterator
protected class	WrapRows.Wrap2DIterator

Field Summary

Fields inherited from class mklab.JGNN.core.Tensor

vectorization

Constructor Summary

Constructors

Constructor	Description
WrapRows(List<Tensor> rows)
WrapRows(Tensor... rows)

Method Summary

Modifier and Type	Method	Description
Tensor	accessRow(long row)	Retrieves the given row as a tensor.
protected void	allocate(long size)
long	estimateNumNonZeroElements()	Provides an estimation for the non-zero number of elements stored in the tensor, where this number is equal to the size for dense tensors, but equal to the actual number of non-zero elements for sparse tensors.
double	get(long pos)	Retrieves the value of a tensor element at a given position.
Iterable<Map.Entry<Long,Long>>	getNonZeroEntries()	Retrieves an iterable that traverses (row, col) entry pairs of non zero entries.
void	persist()	If supported by the subclassed tensor, invalidates calls to Tensor.release() so that memory is de-allocated only when object references expire.
Tensor	put(long pos, double value)	Assign a value to a tensor element.
void	release()	If the subclassed tensor allows it, release all memory it takes up so that the garbage collector will eventually clean it up.
WrapRows	setZeroCopyType(Matrix zeroCopyType)	Sets a prototype matrix from which to borrow copying operations.
Iterator<Long>	traverseNonZeroElements()	Retrieves positions within the tensor that may hold non-zero elements.
Matrix	zeroCopy(long rows, long cols)	Creates a matrix of the same class and all element set to zero, but with a given number of rows and columns.

Methods inherited from class mklab.JGNN.core.Matrix

accessCol, accessColumns, accessColumns, accessColumns, accessColumns, accessDim, accessRows, accessRows, accessRows, accessRows, asTransposed, describe, determineZeroCopy, external, eye, fromDouble, get, getColName, getCols, getDimensionSize, getRowName, getRows, isMatching, matmul, matmul, onesMask, put, setColName, setDiagonal, setDimensionName, setDimensionName, setMainDiagonal, setRowName, setToASymmetricNormalization, setToSymmetricNormalization, symmetricNormalization, toDense, toNonZeroString, toSparse, toString, transform, transposed, zeroCopy, zeroCopy, zeroCopy

Methods inherited from class mklab.JGNN.core.Tensor

abs, accessSubtensor, accessSubtensor, add, add, argmax, argmin, asColumn, asRow, assertFinite, assertMatching, assertSize, assign, cast, copy, density, determineZeroCopy, dot, dot, expMinusOne, fromRange, fromRange, getDimensionName, getNonZeroElements, init, inverse, iterator, log, max, min, multiply, multiply, negative, norm, normalized, putAdd, selfAbs, selfAdd, selfAdd, selfAdd, selfExpMinusOne, selfInverse, selfLog, selfMultiply, selfMultiply, selfNegative, selfSqrt, selfSubtract, setDimensionName, setToNormalized, setToOnes, setToProbability, setToRandom, setToRandom, setToUniform, setToZero, size, sqrt, subtract, sum, toArray, toDouble, toProbability

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

WrapRows

public WrapRows(Tensor... rows)

WrapRows

public WrapRows(List<Tensor> rows)

Method Details

estimateNumNonZeroElements

public long estimateNumNonZeroElements()

Description copied from class: Tensor

Provides an estimation for the non-zero number of elements stored in the tensor, where this number is equal to the size for dense tensors, but equal to the actual number of non-zero elements for sparse tensors. Basically, this quantity is proportional to the allocated memory.

Overrides:

estimateNumNonZeroElements in class Tensor

Returns:

A long number equal to or less to the tensor size.

See Also:

• Tensor.density()

setZeroCopyType

public WrapRows setZeroCopyType(Matrix zeroCopyType)

Sets a prototype matrix from which to borrow copying operations.

Parameters:

zeroCopyType - A Matrix instance from which to borrow zeroCopy(long, long).

Returns:

this object

zeroCopy

public Matrix zeroCopy(long rows,
 long cols)

Description copied from class: Matrix

Creates a matrix of the same class and all element set to zero, but with a given number of rows and columns.

Specified by:

zeroCopy in class Matrix

Parameters:

rows - The number of rows of the matrix.

cols - The number of columns of the matrix.

Returns:

A Matrix of the same class.

See Also:

• Matrix.zeroCopy()

allocate

protected void allocate(long size)

Specified by:

allocate in class Tensor

put

public Tensor put(long pos,
 double value)

Description copied from class: Tensor

Assign a value to a tensor element. All tensor operations use this function to wrap element assignments.

Specified by:

put in class Tensor

Parameters:

pos - The position of the tensor element.

value - The value to assign.

Returns:

this Tensor instance.

See Also:

• Tensor.put(int, double)

get

public double get(long pos)

Description copied from class: Tensor

Retrieves the value of a tensor element at a given position. All tensor operations use this function to wrap element retrieval.

Specified by:

get in class Tensor

Parameters:

pos - The position of the tensor element

Returns:

The value of the tensor element

traverseNonZeroElements

public Iterator<Long> traverseNonZeroElements()

Description copied from class: Tensor

Retrieves positions within the tensor that may hold non-zero elements. This guarantees that all non-zero elements positions are traversed but some of the returned positions could hold zero elements. For example, DenseTensor traverses all of its elements this way, whereas SparseTensor indeed traverses only non-zero elements.

Specified by:

traverseNonZeroElements in class Tensor

Returns:

An iterator that traverses positions within the tensor.

getNonZeroEntries

public Iterable<Map.Entry<Long,Long>> getNonZeroEntries()

Description copied from class: Matrix

Retrieves an iterable that traverses (row, col) entry pairs of non zero entries.

Specified by:

getNonZeroEntries in class Matrix

Returns:

An Entry iterable.

See Also:

• Tensor.getNonZeroElements()

accessRow

public Tensor accessRow(long row)

Description copied from class: Matrix

Retrieves the given row as a tensor. Editing the result also edits the original matrix. No new memory is allocated for matrix values.

Overrides:

accessRow in class Matrix

Parameters:

row - The given row.

Returns:

An AccessRow instance of the corresponding row.

See Also:

• Matrix.accessDim(long, String)
• Matrix.accessCol(long)
• Matrix.accessRows()
• Matrix.accessRows(long...)
• Matrix.accessRows(Tensor)

release

public void release()

Description copied from class: Tensor

If the subclassed tensor allows it, release all memory it takes up so that the garbage collector will eventually clean it up. This memory will be released anyway by Java once there are no more references to the object.

Specified by:

release in class Tensor

See Also:

• Tensor.persist()

persist

public void persist()

Description copied from class: Tensor

If supported by the subclassed tensor, invalidates calls to Tensor.release() so that memory is de-allocated only when object references expire.

Specified by:

persist in class Tensor

See Also:

• Tensor.release()