CFloat (josef 3.2.5 API)

java.lang.Object
- java.lang.Number
- - org.josef.science.math.CFloat

All Implemented Interfaces:

Serializable, Comparable<CFloat>
```
@Status(stage=PRODUCTION,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @ThreadSafety(level=IMMUTABLE)
public final class CFloat
extends Number
implements Comparable<CFloat>
```
This class wraps a primitive float value.
The main difference between this class and class Float is that this class has (limited) support for arithmetic operations that protect against both underflow and overflow.
Note: The support for underflow/overflow checks is limited since for example Float.MAX_VALUE + 1 equals Float.MAX_VALUE. After an operation, a check for infinity is performed but as explained before, this won't catch all underflow and overflow conditions.
Design considerations: Class Float is final so this class extends class Number instead. This class is immutable and contains private constructors in combination with static factory methods as suggested by Joshua Bloch (Effective Java, Second Edition, item 15).

Version:

2.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static float HUNDRED_PERCENT
100%.

Fields
Modifier and Type	Field and Description
`static float`	`HUNDRED_PERCENT` 100%.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CFloat`	`add(float value)` Adds the supplied value to this value.
`static float`	`add(float x, float y)` Adds y to x.
`byte`	`byteValue()` Returns the value of this CFloat as a byte.
`int`	`compareTo(CFloat object)` Compares two CFloat objects numerically.
`CFloat`	`divide(float value)` Divides this value by the supplied value.
`static float`	`divide(float x, float y)` Divides x by y.
`double`	`doubleValue()` Returns the value of this CFloat as a double.
`static boolean`	`equals(float left, float right, float delta)` Determines whether the supplied left and right float are equal to each other within the limit of the supplied delta.
`boolean`	`equals(Object object)` Determines whether this object and the supplied object are the same.
`float`	`floatValue()` Returns the value of this CFloat as a float.
`int`	`hashCode()` Computes the hash code value for this object.
`int`	`intValue()` Returns the value of this CFloat as an int.
`long`	`longValue()` Returns the value of this CFloat as a long.
`CFloat`	`multiply(float value)` Multiplies this value by the supplied value.
`static float`	`multiply(float x, float y)` Multiplies x by y.
`short`	`shortValue()` Returns the value of this CFloat as a short.
`static float`	`subtract(float x, float y)` Subtracts y from x.
`CFloat`	`subtract(long value)` Subtracts the supplied value from this value.
`String`	`toString()` Converts the stored primitive float value to a String.
`static CFloat`	`valueOf(int value)` Returns a CFloat object holding the value of the supplied value.
`static CFloat`	`valueOf(long value)` Returns a CFloat object holding the value of the supplied value.
`static CFloat`	`valueOf(Number value)` Returns a CFloat object holding the value of the supplied value.
`static CFloat`	`valueOf(String value)` Returns a CFloat object holding the parsed value of the supplied value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - HUNDRED_PERCENT
```
public static final float HUNDRED_PERCENT
```
    100%.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - byteValue
```
public byte byteValue()
```
    Returns the value of this CFloat as a byte.
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    
    The value of this CFloat as a byte.
  - shortValue
```
public short shortValue()
```
    Returns the value of this CFloat as a short.
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    
    The value of this CFloat as a short.
  - intValue
```
public int intValue()
```
    Returns the value of this CFloat as an int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    
    The value of this CFloat as an int.
  - longValue
```
public long longValue()
```
    Returns the value of this CFloat as a long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    
    The value of this CFloat as a long.
  - floatValue
```
public float floatValue()
```
    Returns the value of this CFloat as a float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    
    The value of this CFloat as a float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this CFloat as a double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    
    The value of this CFloat as a double.
  - valueOf
```
public static CFloat valueOf(int value)
```
    Returns a CFloat object holding the value of the supplied value.
    
    Parameters:
    
    value - The int value.
    
    Returns:
    
    A CFloat object holding the value of the supplied value.
    
    Throws:
    
    IllegalArgumentException - When the supplied value could not be converted to a float without losing precision.
  - valueOf
```
public static CFloat valueOf(long value)
```
    Returns a CFloat object holding the value of the supplied value.
    
    Parameters:
    
    value - The long value.
    
    Returns:
    
    A CFloat object holding the value of the supplied value.
    
    Throws:
    
    IllegalArgumentException - When the supplied value could not be converted to a float without losing precision.
  - valueOf
```
public static CFloat valueOf(Number value)
```
    Returns a CFloat object holding the value of the supplied value.
    Depending on the type of the supplied value this may involve rounding.
    
    Parameters:
    
    value - The Number that holds the value.
    
    Returns:
    
    A CFloat object holding the value of the supplied value.
    When the supplied value is Not A Number, 0 is returned.
    
    Throws:
    
    NullPointerException - When the supplied value is null.
  - valueOf
```
public static CFloat valueOf(String value)
```
    Returns a CFloat object holding the parsed value of the supplied value.
    
    Parameters:
    
    value - The String that is parsed.
    
    Returns:
    
    A CFloat object holding the value of the supplied value, after parsing.
    
    Throws:
    
    NumberFormatException - When the supplied value does not contain a parsable float (this includes a null or empty value).
    
    See Also:
    
    Float.parseFloat(String)
  - equals
```
public boolean equals(Object object)
```
    Determines whether this object and the supplied object are the same.
    The two objects are the same if the supplied object is not null and the supplied object is a CFloat and the bit pattern of the stored value in both objects is the same. For consequences of comparing the bit pattern see Float.equals(Object).
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The CFloat object to compare with.
    
    Returns:
    
    True if both objects are the same, false otherwise.
  - equals
```
public static boolean equals(float left,
                             float right,
                             float delta)
```
    Determines whether the supplied left and right float are equal to each other within the limit of the supplied delta.
    Both floats are considered equal when the absolute difference between the two floats is less than the supplied delta value. Using a delta is often necessary! The following expression for example does not result in 0.0: 7 * 0.1 - 0.7
    Note: This method tries to mimic evaluating: left == right
    See the jls to read about how special values like NaN and infinity are handled.
    
    Parameters:
    
    left - The float on the left of the mathematical equals sign.
    
    right - The float on the right of the mathematical equals sign.
    
    delta - The limit within the two floats are considered to be equal.
    
    Returns:
    
    True when the left float equals the right float, false otherwise.
  - hashCode
```
public int hashCode()
```
    Computes the hash code value for this object.
    The float is 'treated' as an int and this int value is returned.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code value for this object.
  - compareTo
```
public int compareTo(CFloat object)
```
    Compares two CFloat objects numerically.
    
    Specified by:
    
    compareTo in interface Comparable<CFloat>
    
    Parameters:
    
    object - CFloat object to compare with this object.
    
    Returns:
    
    a negative number when this value < other value, 0 when both values are equal and a positive number when this value > other value.
    
    Throws:
    
    NullPointerException - When the supplied object is null.
    
    See Also:
    
    Comparable, Float.compare(float, float)
  - add
```
public CFloat add(float value)
```
    Adds the supplied value to this value.
    This method allows for expressions like: CFloat value = i.add(x).multiply(y) where i is a CFloat and x and y are primitive floats.
    
    Parameters:
    
    value - Value to add to the stored value.
    
    Returns:
    
    Result of the addition in a new CFloat.
    When this or the supplied value is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
    
    See Also:
    
    add(float, float)
  - add
```
public static float add(float x,
                        float y)
```
    Adds y to x.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the addition.
    When one of the supplied values is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
  - subtract
```
public CFloat subtract(long value)
```
    Subtracts the supplied value from this value.
    This method allows for expressions like: CFloat value = i.subtract(x).multiply(y) where i is a CFloat and x and y are primitive floats.
    
    Parameters:
    
    value - Value to subtract from the stored value.
    
    Returns:
    
    Result of the subtraction in a new CFloat.
    When this or the supplied value is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
    
    See Also:
    
    subtract(float, float)
  - subtract
```
public static float subtract(float x,
                             float y)
```
    Subtracts y from x.
    
    Parameters:
    
    x - Operand one.
    
    y - operand two.
    
    Returns:
    
    Result of the subtraction.
    When one of the supplied values is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
  - multiply
```
public CFloat multiply(float value)
```
    Multiplies this value by the supplied value.
    This method allows for expressions like: CFloat value = i.multiply(x).subtract(y) where i is a CFloat and x and y are primitive floats.
    
    Parameters:
    
    value - Value to multiply by the stored value.
    
    Returns:
    
    Result of the multiplication in a new CFloat.
    When this or the supplied value is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
    
    See Also:
    
    multiply(float, float)
  - multiply
```
public static float multiply(float x,
                             float y)
```
    Multiplies x by y.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the multiplication.
    When one of the supplied values is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs, possibly due to one of the values being infinite.
  - divide
```
public CFloat divide(float value)
```
    Divides this value by the supplied value.
    This method allows for expressions like: CFloat value = i.divide(x).add(y) where i is a CFloat and x and y are primitive floats.
    
    Parameters:
    
    value - Value by which this value will be divided.
    
    Returns:
    
    Result of the division in a new CFloat.
    When this or the supplied value is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when this value is infinite or when the supplied value is 0.
    
    See Also:
    
    divide(float, float)
  - divide
```
public static float divide(float x,
                           float y)
```
    Divides x by y.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the division.
    When one of the supplied values is NaN the result will be NaN.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied x value is infinite or when the supplied value is 0.
  - toString
```
public String toString()
```
    Converts the stored primitive float value to a String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the stored value.

Class CFloat

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HUNDRED_PERCENT

Method Detail

byteValue

shortValue

intValue

longValue

floatValue

doubleValue

valueOf

valueOf

valueOf

valueOf

equals

equals

hashCode

compareTo

add

add

subtract

subtract

multiply

multiply

divide

divide

toString