org.ojalgo.matrix.store

Class MatrixStore.Builder<N extends Number>

java.lang.Object

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

All Implemented Interfaces:

Supplier<MatrixStore<N>>, Structure1D, Structure2D, Supplier2D<MatrixStore<N>>, ElementsSupplier<N>

Enclosing interface:

MatrixStore<N extends Number>

public static final class MatrixStore.Builder<N extends Number>
extends Object
implements ElementsSupplier<N>

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

Author:

apete

Method Summary

Modifier and Type	Method and Description
MatrixStore.Builder<N>	above(int aRowDim)
MatrixStore.Builder<N>	above(MatrixStore<N>... upperStore)
MatrixStore.Builder<N>	above(N... anUpperStore)
MatrixStore.Builder<N>	below(int aRowDim)
MatrixStore.Builder<N>	below(MatrixStore<N>... aLowerStore)
MatrixStore.Builder<N>	below(N... aLowerStore)
MatrixStore.Builder<N>	bidiagonal(boolean upper, boolean assumeOne)
MatrixStore<N>	build()
MatrixStore.Builder<N>	column(int... col)
MatrixStore.Builder<N>	columns(int aFirst, int aLimit)
MatrixStore.Builder<N>	conjugate()
PhysicalStore<N>	copy()
long	count() count() == countRows() * countColumns()
long	countColumns()
long	countRows()
MatrixStore.Builder<N>	diagonal(boolean assumeOne)
MatrixStore.Builder<N>	diagonally(MatrixStore<N>... aDiagonalStore)
PhysicalStore.Factory<N,?>	factory()
MatrixStore<N>	get()
MatrixStore.Builder<N>	hermitian(boolean upper)
MatrixStore.Builder<N>	hessenberg(boolean upper)
MatrixStore.Builder<N>	left(int aColDim)
MatrixStore.Builder<N>	left(MatrixStore<N>... aLeftStore)
MatrixStore.Builder<N>	left(N... aLeftStore)
MatrixStore.Builder<N>	limits(int rowLimit, int columnLimit)
MatrixStore.Builder<N>	offsets(int rowOffset, int columnOffset)
MatrixStore.Builder<N>	right(int aColDim)
MatrixStore.Builder<N>	right(MatrixStore<N>... aRightStore)
MatrixStore.Builder<N>	right(N... aRightStore)
MatrixStore.Builder<N>	row(int... row)
MatrixStore.Builder<N>	rows(int aFirst, int aLimit)
MatrixStore.Builder<N>	superimpose(int row, int col, MatrixStore<N> aStore)
MatrixStore.Builder<N>	superimpose(int row, int col, Number aStore)
MatrixStore.Builder<N>	superimpose(MatrixStore<N> aStore)
void	supplyTo(ElementsConsumer<N> consumer)
String	toString()
MatrixStore.Builder<N>	transpose()
MatrixStore.Builder<N>	triangular(boolean upper, boolean assumeOne)
MatrixStore.Builder<N>	tridiagonal()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

operateOnAll, operateOnMatching, operateOnMatching

Methods inherited from interface org.ojalgo.access.Structure2D

isEmpty, isFat, isScalar, isSquare, isTall, isVector

Method Detail

above

public final MatrixStore.Builder<N> above(int aRowDim)

above

@SafeVarargs
public final MatrixStore.Builder<N> above(MatrixStore<N>... upperStore)

above

@SafeVarargs
public final MatrixStore.Builder<N> above(N... anUpperStore)

below

public final MatrixStore.Builder<N> below(int aRowDim)

below

@SafeVarargs
public final MatrixStore.Builder<N> below(MatrixStore<N>... aLowerStore)

below

@SafeVarargs
public final MatrixStore.Builder<N> below(N... aLowerStore)

bidiagonal

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

build

public final MatrixStore<N> build()

column

public final MatrixStore.Builder<N> column(int... col)

columns

public final MatrixStore.Builder<N> columns(int aFirst,
                                            int aLimit)

conjugate

public final MatrixStore.Builder<N> conjugate()

copy

public final PhysicalStore<N> copy()

count

public final 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 final long countColumns()

Specified by:

countColumns in interface Structure2D

Returns:

The number of columns

countRows

public final long countRows()

Specified by:

countRows in interface Structure2D

Returns:

The number of rows

diagonal

public final MatrixStore.Builder<N> diagonal(boolean assumeOne)

diagonally

@SafeVarargs
public final MatrixStore.Builder<N> diagonally(MatrixStore<N>... aDiagonalStore)

factory

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

Specified by:

factory in interface ElementsSupplier<N extends Number>

get

public final MatrixStore<N> get()

Specified by:

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

Specified by:

get in interface ElementsSupplier<N extends Number>

hermitian

public final MatrixStore.Builder<N> hermitian(boolean upper)

hessenberg

public final MatrixStore.Builder<N> hessenberg(boolean upper)

left

public final MatrixStore.Builder<N> left(int aColDim)

left

@SafeVarargs
public final MatrixStore.Builder<N> left(MatrixStore<N>... aLeftStore)

left

@SafeVarargs
public final MatrixStore.Builder<N> left(N... aLeftStore)

limits

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

offsets

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

right

public final MatrixStore.Builder<N> right(int aColDim)

right

@SafeVarargs
public final MatrixStore.Builder<N> right(MatrixStore<N>... aRightStore)

right

@SafeVarargs
public final MatrixStore.Builder<N> right(N... aRightStore)

row

public final MatrixStore.Builder<N> row(int... row)

rows

public final MatrixStore.Builder<N> rows(int aFirst,
                                         int aLimit)

superimpose

public final MatrixStore.Builder<N> superimpose(int row,
                                                int col,
                                                MatrixStore<N> aStore)

superimpose

public final MatrixStore.Builder<N> superimpose(int row,
                                                int col,
                                                Number aStore)

superimpose

public final MatrixStore.Builder<N> superimpose(MatrixStore<N> aStore)

supplyTo

public final void supplyTo(ElementsConsumer<N> consumer)

Specified by:

supplyTo in interface ElementsSupplier<N extends Number>

toString

public String toString()

Overrides:

toString in class Object

transpose

public final MatrixStore.Builder<N> transpose()

Specified by:

transpose in interface ElementsSupplier<N extends Number>

triangular

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

tridiagonal

public final MatrixStore.Builder<N> tridiagonal()