HSideBoolLayer

ostrat.prid.phex.HSideBoolLayer
See theHSideBoolLayer companion object
final class HSideBoolLayer(val arrayUnsafe: Array[Boolean]) extends AnyVal, BoolSeqSpec

Boolean data corresponding to the sides of a HGridSys hex grid system , stored using an underlying Array[Boolean]. These classes should be created, initialised and using an HGrid class. For convenience the HGrid is passed as an implicit parameter.

Attributes

Companion
object
Graph
Supertypes
trait BoolSeqSpec
trait SeqSpec[Boolean]
trait BoolSeqLike
trait SeqLike[Boolean]
class AnyVal
trait Matchable
class Any
Show all

Members list

Keywords
  • no keywords
  • final
  • override
Inherited
  • Not inherited
  • BoolSeqLike
  • BoolSeqSpec
  • SeqLike
  • SeqLikeBacked
  • SeqSpec

Type members

Types

override type ThisT = HSideBoolLayer

Gives the final type of this class.

Gives the final type of this class.

Attributes

Value members

Concrete methods

def apply(hs: HSep)(using gridSys: HGridSys): Boolean
def apply(gridSys: HGridSys, hs: HSep): Boolean
override def fromArray(array: Array[Boolean]): HSideBoolLayer

Constructs a new instance of the final type / class from an Array[Boolean].

Constructs a new instance of the final type / class from an Array[Boolean].

Attributes

Definition Classes
def projFalseLinksHsLineSegOptMap[B, ArrB <: Arr[B]](f: (HSep, LSeg2) => Option[B])(using proj: HSysProjection, build: BuilderArrMap[B, ArrB]): ArrB

Projection OptMaps over the HSep and LSeg2 of eahc false HSep link.

Projection OptMaps over the HSep and LSeg2 of eahc false HSep link.

Attributes

def projFalseLinksHsLineSegOptMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: (HSep, LSeg2) => Option[B])(using build: BuilderArrMap[B, ArrB]): ArrB

Projection OptMaps over the HSep and LSeg2 of eahc false HSep link.

Projection OptMaps over the HSep and LSeg2 of eahc false HSep link.

Attributes

def projFalsesHsLineSegOptMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: (HSep, LSeg2) => Option[B])(using build: BuilderArrMap[B, ArrB]): ArrB
def projFalsesLineSegMap[B, ArrB <: Arr[B]](f: LSeg2 => B)(using proj: HSysProjection, build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the falses in this Side Layer that exist in the projection.

Maps across all the falses in this Side Layer that exist in the projection.

Attributes

def projFalsesLineSegMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: LSeg2 => B)(using build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the falses in this Side Layer that exist in the projection.

Maps across all the falses in this Side Layer that exist in the projection.

Attributes

def projLinkTruesLineSegMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: LSeg2 => B)(using build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the link trues in this Side Layer that exist in the projection.

Maps across all the link trues in this Side Layer that exist in the projection.

Attributes

def projLinkTruesLineSegMap[B, ArrB <: Arr[B]](f: LSeg2 => B)(using proj: HSysProjection, build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the link trues in this Side Layer that exist in the projection.

Maps across all the link trues in this Side Layer that exist in the projection.

Attributes

def projTruesLineSegMap[B, ArrB <: Arr[B]](f: LSeg2 => B)(using proj: HSysProjection, build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the trues in this Side Layer that exist in the projection.

Maps across all the trues in this Side Layer that exist in the projection.

Attributes

def projTruesLineSegMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: LSeg2 => B)(using build: BuilderArrMap[B, ArrB]): ArrB

Maps across all the trues in this Side Layer that exist in the projection.

Maps across all the trues in this Side Layer that exist in the projection.

Attributes

def projTruesMap[B, ArrB <: Arr[B]](proj: HSysProjection)(f: HSep => B)(using build: BuilderArrMap[B, ArrB]): ArrB
def set(hs: HSep, value: Boolean)(using gSys: HGridSys): Unit
def set(gSys: HGridSys, hs: HSep, value: Boolean): Unit
def set(r: Int, c: Int, value: Boolean)(using grid: HGridSys): Unit
override def setElemUnsafe(index: Int, newElem: Boolean): Unit

Sets / mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Sets / mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Definition Classes
def setTrues(hSides: HSepArr)(using grid: HGridSys): Unit
def setTrues(hSides: HSep*)(using grid: HGridSys): Unit
def setTruesInts(hSideInts: Int*)(using grid: HGridSys): Unit
def setTruesPairs(hSidePairs: (Int, Int)*)(using grid: HGridSys): Unit
def spawn(parentGridSys: HGridSys, childGridSys: HGridSys): HSideBoolLayer

Spawns a new HSideBoolLayer data layer for the child HGridSys.

Spawns a new HSideBoolLayer data layer for the child HGridSys.

Attributes

def trueHSides(using gridSys: HGridSys): HSepArr

Returns the HSeps that have a corresponding true value.

Returns the HSeps that have a corresponding true value.

Attributes

def truesHsForeach(f: HSep => Unit)(using gridSys: HGridSys): Unit

Foreach true value applies the side effecting function to the corresponding HSep value.

Foreach true value applies the side effecting function to the corresponding HSep value.

Attributes

def truesHsMap[B, ArrB <: Arr[B]](f: HSep => B)(using gridSys: HGridSys, build: BuilderArrMap[B, ArrB]): ArrB

Maps the true values to a Arr[B].

Maps the true values to a Arr[B].

Attributes

def truesHsMap[B, ArrB <: Arr[B]](gridSys: HGridSys)(f: HSep => B)(using build: BuilderArrMap[B, ArrB]): ArrB

Maps the true values to a Arr[B].

Maps the true values to a Arr[B].

Attributes

override def typeStr: String

String specifying the type of this object.

String specifying the type of this object.

Attributes

Definition Classes

Inherited methods

final override def elem(index: Int): Boolean

Accesses the specifying sequence element by a 0 based index. For Sequs this will an alternative name for apply.

Accesses the specifying sequence element by a 0 based index. For Sequs this will an alternative name for apply.

Attributes

Definition Classes
Inherited from:
BoolSeqSpec
override def elemsStr: String

The element String allows the composition of toString for the whole collection. The syntax of the output will be reworked.

The element String allows the composition of toString for the whole collection. The syntax of the output will be reworked.

Attributes

Definition Classes
Inherited from:
SeqSpec
override def fElemStr: Boolean => String

String for element, can be overridden.

String for element, can be overridden.

Attributes

Definition Classes
Inherited from:
BoolSeqLike
def foldLeft[B](initVal: B)(f: (B, Boolean) => B): B

foldLeft over the specifying sequence.

foldLeft over the specifying sequence.

Attributes

Inherited from:
SeqSpec
override def foreach[U](f: Boolean => U): Unit

Performs a side effecting function on each element of the specifying sequence in order.

Performs a side effecting function on each element of the specifying sequence in order.

Attributes

Definition Classes
Inherited from:
SeqSpec
def iForeach[U](initIndex: Int)(f: (Int, Boolean) => U): Unit

Index with foreach on the data elements. Performs a side effecting function on the index and each element of the data sequence. It takes a function as a parameter. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. 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.

Index with foreach on the data elements. Performs a side effecting function on the index and each element of the data sequence. It takes a function as a parameter. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. 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:
SeqSpec
def iForeach[U](f: (Int, Boolean) => Any): Unit

Index with foreach on the specifying sequence elements. Performs a side effecting function on the index and each element of the specifying sequence. It takes a function as a parameter. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. 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.

Index with foreach on the specifying sequence elements. Performs a side effecting function on the index and each element of the specifying sequence. It takes a function as a parameter. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users. The method has 2 versions / name overloads. The default start for the index is 0 if just the function parameter is passed. The second version name overload takes an Int for the first parameter list, to set the start value of the index. 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:
SeqSpec
def innerForeach[U](f: Boolean => U): Unit

Foreachs over the inner of the specifying sequence, excludes the first and last element. Performs a side effecting function on each element of the tail of the specifying sequence in order.

Foreachs over the inner of the specifying sequence, excludes the first and last element. Performs a side effecting function on each element of the tail of the specifying sequence in order.

Attributes

Inherited from:
SeqSpec
def last: Boolean

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def mapArr[B, ArrB <: Arr[B]](f: Boolean => B)(implicit ev: BuilderArrMap[B, ArrB]): ArrB

Specialised map to an immutable Arr of B. For Sequ dataMap is the same as map, but for other structures it will be different, for example a PolygonLike will map to another PolygonLike.

Specialised map to an immutable Arr of B. For Sequ dataMap is the same as map, but for other structures it will be different, for example a PolygonLike will map to another PolygonLike.

Attributes

Inherited from:
SeqSpec
def mutateElemUnsafe(index: Int, f: Boolean => Boolean): Unit

Mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Mutates an element in the Arr at the given index. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Inherited from:
SeqLikeBacked
final override def numElems: Int

The number of data elements in the defining sequence. These collections use underlying mutable Arrays and ArrayBuffers. The length of the underlying Array will be a multiple of this number. For Sequs this will be an alternative name for length.

The number of data elements in the defining sequence. These collections use underlying mutable Arrays and ArrayBuffers. The length of the underlying Array will be a multiple of this number. For Sequs this will be an alternative name for length.

Attributes

Definition Classes
Inherited from:
BoolSeqSpec
def reverseForeach[U](f: Boolean => U): Unit

Performs a side effecting function on each element of the specifying-sequence in reverse order. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users.

Performs a side effecting function on each element of the specifying-sequence in reverse order. The function may return Unit. If it does return a non-Unit value it is discarded. The [U] type parameter is there just to avoid warnings about discarded values and can be ignored by method users.

Attributes

Inherited from:
SeqSpec
def setElemsUnsafe(index: Int, elems: Boolean*): Unit

Sets / mutates elements in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Sets / mutates elements in the Arr. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Inherited from:
SeqLikeBacked
def tailFold[B](initial: B)(f: (B, Boolean) => B): B

FoldLeft over the tail of the specifying sequence.

FoldLeft over the tail of the specifying sequence.

Attributes

Inherited from:
SeqSpec
def tailForeach[U](f: Boolean => U): Unit

Foreachs over the tail of the specifying sequence. Performs a side effecting function on each element of the tail of the specifying sequence in order.

Foreachs over the tail of the specifying sequence. Performs a side effecting function on each element of the tail of the specifying sequence in order.

Attributes

Inherited from:
SeqSpec
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
SeqLike -> Any
Inherited from:
SeqLike
def unsafeArrayCopy(operand: Array[Boolean], offset: Int, copyLength: Int): Unit

Attributes

Inherited from:
BoolSeqLike

Concrete fields