float_sum

Concepts

Floating Point Numbers (XFL)

Behaviour

C

• Compute the addition of two XFL (xls17) floating point numbers
• Return a new XFL as an int64_t

JavaScript

• Sums two float representations.
• Returns an error code or the sum as a bigint.

Definition

C

int64_t float_sum (
    int64_t float1,
    int64_t float2
);

JavaScript

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

Example

C

int64_t two =
    float_sum(float_one(), float_one());

JavaScript

const two =
  float_sum(float_one(), float_one());

Parameters

C

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number representing the first operand to the addition
float2	int64_t	An XFL floating point enclosing number representing the second operand to the addition

Tip

To subtract two floats use float_negate on the second float then use float_sum.

JavaScript

Name	Type	Description
f1	bigint	The first float to sum.
f2	bigint	The second float to sum.

Return Code

C

Type	Description
int64_t	The XFL (xls17) enclosing number If negative, an error: INVALID_FLOAT - one of the supplied parameters was not a valid XFL enclosing number OVERFLOW - the result of the addition was too large to store in an XFL.

JavaScript

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