com.tinkerpop.gremlin.process.computer

Class MessageScope.Local<M>

java.lang.Object

com.tinkerpop.gremlin.process.computer.MessageScope

com.tinkerpop.gremlin.process.computer.MessageScope.Local<M>

Type Parameters:

M - The VertexProgram message class

Enclosing class:

MessageScope

public static final class MessageScope.Local<M>
extends MessageScope

A Local message is directed to an adjacent (or "memory adjacent") vertex. The adjacent vertex set is defined by the provided Traversal that dictates how to go from the sending vertex to the receiving vertex. This is the preferred message scope as it can potentially be optimized by the underlying Messenger implementation. The preferred optimization is to not distribute a message object to all adjacent vertices. Instead, allow the recipients to read a single message object stored at the "sending" vertex. This is possible via `Traversal.reverse()`. This optimizations greatly reduces the amount of data created in the computation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageScope.Local.ReverseTraversalSupplier A helper class that can be used to generate the reverse traversal of the traversal within a MessageScope.Local.

Nested classes/interfaces inherited from class com.tinkerpop.gremlin.process.computer.MessageScope

MessageScope.Global, MessageScope.Local<M>

Field Summary

Fields

Modifier and Type	Field and Description
java.util.function.BiFunction<M,Edge,M>	edgeFunction
java.util.function.Supplier<? extends Traversal<Vertex,Edge>>	incidentTraversal

Method Summary

Modifier and Type	Method and Description
java.util.function.BiFunction<M,Edge,M>	getEdgeFunction()
java.util.function.Supplier<? extends Traversal<Vertex,Edge>>	getIncidentTraversal()
static <M> MessageScope.Local<M>	of(java.util.function.Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal)
static <M> MessageScope.Local<M>	of(java.util.function.Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal, java.util.function.BiFunction<M,Edge,M> edgeFunction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

incidentTraversal

public final java.util.function.Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal

edgeFunction

public final java.util.function.BiFunction<M,Edge,M> edgeFunction

Method Detail

of

public static <M> MessageScope.Local<M> of(java.util.function.Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal)

of

public static <M> MessageScope.Local<M> of(java.util.function.Supplier<? extends Traversal<Vertex,Edge>> incidentTraversal,
                                           java.util.function.BiFunction<M,Edge,M> edgeFunction)

getEdgeFunction

public java.util.function.BiFunction<M,Edge,M> getEdgeFunction()

getIncidentTraversal

public java.util.function.Supplier<? extends Traversal<Vertex,Edge>> getIncidentTraversal()