org.ojalgo.matrix.store

Class MatrixStore.LogicalBuilder<N extends Number>

java.lang.Object

org.ojalgo.matrix.store.MatrixStore.LogicalBuilder<N>

All Implemented Interfaces:

Supplier<MatrixStore<N>>, ElementsSupplier<N>, Access2D.Collectable<N,TransformableRegion<N>>, Stream2D<N,MatrixStore<N>,TransformableRegion<N>,ElementsSupplier<N>>, Structure1D, Structure2D, Structure2D.Logical<MatrixStore<N>,MatrixStore.LogicalBuilder<N>>

Enclosing interface:

MatrixStore<N extends Number>

public static final class MatrixStore.LogicalBuilder<N extends Number>
extends Object
implements ElementsSupplier<N>, Structure2D.Logical<MatrixStore<N>,MatrixStore.LogicalBuilder<N>>

A builder that lets you logically construct matrices and/or encode element structure.

Author:

apete

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
MatrixStore.LogicalBuilder<N>	above(int numberOfRows)
MatrixStore.LogicalBuilder<N>	above(MatrixStore<N>... upperStore)
MatrixStore.LogicalBuilder<N>	above(N... elements)
MatrixStore.LogicalBuilder<N>	below(int numberOfRows)
MatrixStore.LogicalBuilder<N>	below(MatrixStore<N>... lowerStore)
MatrixStore.LogicalBuilder<N>	below(N... elements)
MatrixStore.LogicalBuilder<N>	bidiagonal(boolean upper, boolean assumeOne)
MatrixStore.LogicalBuilder<N>	column(int... columns)
MatrixStore.LogicalBuilder<N>	columns(int[] columns) A selection (re-ordering) of columns.
MatrixStore.LogicalBuilder<N>	conjugate()
PhysicalStore<N>	copy()
long	count() count() == countRows() * countColumns()
long	countColumns()
long	countRows()
MatrixStore.LogicalBuilder<N>	diagonal()
MatrixStore.LogicalBuilder<N>	diagonal(boolean maintain)
MatrixStore.LogicalBuilder<N>	diagonally(MatrixStore<N>... diagonally)
MatrixStore<N>	get()
MatrixStore.LogicalBuilder<N>	hermitian(boolean upper)
MatrixStore.LogicalBuilder<N>	hessenberg(boolean upper)
MatrixStore.LogicalBuilder<N>	left(int numberOfColumns)
MatrixStore.LogicalBuilder<N>	left(MatrixStore<N>... left)
MatrixStore.LogicalBuilder<N>	left(N... elements)
MatrixStore.LogicalBuilder<N>	limits(int rowLimit, int columnLimit) Setting either limit to < 0 is interpreted as "no limit" (useful when you only want to limit either the rows or columns, and don't know the size of the other)
MatrixStore.LogicalBuilder<N>	offsets(int rowOffset, int columnOffset)
PhysicalStore.Factory<N,?>	physical()
MatrixStore.LogicalBuilder<N>	right(int numberOfColumns)
MatrixStore.LogicalBuilder<N>	right(MatrixStore<N>... right)
MatrixStore.LogicalBuilder<N>	right(N... elements)
MatrixStore.LogicalBuilder<N>	row(int... rows)
MatrixStore.LogicalBuilder<N>	rows(int[] rows) A selection (re-ordering) of rows.
MatrixStore.LogicalBuilder<N>	superimpose(int row, int col, MatrixStore<N> matrix)
MatrixStore.LogicalBuilder<N>	superimpose(int row, int col, Number matrix)
MatrixStore.LogicalBuilder<N>	superimpose(MatrixStore<N> matrix)
void	supplyTo(TransformableRegion<N> receiver)
String	toString()
MatrixStore.LogicalBuilder<N>	transpose()
MatrixStore.LogicalBuilder<N>	triangular(boolean upper, boolean assumeOne)
MatrixStore.LogicalBuilder<N>	tridiagonal()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.matrix.store.ElementsSupplier

operateOnAll, operateOnAny, operateOnColumns, operateOnMatching, operateOnMatching, operateOnRows

Methods inherited from interface org.ojalgo.structure.Stream2D

operateOnAll, operateOnAll, operateOnAll, operateOnAll, operateOnAll

Methods inherited from interface org.ojalgo.structure.Access2D.Collectable

collect

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.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Method Detail

above

public MatrixStore.LogicalBuilder<N> above(int numberOfRows)

above

public MatrixStore.LogicalBuilder<N> above(MatrixStore<N>... upperStore)

Specified by:

above in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

above

public MatrixStore.LogicalBuilder<N> above(N... elements)

below

public MatrixStore.LogicalBuilder<N> below(int numberOfRows)

below

public MatrixStore.LogicalBuilder<N> below(MatrixStore<N>... lowerStore)

Specified by:

below in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

below

public MatrixStore.LogicalBuilder<N> below(N... elements)

bidiagonal

public MatrixStore.LogicalBuilder<N> bidiagonal(boolean upper,
                                                boolean assumeOne)

column

public MatrixStore.LogicalBuilder<N> column(int... columns)

See Also:

columns(int[])

columns

public MatrixStore.LogicalBuilder<N> columns(int[] columns)

A selection (re-ordering) of columns. Note that it's ok to reference the same base column more than once, and any negative column reference/index will translate to a column of zeros. The number of columns in the resulting matrix is the same as the number of elements in the columns index array.

conjugate

public MatrixStore.LogicalBuilder<N> conjugate()

copy

public PhysicalStore<N> copy()

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

diagonal

public MatrixStore.LogicalBuilder<N> diagonal()

Returns:

A square diagonal matrix (main diagonal only)

diagonal

public MatrixStore.LogicalBuilder<N> diagonal(boolean maintain)

Parameters:

maintain - Maintain the original matrix dimensions (resulting matrix not necessarily square).

Returns:

A diagonal matrix (main diagonal only)

diagonally

public MatrixStore.LogicalBuilder<N> diagonally(MatrixStore<N>... diagonally)

Specified by:

diagonally in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

get

public MatrixStore<N> get()

Specified by:

get in interface Supplier<MatrixStore<N extends Number>>

Specified by:

get in interface ElementsSupplier<N extends Number>

Specified by:

get in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

hermitian

public MatrixStore.LogicalBuilder<N> hermitian(boolean upper)

hessenberg

public MatrixStore.LogicalBuilder<N> hessenberg(boolean upper)

left

public MatrixStore.LogicalBuilder<N> left(int numberOfColumns)

left

public MatrixStore.LogicalBuilder<N> left(MatrixStore<N>... left)

Specified by:

left in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

left

public MatrixStore.LogicalBuilder<N> left(N... elements)

limits

public MatrixStore.LogicalBuilder<N> limits(int rowLimit,
                                            int columnLimit)

Setting either limit to < 0 is interpreted as "no limit" (useful when you only want to limit either the rows or columns, and don't know the size of the other)

offsets

public MatrixStore.LogicalBuilder<N> offsets(int rowOffset,
                                             int columnOffset)

physical

public PhysicalStore.Factory<N,?> physical()

Specified by:

physical in interface ElementsSupplier<N extends Number>

right

public MatrixStore.LogicalBuilder<N> right(int numberOfColumns)

right

public MatrixStore.LogicalBuilder<N> right(MatrixStore<N>... right)

Specified by:

right in interface Structure2D.Logical<MatrixStore<N extends Number>,MatrixStore.LogicalBuilder<N extends Number>>

right

public MatrixStore.LogicalBuilder<N> right(N... elements)

row

public MatrixStore.LogicalBuilder<N> row(int... rows)

See Also:

rows(int[])

rows

public MatrixStore.LogicalBuilder<N> rows(int[] rows)

A selection (re-ordering) of rows. Note that it's ok to reference the same base row more than once, and any negative row reference/index will translate to a row of zeros. The number of rows in the resulting matrix is the same as the number of elements in the rows index array.

superimpose

public MatrixStore.LogicalBuilder<N> superimpose(int row,
                                                 int col,
                                                 MatrixStore<N> matrix)

superimpose

public MatrixStore.LogicalBuilder<N> superimpose(int row,
                                                 int col,
                                                 Number matrix)

superimpose

public MatrixStore.LogicalBuilder<N> superimpose(MatrixStore<N> matrix)

supplyTo

public void supplyTo(TransformableRegion<N> receiver)

Specified by:

supplyTo in interface Access2D.Collectable<N extends Number,TransformableRegion<N extends Number>>

toString

public String toString()

Overrides:

toString in class Object

transpose

public MatrixStore.LogicalBuilder<N> transpose()

Specified by:

transpose in interface ElementsSupplier<N extends Number>

Specified by:

transpose in interface Stream2D<N extends Number,MatrixStore<N extends Number>,TransformableRegion<N extends Number>,ElementsSupplier<N extends Number>>

triangular

public MatrixStore.LogicalBuilder<N> triangular(boolean upper,
                                                boolean assumeOne)

tridiagonal

public MatrixStore.LogicalBuilder<N> tridiagonal()