uk.co.strangeskies.mathematics.geometry.matrix

Interface Matrix<S extends Matrix<S,V>,V extends Value<V>>

All Superinterfaces:

Addable<S,Matrix<?,?>>, java.lang.Comparable<Matrix<?,?>>, Copyable<S>, Expression<S>, Multipliable<S,Matrix<?,?>>, Negatable<S,S>, NonCommutativelyMultipliable<S,Matrix<?,?>>, Scalable<S>, Self<S>, SelfExpression<S>, Subtractable<S,Matrix<?,?>>

All Known Subinterfaces:

Matrix2<V>, Matrix3<V>, Matrix4<V>, MatrixH<S,V>, MatrixH2<V>, MatrixH3<V>, MatrixHN<V>, MatrixN<V>, MatrixNN<V>, MatrixS<S,V>, Vector<S,V>, Vector2<V>, Vector3<V>, Vector4<V>, VectorH<S,V>, VectorH2<V>, VectorH3<V>, VectorHN<V>, VectorN<V>

All Known Implementing Classes:

ReOrderedMatrix

public interface Matrix<S extends Matrix<S,V>,V extends Value<V>>
extends java.lang.Comparable<Matrix<?,?>>, SelfExpression<S>, Scalable<S>, Subtractable<S,Matrix<?,?>>, Negatable<S,S>, NonCommutativelyMultipliable<S,Matrix<?,?>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Matrix.Order

Method Summary

Modifier and Type	Method and Description
default S	add(Matrix<?,?> other) add the value to this
static <T extends Matrix<?,?>> T	assertDimensions(T matrix, int size)
static <T extends Matrix<?,?>> T	assertDimensions(T matrix, int rows, int columns)
static <T extends Matrix<?,?>> T	assertIsSquare(T matrix)
default S	divide(double scalar)
default S	divide(long scalar)
default S	divide(Value<?> scalar)
default int	getColumnSize()
default Vector<?,V>	getColumnVector(int column)
default java.util.List<? extends Vector<?,V>>	getColumnVectors()
java.util.List<V>	getData()
default double[]	getData(double[] dataArray)
default float[]	getData(float[] dataArray)
default int[]	getData(int[] dataArray)
default long[]	getData(long[] dataArray)
java.util.List<java.util.List<V>>	getData2()
default double[][]	getData2(double[][] dataArray)
default float[][]	getData2(float[][] dataArray)
default int[][]	getData2(int[][] dataArray)
default long[][]	getData2(long[][] dataArray)
default int	getDataSize()
Vector2<IntValue>	getDimensions2() Get the dimensions as: [columns, rows].
default double[]	getDoubleData()
default double[][]	getDoubleData2()
V	getElement(int major, int minor)
default float[]	getFloatData()
default float[][]	getFloatData2()
default int[]	getIntData()
default int[][]	getIntData2()
default long[]	getLongData()
default long[][]	getLongData2()
int	getMajorSize()
Vector<?,V>	getMajorVector(int index)
default java.util.List<? extends Vector<?,V>>	getMajorVectors()
int	getMinorSize()
Vector<?,V>	getMinorVector(int index)
default java.util.List<? extends Vector<?,V>>	getMinorVectors()
Matrix.Order	getOrder()
default int	getRowSize()
default Vector<?,V>	getRowVector(int row)
default java.util.List<? extends Vector<?,V>>	getRowVectors()
Matrix<?,V>	getTransposed()
default boolean	isSquare()
default S	multiply(double scalar)
default S	multiply(long scalar)
default S	multiply(Matrix<?,?> other)
default S	multiply(Value<?> scalar)
static <V extends Value<?>> java.util.List<java.util.List<V>>	multiplyData(java.util.List<? extends java.util.List<? extends Value<?>>> data, java.util.List<? extends java.util.List<? extends Value<?>>> otherData)
default S	negate()
S	operateOnData(java.util.function.BiFunction<? super V,java.lang.Integer,? extends V> operator)
S	operateOnData(java.util.function.Function<? super V,? extends V> operator)
default <I> S	operateOnData(java.util.List<? extends I> itemList, java.util.function.BiFunction<? super V,? super I,? extends V> operator)
default <I> S	operateOnData2(java.util.List<? extends java.util.List<? extends I>> itemList, java.util.function.BiFunction<? super V,? super I,? extends V> operator)
S	operateOnData2(TriFunction<? super V,java.lang.Integer,java.lang.Integer,? extends V> operator)
default S	preMultiply(Matrix<?,?> other)
static <V extends Value<?>> java.util.List<java.util.List<V>>	preMultiplyData(java.util.List<? extends java.util.List<? extends Value<?>>> data, java.util.List<? extends java.util.List<? extends Value<?>>> otherData)
default S	setData(boolean setByReference, java.util.List<? extends V> to)
default S	setData(boolean setByReference, V... to)
default S	setData(double[] to)
default S	setData(float[] to)
default S	setData(int[] to)
default S	setData(java.util.List<? extends Value<?>> to)
default S	setData(long[] to)
default S	setData(java.lang.Number... values)
default S	setData(Value<?>... to)
default S	setData2(boolean setByReference, java.util.List<? extends java.util.List<? extends V>> to)
default S	setData2(boolean copyByReference, Vector<?,V>... to)
default S	setData2(double[]... to)
default S	setData2(float[]... to)
default S	setData2(int[]... to)
default S	setData2(java.util.List<? extends java.util.List<? extends Value<?>>> to)
default S	setData2(long[]... to)
default S	setData2(Vector<?,?>... values)
default S	subtract(Matrix<?,?> other) subtract the value from this
S	transpose()
static <V extends Value<V>> java.util.List<java.util.List<V>>	transposeData(java.util.List<java.util.List<V>> data)
Matrix<?,V>	withOrder(Matrix.Order order)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface uk.co.strangeskies.expression.Expression

anonymize, decoupleValue, getValue, immutable, invalidations, over, over

Methods inherited from interface uk.co.strangeskies.mathematics.operation.Scalable

divide, divide, getDivided, getDivided, getDivided, getDivided, getDivided, getMultiplied, getMultiplied, getMultiplied, getMultiplied, getMultiplied, multiply, multiply

Methods inherited from interface uk.co.strangeskies.mathematics.operation.Subtractable

getSubtracted

Methods inherited from interface uk.co.strangeskies.mathematics.operation.Addable

getAdded

Methods inherited from interface uk.co.strangeskies.mathematics.operation.Negatable

getNegated

Methods inherited from interface uk.co.strangeskies.mathematics.operation.NonCommutativelyMultipliable

getPreMultiplied

Methods inherited from interface uk.co.strangeskies.mathematics.operation.Multipliable

getMultiplied

Method Detail

getOrder

Matrix.Order getOrder()

withOrder

Matrix<?,V> withOrder(Matrix.Order order)

Returns:

A view of this matrix with the requested order. Changes to the view affect this matrix and vice versa.

getMajorVector

Vector<?,V> getMajorVector(int index)

getMinorVector

Vector<?,V> getMinorVector(int index)

getData

java.util.List<V> getData()

getData2

java.util.List<java.util.List<V>> getData2()

getDimensions2

Vector2<IntValue> getDimensions2()

Get the dimensions as: [columns, rows].

Returns:

A vector representing the current dimensions.

negate

default S negate()

Specified by:

negate in interface Negatable<S extends Matrix<S,V>,S extends Matrix<S,V>>

multiply

default S multiply(Value<?> scalar)

Specified by:

multiply in interface Scalable<S extends Matrix<S,V>>

multiply

default S multiply(long scalar)

Specified by:

multiply in interface Scalable<S extends Matrix<S,V>>

multiply

default S multiply(double scalar)

Specified by:

multiply in interface Scalable<S extends Matrix<S,V>>

divide

default S divide(Value<?> scalar)

Specified by:

divide in interface Scalable<S extends Matrix<S,V>>

divide

default S divide(long scalar)

Specified by:

divide in interface Scalable<S extends Matrix<S,V>>

divide

default S divide(double scalar)

Specified by:

divide in interface Scalable<S extends Matrix<S,V>>

add

default S add(Matrix<?,?> other)

Description copied from interface: Addable

add the value to this

Specified by:

add in interface Addable<S extends Matrix<S,V>,Matrix<?,?>>

Parameters:

other - the value to add to this

Returns:

this

subtract

default S subtract(Matrix<?,?> other)

Description copied from interface: Subtractable

subtract the value from this

Specified by:

subtract in interface Subtractable<S extends Matrix<S,V>,Matrix<?,?>>

Parameters:

other - the value to add to the copy

Returns:

the copy with the added value

multiply

default S multiply(Matrix<?,?> other)

Specified by:

multiply in interface Multipliable<S extends Matrix<S,V>,Matrix<?,?>>

preMultiply

default S preMultiply(Matrix<?,?> other)

Specified by:

preMultiply in interface NonCommutativelyMultipliable<S extends Matrix<S,V>,Matrix<?,?>>

multiplyData

static <V extends Value<?>> java.util.List<java.util.List<V>> multiplyData(java.util.List<? extends java.util.List<? extends Value<?>>> data,
                                                                           java.util.List<? extends java.util.List<? extends Value<?>>> otherData)

preMultiplyData

static <V extends Value<?>> java.util.List<java.util.List<V>> preMultiplyData(java.util.List<? extends java.util.List<? extends Value<?>>> data,
                                                                              java.util.List<? extends java.util.List<? extends Value<?>>> otherData)

transpose

S transpose()

getTransposed

Matrix<?,V> getTransposed()

transposeData

static <V extends Value<V>> java.util.List<java.util.List<V>> transposeData(java.util.List<java.util.List<V>> data)

getDataSize

default int getDataSize()

getMajorSize

int getMajorSize()

getMinorSize

int getMinorSize()

getElement

V getElement(int major,
             int minor)

getRowSize

default int getRowSize()

getColumnSize

default int getColumnSize()

isSquare

default boolean isSquare()

assertIsSquare

static <T extends Matrix<?,?>> T assertIsSquare(T matrix)

assertDimensions

static <T extends Matrix<?,?>> T assertDimensions(T matrix,
                                                  int rows,
                                                  int columns)

assertDimensions

static <T extends Matrix<?,?>> T assertDimensions(T matrix,
                                                  int size)

getRowVectors

default java.util.List<? extends Vector<?,V>> getRowVectors()

getColumnVectors

default java.util.List<? extends Vector<?,V>> getColumnVectors()

getRowVector

default Vector<?,V> getRowVector(int row)

getColumnVector

default Vector<?,V> getColumnVector(int column)

getMajorVectors

default java.util.List<? extends Vector<?,V>> getMajorVectors()

getMinorVectors

default java.util.List<? extends Vector<?,V>> getMinorVectors()

getData

default int[] getData(int[] dataArray)

getData

default long[] getData(long[] dataArray)

getData

default float[] getData(float[] dataArray)

getData

default double[] getData(double[] dataArray)

getData2

default int[][] getData2(int[][] dataArray)

getData2

default long[][] getData2(long[][] dataArray)

getData2

default float[][] getData2(float[][] dataArray)

getData2

default double[][] getData2(double[][] dataArray)

getIntData

default int[] getIntData()

getLongData

default long[] getLongData()

getFloatData

default float[] getFloatData()

getDoubleData

default double[] getDoubleData()

getIntData2

default int[][] getIntData2()

getLongData2

default long[][] getLongData2()

getFloatData2

default float[][] getFloatData2()

getDoubleData2

default double[][] getDoubleData2()

operateOnData

S operateOnData(java.util.function.Function<? super V,? extends V> operator)

operateOnData

S operateOnData(java.util.function.BiFunction<? super V,java.lang.Integer,? extends V> operator)

operateOnData2

S operateOnData2(TriFunction<? super V,java.lang.Integer,java.lang.Integer,? extends V> operator)

operateOnData

default <I> S operateOnData(java.util.List<? extends I> itemList,
                            java.util.function.BiFunction<? super V,? super I,? extends V> operator)

operateOnData2

default <I> S operateOnData2(java.util.List<? extends java.util.List<? extends I>> itemList,
                             java.util.function.BiFunction<? super V,? super I,? extends V> operator)

setData2

default S setData2(boolean setByReference,
                   java.util.List<? extends java.util.List<? extends V>> to)

setData

default S setData(boolean setByReference,
                  java.util.List<? extends V> to)

setData

default S setData(boolean setByReference,
                  V... to)

setData

default S setData(java.lang.Number... values)

setData

default S setData(Value<?>... to)

setData

default S setData(int[] to)

setData

default S setData(long[] to)

setData

default S setData(float[] to)

setData

default S setData(double[] to)

setData2

default S setData2(int[]... to)

setData2

default S setData2(long[]... to)

setData2

default S setData2(float[]... to)

setData2

default S setData2(double[]... to)

setData2

default S setData2(boolean copyByReference,
                   Vector<?,V>... to)

setData2

default S setData2(Vector<?,?>... values)

setData2

default S setData2(java.util.List<? extends java.util.List<? extends Value<?>>> to)

setData

default S setData(java.util.List<? extends Value<?>> to)