org.apache.flink.graph.library.linkanalysis

Class HITS<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,HITS.Result<K>>

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

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

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.

See http://www.cs.cornell.edu/home/kleinber/auth.pdf

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HITS.Result<T> A result for the HITS algorithm.

Field Summary

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

parallelism

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 void	mergeConfiguration(GraphAlgorithmWrappingBase other) Merge the other configuration into this algorithm's after the call to GraphAlgorithmWrappingBase.canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.
DataSet<HITS.Result<K>>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).

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

canMergeConfigurationWith, getAlgorithmName, setParallelism

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

mergeConfiguration

protected void mergeConfiguration(GraphAlgorithmWrappingBase other)

Description copied from class: GraphAlgorithmWrappingBase

Merge the other configuration into this algorithm's after the call to GraphAlgorithmWrappingBase.canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.

Overrides:

mergeConfiguration in class GraphAlgorithmWrappingBase<K,VV,EV,DataSet<HITS.Result<K>>>

Parameters:

other - the algorithm from which to merge configuration

See Also:

GraphAlgorithmWrappingBase.canMergeConfigurationWith(GraphAlgorithmWrappingBase)

runInternal

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

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception