com.github.signaflo.math

Class Real

java.lang.Object

com.github.signaflo.math.Real

All Implemented Interfaces:

FieldElement<Real>, Comparable<Real>

public final class Real
extends Object
implements FieldElement<Real>

A numerical approximation of a real number. This class is immutable and thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Real.Interval An interval on the real line.

Method Summary

Modifier and Type	Method and Description
double	abs() Compute and return the absolute value of this element.
Real	additiveInverse() Take the additive inverse, or negative, of this real number and return the result.
double	asDouble()
int	compareTo(Real other)
Complex	complexSqrt() The square root operation applied to this element, returning a complex number.
Real	conjugate() Compute and return the conjugate of this element.
Real	cubed() Cube this real number and return the result.
Real	dividedBy(Real other) Divide this real number by the given real number and return the result.
static Real	from(double value) Create a new real number using the given double.
Complex	minus(Complex complex)
Real	minus(Real other) Subtract the given real number from this real number and return the result.
Complex	plus(Complex complex)
Real	plus(Real other) Add this real number to the given real number and return the result.
Real	sqrt() Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number.
Real	squared() Square this real number and return the result.
Real	times(double other)
Real	times(Real other) Multiply this real number by the given real number and return the result.
String	toString()
static Real	zero()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

from

public static Real from(double value)

Create a new real number using the given double.

Parameters:

value - the primitive double approximating the real number.

Returns:

a new real number from the given double.

zero

public static Real zero()

plus

public Real plus(Real other)

Add this real number to the given real number and return the result.

Specified by:

plus in interface FieldElement<Real>

Parameters:

other - the real number to add to this one.

Returns:

the sum of this real number and the given real number.

plus

public Complex plus(Complex complex)

minus

public Real minus(Real other)

Subtract the given real number from this real number and return the result.

Specified by:

minus in interface FieldElement<Real>

Parameters:

other - the real number to subtract from this one.

Returns:

the difference of the given real number from this real number.

minus

public Complex minus(Complex complex)

times

public Real times(Real other)

Multiply this real number by the given real number and return the result.

Specified by:

times in interface FieldElement<Real>

Parameters:

other - the real number to multiply this one by.

Returns:

this real number multiplied by the given real number.

sqrt

public Real sqrt()

Description copied from interface: FieldElement

Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number. If the return type is not guaranteed to be of the same type as this number, then FieldElement.complexSqrt() should be used instead.

Specified by:

sqrt in interface FieldElement<Real>

Returns:

the square root of this number if the square root is of the same type.

complexSqrt

public Complex complexSqrt()

Description copied from interface: FieldElement

The square root operation applied to this element, returning a complex number. If the field this element belongs to is not part of the complex number hierarchy, then implementations may throw an IllegalStateException

Specified by:

complexSqrt in interface FieldElement<Real>

Returns:

the square root of this element.

conjugate

public Real conjugate()

Description copied from interface: FieldElement

Compute and return the conjugate of this element.

Specified by:

conjugate in interface FieldElement<Real>

Returns:

the conjugate of this element.

times

public Real times(double other)

squared

public Real squared()

Square this real number and return the result.

Returns:

the square of this real number.

cubed

public Real cubed()

Cube this real number and return the result.

Returns:

the cube of this real number.

dividedBy

public Real dividedBy(Real other)

Divide this real number by the given real number and return the result.

Specified by:

dividedBy in interface FieldElement<Real>

Parameters:

other - the real number to divide this one by.

Returns:

this real number divided by the given real number.

additiveInverse

public Real additiveInverse()

Take the additive inverse, or negative, of this real number and return the result.

Specified by:

additiveInverse in interface FieldElement<Real>

Returns:

the additive inverse, or negative, of this real number.

abs

public double abs()

Description copied from interface: FieldElement

Compute and return the absolute value of this element.

Specified by:

abs in interface FieldElement<Real>

Returns:

the absolute value of this element.

asDouble

public double asDouble()

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(@NonNull
                     Real other)

Specified by:

compareTo in interface Comparable<Real>