org.apache.flink.graph

Interface ReduceNeighborsFunction<VV>

Type Parameters:

VV - the vertex value type

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

public interface ReduceNeighborsFunction<VV>
extends org.apache.flink.api.common.functions.Function, Serializable

Interface to be implemented by the function applied to a vertex neighborhood in the Graph.reduceOnNeighbors(ReduceNeighborsFunction, EdgeDirection) method.

Method Summary

Modifier and Type	Method and Description
VV	reduceNeighbors(VV firstNeighborValue, VV secondNeighborValue) It combines two neighboring vertex values into one new value of the same type.

Method Detail

reduceNeighbors

VV reduceNeighbors(VV firstNeighborValue,
                   VV secondNeighborValue)

It combines two neighboring vertex values into one new value of the same type. For each vertex, this function is consecutively called, until only a single value for each vertex remains.

Parameters:

firstNeighborValue - the first neighboring vertex value to combine

secondNeighborValue - the second neighboring vertex value to combine

Returns:

the combined value of both input values