org.decimal4j.arithmetic

Class FloatConversion

java.lang.Object

org.decimal4j.arithmetic.FloatConversion

final class FloatConversion
extends Object

Contains methods to convert from and to float.

Method Summary

Modifier and Type	Method and Description
static long	floatToLong(DecimalRounding rounding, float value) Converts the specified float value to a long rounding the fractional part if necessary using the given rounding mode.
static long	floatToLong(float value) Converts the specified float value to a long truncating the fractional part if any is present.
static long	floatToUnscaled(DecimalArithmetic arith, DecimalRounding rounding, float value) Converts the specified float value to an unscaled decimal.
static long	floatToUnscaled(DecimalArithmetic arith, float value) Converts the specified float value to an unscaled decimal truncating extra fractional digits if necessary.
static float	longToFloat(DecimalArithmetic arith, DecimalRounding rounding, long value) Converts the specified long value to a float rounding extra mantissa digits if necessary.
static float	longToFloat(DecimalArithmetic arith, long value) Converts the specified long value to a float truncating extra mantissa digits if necessary.
static float	unscaledToFloat(DecimalArithmetic arith, DecimalRounding rounding, long unscaled) Converts the specified unscaled decimal value to a float rounding extra precision digits if necessary.
static float	unscaledToFloat(DecimalArithmetic arith, long unscaled) Converts the specified unscaled decimal value to a float truncating extra precision digits if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

floatToLong

public static final long floatToLong(float value)

Converts the specified float value to a long truncating the fractional part if any is present. If the value is NaN, infinite or outside of the valid long range, an exception is thrown.

Parameters:

value - the value to convert

Returns:

roundDOWN(value)

Throws:

IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a long

floatToLong

public static final long floatToLong(DecimalRounding rounding,
                                     float value)

Converts the specified float value to a long rounding the fractional part if necessary using the given rounding mode. If the value is NaN, infinite or outside of the valid long range, an exception is thrown.

Parameters:

rounding - the rounding to apply if necessary

value - the value to convert

Returns:

round(value)

Throws:

IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a long

floatToUnscaled

public static final long floatToUnscaled(DecimalArithmetic arith,
                                         float value)

Converts the specified float value to an unscaled decimal truncating extra fractional digits if necessary. If the value is NaN, infinite or outside of the valid Decimal range, an exception is thrown.

Parameters:

arith - the arithmetic associated with the result value

value - the value to convert

Returns:

round(value)

Throws:

IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a Decimal of the arithmetic's scale

floatToUnscaled

public static final long floatToUnscaled(DecimalArithmetic arith,
                                         DecimalRounding rounding,
                                         float value)

Converts the specified float value to an unscaled decimal. The specified rounding mode is used if rounding is necessary. If the value is NaN, infinite or outside of the valid Decimal range, an exception is thrown.

Parameters:

arith - the arithmetic associated with the result value

rounding - the rounding to apply if necessary

value - the value to convert

Returns:

round(value)

Throws:

IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a Decimal of the arithmetic's scale

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary

longToFloat

public static final float longToFloat(DecimalArithmetic arith,
                                      long value)

Converts the specified long value to a float truncating extra mantissa digits if necessary.

Parameters:

arith - the arithmetic associated with the value

value - the long value

Returns:

roundDOWN(value)

longToFloat

public static final float longToFloat(DecimalArithmetic arith,
                                      DecimalRounding rounding,
                                      long value)

Converts the specified long value to a float rounding extra mantissa digits if necessary.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply if necessary

value - the long value

Returns:

round(value)

Throws:

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary

unscaledToFloat

public static final float unscaledToFloat(DecimalArithmetic arith,
                                          long unscaled)

Converts the specified unscaled decimal value to a float truncating extra precision digits if necessary.

Parameters:

arith - the arithmetic associated with the value

unscaled - the unscaled decimal value

Returns:

roundDOWN(value)

unscaledToFloat

public static final float unscaledToFloat(DecimalArithmetic arith,
                                          DecimalRounding rounding,
                                          long unscaled)

Converts the specified unscaled decimal value to a float rounding extra precision digits if necessary.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply if necessary

unscaled - the unscaled decimal value

Returns:

round(value)

Throws:

ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary