de.caff.generics.mda

Interface ThreeDimensionalBooleanReadAccess

All Superinterfaces:

MultiDimensional, MultiDimensionalReadAccess<java.lang.Boolean>, ThreeDimensionalReadAccess<java.lang.Boolean>

All Known Subinterfaces:

ThreeDimensionalBooleanAccess

All Known Implementing Classes:

ThreeDimensionalBooleanArray

public interface ThreeDimensionalBooleanReadAccess
extends ThreeDimensionalReadAccess<java.lang.Boolean>

Read access for 3-dimensional rectangular boolean arrays.

Since:

November 11, 2019

Author:

Rammi

Field Summary

Fields

Modifier and Type	Field and Description
static ThreeDimensionalBooleanReadAccess	EMPTY Empty 3dimensional boolean read 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 java.lang.Boolean	getElementAt(int ix, int iy, int iz) Get the element at the given indexes.
boolean	getValueAt(int ix, int iy, int iz) Get the value at the given indexes.
static ThreeDimensionalBooleanReadAccess	singleton(boolean singleElement) Get a 3dimensional boolean read access for a single element.
default TwoDimensionalBooleanReadAccess	subAtX(int fixX) Get a 2-dimensional view of the plane at the given X index.
default TwoDimensionalBooleanReadAccess	subAtY(int fixY) Get a 2-dimensional view of the plane at the given Y index.
default TwoDimensionalBooleanReadAccess	subAtZ(int fixZ) Get a 2-dimensional view of the plane at the given Z index.

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

empty, getElement, getNumDimensions, getNumElements, getSize, getSizes, sizeX, sizeY, sizeZ, view, visitAll, visitAll

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

empty, linearized

Field Detail

EMPTY

static final ThreeDimensionalBooleanReadAccess EMPTY

Empty 3dimensional boolean read access.

Method Detail

singleton

@NotNull
static ThreeDimensionalBooleanReadAccess singleton(boolean singleElement)

Get a 3dimensional boolean read access for a single element.

Specified by:

singleton in interface ThreeDimensionalReadAccess<java.lang.Boolean>

Parameters:

singleElement - single element

Returns:

3dimensional boolean read access with size 1 in all 3 directions, containing just the given single element

getValueAt

boolean getValueAt(int ix,
                   int iy,
                   int iz)

Get the value at the given indexes.

Parameters:

ix - X index

iy - Y index

iz - Z index

Returns:

value at the given index

getElementAt

@NotNull
default java.lang.Boolean getElementAt(int ix,
                                                int iy,
                                                int iz)

Description copied from interface: ThreeDimensionalReadAccess

Get the element at the given indexes.

Specified by:

getElementAt in interface ThreeDimensionalReadAccess<java.lang.Boolean>

Parameters:

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

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

iz - index in Z direction from 0 (included) to ThreeDimensionalReadAccess.sizeZ() (excluded)

Returns:

element at the given indexes

subAtX

@NotNull
default TwoDimensionalBooleanReadAccess subAtX(int fixX)

Description copied from interface: ThreeDimensionalReadAccess

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

Specified by:

subAtX in interface ThreeDimensionalReadAccess<java.lang.Boolean>

Parameters:

fixX - fix X index

Returns:

2-dimensional array at fixX

subAtY

@NotNull
default TwoDimensionalBooleanReadAccess subAtY(int fixY)

Description copied from interface: ThreeDimensionalReadAccess

Get a 2-dimensional view of the plane at the given Y index. This is a view, so setting elements will change values in this array.

Specified by:

subAtY in interface ThreeDimensionalReadAccess<java.lang.Boolean>

Parameters:

fixY - fix Y index

Returns:

2-dimensional array at fixY

subAtZ

@NotNull
default TwoDimensionalBooleanReadAccess subAtZ(int fixZ)

Description copied from interface: ThreeDimensionalReadAccess

Get a 2-dimensional view of the plane at the given Z index. This is a view, so setting elements will change values in this array.

Specified by:

subAtZ in interface ThreeDimensionalReadAccess<java.lang.Boolean>

Parameters:

fixZ - fix Z index

Returns:

2-dimensional array at fixZ