float_divide

Concepts

Floating Point Numbers (XFL)

Behaviour

C

• Divide an XFL by another XFL
• Return a new XFL as an int64_t

JavaScript

• Divides one float representation by another.
• An error code or the quotient as a bigint.

Definition

C

int64_t float_divide (
    int64_t float1,
    int64_t float2
);

JavaScript

 function float_divide(f1: bigint, f2: bigint): ErrorCode | bigint

Example

C

int64_t still_one =
    float_divide(float_one(), float_one());

JavaScript

const still_one =
    float_divide(float_one(), float_one())

Parameters

C

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number to act as numerator
float2	int64_t	An XFL floating point enclosing number to act as denominator

JavaScript

Name	Type	Description
f1	bigint	The dividend float.
f2	bigint	The divisor float.

Return Code

C

Type	Description
int64_t	The XFL (xls17) enclosing number If negative, an error: INVALID_FLOAT - the supplied parameter was not a valid XFL enclosing number or the division resulted in an XFL that cannot be represented. DIVISION_BY_ZERO - the supplied parameter was zero.

JavaScript

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