## Uses of Interface
org.apache.tinkerpop.gremlin.process.computer.Memory

- Packages that use Memory
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.process.computer |
  org.apache.tinkerpop.gremlin.process.computer.clustering.connected |
  org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure |
  org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank |
  org.apache.tinkerpop.gremlin.process.computer.search.path |
  org.apache.tinkerpop.gremlin.process.computer.traversal |

- - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer

    Subinterfaces of Memory in org.apache.tinkerpop.gremlin.process.computer
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Memory.Admin` The Admin interface is used by the `GraphComputer` to update the Memory.

    Methods in org.apache.tinkerpop.gremlin.process.computer that return Memory
    Modifier and Type | Method and Description
    --- | ---
    `default Memory` | Memory.Admin.`asImmutable()`
    `Memory` | ComputerResult.`memory()` Get the GraphComputer's computational sideEffects known as `Memory`.

    Methods in org.apache.tinkerpop.gremlin.process.computer with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | VertexProgram.`execute(Vertex vertex, Messenger<M> messenger, Memory memory)` This method denotes the main body of the computation and is executed on each vertex in the graph.
    `Set<MessageScope>` | VertexProgram.`getMessageScopes(Memory memory)` This method returns all the `MessageScope` possibilities for a particular iteration of the vertex program.
    `void` | VertexProgram.`setup(Memory memory)` The method is called at the beginning of the computation.
    `boolean` | VertexProgram.`terminate(Memory memory)` The method is called at the end of each iteration to determine if the computation is complete.
    `default void` | VertexProgram.`workerIterationEnd(Memory memory)` This method is called at the end of each iteration of each "computational chunk." The set of vertices in the graph are typically not processed with full parallelism.
    `default void` | VertexProgram.`workerIterationStart(Memory memory)` This method is called at the start of each iteration of each "computational chunk." The set of vertices in the graph are typically not processed with full parallelism.

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer.clustering.connected

    Methods in org.apache.tinkerpop.gremlin.process.computer.clustering.connected with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConnectedComponentVertexProgram.`execute(Vertex vertex, Messenger<String> messenger, Memory memory)`
    `Set<MessageScope>` | ConnectedComponentVertexProgram.`getMessageScopes(Memory memory)`
    `void` | ConnectedComponentVertexProgram.`setup(Memory memory)`
    `boolean` | ConnectedComponentVertexProgram.`terminate(Memory memory)`

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure

    Methods in org.apache.tinkerpop.gremlin.process.computer.clustering.peerpressure with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | PeerPressureVertexProgram.`execute(Vertex vertex, Messenger<org.javatuples.Pair<Serializable,Double>> messenger, Memory memory)`
    `Set<MessageScope>` | PeerPressureVertexProgram.`getMessageScopes(Memory memory)`
    `void` | PeerPressureVertexProgram.`setup(Memory memory)`
    `boolean` | PeerPressureVertexProgram.`terminate(Memory memory)`

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank

    Methods in org.apache.tinkerpop.gremlin.process.computer.ranking.pagerank with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | PageRankVertexProgram.`execute(Vertex vertex, Messenger<Double> messenger, Memory memory)`
    `Set<MessageScope>` | PageRankVertexProgram.`getMessageScopes(Memory memory)`
    `void` | PageRankVertexProgram.`setup(Memory memory)`
    `boolean` | PageRankVertexProgram.`terminate(Memory memory)`

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer.search.path

    Methods in org.apache.tinkerpop.gremlin.process.computer.search.path with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | ShortestPathVertexProgram.`execute(Vertex vertex, Messenger<org.javatuples.Triplet<Path,Edge,Number>> messenger, Memory memory)`
    `Set<MessageScope>` | ShortestPathVertexProgram.`getMessageScopes(Memory memory)`
    `void` | ShortestPathVertexProgram.`setup(Memory memory)`
    `boolean` | ShortestPathVertexProgram.`terminate(Memory memory)`

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.process.computer.traversal

    Methods in org.apache.tinkerpop.gremlin.process.computer.traversal with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | TraversalVertexProgram.`execute(Vertex vertex, Messenger<org.apache.tinkerpop.gremlin.process.traversal.traverser.util.TraverserSet<Object>> messenger, Memory memory)`
    `Set<MessageScope>` | TraversalVertexProgram.`getMessageScopes(Memory memory)`
    `void` | TraversalVertexProgram.`setup(Memory memory)`
    `boolean` | TraversalVertexProgram.`terminate(Memory memory)`
    `void` | TraversalVertexProgram.`workerIterationEnd(Memory memory)`
    `void` | TraversalVertexProgram.`workerIterationStart(Memory memory)`

Copyright © 2013–2022 Apache Software Foundation. All rights reserved.