org.apache.flink.graph.library.similarity

Class JaccardIndex.Result<T>

java.lang.Object

org.apache.flink.graph.asm.result.ResultBase

org.apache.flink.graph.asm.result.BinaryResultBase<T>

org.apache.flink.graph.library.similarity.JaccardIndex.Result<T>

Type Parameters:

T - ID type

All Implemented Interfaces:

Serializable, Comparable<JaccardIndex.Result<T>>, BinaryResult<T>, PrintableResult, TranslatableResult<T>

Enclosing class:

JaccardIndex<K extends CopyableValue<K>,VV,EV>

public static class JaccardIndex.Result<T>
extends BinaryResultBase<T>
implements PrintableResult, Comparable<JaccardIndex.Result<T>>

A result for the Jaccard Index algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.graph.asm.result.BinaryResult

BinaryResult.MirrorResult<T,RT extends BinaryResult<T>>

Field Summary

Fields

Modifier and Type	Field and Description
static int	HASH_SEED

Constructor Summary

Constructors

Constructor and Description
Result()

Method Summary

Modifier and Type	Method and Description
int	compareTo(JaccardIndex.Result<T> o)
IntValue	getDistinctNeighborCount() Get the distinct neighbor count.
double	getJaccardIndexScore() Get the Jaccard Index score, equal to the number of shared neighbors of the source and target vertices divided by the number of distinct neighbors.
IntValue	getSharedNeighborCount() Get the shared neighbor count.
int	hashCode()
void	setDistinctNeighborCount(IntValue distinctNeighborCount) Set the distinct neighbor count.
void	setSharedNeighborCount(IntValue sharedNeighborCount) Set the shared neighbor count.
String	toPrintableString() A human-readable representation of this value.
String	toString() Object.toString() must be overridden to write POJO values in the same form as Tuple.

Methods inherited from class org.apache.flink.graph.asm.result.BinaryResultBase

getVertexId0, getVertexId1, setVertexId0, setVertexId1, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HASH_SEED

public static final int HASH_SEED

See Also:

Constant Field Values

Constructor Detail

Result

public Result()

Method Detail

getSharedNeighborCount

public IntValue getSharedNeighborCount()

Get the shared neighbor count.

Returns:

shared neighbor count

setSharedNeighborCount

public void setSharedNeighborCount(IntValue sharedNeighborCount)

Set the shared neighbor count.

Parameters:

sharedNeighborCount - the shared neighbor count

getDistinctNeighborCount

public IntValue getDistinctNeighborCount()

Get the distinct neighbor count.

Returns:

distinct neighbor count

setDistinctNeighborCount

public void setDistinctNeighborCount(IntValue distinctNeighborCount)

Set the distinct neighbor count.

Parameters:

distinctNeighborCount - the distinct neighbor count

getJaccardIndexScore

public double getJaccardIndexScore()

Get the Jaccard Index score, equal to the number of shared neighbors of the source and target vertices divided by the number of distinct neighbors.

Returns:

Jaccard Index score

toString

public String toString()

Description copied from class: ResultBase

Object.toString() must be overridden to write POJO values in the same form as Tuple. Values are comma-separated and enclosed in parenthesis, e.g. "(f0,f1)".

Specified by:

toString in class ResultBase

Returns:

tuple representation string

toPrintableString

public String toPrintableString()

Description copied from interface: PrintableResult

A human-readable representation of this value.

Specified by:

toPrintableString in interface PrintableResult

Returns:

printable string

compareTo

public int compareTo(JaccardIndex.Result<T> o)

Specified by:

compareTo in interface Comparable<JaccardIndex.Result<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class Object