LinePathHC

ostrat.prid.phex.LinePathHC
See theLinePathHC companion object
final class LinePathHC(val unsafeArray: Array[Int]) extends AnyVal with HCoordSeqSpec with LinePathInt2[HCoord]

A trait for classes of line paths specified by [HCoord hex grid tile coordinates.

Attributes

Companion:
object
Graph
Supertypes

Members list

Concise view

Type members

Types

override type ThisT = LinePathHC

Gives the final type of this class.

Gives the final type of this class.

Attributes

Value members

Concrete methods

override def fromArray(array: Array[Int]): LinePathHC

Constructs the final type of these IntNSeqLike from an Array[Int]. Mostly you will access this capability from the companion object or the appropriate builder, but it can be useful to access this from the class itself.

Constructs the final type of these IntNSeqLike from an Array[Int]. Mostly you will access this capability from the companion object or the appropriate builder, but it can be useful to access this from the class itself.

Attributes

Definition Classes
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 elemProdSize: Int

The number of atomic values, Ints, Doubles, Longs etc that specify / construct an element of this immutable flat Array based collection class.

The number of atomic values, Ints, Doubles, Longs etc that specify / construct an element of this immutable flat Array based collection class.

Attributes

Definition Classes
Inherited from:
Int2SeqLike
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
final override def fElemStr: HCoord => String

Attributes

Definition Classes
Inherited from:
HCoordSeqLike
override def intBufferAppend(buffer: ArrayBuffer[Int], elem: HCoord): Unit

Utility method to append element on to an ArrayBuffer[Int]. End users should rarely need to use this method.

Utility method to append element on to an ArrayBuffer[Int]. End users should rarely need to use this method.

Attributes

Definition Classes
Inherited from:
Int2SeqLike
def map[B <: ElemValueN, BB <: LinePathLike[B]](f: HCoord => B)(implicit build: LinePathBuilder[B, BB]): BB

maps to a LinePathLike. This map operates on a single LinePathLike its not to be confused with a map on Arr of LinePathLikes.

maps to a LinePathLike. This map operates on a single LinePathLike its not to be confused with a map on Arr of LinePathLikes.

Attributes

Inherited from:
LinePathLike
final override def newElem(int1: Int, int2: Int): HCoord

Attributes

Definition Classes
Inherited from:
HCoordSeqLike
override def ssElem(int1: Int, int2: Int): HCoord

Construct element of the specifying sequence from 2 Ints.

Construct element of the specifying sequence from 2 Ints.

Attributes

Definition Classes
Inherited from:
HCoordSeqSpec
override def ssElemEq(a1: HCoord, a2: HCoord): Boolean

Checks if 2 values of the specifying sequence are equal.

Checks if 2 values of the specifying sequence are equal.

Attributes

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

specifying -sequence fold.

specifying -sequence fold.

Attributes

Inherited from:
SeqSpec

Attributes

Inherited from:
ValueNSeqSpec
def ssForeach[U](f: HCoord => 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, HCoord) => 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, HCoord) => 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
override def ssIndex(index: Int): A

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:
Int2SeqSpec
def ssLast: A

Last element of the specifying sequence.

Last element of the specifying sequence.

Attributes

Inherited from:
SeqSpec
override def ssLength: Int

The number of product elements in this collection. For example in a [[PolygonImp], this is the number of Pt2s in the Polygon

The number of product elements in this collection. For example in a [[PolygonImp], this is the number of Pt2s in the Polygon

Attributes

Definition Classes
Inherited from:
ValueNSeqSpec
def ssMap[B, ArrB <: Arr[B]](f: HCoord => 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
override def ssReverse: ThisT

Reverses the order of the elements of the specifying sequence.

Reverses the order of the elements of the specifying sequence.

Attributes

Definition Classes
Inherited from:
IntNSeqSpec
def ssReverseForeach[U](f: HCoord => 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, HCoord) => 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: HCoord => 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

The length of the Array[Int] backing array.

The length of the Array[Int] backing array.

Attributes

Inherited from:
IntNSeqLike
final def unsafeSameSize(length: Int): ThisT

Method for creating a new Array[Int] backed collection class of this collection class's final type.

Method for creating a new Array[Int] backed collection class of this collection class's final type.

Attributes

Inherited from:
IntNSeqLike
final override def unsafeSetElem(index: Int, elem: HCoord): 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:
Int2SeqLike
def unsafeSetElems(index: Int, elems: HCoord*): 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

The backing Array[Int] of this collection class. End users should not normally need to interact with this directly.

The backing Array[Int] of this collection class. End users should not normally need to interact with this directly.

Attributes