float_sign

Get the sign of an XFL enclosing number

Concepts

• Floating Point Numbers (XFL)

Behaviour

C

• Return 1 if the XFL is negative, otherwise return 0

Javascript

• Return 1 if the XFL is negative, otherwise return 0

Definition

C

int64_t float_sign (
    int64_t float1
);

Javascript

function float_sign(f1: bigint): ErrorCode | number

Example

C

int64_t sign =
    float_sign(float_one());

📘Hint

The sign bit inside the XFL is the 0 when the XFL is negative, however this function follows the standard computing convention to return 1 if it is negative.

Javascript

const sign =
   float_sign(float_one());

Parameters

C

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number

Javascript

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

Return Code

C

Type	Description
int64_t	The sign of the XFL: 0 if positive, 1 if negative. 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.