org.openimaj.hadoop.tools.twitter.token.outputmode.jacard

Class JacardIndex

java.lang.Object

org.openimaj.hadoop.tools.twitter.token.outputmode.jacard.JacardIndex

All Implemented Interfaces:

ReadableASCII, ReadWriteableASCII, WriteableASCII

public class JacardIndex
extends Object
implements ReadWriteableASCII

An index encoding the difference between two sets

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
long	intersection The number of words forming the intersection between now and historic words
double	jacardIndex The jacard index is: J(A,B) = |intersection(A,B)| / |union(A,B)| for this time period
long	time current time period
long	union The number of words forming the union between now and historic words

Constructor Summary

Constructors

Constructor and Description
JacardIndex(long time, long intersection, long union)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
boolean	equals(Object other)
static JacardIndex	fromString(String next) Read a new jacard index from a comma separated line
void	readASCII(Scanner in) Read internal state from in.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.

Methods inherited from class java.lang.Object

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

Field Detail

intersection

public long intersection

The number of words forming the intersection between now and historic words

union

public long union

The number of words forming the union between now and historic words

time

public long time

current time period

jacardIndex

public double jacardIndex

The jacard index is: J(A,B) = |intersection(A,B)| / |union(A,B)| for this time period

Constructor Detail

JacardIndex

public JacardIndex(long time,
                   long intersection,
                   long union)

Parameters:

time -

intersection -

union -

Method Detail

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

fromString

public static JacardIndex fromString(String next)
                              throws IOException

Read a new jacard index from a comma separated line

Parameters:

next -

Returns:

new JacardIndex

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object