Package eu.bandm.tools.ops

Class FreeMatrix<I>

java.lang.Object

eu.bandm.tools.ops.AbstractFreeVector<Tuple2<I,I>>

eu.bandm.tools.ops.FreeMatrix<I>

Type Parameters:

I - the index type

public class FreeMatrix<I>
extends AbstractFreeVector<Tuple2<I,I>>

A real-valued matrix over an index set with finitely many nonzero coordinates, except perhaps for the diagonal.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FreeMatrix.OntoconeDemo

Field Summary

Fields

Modifier and Type	Field	Description
protected final double	identityDefault

Fields inherited from class eu.bandm.tools.ops.AbstractFreeVector

coords

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FreeMatrix(Map<Tuple2<I,I>,Double> coords, double identityDefault)

Method Summary

Modifier and Type	Method	Description
FreeMatrix<I>	add(FreeMatrix<I> other)
static <I> FreeMatrix<I>	build(Set<Tuple2<I,I>> support, ToDoubleBiFunction<? super I,? super I> value, double identityDefault)
static <I> FreeMatrix<I>	build(Set<I> rowSupport, Set<I> columnSupport, ToDoubleBiFunction<? super I,? super I> value, double identityDefault)
ToDoubleFunction<I>	column(I index)	Returns a function view on one column of this matrix.
Set<I>	columnSupport()
double	get(Tuple2<I,I> index)
double	get(I rowIndex, I columnIndex)
static <I> FreeMatrix<I>	identity()
boolean	isNonNegative()
boolean	isZero()
FreeMatrix<I>	multiply(FreeMatrix<I> other)
FreeVector<I>	multiply(FreeVector<I> other)
double	multiply(FreeVector<I> left, FreeVector<I> right)
protected Map<Tuple2<I,I>,Double>	multiplyCoords(FreeMatrix<I> other)
FreeMatrix<I>	power(long exponent)
ToDoubleFunction<I>	row(I index)	Returns a function view on one row of this matrix.
Set<I>	rowSupport()
FreeMatrix<I>	scale(double factor)
<J> FreeMatrix<J>	transformBoth(Function<I,J> fun)
FreeMatrix<I>	transpose()	Returns a copy of this matrix where rows and columns are exchanged.
FreeMatrix<I>	trim(double epsilon)
static <I> FreeMatrix<I>	unit(I rowIndex, I columnIndex)
static <I> FreeMatrix<I>	unit(I rowIndex, I columnIndex, double value)
static <I> FreeMatrix<I>	zero()

Methods inherited from class eu.bandm.tools.ops.AbstractFreeVector

addCoords, buildCoords, hasNonNegativeCoords, hasZeroCoords, nearlyEqual, scaleCoords, transformCoords, trimCoords

Methods inherited from class java.lang.Object

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

Field Details

identityDefault

protected final double identityDefault

Constructor Details

FreeMatrix

protected FreeMatrix(Map<Tuple2<I,I>,Double> coords,
 double identityDefault)

Method Details

get

public double get(I rowIndex,
 I columnIndex)

get

public double get(Tuple2<I,I> index)

zero

public static <I> FreeMatrix<I> zero()

identity

public static <I> FreeMatrix<I> identity()

unit

public static <I> FreeMatrix<I> unit(I rowIndex,
 I columnIndex)

unit

public static <I> FreeMatrix<I> unit(I rowIndex,
 I columnIndex,
 double value)

build

public static <I> FreeMatrix<I> build(Set<Tuple2<I,I>> support,
 ToDoubleBiFunction<? super I,? super I> value,
 double identityDefault)

build

public static <I> FreeMatrix<I> build(Set<I> rowSupport,
 Set<I> columnSupport,
 ToDoubleBiFunction<? super I,? super I> value,
 double identityDefault)

scale

public FreeMatrix<I> scale(double factor)

Specified by:

scale in class AbstractFreeVector<Tuple2<I,I>>

trim

public FreeMatrix<I> trim(double epsilon)

Specified by:

trim in class AbstractFreeVector<Tuple2<I,I>>

add

public FreeMatrix<I> add(FreeMatrix<I> other)

transformBoth

public <J> FreeMatrix<J> transformBoth(Function<I,J> fun)

transpose

public FreeMatrix<I> transpose()

Returns a copy of this matrix where rows and columns are exchanged.

Returns:

a copy of this matrix where rows and columns are exchanged

row

public ToDoubleFunction<I> row(I index)

Returns a function view on one row of this matrix.

Parameters:

index - the row index

Returns:

a function that returns the coordinates in the specified row of this matrix

See Also:

• FreeVector.build(java.util.Set<I>, java.util.function.ToDoubleFunction<? super I>)

column

public ToDoubleFunction<I> column(I index)

Returns a function view on one column of this matrix.

Parameters:

index - the column index

Returns:

a function that returns the coordinates in the specified column of this matrix

See Also:

• FreeVector.build(java.util.Set<I>, java.util.function.ToDoubleFunction<? super I>)

rowSupport

public Set<I> rowSupport()

columnSupport

public Set<I> columnSupport()

multiply

public FreeMatrix<I> multiply(FreeMatrix<I> other)

multiplyCoords

protected Map<Tuple2<I,I>,Double> multiplyCoords(FreeMatrix<I> other)

multiply

public FreeVector<I> multiply(FreeVector<I> other)

multiply

public double multiply(FreeVector<I> left,
 FreeVector<I> right)

power

public FreeMatrix<I> power(long exponent)

isZero

public boolean isZero()

Overrides:

isZero in class AbstractFreeVector<Tuple2<I,I>>

isNonNegative

public boolean isNonNegative()

Overrides:

isNonNegative in class AbstractFreeVector<Tuple2<I,I>>