OpenStrat
API
Generated with
OpenStrat/ostrat/ostrat.geom/LinePathDbl2

LinePathDbl2

ostrat.geom.LinePathDbl2
trait LinePathDbl2[VT <: Dbl2Elem] extends LinePathDblN[VT], SeqSpecDbl2[VT]

LinePathLike whose points are Dbl2Elems. Includes the LinePath class.

Attributes

Graph
Supertypes
trait SeqSpecDbl2[VT]
trait SeqLikeDbl2[VT]
trait LinePathDblN[VT]
trait SeqSpecDblN[VT]
trait SeqSpecValueN[VT]
trait SeqLikeDblN[VT]
trait SpecialT
trait SeqLikeValueN[VT]
trait LinePathLike[VT]
trait SeqSpec[VT]
trait SeqLike[VT]
class Any
Show all
Known subtypes
class LinePathLL
class LinePath
class LinePathKm2
class LinePathM2

Members list

Type members

Types

type ThisT <: LinePathDbl2[VT]

Gives the final type of this class.

Gives the final type of this class.

Attributes

Inherited and Abstract types

type LineSegArrT <: Arr[LineSegT]

Attributes

Inherited from:
LinePathLike
type LineSegT <: LineSegLike[VT]

Attributes

Inherited from:
LinePathLike

Value members

Inherited methods

final override def %:(operand: VT): 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:
LinePathDblN
final override def %<:(operand: VT): 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:
LinePathDblN
final override def +%(operandPt: VT): 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:
LinePathDblN
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:
LinePathDblN
final override def ++<(operand: ThisT): ThisT

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended LinePathLike. The < character after the ++ indicates that is the operand that is being reversed.

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended LinePathLike. The < character after the ++ indicates that is the operand that is being reversed.

Attributes

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

Appends the tail (without its first point) of the operand LinePathLike of this type. The ++ indicates to append a sequence. The trailing indicates to drop the first point of the operand.

Appends the tail (without its first point) of the operand LinePathLike of this type. The ++ indicates to append a sequence. The trailing indicates to drop the first point of the operand.

Attributes

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

Reverses this line path and then appends the operand. The < character between the + characters indicates that it this line path that is reversed.

Reverses this line path and then appends the operand. The < character between the + characters indicates that it this line path that is reversed.

Attributes

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

Reverses this line path and then appends the operand. The < character between the + characters indicates that it this line path that is reversed.

Reverses this line path and then appends the operand. The < character between the + characters indicates that it this line path that is reversed.

Attributes

Definition Classes
Inherited from:
LinePathDblN
def appendArray(appendProductsLength: Int): Array[Double]

Builder helper method that provides a longer array, with the underlying array copied into the new extended Array.

Builder helper method that provides a longer array, with the underlying array copied into the new extended Array.

Attributes

Inherited from:
SeqSpecDblN
def appendPtToArray(pt: VT): Array[Double]

Attributes

Inherited from:
LinePathDblN
def appendTailArray(opArray: Array[Double]): Array[Double]

Implementation helper method for implementation of appendTail and appendTailToPolygon methods. End users should rarely need to use this, but it's been left public for when it is.

Implementation helper method for implementation of appendTail and appendTailToPolygon methods. End users should rarely need to use this, but it's been left public for when it is.

Attributes

Inherited from:
LinePathDblN
final def arrayLen: Int

The total number of atomic values, Ints, Doubles, Longs etc in the backing Array.

The total number of atomic values, Ints, Doubles, Longs etc in the backing Array.

Attributes

Inherited from:
SeqLikeDblN
def elem1sArray: Array[Double]

Attributes

Inherited from:
SeqSpecDbl2
def elem2sArray: Array[Double]

Attributes

Inherited from:
SeqSpecDbl2
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:
SeqLikeDbl2
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 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:
LinePathDblN
def initAppendInitArray(opArray: Array[Double]): Array[Double]

Attributes

Inherited from:
LinePathDblN
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:
LinePathDblN
def map[B <: ValueNElem, BB <: LinePathLike[B]](f: VT => 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 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:
SeqSpecDblN
override def setElemUnsafe(index: Int, newElem: VT): 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:
SeqLikeDbl2
def setElemsUnsafe(index: Int, elems: VT*): 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
override def ssElemEq(a1: VT, a2: VT): 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:
SeqSpecDbl2
def ssFold[B](initVal: B)(f: (B, VT) => B): B

specifying -sequence fold.

specifying -sequence fold.

Attributes

Inherited from:
SeqSpec
def ssForAll(f: VT => Boolean): Boolean

Attributes

Inherited from:
SeqSpecValueN
def ssForeach[U](f: VT => 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 ssForeachPairTail[U](f: (Double, Double) => U): Unit

Attributes

Inherited from:
SeqSpecDbl2
def ssIForeach[U](initIndex: Int)(f: (Int, VT) => 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, VT) => 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
override def ssIndex(index: Int): VT

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:
SeqSpecDbl2
def ssInnerForeach[U](f: VT => 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: VT

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: VT => 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: VT => 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, VT) => 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: VT => 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:
LinePathDblN
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:
LinePathDblN
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 unsafeD1Map(f: Double => Double): Array[Double]

Maps the 1st Double of each element to a new Array[Double], copies the 2nd elements.

Maps the 1st Double of each element to a new Array[Double], copies the 2nd elements.

Attributes

Inherited from:
SeqSpecDbl2
def unsafeD2Map(f: Double => Double): Array[Double]

Maps the 2nd Double of each element with the parameter function to a new Array[Double], copies the 1st Double of each element.

Maps the 2nd Double of each element with the parameter function to a new Array[Double], copies the 1st Double of each element.

Attributes

Inherited from:
SeqSpecDbl2
def unsafeMap(f: VT => VT): Array[Double]

Maps the 2 Doubles of each element to a new Array[Double].

Maps the 2 Doubles of each element to a new Array[Double].

Attributes

Inherited from:
SeqSpecDbl2
def unsafeReverseArray: Array[Double]

Reverses the order of the elements in a new Array[Double] which is returned.

Reverses the order of the elements in a new Array[Double] which is returned.

Attributes

Inherited from:
SeqSpecDblN
def unsafeSameSize(length: Int): ThisT

Attributes

Inherited from:
SeqLikeDblN
final override def |+%|(operandPt: VT): PolygonT

Appends the operand point and closes the path into a PolygonLike of the matching type. +% indicates to append a point. The enclosing '|' characters indicate to close the line path into a polygon.

Appends the operand point and closes the path into a PolygonLike of the matching type. +% indicates to append a point. The enclosing '|' characters indicate to close the line path into a polygon.

Attributes

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

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended closed PolygonLike. The < after the ++ indicates it is the operand to be reversed.

Appends the reverse vertex order of another LinePathLike of this type. Returns a new extended closed PolygonLike. The < after the ++ indicates it is the operand to be reversed.

Attributes

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

Appends the operand LinePathLike of this type and closes the path into a PolygonLike of the matching type. ++ indicates to append a sequence. The enclosing '|' characters indicate to close the line path into a polygon.

Appends the operand LinePathLike of this type and closes the path into a PolygonLike of the matching type. ++ indicates to append a sequence. The enclosing '|' characters indicate to close the line path into a polygon.

Attributes

Definition Classes
Inherited from:
LinePathDblN
final override def |+-+|(operand: ThisT): PolygonT

Appends the tail (without its first point) of the operand LinePathLike of this type, closing the path to a PolygonLike of the matching type. ++ indicates append a sequence. The - between the + characters indicates to drop the first point of the operand. The enclosing '|' characters indicate to close the line path into a polygon.

Appends the tail (without its first point) of the operand LinePathLike of this type, closing the path to a PolygonLike of the matching type. ++ indicates append a sequence. The - between the + characters indicates to drop the first point of the operand. The enclosing '|' characters indicate to close the line path into a polygon.

Attributes

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

Reverses this line path, appends the operand line path and then closes to a polygon. The < character between the + characters indicates that this line is reversed. The | characters at the begining and the end indicate to close to a polygon.

Reverses this line path, appends the operand line path and then closes to a polygon. The < character between the + characters indicates that this line is reversed. The | characters at the begining and the end indicate to close to a polygon.

Attributes

Definition Classes
Inherited from:
LinePathDblN
final override def |+|[AA >: VT](pt: VT): 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:
LinePathDblN
final override def |-++-|(operand: ThisT): PolygonT

Appends the init of another LinePathLike of this type to the init of this LinePathLike, closing the path to return a PolygonLike of the matching type. The - before the ++ indicates to drop the last point of this line path. The - after the ++ indicates to drop the end point of the operand.

Appends the init of another LinePathLike of this type to the init of this LinePathLike, closing the path to return a PolygonLike of the matching type. The - before the ++ indicates to drop the last point of this line path. The - after the ++ indicates to drop the end point of the operand.

Attributes

Definition Classes
Inherited from:
LinePathDblN

Inherited and Abstract methods

def arrayUnsafe: Array[Double]

Attributes

Inherited from:
ArrayDblBacked
def fElemStr: VT => String

Attributes

Inherited from:
SeqLike
def fromArray(array: Array[Double]): ThisT

Attributes

Inherited from:
SeqLikeDblN
def polygonFromArray(array: Array[Double]): PolygonT

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

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

Attributes

Inherited from:
LinePathDblN
def ssElem(d1: Double, d2: Double): VT

Method for creating new specifying sequence elements from 2 Doubles In the case of ArrDbl2 this will be thee type of the elements of the sequence.

Method for creating new specifying sequence elements from 2 Doubles In the case of ArrDbl2 this will be thee type of the elements of the sequence.

Attributes

Inherited from:
SeqSpecDbl2
def typeStr: String

String specifying the type of this object.

String specifying the type of this object.

Attributes

Inherited from:
SeqLike
Generated with