## 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.clone |
  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 |
  org.apache.tinkerpop.gremlin.process.computer.traversal.step |
  org.apache.tinkerpop.gremlin.process.computer.traversal.step.map |
  org.apache.tinkerpop.gremlin.process.computer.traversal.strategy |
  org.apache.tinkerpop.gremlin.process.computer.util |
  org.apache.tinkerpop.gremlin.process.traversal.step.map |
  org.apache.tinkerpop.gremlin.structure.util |
  org.apache.tinkerpop.gremlin.tinkergraph.process.computer |

- - ### 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` | GraphComputerTest.MultiScopeVertexProgram.`execute(Vertex vertex, Messenger<Long> messenger, Memory memory)`
    `void` | GraphComputerTest.MultiScopeVertexWithEdgeFunctionProgram.`execute(Vertex vertex, Messenger<Long> messenger, Memory memory)`
    `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.
    `void` | GraphComputerTest.VertexProgramF.`execute(Vertex vertex, Messenger<Object> messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramB.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramC.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramD.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramE.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramA.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramG.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramH.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramI.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramJ.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramK.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramL.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `void` | GraphComputerTest.VertexProgramM.`execute(Vertex vertex, Messenger messenger, Memory memory)`
    `Set<MessageScope>` | VertexProgram.`getMessageScopes(Memory memory)` This method returns all the `MessageScope` possibilities for a particular iteration of the vertex program.
    `Set<MessageScope>` | GraphComputerTest.VertexProgramB.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramC.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramD.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramE.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramA.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramF.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramG.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramH.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramI.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramJ.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramK.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramL.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.MultiScopeVertexProgram.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.MultiScopeVertexWithEdgeFunctionProgram.`getMessageScopes(Memory memory)`
    `Set<MessageScope>` | GraphComputerTest.VertexProgramM.`getMessageScopes(Memory memory)`
    `void` | VertexProgram.`setup(Memory memory)` The method is called at the beginning of the computation.
    `void` | GraphComputerTest.VertexProgramB.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramC.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramD.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramE.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramA.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramF.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramG.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramH.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramI.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramJ.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramK.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramL.`setup(Memory memory)`
    `void` | GraphComputerTest.MultiScopeVertexProgram.`setup(Memory memory)`
    `void` | GraphComputerTest.MultiScopeVertexWithEdgeFunctionProgram.`setup(Memory memory)`
    `void` | GraphComputerTest.VertexProgramM.`setup(Memory memory)`
    `boolean` | VertexProgram.`terminate(Memory memory)` The method is called at the end of each iteration to determine if the computation is complete.
    `boolean` | GraphComputerTest.VertexProgramB.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramC.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramD.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramE.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramA.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramF.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramG.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramH.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramI.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramJ.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramK.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramL.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.MultiScopeVertexProgram.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.MultiScopeVertexWithEdgeFunctionProgram.`terminate(Memory memory)`
    `boolean` | GraphComputerTest.VertexProgramM.`terminate(Memory memory)`
    `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.
    `void` | GraphComputerTest.VertexProgramJ.`workerIterationEnd(Memory memory)`
    `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.
    `void` | GraphComputerTest.VertexProgramJ.`workerIterationStart(Memory memory)`

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

    Methods in org.apache.tinkerpop.gremlin.process.computer.clone with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | CloneVertexProgram.`execute(Vertex sourceVertex, Messenger<org.javatuples.Tuple> messenger, Memory memory)`
    `Set<MessageScope>` | CloneVertexProgram.`getMessageScopes(Memory memory)`
    `void` | CloneVertexProgram.`setup(Memory memory)`
    `boolean` | CloneVertexProgram.`terminate(Memory memory)`

  - ### 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<TraverserSet<Object>> messenger, Memory memory)`
    `Set<MessageScope>` | TraversalVertexProgram.`getMessageScopes(Memory memory)`
    `static void` | MemoryTraversalSideEffects.`setMemorySideEffects(Traversal.Admin<?,?> traversal, Memory memory, ProgramPhase phase)`
    `void` | TraversalVertexProgram.`setup(Memory memory)`
    `boolean` | TraversalVertexProgram.`terminate(Memory memory)`
    `void` | TraversalVertexProgram.`workerIterationEnd(Memory memory)`
    `void` | TraversalVertexProgram.`workerIterationStart(Memory memory)`

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

    Methods in org.apache.tinkerpop.gremlin.process.computer.traversal.step with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `VertexProgram` | VertexComputing.`generateProgram(Graph graph, Memory memory)` Generate the `VertexProgram`.

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

    Methods in org.apache.tinkerpop.gremlin.process.computer.traversal.step.map with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `ShortestPathVertexProgram` | ShortestPathVertexProgramStep.`generateProgram(Graph graph, Memory memory)`
    `PageRankVertexProgram` | PageRankVertexProgramStep.`generateProgram(Graph graph, Memory memory)`
    `VertexProgram` | ProgramVertexProgramStep.`generateProgram(Graph graph, Memory memory)`
    `PeerPressureVertexProgram` | PeerPressureVertexProgramStep.`generateProgram(Graph graph, Memory memory)`
    `TraversalVertexProgram` | TraversalVertexProgramStep.`generateProgram(Graph graph, Memory memory)`
    `ConnectedComponentVertexProgram` | ConnectedComponentVertexProgramStep.`generateProgram(Graph graph, Memory memory)`

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

    Classes in org.apache.tinkerpop.gremlin.process.computer.traversal.strategy with type parameters of type Memory
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `VertexProgramInterceptor<V extends VertexProgram,G,M extends Memory>`

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

    Classes in org.apache.tinkerpop.gremlin.process.computer.util that implement Memory
    Modifier and Type | Class and Description
    --- | ---
    `class` | `EmptyMemory`
    `class` | `ImmutableMemory`
    `class` | `MapMemory`

    Fields in org.apache.tinkerpop.gremlin.process.computer.util declared as Memory
    Modifier and Type | Field and Description
    --- | ---
    `protected Memory` | DefaultComputerResult.`memory`

    Methods in org.apache.tinkerpop.gremlin.process.computer.util that return Memory
    Modifier and Type | Method and Description
    --- | ---
    `Memory` | EmptyMemory.`asImmutable()`
    `Memory` | DefaultComputerResult.`memory()`

    Methods in org.apache.tinkerpop.gremlin.process.computer.util with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `void` | VertexProgramPool.`workerIterationEnd(Memory memory)`
    `void` | VertexProgramPool.`workerIterationStart(Memory memory)`

    Constructors in org.apache.tinkerpop.gremlin.process.computer.util with parameters of type Memory
    Constructor and Description
    `DefaultComputerResult(Graph graph, Memory memory)`
    `ImmutableMemory(Memory baseMemory)`
    `MapMemory(Memory otherMemory)`

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

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

  - ### Uses of Memory in org.apache.tinkerpop.gremlin.structure.util

    Methods in org.apache.tinkerpop.gremlin.structure.util with parameters of type Memory
    Modifier and Type | Method and Description
    --- | ---
    `static String` | StringFactory.`memoryString(Memory memory)`

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

    Classes in org.apache.tinkerpop.gremlin.tinkergraph.process.computer that implement Memory
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TinkerMemory`
    `class` | `TinkerWorkerMemory`

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