de.caff.generics.mda

Class TwoDimensionalDoubleArray

java.lang.Object

de.caff.generics.mda.TwoDimensionalReadAccess.Base<java.lang.Double>

de.caff.generics.mda.TwoDimensionalDoubleReadAccess.Base

de.caff.generics.mda.TwoDimensionalDoubleArray

All Implemented Interfaces:

MultiDimensional, MultiDimensionalAccess<java.lang.Double>, MultiDimensionalReadAccess<java.lang.Double>, TwoDimensionalAccess<java.lang.Double>, TwoDimensionalDoubleAccess, TwoDimensionalDoubleReadAccess, TwoDimensionalReadAccess<java.lang.Double>

public class TwoDimensionalDoubleArray
extends TwoDimensionalDoubleReadAccess.Base
implements TwoDimensionalDoubleAccess

A two-dimensional array of double values.

Since:

November 11, 2019

Author:

Rammi

Nested Class Summary

Nested classes/interfaces inherited from interface de.caff.generics.mda.TwoDimensionalDoubleReadAccess

TwoDimensionalDoubleReadAccess.Base

Field Summary

Fields inherited from interface de.caff.generics.mda.TwoDimensionalDoubleAccess

EMPTY

Fields inherited from interface de.caff.generics.mda.MultiDimensionalReadAccess

EMPTY0, EMPTY1, EMPTY2, EMPTY3, EMPTY4, EMPTY5, EMPTY6, EMPTY7

Constructor Summary

Constructors

Constructor and Description
TwoDimensionalDoubleArray(int ySize, double... values) Constructor.
TwoDimensionalDoubleArray(int xSize, int ySize) Constructor.
TwoDimensionalDoubleArray(int xSize, int ySize, IntToDoubleFunction2 filler) Initializing constructor.
TwoDimensionalDoubleArray(TwoDimensionalDoubleReadAccess array) Copy constructor.

Method Summary

Modifier and Type	Method and Description
TwoDimensionalDoubleArray	copy() Get a copy of this array.
double	getValueAt(int ix, int iy) Get the value at the given indexes.
void	invertX() Invert the row order in X direction.
void	invertY() Invert the row order in Y direction.
void	setValueAt(double value, int ix, int iy) Set the value at the given indexes.
int	sizeX() Get the number of elements in X direction.
int	sizeY() Get the number of elements in Y direction
static TwoDimensionalDoubleArray	unitySquare(int size) Create a unity square 2-dimensional double array.

Methods inherited from class de.caff.generics.mda.TwoDimensionalDoubleReadAccess.Base

asBase

Methods inherited from class de.caff.generics.mda.TwoDimensionalReadAccess.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.caff.generics.mda.TwoDimensionalDoubleAccess

changeAllValues, changeValueAt, fillValuesByIndex, setElementAt, subAtX, subAtY, transposed

Methods inherited from interface de.caff.generics.mda.TwoDimensionalDoubleReadAccess

asBase, getElementAt, singleton

Methods inherited from interface de.caff.generics.mda.TwoDimensionalAccess

changeAll, changeAll, createConstant, createIndexed, createNulled, createSupplied, empty, fillByIndex, setElement, zeroX, zeroY

Methods inherited from interface de.caff.generics.mda.TwoDimensionalReadAccess

equal, getElement, getNumDimensions, getNumElements, getSize, getSizes, hash, toString, view, visitAll, visitAll, xIterable, xIterator, yIterable, yIterator

Methods inherited from interface de.caff.generics.mda.MultiDimensionalAccess

change, setAll, setFrom, setFrom, setFrom

Methods inherited from interface de.caff.generics.mda.MultiDimensionalReadAccess

empty, linearized

Constructor Detail

TwoDimensionalDoubleArray

public TwoDimensionalDoubleArray(int xSize,
                                 int ySize)

Constructor. This fills all elements with 0.0 values.

Parameters:

xSize - X size of array

ySize - Y size of array

See Also:

TwoDimensionalDoubleArray(int, int, IntToDoubleFunction2)

TwoDimensionalDoubleArray

public TwoDimensionalDoubleArray(int xSize,
                                 int ySize,
                                 @NotNull
                                 IntToDoubleFunction2 filler)

Initializing constructor.

Parameters:

xSize - X size of array

ySize - Y size of array

filler - setter function which provides the value to set for each index combination

See Also:

TwoDimensionalDoubleAccess.fillValuesByIndex(IntToDoubleFunction2)

TwoDimensionalDoubleArray

public TwoDimensionalDoubleArray(int ySize,
                                 double... values)

Constructor.

Parameters:

ySize - size in y direction

values - values in order, the first ySize values will become row 0, the second ySize values row 1, and so on. Needs a multiple of ySize values.

TwoDimensionalDoubleArray

public TwoDimensionalDoubleArray(@NotNull
                                 TwoDimensionalDoubleReadAccess array)

Copy constructor.

Parameters:

array - array to copy

Method Detail

setValueAt

public void setValueAt(double value,
                       int ix,
                       int iy)

Set the value at the given indexes.

Specified by:

setValueAt in interface TwoDimensionalDoubleAccess

Parameters:

value - value to set

ix - X index

iy - Y index

getValueAt

public double getValueAt(int ix,
                         int iy)

Get the value at the given indexes.

Specified by:

getValueAt in interface TwoDimensionalDoubleReadAccess

Parameters:

ix - X index

iy - Y index

Returns:

value at given index

sizeX

public int sizeX()

Description copied from interface: TwoDimensionalReadAccess

Get the number of elements in X direction.

Specified by:

sizeX in interface TwoDimensionalReadAccess<java.lang.Double>

Returns:

number of elements in X direction

sizeY

public int sizeY()

Description copied from interface: TwoDimensionalReadAccess

Get the number of elements in Y direction

Specified by:

sizeY in interface TwoDimensionalReadAccess<java.lang.Double>

Returns:

number of elements in Y direction

invertX

public void invertX()

Invert the row order in X direction.

invertY

public void invertY()

Invert the row order in Y direction.

copy

@NotNull
public TwoDimensionalDoubleArray copy()

Get a copy of this array.

Returns:

copy of this array

unitySquare

@NotNull
public static TwoDimensionalDoubleArray unitySquare(int size)

Create a unity square 2-dimensional double array. The returned array will have all values on the x == y diagonal initialized to 1.0.

Parameters:

size - size of returned square array

Returns:

pre-initialized unity square array