HSideBoolLayer

ostrat.prid.phex.HSideBoolLayer
See theHSideBoolLayer companion object
final class HSideBoolLayer(val unsafeArray: Array[Boolean]) extends AnyVal with BooleanSeqSpec

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

Attributes

Companion:
object
Graph
Supertypes
class AnyVal
trait Matchable
class Any

Members list

Concise view

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: HSide)(implicit gridSys: HGridSys): 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 set(hs: HSide, value: Boolean)(implicit grid: HGridSys): Unit
def set(r: Int, c: Int, value: Boolean)(implicit grid: HGridSys): Unit
def setTrues(hSides: HSideArr)(implicit grid: HGridSys): Unit
def setTrues(hSides: HSide*)(implicit grid: HGridSys): Unit
def setTruesInts(hSides: (Int, Int)*)(implicit grid: HGridSys): Unit
def trueHSides(implicit gridSys: HGridSys): HSideArr
def truesForeach(f: HSide => Unit)(implicit gridSys: HGridSys): Unit
def truesMap[B, ArrB <: Arr[B]](f: HSide => B)(implicit gridSys: HGridSys, build: ArrMapBuilder[B, ArrB]): ArrB

Maps the true values to a Arr[B].

Maps the true values to a Arr[B].

Attributes

def truesMap[B, ArrB <: Arr[B]](gridSys: HGridSys)(f: HSide => B)(implicit build: ArrMapBuilder[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

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

Attributes

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

specifying -sequence fold.

specifying -sequence fold.

Attributes

Inherited from:
SeqSpec
def ssForeach[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

Inherited from:
SeqSpec
def ssIForeach[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 ssIForeach[U](f: (Int, Boolean) => Any): Unit

Index with foreach on the 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 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
final override def ssIndex(index: Int): Boolean

Accesses the specifying sequence element by a 0 based index.

Accesses the specifying sequence element by a 0 based index.

Attributes

Definition Classes
Inherited from:
BooleanSeqSpec
def ssLast: A

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
final override def ssLength: 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.

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.

Attributes

Definition Classes
Inherited from:
BooleanSeqSpec
def ssMap[B, ArrB <: Arr[B]](f: Boolean => B)(implicit ev: ArrMapBuilder[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 ssReverseForeach[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 ssTailFold[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 ssTailForeach[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:
BooleanSeqSpec
def unsafeSameSize(length: Int): ThisT

Attributes

Inherited from:
BooleanSeqSpec
final override def unsafeSetElem(i: Int, value: Boolean): Unit

Sets / mutates an element in the Arr. 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. This method should rarely be needed by end users, but is used by the initialisation and factory methods.

Attributes

Definition Classes
Inherited from:
BooleanSeqSpec
def unsafeSetElems(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:
SeqLike

Concrete fields