org.apache.flink.graph.library.similarity

Class AdamicAdar<K extends CopyableValue<K>,VV,EV>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase<K,VV,EV,DataSet<T>>

org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingDataSet<K,VV,EV,AdamicAdar.Result<K>>

org.apache.flink.graph.library.similarity.AdamicAdar<K,VV,EV>

Type Parameters:

K - graph ID type

VV - vertex value type

EV - edge value type

All Implemented Interfaces:

GraphAlgorithm<K,VV,EV,DataSet<AdamicAdar.Result<K>>>

public class AdamicAdar<K extends CopyableValue<K>,VV,EV>
extends GraphAlgorithmWrappingDataSet<K,VV,EV,AdamicAdar.Result<K>>

http://social.cs.uiuc.edu/class/cs591kgk/friendsadamic.pdf

Adamic-Adar measures the similarity between pairs of vertices as the sum of the inverse logarithm of degree over shared neighbors. Scores are non-negative and unbounded. A vertex with higher degree has greater overall influence but is less influential to each pair of neighbors.

This implementation produces similarity scores for each pair of vertices in the graph with at least one shared neighbor; equivalently, this is the set of all non-zero Adamic-Adar coefficients.

The input graph must be a simple, undirected graph containing no duplicate edges or self-loops.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdamicAdar.Result<T> A result for the Adamic-Adar algorithm.

Field Summary

Fields inherited from class org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase

parallelism

Constructor Summary

Constructors

Constructor and Description
AdamicAdar()

Method Summary

Modifier and Type	Method and Description
protected boolean	canMergeConfigurationWith(GraphAlgorithmWrappingBase other) First test whether the algorithm configurations can be merged before the call to GraphAlgorithmWrappingBase.mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).
DataSet<AdamicAdar.Result<K>>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).
AdamicAdar<K,VV,EV>	setMinimumRatio(float ratio) Filter out Adamic-Adar scores less than the given ratio times the average score.
AdamicAdar<K,VV,EV>	setMinimumScore(float score) Filter out Adamic-Adar scores less than the given minimum.
AdamicAdar<K,VV,EV>	setMirrorResults(boolean mirrorResults) By default only one result is output for each pair of vertices.

Methods inherited from class org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingDataSet

equals, hashCode, run

Methods inherited from class org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase

getAlgorithmName, mergeConfiguration, setParallelism

Methods inherited from class java.lang.Object

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

Constructor Detail

AdamicAdar

public AdamicAdar()

Method Detail

setMinimumScore

public AdamicAdar<K,VV,EV> setMinimumScore(float score)

Filter out Adamic-Adar scores less than the given minimum.

Parameters:

score - minimum score

Returns:

this

setMinimumRatio

public AdamicAdar<K,VV,EV> setMinimumRatio(float ratio)

Filter out Adamic-Adar scores less than the given ratio times the average score.

Parameters:

ratio - minimum ratio

Returns:

this

setMirrorResults

public AdamicAdar<K,VV,EV> setMirrorResults(boolean mirrorResults)

By default only one result is output for each pair of vertices. When mirroring a second result with the vertex order flipped is output for each pair of vertices.

Parameters:

mirrorResults - whether output results should be mirrored

Returns:

this

canMergeConfigurationWith

protected boolean canMergeConfigurationWith(GraphAlgorithmWrappingBase other)

Description copied from class: GraphAlgorithmWrappingBase

First test whether the algorithm configurations can be merged before the call to GraphAlgorithmWrappingBase.mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).

Overrides:

canMergeConfigurationWith in class GraphAlgorithmWrappingBase<K extends CopyableValue<K>,VV,EV,DataSet<AdamicAdar.Result<K extends CopyableValue<K>>>>

Parameters:

other - the algorithm with which to compare configuration

Returns:

true if and only if configuration can be merged and the algorithm's output can be reused

See Also:

GraphAlgorithmWrappingBase.mergeConfiguration(GraphAlgorithmWrappingBase)

runInternal

public DataSet<AdamicAdar.Result<K>> runInternal(Graph<K,VV,EV> input)
                                          throws Exception

Description copied from class: GraphAlgorithmWrappingDataSet

The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).

Specified by:

runInternal in class GraphAlgorithmWrappingDataSet<K extends CopyableValue<K>,VV,EV,AdamicAdar.Result<K extends CopyableValue<K>>>

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception