org.openimaj.text.nlp.sentiment.type

Class WeightedBipolarSentiment

java.lang.Object

org.openimaj.text.nlp.sentiment.type.WeightedBipolarSentiment

All Implemented Interfaces:

BipolarSentimentProvider, Sentiment, ObjectArithmetic<WeightedBipolarSentiment>, ScalarArithmetic<WeightedBipolarSentiment,Double>

public class WeightedBipolarSentiment
extends Object
implements Sentiment, BipolarSentimentProvider, ScalarArithmetic<WeightedBipolarSentiment,Double>, ObjectArithmetic<WeightedBipolarSentiment>

A weighted bipolar sentiment is one which is positive, negative or netural to some degree. The sentiment holds values for the three and the total number of words the sentiment was decided against. In a simple case the numbers might be wieghted counts of words judged as being positive, negative or neutral. In more complex implementations the numbers may represent probability estimates for the three states No guarantee is made on the range of weights

Author:

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

Constructor Summary

Constructors

Constructor and Description
WeightedBipolarSentiment() all weights set to 0
WeightedBipolarSentiment(double positive, double negative, double neutral)

Method Summary

Modifier and Type	Method and Description
WeightedBipolarSentiment	add(Double f) Add to a copy of this.
WeightedBipolarSentiment	add(WeightedBipolarSentiment that) Add to a copy of this.
WeightedBipolarSentiment	addInplace(Double f) Add to this.
WeightedBipolarSentiment	addInplace(WeightedBipolarSentiment that) Add to this.
Map<String,?>	asMap()
BipolarSentiment	bipolar()
BipolarSentiment	bipolar(double deltaThresh)
WeightedBipolarSentiment	clipMaxInplace(double d)
WeightedBipolarSentiment	clone()
boolean	containsNaN()
void	correctNaN(double d)
WeightedBipolarSentiment	divide(Double d) Divide a copy of this.
WeightedBipolarSentiment	divide(WeightedBipolarSentiment that) Divide a copy of this.
WeightedBipolarSentiment	divideInplace(Double d) Divide this.
WeightedBipolarSentiment	divideInplace(WeightedBipolarSentiment that) Divide this.
boolean	equals(Object obj)
WeightedBipolarSentiment	expInplace()
void	fromMap(Map<String,?> map)
WeightedBipolarSentiment	logInplace()
WeightedBipolarSentiment	multiply(Double value) Multiply a copy of this.
WeightedBipolarSentiment	multiply(WeightedBipolarSentiment that) Multiply a copy of this.
WeightedBipolarSentiment	multiplyInplace(Double value) Multiply this.
WeightedBipolarSentiment	multiplyInplace(WeightedBipolarSentiment that) Multiply this.
double	negative()
void	negative(double negative)
double	neutral()
void	neutral(double neutral)
double	positive()
void	positive(double positive)
WeightedBipolarSentiment	subtract(Double s) Subtract from a copy of this.
WeightedBipolarSentiment	subtract(WeightedBipolarSentiment s) Subtract from a copy of this.
WeightedBipolarSentiment	subtractInplace(Double s) Subtract from this.
WeightedBipolarSentiment	subtractInplace(WeightedBipolarSentiment f) Subtract from this.
String	toString()
double	total()

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedBipolarSentiment

public WeightedBipolarSentiment()

all weights set to 0

WeightedBipolarSentiment

public WeightedBipolarSentiment(double positive,
                                double negative,
                                double neutral)

Parameters:

positive - the positive

negative - the negative

neutral - the neutral

Method Detail

positive

public double positive()

Returns:

positive

negative

public double negative()

Returns:

negative

neutral

public double 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

toString

public String toString()

Overrides:

toString in class Object

addInplace

public WeightedBipolarSentiment addInplace(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Add to this.

Specified by:

addInplace in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - add s to this

Returns:

this (for convenience)

add

public WeightedBipolarSentiment add(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Add to a copy of this.

Specified by:

add in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - add s to a copy of this

Returns:

a new instance of this

divide

public WeightedBipolarSentiment divide(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Divide a copy of this.

Specified by:

divide in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - divide a copy of this by s

Returns:

a new instance of this

divideInplace

public WeightedBipolarSentiment divideInplace(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Divide this.

Specified by:

divideInplace in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - divide this by s

Returns:

this (for convenience)

clone

public WeightedBipolarSentiment clone()

Overrides:

clone in class Object

total

public double total()

Returns:

the total of the bipolar weightings

add

public WeightedBipolarSentiment add(Double f)

Description copied from interface: ScalarArithmetic

Add to a copy of this.

Specified by:

add in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

f - add s to a copy of this

Returns:

a new instance of this

addInplace

public WeightedBipolarSentiment addInplace(Double f)

Description copied from interface: ScalarArithmetic

Add to this.

Specified by:

addInplace in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

f - add s to this

Returns:

this (for convenience)

divide

public WeightedBipolarSentiment divide(Double d)

Description copied from interface: ScalarArithmetic

Divide a copy of this.

Specified by:

divide in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

d - divide a copy of this by s

Returns:

a new instance of this

divideInplace

public WeightedBipolarSentiment divideInplace(Double d)

Description copied from interface: ScalarArithmetic

Divide this.

Specified by:

divideInplace in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

d - divide this by s

Returns:

this (for convenience)

subtract

public WeightedBipolarSentiment subtract(WeightedBipolarSentiment s)

Description copied from interface: ObjectArithmetic

Subtract from a copy of this.

Specified by:

subtract in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

s - minus a copy of this by s

Returns:

a new instance of this

subtractInplace

public WeightedBipolarSentiment subtractInplace(WeightedBipolarSentiment f)

Description copied from interface: ObjectArithmetic

Subtract from this.

Specified by:

subtractInplace in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

f - minus this by s

Returns:

this (for convenience)

multiply

public WeightedBipolarSentiment multiply(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Multiply a copy of this.

Specified by:

multiply in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - times a copy of this by s

Returns:

a new instance of this

multiplyInplace

public WeightedBipolarSentiment multiplyInplace(WeightedBipolarSentiment that)

Description copied from interface: ObjectArithmetic

Multiply this.

Specified by:

multiplyInplace in interface ObjectArithmetic<WeightedBipolarSentiment>

Parameters:

that - times this by s

Returns:

this (for convenience)

multiply

public WeightedBipolarSentiment multiply(Double value)

Description copied from interface: ScalarArithmetic

Multiply a copy of this.

Specified by:

multiply in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

value - times a copy of this by s

Returns:

a new instance of this

multiplyInplace

public WeightedBipolarSentiment multiplyInplace(Double value)

Description copied from interface: ScalarArithmetic

Multiply this.

Specified by:

multiplyInplace in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

value - times this by s

Returns:

this (for convenience)

subtract

public WeightedBipolarSentiment subtract(Double s)

Description copied from interface: ScalarArithmetic

Subtract from a copy of this.

Specified by:

subtract in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

s - minus a copy of this by s

Returns:

a new instance of this

subtractInplace

public WeightedBipolarSentiment subtractInplace(Double s)

Description copied from interface: ScalarArithmetic

Subtract from this.

Specified by:

subtractInplace in interface ScalarArithmetic<WeightedBipolarSentiment,Double>

Parameters:

s - minus this by s

Returns:

this (for convenience)

containsNaN

public boolean containsNaN()

Returns:

whether any weight is NaN

logInplace

public WeightedBipolarSentiment logInplace()

Returns:

log the weights in place

neutral

public void neutral(double neutral)

Parameters:

neutral -

negative

public void negative(double negative)

Parameters:

negative -

positive

public void positive(double positive)

Parameters:

positive -

correctNaN

public void correctNaN(double d)

Parameters:

d - set NaN instances to this value

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

expInplace

public WeightedBipolarSentiment expInplace()

Returns:

Math.exp(double) each value inplace

clipMaxInplace

public WeightedBipolarSentiment clipMaxInplace(double d)

Parameters:

d -

Returns:

clip each value to d inplace