org.kramerlab.bmad.matrix

Class RowMajor<X>

java.lang.Object

org.kramerlab.bmad.matrix.RowMajor<X>

public class RowMajor<X>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<ArrayList<X>>	entries
protected int	height
protected int	width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RowMajor(int h, int w, ArrayList<ArrayList<X>> entries)
	RowMajor(int h, int w, Function<Tuple<Integer,Integer>,X> fill) Creates new matrix of the specified size, with entries given by the function entry.
	RowMajor(int h, int w, X defaultValue) Creates new matrix of the specified size, with all entries set to a constant value.

Method Summary

Methods

Modifier and Type	Method and Description
X	apply(int column) Gets an entry in the zeroth row of this matrix.
X	apply(int row, int column) Returns the entry at the specified position.
static <X> RowMajor<X>	asColumnVector(ArrayList<X> list)
static <X> RowMajor<X>	asRowVector(ArrayList<X> list)
<Y> RowMajor<Y>	flatMap(Function<X,RowMajor<Y>> f) A dense matrix flatMap, that is done about right: it makes real effort not to calculate anything twice, not to allocate more space than necessary, and not to use dynamic memory allocation of arrayLists, which copies entries under the hood.
int	getHeight() Returns height of this matrix
int	getWidth() Returns the width of this matrix
<Y> RowMajor<Y>	map(Function<X,Y> f) Creates new matrix, where each entry is mapped by the function f
<Y> RowMajor<Y>	mapWithIndices(Function<Tuple<X,Tuple<Integer,Integer>>,Y> f) Pointwise application of a function that can depend on the value and the index.
Tuple<Integer,Integer>	size() Height and width of the matrix.
Image	toImage(Function<X,Color> toColor) Converts this matrix to image.
String	toString()
protected String	toString(Function<Integer,Padding> columnToHorizontalPadding, Function<Integer,Padding> rowToVerticalPadding)
String	toString(Padding padding, String begin, String end, String columnSeparator, String rowSeparator) Creates string representation of this matrix, indenting the entries horizontally, but ignoring the fact that some entries might contain multiple lines: in such cases, the whole layout probably will be pretty botched.
void	update(int row, int column, X value) Overrides the entry at the specified position by a new value.
void	update(int column, X value) Updates an entry in the zeroth row of this matrix.

Methods inherited from class java.lang.Object

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

Field Detail

entries

protected ArrayList<ArrayList<X>> entries

width

protected int width

height

protected int height

Constructor Detail

RowMajor

protected RowMajor(int h,
        int w,
        ArrayList<ArrayList<X>> entries)

RowMajor

public RowMajor(int h,
        int w,
        Function<Tuple<Integer,Integer>,X> fill)

Creates new matrix of the specified size, with entries given by the function entry.

Parameters:

h -

w -

fill -

RowMajor

public RowMajor(int h,
        int w,
        X defaultValue)

Creates new matrix of the specified size, with all entries set to a constant value.

Parameters:

h -

w -

defaultValue -

Method Detail

asRowVector

public static <X> RowMajor<X> asRowVector(ArrayList<X> list)

asColumnVector

public static <X> RowMajor<X> asColumnVector(ArrayList<X> list)

apply

public X apply(int row,
      int column)

Returns the entry at the specified position.

Parameters:

row -

column -

Returns:

apply

public X apply(int column)

Gets an entry in the zeroth row of this matrix. Should be used only if the matrix is actually a row vector.

Parameters:

column -

Returns:

update

public void update(int row,
          int column,
          X value)

Overrides the entry at the specified position by a new value.

Parameters:

row -

column -

value -

update

public void update(int column,
          X value)

Updates an entry in the zeroth row of this matrix. Should be used only if the matrix is actually a row vertor.

Parameters:

column -

value -

getWidth

public int getWidth()

Returns the width of this matrix

Returns:

getHeight

public int getHeight()

Returns height of this matrix

Returns:

map

public <Y> RowMajor<Y> map(Function<X,Y> f)

Creates new matrix, where each entry is mapped by the function f

Parameters:

f -

Returns:

mapWithIndices

public <Y> RowMajor<Y> mapWithIndices(Function<Tuple<X,Tuple<Integer,Integer>>,Y> f)

Pointwise application of a function that can depend on the value and the index.

Parameters:

f -

Returns:

flatMap

public <Y> RowMajor<Y> flatMap(Function<X,RowMajor<Y>> f)

A dense matrix flatMap, that is done about right: it makes real effort not to calculate anything twice, not to allocate more space than necessary, and not to use dynamic memory allocation of arrayLists, which copies entries under the hood.

toString

public String toString(Padding padding,
              String begin,
              String end,
              String columnSeparator,
              String rowSeparator)

Creates string representation of this matrix, indenting the entries horizontally, but ignoring the fact that some entries might contain multiple lines: in such cases, the whole layout probably will be pretty botched.

Parameters:

padding - horizontal padding strategy applied to each entry

begin - prefix of the whole result string

end - suffix of the whole result string

columnSeparator - string that is inserted between the padded entries of same row

rowSeparator - string that separates rows

Returns:

begin + a00 + columnSeparator + ... + columnSeparator + a0(n-1) + rowSeparator + ... + end

toString

protected String toString(Function<Integer,Padding> columnToHorizontalPadding,
              Function<Integer,Padding> rowToVerticalPadding)

toString

public String toString()

Overrides:

toString in class Object

toImage

public Image toImage(Function<X,Color> toColor)

Converts this matrix to image.

Parameters:

toColor - function that maps entries to pixel colors.

Returns:

image

size

public Tuple<Integer,Integer> size()

Height and width of the matrix.

Returns:

(h, w)