Packages

object Orientation

Utility methods for calculations on Orientations

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Orientation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val commaSepList: String

    Comma separated list of string representations of Orientations

  7. def consensus(o1: Orientation, o2: Orientation): Orientation

    Returns the consensus of two possibly different Orientations.

    Returns the consensus of two possibly different Orientations.

    The consensus is Unstranded if the two Orientations are incompatible.

    o1

    Orientation 1

    o2

    Orientation 2

    returns

    The consensus Orientation

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fromString(s: String): Orientation

    Returns an Orientation from its string description.

    Returns an Orientation from its string description.

    Throws IllegalArgumentException if the passed string does not correspond to an Orientation.

    s

    String description

    returns

    The corresponding Orientation

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  14. def invert(o: Orientation): Orientation

    Returns the reverse of the specified Orientation.

    Returns the reverse of the specified Orientation.

    Plus and Minus are swapped by this function. Unstranded is unchanged.

    o

    Orientation to get the reverse of

    returns

    The reverse of the specified Orientation

  15. def isCompatible(f1: Region, f2: Region): Boolean

    Returns a boolean value representing whether the Orientations of two Regions are compatible.

    Returns a boolean value representing whether the Orientations of two Regions are compatible.

    The notion of compatibility is used when, e.g., merging or intersecting Regions.

    Every Orientation is compatible with itself. Plus and Minus are incompatible with each other. Unstranded is compatible with Plus and Minus.

    f1

    Region 1

    f2

    Region 2

    returns

    The boolean value indicating compatibility

  16. def isCompatible(o1: Orientation, o2: Orientation): Boolean

    Returns a boolean value representing whether two Orientations are compatible.

    Returns a boolean value representing whether two Orientations are compatible.

    The notion of compatibility is used when, e.g., merging or intersecting Features.

    Every Orientation is compatible with itself. Plus and Minus are incompatible with each other. Unstranded is compatible with Plus and Minus.

    o1

    Orientation 1

    o2

    Orientation 2

    returns

    The boolean value indicating compatibility

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. object ArbitraryOrdering extends Ordering[Orientation]

    An arbitrary ordering on Orientations.

Inherited from AnyRef

Inherited from Any

Ungrouped