Real (GeLL)

All Known Implementing Classes:

SmallDouble, StandardDouble
```
public interface Real
```
Represents a Real number. This allows use of classes with additional capabilities beyond Double. Specifically although Double is fast it may not be able to store small enough numbers for some likelihood calculations, hence SmallDouble.

Version:

2.0

Method Summary

Methods
Modifier and Type	Method and Description
`Real`	`add(double o)` Adds this Real to a double
`Real`	`add(Real o)` 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.
`Real`	`divide(double o)` Divides this Real by a double
`Real`	`divide(Real o)` Divides this Real by another one
`boolean`	`greaterThan(double o)` Compares this real to a double
`boolean`	`greaterThan(Real o)` Compares this real to another
`Real`	`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
`Real`	`multiply(double o)` Multiplies this Real by a double
`Real`	`multiply(Real o)` Multiplies this Real by another
`void`	`multiplyip(double o)` Multiplies this Real by a double in place.
`void`	`multiplyip(Real o)` Multiplies this Real by another Real in place.
`Real`	`negate()` Negates this real.
`Real`	`subtract(double o)` Subtracts a double from this Real
`Real`	`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

- Method Detail
  - multiply
```
Real multiply(Real o)
```
    Multiplies this Real by another
    
    Parameters:
    o - The other Real
    
    Returns:
    A new Real storing the result
  - multiply
```
Real multiply(double o)
```
    Multiplies this Real by a double
    
    Parameters:
    o - The double
    
    Returns:
    A new Real storing the result
  - add
```
Real add(Real o)
```
    Adds this Real to another
    
    Parameters:
    o - The other Real
    
    Returns:
    A new Real storing the result
  - add
```
Real add(double o)
```
    Adds this Real to a double
    
    Parameters:
    o - The double
    
    Returns:
    A new Real storing the result
  - ln
```
double ln()
```
    Returns the natural logarithm of this Real
    
    Returns:
    The natural logarithm.
  - ln1m
```
double ln1m()
```
    Returns the natural logithm of one minus the value of this Real
    
    Returns:
    The natural logithm of one minus this Real
  - greaterThan
```
boolean greaterThan(Real o)
```
    Compares this real to another
    
    Parameters:
    o - The other real
    
    Returns:
    True if this real is larger than the other, else false
  - greaterThan
```
boolean greaterThan(double o)
```
    Compares this real to a double
    
    Parameters:
    o - The double
    
    Returns:
    True if this double is larger than the other, else false
  - subtract
```
Real subtract(Real o)
```
    Subtracts another Real from this one
    
    Parameters:
    o - The other Real
    
    Returns:
    A new Real storing the result
  - subtract
```
Real subtract(double o)
```
    Subtracts a double from this Real
    
    Parameters:
    o - The double
    
    Returns:
    A new Real storing the result
  - negate
```
Real negate()
```
    Negates this real.
    
    Returns:
    A real representing minus the value of this Real
  - inverse
```
Real inverse()
```
    Returns the inverse of this real (i.e. one divided by the value of this Real)
    
    Returns:
    A Real representing the inverse of thie Real
  - divide
```
Real divide(Real o)
```
    Divides this Real by another one
    
    Parameters:
    o - The other Real
    
    Returns:
    A new Real storing the result
  - divide
```
Real divide(double o)
```
    Divides this Real by a double
    
    Parameters:
    o - The double
    
    Returns:
    A new Real storing the result
  - toDouble
```
double toDouble()
```
    Returns this real as a double. May return infinites and similar if conversion is not possible.
    
    Returns:
    This Real as a double
  - toSmallDouble
```
SmallDouble toSmallDouble()
```
    Returns this real as a SmallDouble
    
    Returns:
    This Real as a SmallDouble
  - addip
```
void addip(Real o)
```
    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.
    
    Parameters:
    o - The real to add.
  - addproductip
```
void addproductip(Real o1,
                double o2)
```
    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.
    
    Parameters:
    o1 - The real to be be used in the product.
    o2 - The double to be used in the product.
  - multiplyip
```
void multiplyip(Real o)
```
    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.
    
    Parameters:
    o - The real to multiply by.
  - multiplyip
```
void multiplyip(double o)
```
    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.
    
    Parameters:
    o - The double to multiply by.

Interface Real

Method Summary

Method Detail

multiply

multiply

add

add

ln

ln1m

greaterThan

greaterThan

subtract

subtract

negate

inverse

divide

divide

toDouble

toSmallDouble

addip

addproductip

multiplyip

multiplyip