float_mantissa

Concepts

Floating Point Numbers (XFL)

Behaviour

C

• Return the mantissa part of an XFL as an unsigned integer

JavaScript

• Retrieves the mantissa of a float representation.
• An error code or the mantissa as a bigint.

Definition

C

int64_t float_mantissa (
    int64_t float1
);

JavaScript

function float_mantissa(f1: bigint): ErrorCode | bigint

Example

C

int64_t mantissa =
    float_mantissa(float_one());

Tip

The mantissa of a negative XFL is always positive. Use float_sign to determine the sign of the number.

JavaScript

const mantissa =
    float_mantissa(float_one());

Parameters

C

Name	Type	Description
f1	bigint	The float to retrieve the mantissa from.

JavaScript

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number

Return Code

C

Type	Description
int64_t	The mantissa of the XFL If negative, an error: INVALID_FLOAT - the supplied parameter was not a valid XFL enclosing number

JavaScript

Type	Description
bigint or ErrorCode	An error code or the mantissa as a bigint.