org.apache.flink.graph.library.similarity

Class AdamicAdar<K extends org.apache.flink.types.CopyableValue<K>,VV,EV>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmDelegatingDataSet<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,org.apache.flink.api.java.DataSet<AdamicAdar.Result<K>>>

public class AdamicAdar<K extends org.apache.flink.types.CopyableValue<K>,VV,EV>
extends GraphAlgorithmDelegatingDataSet<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> Wraps the vertex type to encapsulate results from the Adamic-Adar algorithm.

Constructor Summary

Constructors

Constructor and Description
AdamicAdar()

Method Summary

Modifier and Type	Method and Description
protected String	getAlgorithmName() Algorithms are identified by name rather than by class to allow subclassing.
protected boolean	mergeConfiguration(GraphAlgorithmDelegatingDataSet other) An algorithm must first test whether the configurations can be merged before merging individual fields.
org.apache.flink.api.java.DataSet<AdamicAdar.Result<K>>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).
AdamicAdar<K,VV,EV>	setLittleParallelism(int littleParallelism) Override the parallelism of operators processing small amounts of data.
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.

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

equals, hashCode, run

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

setLittleParallelism

public AdamicAdar<K,VV,EV> setLittleParallelism(int littleParallelism)

Override the parallelism of operators processing small amounts of data.

Parameters:

littleParallelism - operator parallelism

Returns:

this

getAlgorithmName

protected String getAlgorithmName()

Description copied from class: GraphAlgorithmDelegatingDataSet

Algorithms are identified by name rather than by class to allow subclassing.

Specified by:

getAlgorithmName in class GraphAlgorithmDelegatingDataSet<K extends org.apache.flink.types.CopyableValue<K>,VV,EV,AdamicAdar.Result<K extends org.apache.flink.types.CopyableValue<K>>>

Returns:

name of the algorithm, which may be shared by multiple classes implementing the same algorithm and generating the same output

mergeConfiguration

protected boolean mergeConfiguration(GraphAlgorithmDelegatingDataSet other)

Description copied from class: GraphAlgorithmDelegatingDataSet

An algorithm must first test whether the configurations can be merged before merging individual fields.

Specified by:

mergeConfiguration in class GraphAlgorithmDelegatingDataSet<K extends org.apache.flink.types.CopyableValue<K>,VV,EV,AdamicAdar.Result<K extends org.apache.flink.types.CopyableValue<K>>>

Parameters:

other - the algorithm with which to compare and merge

Returns:

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

runInternal

public org.apache.flink.api.java.DataSet<AdamicAdar.Result<K>> runInternal(Graph<K,VV,EV> input)
                                                                    throws Exception

Description copied from class: GraphAlgorithmDelegatingDataSet

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

Specified by:

runInternal in class GraphAlgorithmDelegatingDataSet<K extends org.apache.flink.types.CopyableValue<K>,VV,EV,AdamicAdar.Result<K extends org.apache.flink.types.CopyableValue<K>>>

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception