float_divide

Divide an XFL by another XFL floating point number

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

First Tab

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.

Second Tab

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