com.bigdata.rdf.graph.impl.bd

Class PATHS

java.lang.Object

com.bigdata.rdf.graph.impl.BaseGASProgram<PATHS.VS,PATHS.ES,Void>

com.bigdata.rdf.graph.impl.bd.PATHS

All Implemented Interfaces:

IBindingExtractor<PATHS.VS,PATHS.ES,Void>, IGASOptions<PATHS.VS,PATHS.ES,Void>, IGASProgram<PATHS.VS,PATHS.ES,Void>, IPredecessor<PATHS.VS,PATHS.ES,Void>

public class PATHS
extends BaseGASProgram<PATHS.VS,PATHS.ES,Void>
implements IPredecessor<PATHS.VS,PATHS.ES,Void>

PATHS is an iterative graph traversal operation. The frontier is expanded iteratively until no new vertices are discovered, or until the target vertices have all been reached. Each vertex is marked with its depth and with a list of all predecessors and their edges to the vertex. This algorithm is useful for creating a complete connected subgraph between a source and a set of targets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PATHS.Bindings Additional IBindingExtractor.IBinders exposed by PATHS.
static class	PATHS.ES Edge state is not used.
static class	PATHS.VS

Constructor Summary

Constructors

Constructor and Description
PATHS()

Method Summary

Methods

Modifier and Type	Method and Description
PATHS.VS	apply(IGASState<PATHS.VS,PATHS.ES,Void> state, org.openrdf.model.Value u, Void sum) NOP
Void	gather(IGASState<PATHS.VS,PATHS.ES,Void> state, org.openrdf.model.Value u, org.openrdf.model.Statement e) Not used.
List<IBinder<PATHS.VS,PATHS.ES,Void>>	getBinderList() Return a list of interfaces that may be used to extract variable bindings for the vertices visited by the algorithm.
Factory<org.openrdf.model.Statement,PATHS.ES>	getEdgeStateFactory() Return a factory for edge state objects -or- null if the IGASProgram does not use edge state (in which case the edge state will not be allocated or maintained).
EdgesEnum	getGatherEdges() Return the set of edges to which the GATHER is applied for a directed graph -or- EdgesEnum.NoEdges to skip the GATHER phase.
FrontierEnum	getInitialFrontierEnum() Return the nature of the initial frontier for this algorithm.
EdgesEnum	getScatterEdges() Return the set of edges to which the SCATTER is applied for a directed graph -or- EdgesEnum.NoEdges to skip the SCATTER phase.
Factory<org.openrdf.model.Value,PATHS.VS>	getVertexStateFactory() Return a factory for vertex state objects.
void	initVertex(IGASContext<PATHS.VS,PATHS.ES,Void> ctx, IGASState<PATHS.VS,PATHS.ES,Void> state, org.openrdf.model.Value u) Not used.
boolean	isChanged(IGASState<PATHS.VS,PATHS.ES,Void> state, org.openrdf.model.Value u) Returns true.
boolean	nextRound(IGASContext<PATHS.VS,PATHS.ES,Void> ctx) Return true iff the algorithm should continue.
void	prunePaths(IGASContext<PATHS.VS,PATHS.ES,Void> ctx, org.openrdf.model.Value[] targetVertices) Remove any vertices from the visited set that do not line on path that leads to at least one of the target vertices.
void	scatter(IGASState<PATHS.VS,PATHS.ES,Void> state, IGASScheduler sch, org.openrdf.model.Value u, org.openrdf.model.Statement e) The remote vertex is scheduled for activation unless it has already been visited.
Void	sum(IGASState<PATHS.VS,PATHS.ES,Void> state, Void left, Void right) Not used.
protected void	visitPredecessors(IGASState<PATHS.VS,PATHS.ES,Void> gasState, org.openrdf.model.Value v, Set<org.openrdf.model.Value> retainSet)

Methods inherited from class com.bigdata.rdf.graph.impl.BaseGASProgram

before, getSampleEdgesFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

PATHS

public PATHS()

Method Detail

getVertexStateFactory

public Factory<org.openrdf.model.Value,PATHS.VS> getVertexStateFactory()

Description copied from interface: IGASOptions

Return a factory for vertex state objects.

Note: A null value may not be allowed in the visited vertex map, so if the algorithm does not use vertex state, then the factory should return a singleton instance each time it is invoked.

Specified by:

getVertexStateFactory in interface IGASOptions<PATHS.VS,PATHS.ES,Void>

getEdgeStateFactory

public Factory<org.openrdf.model.Statement,PATHS.ES> getEdgeStateFactory()

Description copied from class: BaseGASProgram

Return a factory for edge state objects -or- null if the IGASProgram does not use edge state (in which case the edge state will not be allocated or maintained).

The default implementation returns null. Override this if the algorithm uses per-edge computation state.

Specified by:

getEdgeStateFactory in interface IGASOptions<PATHS.VS,PATHS.ES,Void>

Overrides:

getEdgeStateFactory in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

getInitialFrontierEnum

public FrontierEnum getInitialFrontierEnum()

Description copied from interface: IGASOptions

Return the nature of the initial frontier for this algorithm.

Specified by:

getInitialFrontierEnum in interface IGASOptions<PATHS.VS,PATHS.ES,Void>

getGatherEdges

public EdgesEnum getGatherEdges()

Description copied from class: BaseGASProgram

Return the set of edges to which the GATHER is applied for a directed graph -or- EdgesEnum.NoEdges to skip the GATHER phase. This will be interpreted based on the value reported by IGASContext#isDirectedTraversal(). TODO We may need to set dynamically when visting the vertex in the frontier rather than having it be a one-time property of the vertex program.

The default gathers on the EdgesEnum.InEdges.

Specified by:

getGatherEdges in interface IGASOptions<PATHS.VS,PATHS.ES,Void>

Overrides:

getGatherEdges in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

getScatterEdges

public EdgesEnum getScatterEdges()

Description copied from class: BaseGASProgram

Return the set of edges to which the SCATTER is applied for a directed graph -or- EdgesEnum.NoEdges to skip the SCATTER phase. This will be interpreted based on the value reported by IGASContext#isDirectedTraversal().

The default scatters on the EdgesEnum.OutEdges.

Specified by:

getScatterEdges in interface IGASOptions<PATHS.VS,PATHS.ES,Void>

Overrides:

getScatterEdges in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

initVertex

public void initVertex(IGASContext<PATHS.VS,PATHS.ES,Void> ctx,
              IGASState<PATHS.VS,PATHS.ES,Void> state,
              org.openrdf.model.Value u)

Not used.

Specified by:

initVertex in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

Overrides:

initVertex in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

u - The vertex. TODO We do not need both the IGASContext and the IGASState. The latter is available from the former.

gather

public Void gather(IGASState<PATHS.VS,PATHS.ES,Void> state,
          org.openrdf.model.Value u,
          org.openrdf.model.Statement e)

Not used.

Specified by:

gather in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

u - The vertex for which the gather is being performed. The gather will be invoked for each edge indident on u (as specified by IGASOptions.getGatherEdges()).

e - An edge (s,p,o).

Returns:

The new edge state accumulant. FIXME DESIGN: The problem with pushing the ISPO onto the ES is that we are then forced to maintain edge state (for the purposes of accessing those ISPO references) even if the algorithm does not require any memory for the edge state!

Note: by lazily resolving the vertex and/or edge state in the GAS callback methods we avoid eagerly materializing data that we do not need. [Lazy resolution does not work on a cluster. The only available semantics there are lazy resolution of state that was materialized in order to support a gather() or scatter() for a vertex.]

Note: The state associated with the source/target vertex and the edge should all be immutable for the GATHER. The vertex state should only be mutable for the APPLY(). The target vertex state and/or edge state MAY be mutable for the SCATTER, but that depends on the algorithm. How can we get these constraints into the API?

sum

public Void sum(IGASState<PATHS.VS,PATHS.ES,Void> state,
       Void left,
       Void right)

Not used.

Specified by:

sum in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

left - An edge state accumulant.

right - Another edge state accumulant.

Returns:

Their "sum". TODO DESIGN: Rather than pair-wise reduction, why not use vectored reduction? That way we could use an array of primitives as well as objects. TODO DESIGN: This should be a reduced interface since we only need access to the comparator semantics while the [state] provides random access to vertex and edge state. The comparator is necessary for MIN semantics for the Value implementation of the backend. E.g., Value versus IV.

apply

public PATHS.VS apply(IGASState<PATHS.VS,PATHS.ES,Void> state,
             org.openrdf.model.Value u,
             Void sum)

NOP

Specified by:

apply in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

u - The vertex.

sum - The aggregated accumulate across the edges as computed by GATHER and SUM -or- null if there is no accumulant (this will happen if the GATHER did not find any edges to visit).

Returns:

The new state for the vertex. TODO How to indicate if there is no state change? return the same object? This only matters with secondary storage for the vertex state. Alternative is to side-effect the vertex state, but then we can not manage the barriers (BFS versus asynchronous). Except for indicating that the state is dirty, we do not need a return value. [The pattern appears to be that a vertex leaves a marker on its vertex state object indicating whether or not it was changed and then tests that state when deciding whether or not to scatter]. TODO There could be a big win here if we are able to detect when a newly initialized vertex state does not "escape" and simply not store it. For some graphs, the vertexState map grows very rapidly when compared to either the frontier or the set of states that have been in the frontier during the computation.

isChanged

public boolean isChanged(IGASState<PATHS.VS,PATHS.ES,Void> state,
                org.openrdf.model.Value u)

Returns true.

Specified by:

isChanged in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

Overrides:

isChanged in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

u - The vertex.

Returns:

scatter

public void scatter(IGASState<PATHS.VS,PATHS.ES,Void> state,
           IGASScheduler sch,
           org.openrdf.model.Value u,
           org.openrdf.model.Statement e)

The remote vertex is scheduled for activation unless it has already been visited.

Note: We are scattering to out-edges. Therefore, this vertex is Statement.getSubject(). The remote vertex is Statement.getObject().

Specified by:

scatter in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

u - The vertex for which the scatter will being performed.

e - The edge.

nextRound

public boolean nextRound(IGASContext<PATHS.VS,PATHS.ES,Void> ctx)

Description copied from class: BaseGASProgram

Return true iff the algorithm should continue. This is invoked after every iteration, once the new frontier has been computed and IGASState.round() has been advanced. An implementation may simply return true, in which case the algorithm will continue IFF the current frontier is not empty.

Note: While this can be used to make custom decisions concerning the halting criteria, it can also be used as an opportunity to handshake with a custom IGraphAccessor in order to process a dynamic graph.

The default returns true.

Specified by:

nextRound in interface IGASProgram<PATHS.VS,PATHS.ES,Void>

Overrides:

nextRound in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

Parameters:

ctx - The evaluation context.

Returns:

true if the algorithm should continue (as long as the frontier is non-empty).

getBinderList

public List<IBinder<PATHS.VS,PATHS.ES,Void>> getBinderList()

Return a list of interfaces that may be used to extract variable bindings for the vertices visited by the algorithm.

The visited vertex itself.

The depth at which the vertex was first encountered during traversal.

The predecessors are all the vertices that discovers a given vertex during traversal.

These are the edges along which each predecessor discovered a given vertex during traversal.

Specified by:

getBinderList in interface IBindingExtractor<PATHS.VS,PATHS.ES,Void>

Overrides:

getBinderList in class BaseGASProgram<PATHS.VS,PATHS.ES,Void>

prunePaths

public void prunePaths(IGASContext<PATHS.VS,PATHS.ES,Void> ctx,
              org.openrdf.model.Value[] targetVertices)

Description copied from interface: IPredecessor

Remove any vertices from the visited set that do not line on path that leads to at least one of the target vertices.

Specified by:

prunePaths in interface IPredecessor<PATHS.VS,PATHS.ES,Void>

Parameters:

ctx - The IGASContext.

targetVertices - An array of zero or more target vertices.

visitPredecessors

protected void visitPredecessors(IGASState<PATHS.VS,PATHS.ES,Void> gasState,
                     org.openrdf.model.Value v,
                     Set<org.openrdf.model.Value> retainSet)