com.dautelle.math.numbers
Class Float32

java.lang.Object
  java.lang.Number
      com.dautelle.math.numbers.RealtimeNumber
          com.dautelle.math.numbers.Float32

All Implemented Interfaces:

java.lang.Comparable, Operable, Realtime, Representable, java.io.Serializable

public final class Float32

extends RealtimeNumber

implements java.lang.Comparable

This class represents a 32 bits floating point number.

Version:

5.1, August 27, 2003

Author:

Jean-Marie Dautelle

See Also:

Serialized Form

Nested Class Summary

static class

Float32.Value This inner class represents a mutable image of an immutable Float32.

Nested classes inherited from class com.dautelle.math.numbers.RealtimeNumber

RealtimeNumber.Factory

Field Summary

static Float32	ONE The 32 bits float one.
static Float32	ZERO The 32 bits floating point representing zero.

Method Summary

Float32	abs() Returns the absolute value of this number.
Float32	add(Float32 that) Returns the sum of this number with the one specified.
java.lang.StringBuffer	appendTo(java.lang.StringBuffer sb) Appends the decimal text representation of this number to the StringBuffer argument.
int	compareTo(Float32 that) Compares two 32 bits float numerically.
int	compareTo(java.lang.Object that)
Float32	divide(Float32 that) Returns this number divided by the one specified.
double	doubleValue() Returns the value of this number as a double.
boolean	equals(Float32 that, float tolerance) Indicates if two 32 bits float are "sufficiently" alike to be considered equal.
boolean	equals(java.lang.Object that) Compares this 32 bits float against the specified object.
float	floatValue() Returns the value of this number as a float.
int	hashCode() Returns the hash code for this number.
int	intValue() Returns the value of this number as an int.
Float32	inverse() Returns the inverse of this number.
boolean	isInfinite() Indicates if this 32 bits float is infinite.
boolean	isNaN() Indicates if this 32 bits Float is not a number.
long	longValue() Returns the value of this number as a long.
Float32	multiply(Float32 that) Returns the product of this number with the one specified.
Float32	negate() Returns the negation of this number.
Operable	opposite() Returns the additive inverse of this object.
Operable	plus(Operable that) Returns the sum of this object with the one specified.
Operable	reciprocal() Returns the multiplicative inverse of this object.
Float32	subtract(Float32 that) Returns the difference between this number and the one specified.
Operable	times(Operable that) Returns the product of this object with the one specified.
java.lang.String	toString() Returns the decimal text representation of this number.
void	toXml(XmlElement xml) Sets the attributes and content of the XML element corresponding to this object.
static Float32	valueOf(java.lang.CharSequence chars) Returns the 32 bits float for the specified character sequence.
static Float32	valueOf(float floatValue) Returns the 32 bits float of specified float value.
static Float32	valueOf(XmlElement xml) XML factory method.

Methods inherited from class com.dautelle.math.numbers.RealtimeNumber

clone, export, isLocalObject, isPoolObject, pow, recycle, toHeap

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final Float32 ZERO

The 32 bits floating point representing zero.

ONE

public static final Float32 ONE

The 32 bits float one.

Method Detail

valueOf

public static Float32 valueOf(float floatValue)

Returns the 32 bits float of specified float value.

Parameters:

floatValue - the float value for this number.

Returns:

the corresponding number.

See Also:

doubleValue()

valueOf

public static Float32 valueOf(java.lang.CharSequence chars)

Returns the 32 bits float for the specified character sequence.

Parameters:

chars - the character sequence.

Returns:

the corresponding number.

valueOf

public static Float32 valueOf(XmlElement xml)

XML factory method.

Parameters:

xml - the XML element describing the 32 bits float to return (e.g. <math:Float32 value="0.0"/>).

Returns:

a number as described by the specified xml element.

isInfinite

public boolean isInfinite()

Indicates if this 32 bits float is infinite.

Returns:

true if this float is infinite; false otherwise.

isNaN

public boolean isNaN()

Indicates if this 32 bits Float is not a number.

Returns:

true if this float is NaN; false otherwise.

negate

public Float32 negate()

Returns the negation of this number.

Returns:

-this.

add

public Float32 add(Float32 that)

Returns the sum of this number with the one specified.

Parameters:

that - the number to be added.

Returns:

this + that.

subtract

public Float32 subtract(Float32 that)

Returns the difference between this number and the one specified.

Parameters:

that - the number to be subtracted.

Returns:

this - that.

multiply

public Float32 multiply(Float32 that)

Returns the product of this number with the one specified.

Parameters:

that - the multiplier.

Returns:

this * that.

inverse

public Float32 inverse()

Returns the inverse of this number.

Returns:

1 / this.

divide

public Float32 divide(Float32 that)

Returns this number divided by the one specified.

Parameters:

that - the divisor.

Returns:

this / that.

abs

public Float32 abs()

Returns the absolute value of this number.

Returns:

abs(this).

appendTo

public java.lang.StringBuffer appendTo(java.lang.StringBuffer sb)

Appends the decimal text representation of this number to the StringBuffer argument.

Parameters:

sb - the StrinBuffer to append.

Returns:

the specified StrinBuffer.

toString

public java.lang.String toString()

Returns the decimal text representation of this number.

Returns:

the text representation of this number.

equals

public boolean equals(Float32 that,
                      float tolerance)

Indicates if two 32 bits float are "sufficiently" alike to be considered equal.

Parameters:

that - the number to compare with.

tolerance - the maximum difference between them before they are considered not equal.

Returns:

true if they are considered equal; false otherwise.

equals

public boolean equals(java.lang.Object that)

Compares this 32 bits float against the specified object.

Parameters:

that - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Returns the hash code for this number.

Returns:

the hash code value.

intValue

public int intValue()

Returns the value of this number as an int.

Returns:

the int value.

longValue

public long longValue()

Returns the value of this number as a long.

Returns:

the long value.

floatValue

public float floatValue()

Returns the value of this number as a float.

Returns:

the float value.

doubleValue

public double doubleValue()

Returns the value of this number as a double.

Returns:

the double value

compareTo

public int compareTo(Float32 that)

Compares two 32 bits float numerically.

Parameters:

that - the number to compare with.

Returns:

-1, 0 or 1 as this number is numerically less than, equal to, or greater than that.

compareTo

public int compareTo(java.lang.Object that)

Specified by:

compareTo in interface java.lang.Comparable

plus

public Operable plus(Operable that)

Description copied from interface: Operable

Returns the sum of this object with the one specified.

Specified by:

plus in interface Operable

Parameters:

that - the object to be added.

Returns:

this + that.

opposite

public Operable opposite()

Description copied from interface: Operable

Returns the additive inverse of this object. It is the object such as this.plus(this.opposite()) == ZERO, with ZERO being the additive identity.

Specified by:

opposite in interface Operable

Returns:

-this.

times

public Operable times(Operable that)

Description copied from interface: Operable

Returns the product of this object with the one specified.

Specified by:

times in interface Operable

Parameters:

that - the object multiplier.

Returns:

this * that.

reciprocal

public Operable reciprocal()

Description copied from interface: Operable

Returns the multiplicative inverse of this object. It it the object such as this.times(this.reciprocal()) == ONE , with ONE being the multiplicative identity.

Specified by:

reciprocal in interface Operable

Returns:

ONE / this.

toXml

public void toXml(XmlElement xml)

Description copied from interface: Representable

Sets the attributes and content of the XML element corresponding to this object.

Specified by:

toXml in interface Representable

Parameters:

xml - the XML element to set according to this object's desired XML representation.