Maths

Class SmallDouble

java.lang.Object

Maths.SmallDouble

All Implemented Interfaces:

java.io.Serializable, Real

public class SmallDouble
extends java.lang.Object
implements java.io.Serializable, Real

Represents a real number. Stores the exponent separately as an Integer so can store much smaller (or indeed larger) reals than the standard double.

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SmallDouble	SMALLEST A SmallDouble representing the smallest possible value SmallDouble can represent

Constructor Summary

Constructors

Constructor and Description
SmallDouble(double d) Creates a SmallDouble representing the same number as a double
SmallDouble(double m, int e) Creates a SmallDouble representing the same number as m*2^e

Method Summary

Methods

Modifier and Type	Method and Description
SmallDouble	add(double d) Adds this Real to a double
SmallDouble	add(Real r) Adds this Real to another
void	addip(Real o) Adds a Real to this Real in place.
void	addproductip(Real o1, double o2) Adds the product of a Real and a double to this Real in place.
SmallDouble	divide(double d) Divides this Real by a double
SmallDouble	divide(Real o) Divides this Real by another one
boolean	equals(java.lang.Object o)
boolean	greaterThan(double r) Compares this real to a double
boolean	greaterThan(Real r) Compares this real to another
int	hashCode()
SmallDouble	inverse() Returns the inverse of this real (i.e.
double	ln() Returns the natural logarithm of this Real
double	ln1m() Returns the natural logithm of one minus the value of this Real
SmallDouble	multiply(double d) Multiplies this Real by a double
SmallDouble	multiply(Real r) Multiplies this Real by another
void	multiplyip(double d) Multiplies this Real by a double in place.
void	multiplyip(Real o) Multiplies this Real by another Real in place.
SmallDouble	negate() Negates this real.
SmallDouble	subtract(double d) Subtracts a double from this Real
SmallDouble	subtract(Real o) Subtracts another Real from this one
double	toDouble() Returns this real as a double.
SmallDouble	toSmallDouble() Returns this real as a SmallDouble
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SMALLEST

public static final SmallDouble SMALLEST

A SmallDouble representing the smallest possible value SmallDouble can represent

Constructor Detail

SmallDouble

public SmallDouble(double d)

Creates a SmallDouble representing the same number as a double

Parameters:

d - The double to be represented

SmallDouble

public SmallDouble(double m,
           int e)

Creates a SmallDouble representing the same number as m*2^e

Parameters:

m - m

e - e

Method Detail

multiply

public SmallDouble multiply(Real r)

Description copied from interface: Real

Multiplies this Real by another

Specified by:

multiply in interface Real

Parameters:

r - The other Real

Returns:

A new Real storing the result

multiply

public SmallDouble multiply(double d)

Description copied from interface: Real

Multiplies this Real by a double

Specified by:

multiply in interface Real

Parameters:

d - The double

Returns:

A new Real storing the result

add

public SmallDouble add(Real r)

Description copied from interface: Real

Adds this Real to another

Specified by:

add in interface Real

Parameters:

r - The other Real

Returns:

A new Real storing the result

add

public SmallDouble add(double d)

Description copied from interface: Real

Adds this Real to a double

Specified by:

add in interface Real

Parameters:

d - The double

Returns:

A new Real storing the result

ln

public double ln()

Description copied from interface: Real

Returns the natural logarithm of this Real

Specified by:

ln in interface Real

Returns:

The natural logarithm.

ln1m

public double ln1m()

Description copied from interface: Real

Returns the natural logithm of one minus the value of this Real

Specified by:

ln1m in interface Real

Returns:

The natural logithm of one minus this Real

greaterThan

public boolean greaterThan(Real r)

Description copied from interface: Real

Compares this real to another

Specified by:

greaterThan in interface Real

Parameters:

r - The other real

Returns:

True if this real is larger than the other, else false

greaterThan

public boolean greaterThan(double r)

Description copied from interface: Real

Compares this real to a double

Specified by:

greaterThan in interface Real

Parameters:

r - The double

Returns:

True if this double is larger than the other, else false

subtract

public SmallDouble subtract(Real o)

Description copied from interface: Real

Subtracts another Real from this one

Specified by:

subtract in interface Real

Parameters:

o - The other Real

Returns:

A new Real storing the result

subtract

public SmallDouble subtract(double d)

Description copied from interface: Real

Subtracts a double from this Real

Specified by:

subtract in interface Real

Parameters:

d - The double

Returns:

A new Real storing the result

negate

public SmallDouble negate()

Description copied from interface: Real

Negates this real.

Specified by:

negate in interface Real

Returns:

A real representing minus the value of this Real

inverse

public SmallDouble inverse()

Description copied from interface: Real

Returns the inverse of this real (i.e. one divided by the value of this Real)

Specified by:

inverse in interface Real

Returns:

A Real representing the inverse of thie Real

divide

public SmallDouble divide(Real o)

Description copied from interface: Real

Divides this Real by another one

Specified by:

divide in interface Real

Parameters:

o - The other Real

Returns:

A new Real storing the result

divide

public SmallDouble divide(double d)

Description copied from interface: Real

Divides this Real by a double

Specified by:

divide in interface Real

Parameters:

d - The double

Returns:

A new Real storing the result

toDouble

public double toDouble()

Description copied from interface: Real

Returns this real as a double. May return infinites and similar if conversion is not possible.

Specified by:

toDouble in interface Real

Returns:

This Real as a double

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toSmallDouble

public SmallDouble toSmallDouble()

Description copied from interface: Real

Returns this real as a SmallDouble

Specified by:

toSmallDouble in interface Real

Returns:

This Real as a SmallDouble

addip

public void addip(Real o)

Description copied from interface: Real

Adds a Real to this Real in place. I.e. it does not return a new object, instead the current object is modified. Useful to stop more objects being allocated but should be used carefully.

Specified by:

addip in interface Real

Parameters:

o - The real to add.

multiplyip

public void multiplyip(Real o)

Description copied from interface: Real

Multiplies this Real by another Real in place. I.e. it does not return a new object, instead the current object is modified. Useful to stop more objects being allocated but should be used carefully.

Specified by:

multiplyip in interface Real

Parameters:

o - The real to multiply by.

multiplyip

public void multiplyip(double d)

Description copied from interface: Real

Multiplies this Real by a double in place. I.e. it does not return a new object, instead the current object is modified. Useful to stop more objects being allocated but should be used carefully.

Specified by:

multiplyip in interface Real

Parameters:

d - The double to multiply by.

addproductip

public void addproductip(Real o1,
                double o2)

Description copied from interface: Real

Adds the product of a Real and a double to this Real in place. I.e. it does not return a new object, instead the current object is modified. Useful to stop more objects being allocated but should be used carefully.

Specified by:

addproductip in interface Real

Parameters:

o1 - The real to be be used in the product.

o2 - The double to be used in the product.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object