LayerHcRefGrid

ostrat.prid.phex.LayerHcRefGrid
See theLayerHcRefGrid companion object
final class LayerHcRefGrid[A <: AnyRef](val arrayUnsafe: Array[A]) extends AnyVal, LayerHcRefSys[A]

Attributes

Companion
object
Graph
Supertypes
trait LayerHcRefSys[A]
trait LayerHcRef[A]
trait LayerTcRef[A]
class AnyVal
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def setRow(row: Int, tileMultis: Multiple[A]*)(using grid: HGrid): HCen

Fills in the whole given row. An exception is thrown if the tile values don't match with the end of the row.

Fills in the whole given row. An exception is thrown if the tile values don't match with the end of the row.

Attributes

override def spawn(parentGridSys: HGridSys, childGridSys: HGridSys)(using ctA: ClassTag[A]): LayerHcRefSys[A]

Spawns a new LayerHcRefSys data layer from this LayerHcRefSys's HGridSys to the child HGridSys. There is a name overload for this method that passes the child HGridSys implicitly.

Spawns a new LayerHcRefSys data layer from this LayerHcRefSys's HGridSys to the child HGridSys. There is a name overload for this method that passes the child HGridSys implicitly.

Attributes

Definition Classes

Inherited methods

def ++(operand: LayerHcRefSys[A])(using ctA: ClassTag[A]): LayerHcRefSys[A]

Attributes

Inherited from:
LayerHcRefSys
def apply(key: HexStruct, hc: HCen): A

Apply method returns a data element from this data layer for the given HCen.

Apply method returns a data element from this data layer for the given HCen.

Attributes

Inherited from:
LayerHcRef
def apply(hc: HCen)(using key: HexStruct): A

Apply method returns a data element from this data layer for the given HCen. The appropriate index is found from the implicit HGridSys. There is an alternative nme overload where the HGridSys is passed explicitly as the first parameter.

Apply method returns a data element from this data layer for the given HCen. The appropriate index is found from the implicit HGridSys. There is an alternative nme overload where the HGridSys is passed explicitly as the first parameter.

Attributes

Inherited from:
LayerHcRef
def foreach[U](f: A => U): Unit

For each element in the underlying array performs the side effecting function. This method treats the LayerTcRef class like a standard Arr or Array. It does not utilise the grid TGrid from which this LayerTcRef was created.

For each element in the underlying array performs the side effecting function. This method treats the LayerTcRef class like a standard Arr or Array. It does not utilise the grid TGrid from which this LayerTcRef was created.

Attributes

Inherited from:
LayerTcRef
def getPoly(hc: HCen, terr: Any, corners: HCornerLayer, proj: HSysProjection): Polygon

Attributes

Inherited from:
LayerHcRefSys
def hcFlatMap[BB <: Arr[_]](f: (HCen, A) => BB)(using grid: HexStruct, build: BuilderArrFlat[BB]): BB

HCen with flatmap. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

HCen with flatmap. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

Attributes

Inherited from:
LayerHcRef
def hcForeach[U](f: (HCen, A) => U)(using gSys: HexStruct): Unit

HCen with foreach. Applies the side effecting function to the HCen coordinate with its respective element. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

HCen with foreach. Applies the side effecting function to the HCen coordinate with its respective element. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

Attributes

Inherited from:
LayerHcRef
def hcMap[B, BB <: Arr[B]](f: (HCen, A) => B)(using grid: HexStruct, build: BuilderArrMap[B, BB]): BB

HCen with map. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

HCen with map. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

Attributes

Inherited from:
LayerHcRef
def hcOptFlatMap[BB <: Arr[_]](f: (HCen, A) => Option[BB])(using gridSys: HexStruct, build: BuilderArrFlat[BB]): BB

HCen with optFlatmap. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

HCen with optFlatmap. Applies the function to each HCen coordinate with the corresponding element in the underlying array. Note the function signature follows the foreach based convention of putting the collection element 2nd or last as seen for example in fold methods' (accumulator, element) => B signature.

Attributes

Inherited from:
LayerHcRef
def hcOptMap[B, BB <: Arr[B]](f: (A, HCen) => Option[B])(using grid: HexStruct, build: BuilderArrMap[B, BB]): BB

Maps each data element with thw corresponding HCen to an Option of type B. Collects the Some's values. The length of the returned Arr will be between 0 and the length of this LayerHcRefSys.

Maps each data element with thw corresponding HCen to an Option of type B. Collects the Some's values. The length of the returned Arr will be between 0 and the length of this LayerHcRefSys.

Attributes

Inherited from:
LayerHcRef
final def length: Int

The number of tile centres this array of data represents.

The number of tile centres this array of data represents.

Attributes

Inherited from:
LayerTcRef
def linksFlatMap[BB <: Arr[_]](f: (HSep, A, A) => BB)(using grid: HGridSys, build: BuilderArrFlat[BB]): BB

FlatMaps the links / inner sides to an immutable Array, using the data of this HCenArr. It takes a function, that takes the HSep and the two adjacent hex tile data values.

FlatMaps the links / inner sides to an immutable Array, using the data of this HCenArr. It takes a function, that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def linksMap[B, BB <: Arr[B]](f: (HSep, A, A) => B)(using grid: HGridSys, build: BuilderArrMap[B, BB]): BB

Maps the links or inner sides to an immutable Array, using the data of this HCenArr. It takes a function for the links or inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the links or inner sides to an immutable Array, using the data of this HCenArr. It takes a function for the links or inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def map[B, BB <: Arr[B]](f: A => B)(implicit build: BuilderArrMap[B, BB]): BB

Each element in the underlying array is mapped by the parameter function to an element of type B. This method treat the HCenArr class like a standard Arr or Array. It does not utilise the grid HGrid from which this HCenArr was created.

Each element in the underlying array is mapped by the parameter function to an element of type B. This method treat the HCenArr class like a standard Arr or Array. It does not utilise the grid HGrid from which this HCenArr was created.

Attributes

Inherited from:
LayerTcRef
final def mutSetAll(value: A): Unit

Set all tiles to the given value.

Set all tiles to the given value.

Attributes

Inherited from:
LayerTcRef
def projHCenFlatMap[BB <: Arr[_]](f: (HCen, A) => BB)(using key: HexStruct, proj: HSysProjection, build: BuilderArrFlat[BB]): BB

Attributes

Inherited from:
LayerHcRef

Attributes

Inherited from:
LayerHcRefSys

Maps the visible HCens in the projection with their respective projection Pt2 tile centre points and the data layer element form this collection to GraphicElems. This method name overload takes the HSysProjection as an explicit first parameter list. The other name overload takes it as an implicit parameter.In practice this method may be of limited utility. It may be better to use the HSysProjection or another class as the dispatching object and access these data layer elements by the HCen apply methods.

Maps the visible HCens in the projection with their respective projection Pt2 tile centre points and the data layer element form this collection to GraphicElems. This method name overload takes the HSysProjection as an explicit first parameter list. The other name overload takes it as an implicit parameter.In practice this method may be of limited utility. It may be better to use the HSysProjection or another class as the dispatching object and access these data layer elements by the HCen apply methods.

Attributes

Inherited from:
LayerHcRefSys
def projHCenPtMap(f: (HCen, Pt2, A) => Graphic2Elem)(implicit proj: HSysProjection): GraphicElems

Maps the visible HCens in the projection with their respective projection Pt2 tile centre points and the data layer element form this collection to GraphicElems. This method name overload takes the HSysProjection as an implicit parameter. The other name overload takes it as an explicit first parameter list. In practice this method may be of limited utility. It may be better to use the the HSysProjection or another class as the dispatching object and access the data layer elements by the HCen apply methods.

Maps the visible HCens in the projection with their respective projection Pt2 tile centre points and the data layer element form this collection to GraphicElems. This method name overload takes the HSysProjection as an implicit parameter. The other name overload takes it as an explicit first parameter list. In practice this method may be of limited utility. It may be better to use the the HSysProjection or another class as the dispatching object and access the data layer elements by the HCen apply methods.

Attributes

Inherited from:
LayerHcRefSys
def projLinksFlatMap[BB <: Arr[_]](proj: HSysProjection)(f: (HSep, A, A) => BB)(using build: BuilderArrFlat[BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def projLinksFlatMap[BB <: Arr[_]](f2: (HSep, A, A) => BB)(using proj: HSysProjection, build: BuilderArrFlat[BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def projLinksHsLineOptMap[B, BB <: Arr[B]](proj: HSysProjection)(f: (HSep, LSeg2, A, A) => Option[B])(using build: BuilderArrMap[B, BB]): BB

implementation not correct, Comment not correct, Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

implementation not correct, Comment not correct, Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def projLinksHsLineOptMap[B, BB <: Arr[B]](f: (HSep, LSeg2, A, A) => Option[B])(using proj: HSysProjection, build: BuilderArrMap[B, BB]): BB

Comment no correct, Maps the sides to an immutable Array, using the data of this LayerHcRefSys. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Comment no correct, Maps the sides to an immutable Array, using the data of this LayerHcRefSys. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def projLinksLineOptMap[B, BB <: Arr[B]](proj: HSysProjection)(f: (LSeg2, A, A) => Option[B])(using build: BuilderArrMap[B, BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def projLinksLineOptMap[B, BB <: Arr[B]](f: (LSeg2, A, A) => Option[B])(using proj: HSysProjection, build: BuilderArrMap[B, BB]): BB

Maps the sides to an immutable Array, using the data of this LayerHcRefSys. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this LayerHcRefSys. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys

Attributes

Inherited from:
LayerHcRefSys

Attributes

Inherited from:
LayerHcRefSys

Attributes

Inherited from:
LayerHcRefSys

Attributes

Inherited from:
LayerHcRefSys

Attributes

Inherited from:
LayerHcRefSys
def projSideFlatMap[BB <: Arr[_]](proj: HSysProjection)(f1: (HSep, A) => BB, f2: (HSep, A, A) => BB)(using build: BuilderArrFlat[BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def rc(key: HexStruct, r: Int, c: Int): A

Attributes

Inherited from:
LayerHcRef
def rc(r: Int, c: Int)(using key: HexStruct): A

Attributes

Inherited from:
LayerHcRef
def rowsCombine(using grider: HGridSys): RArr[HCenRowPair[A]]

Attributes

Inherited from:
LayerHcRefSys
def set(r: Int, c: Int, value: A)(using gridSys: HexStruct): Unit

Attributes

Inherited from:
LayerHcRef
def set(hc: HCen, value: A)(using gridSys: HexStruct): Unit

Attributes

Inherited from:
LayerHcRef
final def setRowEnd(row: Int, cStart: Int, tileMultis: Multiple[A]*)(using grid: HGrid): HCen

Completes the given row from the given starting c column value to the end of the row. An exception is thrown if the tile values don't match with the end of the row.

Completes the given row from the given starting c column value to the end of the row. An exception is thrown if the tile values don't match with the end of the row.

Attributes

Inherited from:
LayerHcRefSys
final def setRowEndUnchecked(row: Int, tileMultis: Multiple[A]*)(using grid: HGrid): HCen

Attributes

Inherited from:
LayerHcRefSys
final def setRowPartSame(row: Int, cStart: Int, numOfCens: Int, tileValue: A)(using grid: HGrid): HCen

Sets the given row from the given starting c column value, for the given number of tile centre values. An exception is thrown if the numOfCens overflows the row end.

Sets the given row from the given starting c column value, for the given number of tile centre values. An exception is thrown if the numOfCens overflows the row end.

Attributes

Inherited from:
LayerHcRefSys
def setRowSame(grid: HGrid, row: Int, value: A): Unit

Fills in the whole given row, with the same given value. This method has name overload where the grid is passed implicitly.

Fills in the whole given row, with the same given value. This method has name overload where the grid is passed implicitly.

Attributes

Inherited from:
LayerHcRefSys
inline def setRowSame(row: Int, value: A)(implicit grid: HGrid): Unit

Fills in the whole given row, with the same given value. This method has name overload where the grid is passed explicitly as the first parameter.

Fills in the whole given row, with the same given value. This method has name overload where the grid is passed explicitly as the first parameter.

Attributes

Inherited from:
LayerHcRefSys
final def setRowStartSame(row: Int, numOfCens: Int, tileValue: A)(using grid: HGrid): HCen

Sets the given row from the start of the row, for the given number of tile centre values. An exception is thrown if the numOfCens overflows the row end.

Sets the given row from the start of the row, for the given number of tile centre values. An exception is thrown if the numOfCens overflows the row end.

Attributes

Inherited from:
LayerHcRefSys
def sideFlatMap[BB <: Arr[_]](f1: (HSep, A) => BB, f2: (HSep, A, A) => BB)(using grid: HGridSys, build: BuilderArrFlat[BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def sideMap[B, BB <: Arr[B]](f1: (HSep, A) => B, f2: (HSep, A, A) => B)(using grid: HGrid, build: BuilderArrMap[B, BB]): BB

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Maps the sides to an immutable Array, using the data of this HCenArr. It takes two functions, one for the edges of the grid, that takes the HSep and the single adjacent hex tile data value and one for the inner sides of the grid that takes the HSep and the two adjacent hex tile data values.

Attributes

Inherited from:
LayerHcRefSys
def spawn(parentGridSys: HGridSys)(using ctA: ClassTag[A], childGridSys: HGridSys): LayerHcRefSys[A]

Spawns a new LayerHcRefSys data layer from this LayerHcRefSys's HGridSys to the child HGridSys, passed as implicit parameter. There is a name overload for this method that passes the child HGridSys explicitly.

Spawns a new LayerHcRefSys data layer from this LayerHcRefSys's HGridSys to the child HGridSys, passed as implicit parameter. There is a name overload for this method that passes the child HGridSys explicitly.

Attributes

Inherited from:
LayerHcRefSys

Concrete fields

val arrayUnsafe: Array[A]

The mutable backing Array. End users should rarely if ever have to access this field

The mutable backing Array. End users should rarely if ever have to access this field

Attributes