de.caff.generics.mda

Interface TwoDimensionalCharAccess

All Superinterfaces:

MultiDimensional, MultiDimensionalAccess<java.lang.Character>, MultiDimensionalReadAccess<java.lang.Character>, TwoDimensionalAccess<java.lang.Character>, TwoDimensionalCharReadAccess, TwoDimensionalReadAccess<java.lang.Character>

All Known Implementing Classes:

SmallTwoDimensionalCharArray, TwoDimensionalCharArray

public interface TwoDimensionalCharAccess
extends TwoDimensionalCharReadAccess, TwoDimensionalAccess<java.lang.Character>

Read/write access for 2-dimensional rectangular char arrays.

Since:

November 11, 2019

Author:

Rammi

Nested Class Summary

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

TwoDimensionalCharReadAccess.Base

Field Summary

Fields

Modifier and Type	Field and Description
static TwoDimensionalCharAccess	EMPTY Empty 2dimensional char access.

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

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

Method Summary

Modifier and Type	Method and Description
default void	changeAllValues(CharOperator1 operator) Change all values by applying an operator.
default void	changeValueAt(CharOperator1 operator, int ix, int iy) Change the value at the given indexes.
default void	fillValuesByIndex(IntToCharFunction2 setter) Set all values depending on their indexes.
default void	setElementAt(java.lang.Character element, int ix, int iy) Set the element at the given indexes.
void	setValueAt(char value, int ix, int iy) Set the value at the given indexes.
default OneDimensionalCharAccess	subAtX(int ix) Get a 1-dimensional view of the row at the given X index.
default OneDimensionalCharAccess	subAtY(int iy) Get a 1-dimensional view of the column at the given X index.
default TwoDimensionalCharAccess	transposed() Get a transposed view of this 2-dimensional read access.

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

asBase, getElementAt, getValueAt, 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, sizeX, sizeY, 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

Field Detail

EMPTY

static final TwoDimensionalCharAccess EMPTY

Empty 2dimensional char access.

Method Detail

setValueAt

void setValueAt(char value,
                int ix,
                int iy)

Set the value at the given indexes.

Parameters:

value - value to set

ix - X index

iy - Y index

changeValueAt

default void changeValueAt(@NotNull
                           CharOperator1 operator,
                           int ix,
                           int iy)

Change the value at the given indexes.

Parameters:

operator - operator to apply to the value

ix - X index

iy - Y index

changeAllValues

default void changeAllValues(@NotNull
                             CharOperator1 operator)

Change all values by applying an operator.

Parameters:

operator - operator to apply

fillValuesByIndex

default void fillValuesByIndex(@NotNull
                               IntToCharFunction2 setter)

Set all values depending on their indexes. This will call the setter for all indexes and set the value at the given index from its result.

Parameters:

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

setElementAt

default void setElementAt(@NotNull
                          java.lang.Character element,
                          int ix,
                          int iy)

Description copied from interface: TwoDimensionalAccess

Set the element at the given indexes.

Specified by:

setElementAt in interface TwoDimensionalAccess<java.lang.Character>

Parameters:

element - element to set

ix - index in X direction from 0 (included) to TwoDimensionalReadAccess.sizeX() (excluded)

iy - index in Y direction from 0 (included) to TwoDimensionalReadAccess.sizeY() (excluded)

subAtX

@NotNull
default OneDimensionalCharAccess subAtX(int ix)

Description copied from interface: TwoDimensionalReadAccess

Get a 1-dimensional view of the row at the given X index. This is a view, so setting elements will change values in this array.

Specified by:

subAtX in interface TwoDimensionalAccess<java.lang.Character>

Specified by:

subAtX in interface TwoDimensionalCharReadAccess

Specified by:

subAtX in interface TwoDimensionalReadAccess<java.lang.Character>

Parameters:

ix - X index

Returns:

1-dimensional array at ix

subAtY

@NotNull
default OneDimensionalCharAccess subAtY(int iy)

Description copied from interface: TwoDimensionalReadAccess

Get a 1-dimensional view of the column at the given X index. This is a view, so setting elements will change values in this array.

Specified by:

subAtY in interface TwoDimensionalAccess<java.lang.Character>

Specified by:

subAtY in interface TwoDimensionalCharReadAccess

Specified by:

subAtY in interface TwoDimensionalReadAccess<java.lang.Character>

Parameters:

iy - Y index

Returns:

1-dimensional array at iy

transposed

@NotNull
default TwoDimensionalCharAccess transposed()

Description copied from interface: TwoDimensionalReadAccess

Get a transposed view of this 2-dimensional read access.

Specified by:

transposed in interface TwoDimensionalAccess<java.lang.Character>

Specified by:

transposed in interface TwoDimensionalCharReadAccess

Specified by:

transposed in interface TwoDimensionalReadAccess<java.lang.Character>

Returns:

transposed view where X and Y are interchanged