org.ojalgo.structure

Class MatrixView<N extends Number>

java.lang.Object

org.ojalgo.structure.MatrixView<N>

All Implemented Interfaces:

Comparable<MatrixView<N>>, Iterable<MatrixView<N>>, Iterator<MatrixView<N>>, Access1D<N>, Access2D<N>, Structure1D, Structure2D

public class MatrixView<N extends Number>
extends Object
implements Access2D<N>, Iterable<MatrixView<N>>, Iterator<MatrixView<N>>, Comparable<MatrixView<N>>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.structure.Access2D

Access2D.Aggregatable<N extends Number>, Access2D.Collectable<N extends Number,R extends Mutate2D.Receiver<N>>, Access2D.Elements, Access2D.ElementView<N extends Number>, Access2D.IndexOf, Access2D.Sliceable<N extends Number>, Access2D.Visitable<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure2D

Structure2D.IntRowColumn, Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,?>>, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.RowColumnCallback, Structure2D.RowColumnKey<R,C>, Structure2D.RowColumnMapper<R,C>

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MatrixView(AccessAnyD<N> access)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MatrixView<N> other)
long	count() count() == countRows() * countColumns()
long	countColumns()
long	countRows()
double	doubleValue(long row, long col) Extracts one element of this matrix as a double.
long	estimateSize()
N	get(long row, long col)
boolean	hasNext()
boolean	hasPrevious()
long	index()
MatrixView<N>	iterator()
MatrixView<N>	next()
MatrixView<N>	previous()
void	remove()
protected void	setIndex(long matrix)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.Access2D

asCollectable2D, asPrimitive2D, byteValue, byteValue, columns, doubleValue, elements, equals, floatValue, floatValue, get, intValue, intValue, longValue, longValue, newPrimitiveColumnCollectable, newPrimitiveRowCollectable, rows, shortValue, shortValue, toRawCopy2D, toString, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Structure2D

column, column, column, column, column, count, index, index, isEmpty, isFat, isScalar, isSquare, isTall, isVector, loopAll, loopColumn, loopColumn, loopDiagonal, loopMatching, loopRow, loopRow, mapperOf, row, row, row, row, row

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, equals, hashCode, nonzeros, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

MatrixView

protected MatrixView(AccessAnyD<N> access)

Method Detail

compareTo

public int compareTo(MatrixView<N> other)

Specified by:

compareTo in interface Comparable<MatrixView<N extends Number>>

count

public long count()

Description copied from interface: Structure2D

count() == countRows() * countColumns()

Specified by:

count in interface Structure1D

Specified by:

count in interface Structure2D

Returns:

The total number of elements in this structure.

countColumns

public long countColumns()

Specified by:

countColumns in interface Structure2D

Returns:

The number of columns

countRows

public long countRows()

Specified by:

countRows in interface Structure2D

Returns:

The number of rows

doubleValue

public double doubleValue(long row,
                          long col)

Description copied from interface: Access2D

Extracts one element of this matrix as a double.

Specified by:

doubleValue in interface Access2D<N extends Number>

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element

estimateSize

public long estimateSize()

get

public N get(long row,
             long col)

Specified by:

get in interface Access2D<N extends Number>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<MatrixView<N extends Number>>

hasPrevious

public boolean hasPrevious()

index

public long index()

Returns:

The index of the matrix (which matrix are we currently viewing).

iterator

public MatrixView<N> iterator()

Specified by:

iterator in interface Iterable<MatrixView<N extends Number>>

next

public MatrixView<N> next()

Specified by:

next in interface Iterator<MatrixView<N extends Number>>

previous

public MatrixView<N> previous()

remove

public final void remove()

Specified by:

remove in interface Iterator<MatrixView<N extends Number>>

toString

public final String toString()

Overrides:

toString in class Object

setIndex

protected void setIndex(long matrix)