VertexTraversalResult

com.phasmidsoftware.gryphon.traverse.VertexTraversalResult
See theVertexTraversalResult companion object
case class VertexTraversalResult[V, T](map: Map[V, T]) extends AbstractVertexTraversalResult[V, T]

A concrete implementation of the TraversalResult trait that uses a map to represent vertex traversals. Each vertex in the graph is associated with a traversal result.

CONSIDER this class and its companion object are only used for unit testing. They could be eliminated.

Type parameters

T

The resulting type after traversing a vertex or an edge.

V

The type representing a vertex in the graph.

Value parameters

map

A map where each key is a vertex of type V, and the value is the corresponding traversal result of type T.

Attributes

Constructor

Creates a VertexTraversalResult with the given map of vertices and their associated traversal outputs.

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait TraversalResult[V, T]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def +(t: (V, T)): VertexTraversalResult[V, T]

Adds a new mapping of a vertex to its corresponding traversal result to the existing map, returning a new VertexTraversalResult instance with the updated mapping.

Adds a new mapping of a vertex to its corresponding traversal result to the existing map, returning a new VertexTraversalResult instance with the updated mapping.

Value parameters

t

a tuple where the first element is a vertex of type V, and the second element is its associated traversal result of type T.

Attributes

Returns

a new VertexTraversalResult instance of type VertexTraversalResult[V, E, T] containing the updated map.

Definition Classes
def unit(map: Map[V, T]): TraversalResult[V, T]

Creates a new traversal instance based on the provided map of vertices and their associated traversal results.

Creates a new traversal instance based on the provided map of vertices and their associated traversal results.

Value parameters

map

a map where the keys are vertices of type V and the values are the associated traversal results of type T.

Attributes

Returns

a new traversal instance of type TraversalResult[V, T] constructed with the given map.

Inherited methods

def edgeTraverse(x: Int): T

Traverses a specified edge within a graph-like structure and produces a result of type T.

Traverses a specified edge within a graph-like structure and produces a result of type T.

Value parameters

x

the index of the edge to be traversed

Attributes

Returns

the result of the traversal

Inherited from:
AbstractVertexTraversalResult
def keySet: Set[V]

Retrieves the set of keys from the underlying map that represents the traversal result.

Retrieves the set of keys from the underlying map that represents the traversal result.

Attributes

Returns

a set of keys of type V contained in the underlying map.

Inherited from:
AbstractVertexTraversalResult
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
def size: Int

Returns the number of key-value pairs in the map.

Returns the number of key-value pairs in the map.

Attributes

Returns

the size of the map as an integer

Inherited from:
AbstractVertexTraversalResult
def vertexTraverse(v: V): Option[T]

Traverses the specified vertex in the graph and retrieves the associated traversal result from the underlying map. If the vertex does not exist, a NoSuchElementException is thrown.

Traverses the specified vertex in the graph and retrieves the associated traversal result from the underlying map. If the vertex does not exist, a NoSuchElementException is thrown.

Value parameters

v

the vertex to be traversed and looked up in the map.

Attributes

Returns

the traversal result of type T associated with the provided vertex.

Throws
NoSuchElementException

if the vertex does not exist in the map.

Inherited from:
AbstractVertexTraversalResult