JOGL 2.3.2 · com.jogamp.opengl.math.Binary16

Modifier and Type	Field and Description
public static final int	BIAS The bias value used to offset the encoded exponent.
private static final int	MASK_EXPONENT
private static final int	MASK_SIGN
private static final int	MASK_SIGNIFICAND
public static final char	NEGATIVE_INFINITY The encoded form of negative infinity `-∞`.
public static final char	NEGATIVE_ZERO The encoded form of negative zero `-0`.
public static final char	POSITIVE_INFINITY The encoded form of positive infinity `∞`.
public static final char	POSITIVE_ZERO The encoded form of positive zero `0`.

Access	Constructor and Description
private	Binary16()

Method Summary

Modifier and Type	Method and Description
public static char	exampleNaN() One possible not-a-number value.
public static boolean	isInfinite(final char k) Return `true` if the given packed `binary16` value is infinite.
public static boolean	isNaN(final char k) Return `true` if the given packed `binary16` value is not a number (`NaN`).
public static char	packDouble(final double k) Convert a double precision floating point value to a packed `binary16` value.
public static char	packFloat(final float k) Convert a single precision floating point value to a packed `binary16` value.
public static char	packSetExponentUnbiasedUnchecked(final int e) Encode the unbiased exponent `e`.
public static char	packSetSignificandUnchecked(final int s) Encode the significand `s`.
public static char	packSetSignUnchecked(final int s) Encode the sign bit `s`.
public static String	toRawBinaryString(final char k) Show the given raw packed `binary16` value as a string of binary digits.
public static double	unpackDouble(final char k) Convert a packed `binary16` value `k` to a double-precision floating point value.
public static float	unpackFloat(final char k) Convert a packed `binary16` value `k` to a single-precision floating point value.
public static int	unpackGetExponentUnbiased(final char k) Extract and unbias the exponent of the given packed `binary16` value.
public static int	unpackGetSign(final char k) Retrieve the sign bit of the given packed `binary16` value, as an integer in the range `[0, 1]`.
public static int	unpackGetSignificand(final char k) Return the significand of the given packed `binary16` value as an integer in the range `[0, 1023]`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

BIAS	back to summary
public static final int BIAS The bias value used to offset the encoded exponent. A given exponent `e` is encoded as `BIAS + e`.

MASK_EXPONENT	back to summary
private static final int MASK_EXPONENT

MASK_SIGN	back to summary
private static final int MASK_SIGN

MASK_SIGNIFICAND	back to summary
private static final int MASK_SIGNIFICAND

NEGATIVE_INFINITY	back to summary
public static final char NEGATIVE_INFINITY The encoded form of negative infinity `-∞`.

NEGATIVE_ZERO	back to summary
public static final char NEGATIVE_ZERO The encoded form of negative zero `-0`.

POSITIVE_INFINITY	back to summary
public static final char POSITIVE_INFINITY The encoded form of positive infinity `∞`.

POSITIVE_ZERO	back to summary
public static final char POSITIVE_ZERO The encoded form of positive zero `0`.

Binary16	back to summary
private Binary16()

Method Detail

exampleNaN	back to summary
public static char exampleNaN() One possible not-a-number value.

isInfinite	back to summary
public static boolean isInfinite(final char k) Return `true` if the given packed `binary16` value is infinite.

isNaN	back to summary
public static boolean isNaN(final char k) Return `true` if the given packed `binary16` value is not a number (`NaN`).

packDouble back to summary

packDouble	back to summary
public static char packDouble(final double k) Convert a double precision floating point value to a packed `binary16` value. For the following specific cases, the function returns: `NaN` iff `isNaN(k)` `POSITIVE_INFINITY` iff `k == Double#POSITIVE_INFINITY` `NEGATIVE_INFINITY` iff `k == Double#NEGATIVE_INFINITY` `NEGATIVE_ZERO` iff `k == -0.0` `POSITIVE_ZERO` iff `k == 0.0` Otherwise, the `binary16` value that most closely represents `k` is returned. This may obviously be an infinite value as the interval of double precision values is far larger than that of the `binary16` type. See Also `unpackDouble(char)`

public static char packDouble(final double k)

Convert a double precision floating point value to a packed binary16 value.

For the following specific cases, the function returns:

NaN iff isNaN(k)
POSITIVE_INFINITY iff k == Double#POSITIVE_INFINITY
NEGATIVE_INFINITY iff k == Double#NEGATIVE_INFINITY
NEGATIVE_ZERO iff k == -0.0
POSITIVE_ZERO iff k == 0.0

Otherwise, the binary16 value that most closely represents k is returned. This may obviously be an infinite value as the interval of double precision values is far larger than that of the binary16 type.

See Also: unpackDouble(char)

packFloat back to summary

packFloat	back to summary
public static char packFloat(final float k) Convert a single precision floating point value to a packed `binary16` value. For the following specific cases, the function returns: `NaN` iff `isNaN(k)` `POSITIVE_INFINITY` iff `k == Float#POSITIVE_INFINITY` `NEGATIVE_INFINITY` iff `k == Float#NEGATIVE_INFINITY` `NEGATIVE_ZERO` iff `k == -0.0` `POSITIVE_ZERO` iff `k == 0.0` Otherwise, the `binary16` value that most closely represents `k` is returned. This may obviously be an infinite value as the interval of single precision values is far larger than that of the `binary16` type. See Also `unpackFloat(char)`

public static char packFloat(final float k)

Convert a single precision floating point value to a packed binary16 value.

For the following specific cases, the function returns:

NaN iff isNaN(k)
POSITIVE_INFINITY iff k == Float#POSITIVE_INFINITY
NEGATIVE_INFINITY iff k == Float#NEGATIVE_INFINITY
NEGATIVE_ZERO iff k == -0.0
POSITIVE_ZERO iff k == 0.0

Otherwise, the binary16 value that most closely represents k is returned. This may obviously be an infinite value as the interval of single precision values is far larger than that of the binary16 type.

See Also: unpackFloat(char)

packSetExponentUnbiasedUnchecked back to summary

packSetExponentUnbiasedUnchecked	back to summary
public static char packSetExponentUnbiasedUnchecked(final int e) Encode the unbiased exponent `e`. Values should be in the range `[-15, 16]` - values outside of this range will be truncated. See Also `unpackGetExponentUnbiased(char)`

public static char packSetExponentUnbiasedUnchecked(final int e)

Encode the unbiased exponent e. Values should be in the range [-15, 16] - values outside of this range will be truncated.

See Also: unpackGetExponentUnbiased(char)

packSetSignificandUnchecked back to summary

packSetSignificandUnchecked	back to summary
public static char packSetSignificandUnchecked(final int s) Encode the significand `s`. Values should be in the range `[0, 1023]`. Values outside of this range will be truncated. See Also `unpackGetSignificand(char)`

public static char packSetSignificandUnchecked(final int s)

Encode the significand s. Values should be in the range [0, 1023]. Values outside of this range will be truncated.

See Also: unpackGetSignificand(char)

packSetSignUnchecked back to summary

packSetSignUnchecked	back to summary
public static char packSetSignUnchecked(final int s) Encode the sign bit `s`. Values should be in the range `[0, 1]`, with `0` ironically denoting a positive value. Values outside of this range will be truncated. See Also `unpackGetSign(char)`

public static char packSetSignUnchecked(final int s)

Encode the sign bit s. Values should be in the range [0, 1], with 0 ironically denoting a positive value. Values outside of this range will be truncated.

See Also: unpackGetSign(char)

toRawBinaryString	back to summary
public static String toRawBinaryString(final char k) Show the given raw packed `binary16` value as a string of binary digits.

unpackDouble back to summary

unpackDouble	back to summary
public static double unpackDouble(final char k) Convert a packed `binary16` value `k` to a double-precision floating point value. The function returns: `NaN` iff `isNaN(k)` `Double#POSITIVE_INFINITY` iff `k == POSITIVE_INFINITY` `Double#NEGATIVE_INFINITY` iff `k == NEGATIVE_INFINITY` `-0.0` iff `k == NEGATIVE_ZERO` `0.0` iff `k == POSITIVE_ZERO` `(-1.0 * n) * (2 ^ e) * 1.s`, for the decoded sign `n` of `k`, the decoded exponent `e` of `k`, and the decoded significand `s` of `k`. See Also `packDouble(double)`

public static double unpackDouble(final char k)

Convert a packed binary16 value k to a double-precision floating point value.

The function returns:

NaN iff isNaN(k)
Double#POSITIVE_INFINITY iff k == POSITIVE_INFINITY
Double#NEGATIVE_INFINITY iff k == NEGATIVE_INFINITY
-0.0 iff k == NEGATIVE_ZERO
0.0 iff k == POSITIVE_ZERO
(-1.0 * n) * (2 ^ e) * 1.s, for the decoded sign n of k, the decoded exponent e of k, and the decoded significand s of k.

See Also: packDouble(double)

unpackFloat back to summary

unpackFloat	back to summary
public static float unpackFloat(final char k) Convert a packed `binary16` value `k` to a single-precision floating point value. The function returns: `NaN` iff `isNaN(k)` `Float#POSITIVE_INFINITY` iff `k == POSITIVE_INFINITY` `Float#NEGATIVE_INFINITY` iff `k == NEGATIVE_INFINITY` `-0.0` iff `k == NEGATIVE_ZERO` `0.0` iff `k == POSITIVE_ZERO` `(-1.0 * n) * (2 ^ e) * 1.s`, for the decoded sign `n` of `k`, the decoded exponent `e` of `k`, and the decoded significand `s` of `k`. See Also `packFloat(float)`

public static float unpackFloat(final char k)

Convert a packed binary16 value k to a single-precision floating point value.

The function returns:

NaN iff isNaN(k)
Float#POSITIVE_INFINITY iff k == POSITIVE_INFINITY
Float#NEGATIVE_INFINITY iff k == NEGATIVE_INFINITY
-0.0 iff k == NEGATIVE_ZERO
0.0 iff k == POSITIVE_ZERO
(-1.0 * n) * (2 ^ e) * 1.s, for the decoded sign n of k, the decoded exponent e of k, and the decoded significand s of k.

See Also: packFloat(float)

unpackGetExponentUnbiased back to summary

unpackGetExponentUnbiased	back to summary
public static int unpackGetExponentUnbiased(final char k) Extract and unbias the exponent of the given packed `binary16` value. The exponent is encoded biased as a number in the range `[0, 31]`, with `0` indicating that the number is subnormal and `[1, 30]` denoting the actual exponent plus `BIAS`. Infinite and `NaN` values always have an exponent of `31`. This function will therefore return: `0 - BIAS = -15` iff the input is a subnormal number. An integer in the range `[1 - BIAS, 30 - BIAS] = [-14, 15]` iff the input is a normal number. `16` iff the input is `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, or `NaN`. See Also `packSetExponentUnbiasedUnchecked(int)`

public static int unpackGetExponentUnbiased(final char k)

Extract and unbias the exponent of the given packed binary16 value.

The exponent is encoded biased as a number in the range [0, 31], with 0 indicating that the number is subnormal and [1, 30] denoting the actual exponent plus BIAS. Infinite and NaN values always have an exponent of 31.

This function will therefore return:

0 - BIAS = -15 iff the input is a subnormal number.
An integer in the range [1 - BIAS, 30 - BIAS] = [-14, 15] iff the input is a normal number.
16 iff the input is POSITIVE_INFINITY, NEGATIVE_INFINITY, or NaN.

See Also: packSetExponentUnbiasedUnchecked(int)

unpackGetSign back to summary

unpackGetSign	back to summary
public static int unpackGetSign(final char k) Retrieve the sign bit of the given packed `binary16` value, as an integer in the range `[0, 1]`. See Also `Binary16#packSetSignUnchecked(int)`

public static int unpackGetSign(final char k)

Retrieve the sign bit of the given packed binary16 value, as an integer in the range [0, 1].

See Also: Binary16#packSetSignUnchecked(int)

unpackGetSignificand back to summary

unpackGetSignificand	back to summary
public static int unpackGetSignificand(final char k) Return the significand of the given packed `binary16` value as an integer in the range `[0, 1023]`. See Also `Binary16#packSetSignificandUnchecked(int)`

public static int unpackGetSignificand(final char k)

Return the significand of the given packed binary16 value as an integer in the range [0, 1023].

See Also: Binary16#packSetSignificandUnchecked(int)

public final Class Binary16

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail