com.bigdata.rdf.graph.impl.util

Class GASRunnerBase<VS,ES,ST>

java.lang.Object

com.bigdata.rdf.graph.impl.util.GASRunnerBase<VS,ES,ST>

Type Parameters:

VS - The generic type for the per-vertex state. This is scoped to the computation of the IGASProgram.

ES - The generic type for the per-edge state. This is scoped to the computation of the IGASProgram.

ST - The generic type for the SUM. This is often directly related to the generic type for the per-edge state, but that is not always true. The SUM type is scoped to the GATHER + SUM operation (NOT the computation).

All Implemented Interfaces:

Callable<IGASStats>

Direct Known Subclasses:

BigdataGASRunner, RAMGASRunner, SAILGASRunner

public abstract class GASRunnerBase<VS,ES,ST>
extends Object
implements Callable<IGASStats>

Base class for running performance tests.

Author:

Bryan Thompson TODO Do we need a different driver if the algorithm always visits all vertices? For such algorithms, we just run them once per graph (unless the graph is dynamic).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GASRunnerBase.OptionData Configured options for the GASRunner.

Constructor Summary

Constructors

Constructor and Description
GASRunnerBase(String[] args) Run a GAS analytic against some data set.

Method Summary

Methods

Modifier and Type	Method and Description
IGASStats	call() Run the test.
protected GASRunnerBase.OptionData	getOptionData() The GASRunnerBase.OptionData for the run.
protected abstract void	loadFiles() Load files into the backend if they can not be assumed to already exist (a typical pattern is that files are loaded into an empty KB instance, but not loaded into a pre-existing one).
protected abstract IGASEngine	newGASEngine() Factory for the IGASEngine.
protected IGASProgram<VS,ES,ST>	newGASProgram() Return an instance of the IGASProgram to be evaluated.
protected abstract IGraphAccessor	newGraphAccessor() Return the object used to access the as-configured graph.
protected abstract GASRunnerBase.OptionData	newOptionData() Factory for the GASRunnerBase.OptionData.
protected IGASStats	runAnalytic() Run the analytic.

Methods inherited from class java.lang.Object

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

Constructor Detail

GASRunnerBase

public GASRunnerBase(String[] args)
              throws ClassNotFoundException

Run a GAS analytic against some data set.

Parameters:

args - USAGE:
(options) analyticClass propertyFile

Where:

propertyFile

The implementation specific property file or other type of configuration file.

and options are any of:

-nthreads

The #of threads which will be used for GATHER and SCATTER operations (default ).

-nruns

The #of times that the algorithm will be run. For algorithms that are initialized with a single starting vertex drawn from a random sample, total number of runs is nruns * nsamples. For algorithms that are initialize with either all vertices, there will be a total of nruns runs. (default )

-nsamples

For algorithms that use a single starting vertex (such as BFS, SSSP, etc.), this is the #of starting vertices that will be randomly selected. The sampled vertices will have at least one out-edge or in-edge as appropriate based on the IGASProgram. For algorithm will be run ONCE for EACH sampled vertex. This parameter is ignored for algorithms that initialize the frontier with all vertices (PR, CC, etc). (default )

-seed

The seed for the random number generator (default ).

-schedulerClass

Override the default IGASScheduler. Class must implement IGASSchedulerImpl.

-load

Loads the named resource IFF the KB is empty (or does not exist) at the time this utility is executed. This option may appear multiple times. The resources will be searched for as URLs, on the CLASSPATH, and in the file system.

Throws:

ClassNotFoundException

Method Detail

newOptionData

protected abstract GASRunnerBase.OptionData newOptionData()

Factory for the GASRunnerBase.OptionData.

getOptionData

protected GASRunnerBase.OptionData getOptionData()

The GASRunnerBase.OptionData for the run.

newGASEngine

protected abstract IGASEngine newGASEngine()

Factory for the IGASEngine.

loadFiles

protected abstract void loadFiles()
                           throws Exception

Load files into the backend if they can not be assumed to already exist (a typical pattern is that files are loaded into an empty KB instance, but not loaded into a pre-existing one).

Throws:

Exception

newGraphAccessor

protected abstract IGraphAccessor newGraphAccessor()

Return the object used to access the as-configured graph.

newGASProgram

protected IGASProgram<VS,ES,ST> newGASProgram()

Return an instance of the IGASProgram to be evaluated.

call

public final IGASStats call()
                     throws Exception

Run the test.

This provides a safe pattern for either loading data into a temporary journal, which is then destroyed, or using an exiting journal and optionally loading in some data set. When we load the data the journal is destroyed afterwards and when the journal is pre-existing and we neither load the data nor destroy the journal. This has to do with the effective BufferMode (if transient) and whether the file is specified and whether a temporary file is created (CREATE_TEMP_FILE). If we do our own file create if the effective buffer mode is non-transient, then we can get all this information.

Specified by:

call in interface Callable<IGASStats>

Throws:

Exception

runAnalytic

protected final IGASStats runAnalytic()
                               throws Exception

Run the analytic.

Returns:

The performance statistics for the run.

Throws:

Exception