org.apache.giraph.comm.aggregators

Class AggregatorUtils

java.lang.Object

org.apache.giraph.comm.aggregators.AggregatorUtils

public class AggregatorUtils
extends Object

Class for aggregator constants and utility methods

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_BYTES_PER_AGGREGATOR_REQUEST How big a single aggregator request can be (in bytes)
static int	MAX_BYTES_PER_AGGREGATOR_REQUEST_DEFAULT Default max size of single aggregator request (1MB)
static String	USE_THREAD_LOCAL_AGGREGATORS Whether or not to have a copy of aggregators for each compute thread.
static boolean	USE_THREAD_LOCAL_AGGREGATORS_DEFAULT Default is not to have a copy of aggregators for each thread

Method Summary

Modifier and Type	Method and Description
static WorkerInfo	getOwner(String aggregatorName, List<WorkerInfo> workers) Get owner of aggregator with selected name from the list of workers
static String	getUnregisteredAggregatorMessage(String aggregatorName, boolean hasRegisteredAggregators, ImmutableClassesGiraphConfiguration conf) Get the warning message about usage of unregistered aggregator to be printed to user.
static String	getUnregisteredBroadcastMessage(String broadcastName, boolean hasBroadcasted, ImmutableClassesGiraphConfiguration conf) Get the warning message when user tries to access broadcast, without previously setting it, to be printed to user.
static String	getUnregisteredReducerMessage(String reducerName, boolean hasRegisteredReducers, ImmutableClassesGiraphConfiguration conf) Get the warning message about usage of unregistered reducer to be printed to user.
static boolean	useThreadLocalAggregators(ImmutableClassesGiraphConfiguration conf) Check if we should use thread local aggregators.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BYTES_PER_AGGREGATOR_REQUEST

public static final String MAX_BYTES_PER_AGGREGATOR_REQUEST

How big a single aggregator request can be (in bytes)

See Also:

Constant Field Values

MAX_BYTES_PER_AGGREGATOR_REQUEST_DEFAULT

public static final int MAX_BYTES_PER_AGGREGATOR_REQUEST_DEFAULT

Default max size of single aggregator request (1MB)

See Also:

Constant Field Values

USE_THREAD_LOCAL_AGGREGATORS

public static final String USE_THREAD_LOCAL_AGGREGATORS

Whether or not to have a copy of aggregators for each compute thread. Unless aggregators are very large and it would hurt the application to have that many copies of them, user should use thread-local aggregators to prevent synchronization when aggregate() is called (and get better performance because of it).

See Also:

Constant Field Values

USE_THREAD_LOCAL_AGGREGATORS_DEFAULT

public static final boolean USE_THREAD_LOCAL_AGGREGATORS_DEFAULT

Default is not to have a copy of aggregators for each thread

See Also:

Constant Field Values

Method Detail

getOwner

public static WorkerInfo getOwner(String aggregatorName,
                                  List<WorkerInfo> workers)

Get owner of aggregator with selected name from the list of workers

Parameters:

aggregatorName - Name of the aggregators

workers - List of workers

Returns:

Worker which owns the aggregator

useThreadLocalAggregators

public static boolean useThreadLocalAggregators(ImmutableClassesGiraphConfiguration conf)

Check if we should use thread local aggregators.

Parameters:

conf - Giraph configuration

Returns:

True iff we should use thread local aggregators

getUnregisteredAggregatorMessage

public static String getUnregisteredAggregatorMessage(String aggregatorName,
                                                      boolean hasRegisteredAggregators,
                                                      ImmutableClassesGiraphConfiguration conf)

Get the warning message about usage of unregistered aggregator to be printed to user. If user didn't register any aggregators also provide the explanation on how to do so.

Parameters:

aggregatorName - The name of the aggregator which user tried to access

hasRegisteredAggregators - True iff user registered some aggregators

conf - Giraph configuration

Returns:

Warning message

getUnregisteredReducerMessage

public static String getUnregisteredReducerMessage(String reducerName,
                                                   boolean hasRegisteredReducers,
                                                   ImmutableClassesGiraphConfiguration conf)

Get the warning message about usage of unregistered reducer to be printed to user. If user didn't register any reducers also provide the explanation on how to do so.

Parameters:

reducerName - The name of the aggregator which user tried to access

hasRegisteredReducers - True iff user registered some aggregators

conf - Giraph configuration

Returns:

Warning message

getUnregisteredBroadcastMessage

public static String getUnregisteredBroadcastMessage(String broadcastName,
                                                     boolean hasBroadcasted,
                                                     ImmutableClassesGiraphConfiguration conf)

Get the warning message when user tries to access broadcast, without previously setting it, to be printed to user. If user didn't broadcast any value also provide the explanation on how to do so.

Parameters:

broadcastName - The name of the broadcast which user tried to access

hasBroadcasted - True iff user has broadcasted value before

conf - Giraph configuration

Returns:

Warning message