Packages

class VirtualTileIndexCodec extends VirtualIndexCodec[Vertex, Edge]

This is an experimental API. It may be removed or changed from one version to the next.

Default VirtualIndexCodec for Vertex and Edge.

Virtual vertices and edges are encoded inside the standard Vertex / Edge types by using the reserved tile id -1 as a sentinel value that cannot appear in real map data.

  • A 'virtual vertex' is a Vertex with tileId == TileId(-1). Its index field holds the zero-based position of the virtual vertex the patched graph's virtual vertex array.
  • A 'virtual edge' is an Edge whose source is a virtual vertex. Its index field holds the position of the edge in the patched graph's CSR edge array. The target vertex is resolved by patched-graph adjacency, not encoded in Edge.
Annotations
@Experimental()
Note

A ready-to-use implicit instance of this class is available via Implicits.virtualTileIndexCodec. Import Implicits._ to bring it into scope automatically wherever a VirtualIndexCodec[Vertex, Edge] implicit is required.

Linear Supertypes
VirtualIndexCodec[Vertex, Edge], VirtualVertexCodec[Vertex], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VirtualTileIndexCodec
  2. VirtualIndexCodec
  3. VirtualVertexCodec
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new VirtualTileIndexCodec()

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def isVirtualEdge(e: Edge): Boolean

    Returns true if e is a virtual edge, i.e.

    Returns true if e is a virtual edge, i.e. an edge whose source is a virtual vertex.

    Definition Classes
    VirtualTileIndexCodec → VirtualIndexCodec
  12. def isVirtualVertex(v: Vertex): Boolean

    Returns true if v is a virtual vertex, i.e.

    Returns true if v is a virtual vertex, i.e. a synthetic vertex introduced by a patch.

    Definition Classes
    VirtualTileIndexCodec → VirtualVertexCodec
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def virtualEdge(index: VirtualEdgeIndex, source: Vertex, target: Vertex): Edge

    Creates a virtual edge identified by its index, source, and target.

    Creates a virtual edge identified by its index, source, and target.

    This is the inverse of virtualEdgeIndex: virtualEdgeIndex(virtualEdge(i, s, t)) == i.

    source

    The source vertex of the edge (a virtual vertex).

    target

    The target vertex of the edge (virtual or original).

    Definition Classes
    VirtualTileIndexCodec → VirtualIndexCodec
  19. def virtualEdgeIndex(e: Edge): VirtualEdgeIndex

    Returns the zero-based index of a virtual edge of the patched graph.

    Returns the zero-based index of a virtual edge of the patched graph.

    e

    A virtual edge.

    Definition Classes
    VirtualTileIndexCodec → VirtualIndexCodec
  20. def virtualVertex(index: VirtualVertexIndex): Vertex

    Creates the virtual vertex that corresponds to the given index.

    Creates the virtual vertex that corresponds to the given index.

    This is the inverse of virtualVertexIndex: virtualVertexIndex(virtualVertex(i)) == i.

    index

    Zero-based index into the virtual vertex space.

    Definition Classes
    VirtualTileIndexCodec → VirtualVertexCodec
  21. def virtualVertexIndex(v: Vertex): VirtualVertexIndex

    Returns the zero-based index of a virtual vertex.

    Returns the zero-based index of a virtual vertex.

    v

    A virtual vertex.

    Definition Classes
    VirtualTileIndexCodec → VirtualVertexCodec
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from VirtualIndexCodec[Vertex, Edge]

Inherited from VirtualVertexCodec[Vertex]

Inherited from AnyRef

Inherited from Any

Ungrouped