org.openimaj.text.nlp.sentiment.type

Class DiscreteCountBipolarSentiment

java.lang.Object

org.openimaj.text.nlp.sentiment.type.DiscreteCountBipolarSentiment

All Implemented Interfaces:

BipolarSentimentProvider, Sentiment, WeightedBipolarSentimentProvider, ObjectArithmetic<DiscreteCountBipolarSentiment>, ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

public class DiscreteCountBipolarSentiment
extends Object
implements Sentiment, BipolarSentimentProvider, WeightedBipolarSentimentProvider, ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>, ObjectArithmetic<DiscreteCountBipolarSentiment>

A Discrete count bipolar sentiment is one which is positive, negative or netural by some counts. The sentiment holds values for counts of words considered to be one of the three and the total number of words the sentiment was decided against. An assumption is made that a single term can only have a single sentiment, therefore positive + negative + netural < total though perhaps not equal as some terms may be none of the 3 (stop words etc.)

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static DiscreteCountBipolarSentiment	NEGATIVE a single negative count
static DiscreteCountBipolarSentiment	NEUTRAL a single neutral count
static DiscreteCountBipolarSentiment	POSITIVE A single positive count

Constructor Summary

Constructors

Constructor and Description
DiscreteCountBipolarSentiment() all weights set to 0
DiscreteCountBipolarSentiment(int positive, int negative, int neutral)
DiscreteCountBipolarSentiment(int positive, int negative, int neutral, int total)

Method Summary

Modifier and Type	Method and Description
DiscreteCountBipolarSentiment	add(DiscreteCountBipolarSentiment s) Add to a copy of this.
DiscreteCountBipolarSentiment	add(Integer s) Add to a copy of this.
DiscreteCountBipolarSentiment	addInplace(DiscreteCountBipolarSentiment s) Add to this.
DiscreteCountBipolarSentiment	addInplace(Integer s) Add to this.
Map<String,?>	asMap()
BipolarSentiment	bipolar()
BipolarSentiment	bipolar(double deltaThresh)
protected DiscreteCountBipolarSentiment	clone()
DiscreteCountBipolarSentiment	divide(DiscreteCountBipolarSentiment s) Divide a copy of this.
DiscreteCountBipolarSentiment	divide(Integer s) Divide a copy of this.
DiscreteCountBipolarSentiment	divideInplace(DiscreteCountBipolarSentiment s) Divide this.
DiscreteCountBipolarSentiment	divideInplace(Integer s) Divide this.
void	fromMap(Map<String,?> map)
DiscreteCountBipolarSentiment	multiply(DiscreteCountBipolarSentiment s) Multiply a copy of this.
DiscreteCountBipolarSentiment	multiply(Integer s) Multiply a copy of this.
DiscreteCountBipolarSentiment	multiplyInplace(DiscreteCountBipolarSentiment s) Multiply this.
DiscreteCountBipolarSentiment	multiplyInplace(Integer s) Multiply this.
int	negative()
int	neutral()
int	positive()
DiscreteCountBipolarSentiment	subtract(DiscreteCountBipolarSentiment s) Subtract from a copy of this.
DiscreteCountBipolarSentiment	subtract(Integer s) Subtract from a copy of this.
DiscreteCountBipolarSentiment	subtractInplace(DiscreteCountBipolarSentiment s) Subtract from this.
DiscreteCountBipolarSentiment	subtractInplace(Integer s) Subtract from this.
String	toString()
WeightedBipolarSentiment	weightedBipolar()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

POSITIVE

public static final DiscreteCountBipolarSentiment POSITIVE

A single positive count

NEGATIVE

public static final DiscreteCountBipolarSentiment NEGATIVE

a single negative count

NEUTRAL

public static final DiscreteCountBipolarSentiment NEUTRAL

a single neutral count

Constructor Detail

DiscreteCountBipolarSentiment

public DiscreteCountBipolarSentiment()

all weights set to 0

DiscreteCountBipolarSentiment

public DiscreteCountBipolarSentiment(int positive,
                                     int negative,
                                     int neutral,
                                     int total)
                              throws InvalidSentimentException

Parameters:

positive - the positive

negative - the negative

neutral - the neutral

total - the total number of terms

Throws:

InvalidSentimentException

DiscreteCountBipolarSentiment

public DiscreteCountBipolarSentiment(int positive,
                                     int negative,
                                     int neutral)

Parameters:

positive - the positive

negative - the negative

neutral - the neutral

Method Detail

positive

public int positive()

Returns:

positive

negative

public int negative()

Returns:

negative

neutral

public int neutral()

Returns:

neutral

bipolar

public BipolarSentiment bipolar()

Specified by:

bipolar in interface BipolarSentimentProvider

Returns:

a collapsed version of the sentiment that is either positive, negaitve or neutral

bipolar

public BipolarSentiment bipolar(double deltaThresh)

Specified by:

bipolar in interface BipolarSentimentProvider

Parameters:

deltaThresh - A a proportional threshold

Returns:

a collapsed version of the sentiment that is either positive, negaitve or neutral

asMap

public Map<String,?> asMap()

Specified by:

asMap in interface Sentiment

Returns:

return a map representing this sentiment, may be more than just the held sentiments, but extra data

fromMap

public void fromMap(Map<String,?> map)
             throws UnrecognisedMapException

Specified by:

fromMap in interface Sentiment

Parameters:

map - the map containing this sentiment

Throws:

UnrecognisedMapException

weightedBipolar

public WeightedBipolarSentiment weightedBipolar()

Specified by:

weightedBipolar in interface WeightedBipolarSentimentProvider

Returns:

a collapsed version of the sentiment that is positive, negaitve or neutral all to some degree

clone

protected DiscreteCountBipolarSentiment clone()

Overrides:

clone in class Object

addInplace

public DiscreteCountBipolarSentiment addInplace(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Add to this.

Specified by:

addInplace in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - add s to this

Returns:

this (for convenience)

multiplyInplace

public DiscreteCountBipolarSentiment multiplyInplace(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Multiply this.

Specified by:

multiplyInplace in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - times this by s

Returns:

this (for convenience)

divideInplace

public DiscreteCountBipolarSentiment divideInplace(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Divide this.

Specified by:

divideInplace in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - divide this by s

Returns:

this (for convenience)

add

public DiscreteCountBipolarSentiment add(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Add to a copy of this.

Specified by:

add in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - add s to a copy of this

Returns:

a new instance of this

subtract

public DiscreteCountBipolarSentiment subtract(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Subtract from a copy of this.

Specified by:

subtract in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - minus a copy of this by s

Returns:

a new instance of this

subtractInplace

public DiscreteCountBipolarSentiment subtractInplace(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Subtract from this.

Specified by:

subtractInplace in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - minus this by s

Returns:

this (for convenience)

multiply

public DiscreteCountBipolarSentiment multiply(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Multiply a copy of this.

Specified by:

multiply in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - times a copy of this by s

Returns:

a new instance of this

divide

public DiscreteCountBipolarSentiment divide(DiscreteCountBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Divide a copy of this.

Specified by:

divide in interface ObjectArithmetic<DiscreteCountBipolarSentiment>

Parameters:

s - divide a copy of this by s

Returns:

a new instance of this

addInplace

public DiscreteCountBipolarSentiment addInplace(Integer s)

Description copied from interface: ScalarArithmetic

Add to this.

Specified by:

addInplace in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - add s to this

Returns:

this (for convenience)

multiplyInplace

public DiscreteCountBipolarSentiment multiplyInplace(Integer s)

Description copied from interface: ScalarArithmetic

Multiply this.

Specified by:

multiplyInplace in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - times this by s

Returns:

this (for convenience)

divideInplace

public DiscreteCountBipolarSentiment divideInplace(Integer s)

Description copied from interface: ScalarArithmetic

Divide this.

Specified by:

divideInplace in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - divide this by s

Returns:

this (for convenience)

add

public DiscreteCountBipolarSentiment add(Integer s)

Description copied from interface: ScalarArithmetic

Add to a copy of this.

Specified by:

add in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - add s to a copy of this

Returns:

a new instance of this

subtract

public DiscreteCountBipolarSentiment subtract(Integer s)

Description copied from interface: ScalarArithmetic

Subtract from a copy of this.

Specified by:

subtract in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - minus a copy of this by s

Returns:

a new instance of this

subtractInplace

public DiscreteCountBipolarSentiment subtractInplace(Integer s)

Description copied from interface: ScalarArithmetic

Subtract from this.

Specified by:

subtractInplace in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - minus this by s

Returns:

this (for convenience)

multiply

public DiscreteCountBipolarSentiment multiply(Integer s)

Description copied from interface: ScalarArithmetic

Multiply a copy of this.

Specified by:

multiply in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - times a copy of this by s

Returns:

a new instance of this

divide

public DiscreteCountBipolarSentiment divide(Integer s)

Description copied from interface: ScalarArithmetic

Divide a copy of this.

Specified by:

divide in interface ScalarArithmetic<DiscreteCountBipolarSentiment,Integer>

Parameters:

s - divide a copy of this by s

Returns:

a new instance of this

toString

public String toString()

Overrides:

toString in class Object