LinePathHC

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

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

Attributes

Companion
object
Graph
Supertypes
trait SeqSpec[HCoord]
trait SeqLike[HCoord]
class AnyVal
trait Matchable
class Any
Show all

Members list

Type members

Types

override type LineSegArrT = LineSegHCArr
override type LineSegT = LineSegHC
override type PolygonT = PolygonHC
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 SeqLikeIntN 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 SeqLikeIntN 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 polygonFromArray(array: Array[Int]): PolygonHC

Constructs a PolygonLike for this vertex type from an Array[Int].

Constructs a PolygonLike for this vertex type from an Array[Int].

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

final override def %:(operand: HCoord): ThisT

Prepends a single vertex of type VT. Returns a new extended LinePathLike.

Prepends a single vertex of type VT. Returns a new extended LinePathLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
final override def +%[AA >: HCoord](op: HCoord): ThisT

Appends a single vertex of type VT. Returns a new extended LinePathLike.

Appends a single vertex of type VT. Returns a new extended LinePathLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
final override def ++(operand: ThisT): ThisT

Appends another LinePathLike of this type. Returns a new extended LinePathLike.

Appends another LinePathLike of this type. Returns a new extended LinePathLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
override def ++-(operand: ThisT): ThisT

Appends the init of another LinePathLike of this type. Returns a new extended LinePathLike. The ++ indicates to append a sequence. the trailing - indicates to drop the last point.

Appends the init of another LinePathLike of this type. Returns a new extended LinePathLike. The ++ indicates to append a sequence. the trailing - indicates to drop the last point.

Attributes

Definition Classes
Inherited from:
LinePathIntN
final override def ++<(operand: ThisT): ThisT

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended LinePathLike.

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended LinePathLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
def appendInitArray(opArray: Array[Int]): Array[Int]

Attributes

Inherited from:
LinePathIntN
final def arrayLen: Int

The length of the backing Array.

The length of the backing Array.

Attributes

Inherited from:
ArrayIntBacked
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:
SeqLikeInt2
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 init: ThisT

This line path with the last vertex removed. This can be useful for borders where the end points may show up in multiple line paths and therefore sometimes need to be excluded when appending.

This line path with the last vertex removed. This can be useful for borders where the end points may show up in multiple line paths and therefore sometimes need to be excluded when appending.

Attributes

Definition Classes
Inherited from:
LinePathIntN
override def inner: ThisT

This line path with the first and last vertex's removed. This can be useful for borders where the end points may show up in multiple line paths* and therefore sometimes need to be excluded when appending.

This line path with the first and last vertex's removed. This can be useful for borders where the end points may show up in multiple line paths* and therefore sometimes need to be excluded when appending.

Attributes

Definition Classes
Inherited from:
LinePathIntN
def map[B <: ValueNElem, 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
final def numVerts: Int

Attributes

Inherited from:
LinePathLike
override def reverse: 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:
SeqSpecIntN
final override def setElemUnsafe(index: Int, newElem: 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:
SeqLikeInt2
def setElemsUnsafe(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
final 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:
SeqSpecInt2
def ssFold[B](initVal: B)(f: (B, HCoord) => B): B

specifying -sequence fold.

specifying -sequence fold.

Attributes

Inherited from:
SeqSpec

Attributes

Inherited from:
SeqSpecValueN
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
final override def ssIndex(index: Int): HCoord

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:
SeqSpecInt2
def ssInnerForeach[U](f: HCoord => 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 ssLast: HCoord

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:
SeqSpecValueN
def ssMap[B, ArrB <: Arr[B]](f: HCoord => 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 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 tail: ThisT

This line path with the first vertex removed. This can be useful for borders where the end points may show up in multiple line paths and therefore sometimes need to be excluded when appending.

This line path with the first vertex removed. This can be useful for borders where the end points may show up in multiple line paths and therefore sometimes need to be excluded when appending.

Attributes

Definition Classes
Inherited from:
LinePathIntN
override def toPolygon: PolygonT

Closes this LinePathLike into a PolygonLike by adding a LineSegLike from the last vertex to the first.

Closes this LinePathLike into a PolygonLike by adding a LineSegLike from the last vertex to the first.

Attributes

Definition Classes
Inherited from:
LinePathIntN
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
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:
SeqLikeIntN
final override def |++-|(operand: ThisT): PolygonT

Appends the init of another LinePathLike of this type. Returns a PolygonLike.

Appends the init of another LinePathLike of this type. Returns a PolygonLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
final override def |++<|(operand: ThisT): PolygonT

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended closed PolygonLike.

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended closed PolygonLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN
override def |++|(operand: ThisT): PolygonT

Appends another LinePathLike of this type. Returns a PolygonLike. ++ indicates append a sequence. The enclosing lines indicate to close the polygon.

Appends another LinePathLike of this type. Returns a PolygonLike. ++ indicates append a sequence. The enclosing lines indicate to close the polygon.

Attributes

Definition Classes
Inherited from:
LinePathIntN
override def |+|[AA >: HCoord](op: HCoord): PolygonT

Appends a single vertex of type A. Returns a PolygonLike.

Appends a single vertex of type A. Returns a PolygonLike.

Attributes

Definition Classes
Inherited from:
LinePathIntN

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