org.openimaj.util.math

Interface ObjectArithmetic<OBJECT>

Type Parameters:

OBJECT - The object type to be returned

All Known Implementing Classes:

DiscreteCountBipolarSentiment, WeightedBipolarSentiment

public interface ObjectArithmetic<OBJECT>

Implementing classes provide a set of simple arithmetic operators which can be applied both inplace and on new object instances. These operators work on object types

Author:

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

Method Summary

Modifier and Type	Method and Description
OBJECT	add(OBJECT s) Add to a copy of this.
OBJECT	addInplace(OBJECT s) Add to this.
OBJECT	divide(OBJECT s) Divide a copy of this.
OBJECT	divideInplace(OBJECT s) Divide this.
OBJECT	multiply(OBJECT s) Multiply a copy of this.
OBJECT	multiplyInplace(OBJECT s) Multiply this.
OBJECT	subtract(OBJECT s) Subtract from a copy of this.
OBJECT	subtractInplace(OBJECT s) Subtract from this.

Method Detail

add

OBJECT add(OBJECT s)

Add to a copy of this.

Parameters:

s - add s to a copy of this

Returns:

a new instance of this

addInplace

OBJECT addInplace(OBJECT s)

Add to this.

Parameters:

s - add s to this

Returns:

this (for convenience)

subtract

OBJECT subtract(OBJECT s)

Subtract from a copy of this.

Parameters:

s - minus a copy of this by s

Returns:

a new instance of this

subtractInplace

OBJECT subtractInplace(OBJECT s)

Subtract from this.

Parameters:

s - minus this by s

Returns:

this (for convenience)

multiply

OBJECT multiply(OBJECT s)

Multiply a copy of this.

Parameters:

s - times a copy of this by s

Returns:

a new instance of this

multiplyInplace

OBJECT multiplyInplace(OBJECT s)

Multiply this.

Parameters:

s - times this by s

Returns:

this (for convenience)

divide

OBJECT divide(OBJECT s)

Divide a copy of this.

Parameters:

s - divide a copy of this by s

Returns:

a new instance of this

divideInplace

OBJECT divideInplace(OBJECT s)

Divide this.

Parameters:

s - divide this by s

Returns:

this (for convenience)