org.openimaj.util.math

Interface ScalarArithmetic<OBJECT,SCALAR extends Number>

Type Parameters:

OBJECT - The object type to be returned

SCALAR - The scalar type to be added

All Known Implementing Classes:

DiscreteCountBipolarSentiment, WeightedBipolarSentiment

public interface ScalarArithmetic<OBJECT,SCALAR extends Number>

Implementing classes provide a set of simple arithmetic operators which can be applied both in-place and on new object instances. These operators work on scalars.

Author:

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

Method Summary

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

Method Detail

add

OBJECT add(SCALAR 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(SCALAR s)

Add to this.

Parameters:

s - add s to this

Returns:

this (for convenience)

subtract

OBJECT subtract(SCALAR 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(SCALAR s)

Subtract from this.

Parameters:

s - minus this by s

Returns:

this (for convenience)

multiply

OBJECT multiply(SCALAR s)

Multiply a copy of this.

Parameters:

s - times a copy of this by s

Returns:

a new instance of this

multiplyInplace

OBJECT multiplyInplace(SCALAR s)

Multiply this.

Parameters:

s - times this by s

Returns:

this (for convenience)

divide

OBJECT divide(SCALAR s)

Divide a copy of this.

Parameters:

s - divide a copy of this by s

Returns:

a new instance of this

divideInplace

OBJECT divideInplace(SCALAR s)

Divide this.

Parameters:

s - divide this by s

Returns:

this (for convenience)