org.apache.flink.graph.library.link_analysis

Class HITS<K,VV,EV>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmDelegatingDataSet<K,VV,EV,HITS.Result<K>>

org.apache.flink.graph.library.link_analysis.HITS<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<HITS.Result<K>>>

public class HITS<K,VV,EV>
extends GraphAlgorithmDelegatingDataSet<K,VV,EV,HITS.Result<K>>

http://www.cs.cornell.edu/home/kleinber/auth.pdf Hyperlink-Induced Topic Search computes two interdependent scores for every vertex in a directed graph. A good "hub" links to good "authorities" and good "authorities" are linked from good "hubs". This algorithm can be configured to terminate either by a limit on the number of iterations, a convergence threshold, or both.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HITS.Result<T> Wraps the vertex type to encapsulate results from the HITS algorithm.

Constructor Summary

Constructors

Constructor and Description
HITS(double convergenceThreshold) Hyperlink-Induced Topic Search with a convergence threshold.
HITS(int iterations) Hyperlink-Induced Topic Search with a fixed number of iterations.
HITS(int maxIterations, double convergenceThreshold) Hyperlink-Induced Topic Search with a convergence threshold and a maximum iteration count.

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<HITS.Result<K>>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).
HITS<K,VV,EV>	setParallelism(int parallelism) Override the operator parallelism.

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

HITS

public HITS(int iterations)

Hyperlink-Induced Topic Search with a fixed number of iterations.

Parameters:

iterations - fixed number of iterations

HITS

public HITS(double convergenceThreshold)

Hyperlink-Induced Topic Search with a convergence threshold. The algorithm terminates When the total change in hub and authority scores over all vertices falls to or below the given threshold value.

Parameters:

convergenceThreshold - convergence threshold for sum of scores

HITS

public HITS(int maxIterations,
            double convergenceThreshold)

Hyperlink-Induced Topic Search with a convergence threshold and a maximum iteration count. The algorithm terminates after either the given number of iterations or when the total change in hub and authority scores over all vertices falls to or below the given threshold value.

Parameters:

maxIterations - maximum number of iterations

convergenceThreshold - convergence threshold for sum of scores

Method Detail

setParallelism

public HITS<K,VV,EV> setParallelism(int parallelism)

Override the operator parallelism.

Parameters:

parallelism - 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,VV,EV,HITS.Result<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,VV,EV,HITS.Result<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<HITS.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,VV,EV,HITS.Result<K>>

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception