All pages
Powered by GitBook
1 of 1

float_negate

Negate an XFL floating point number

Concepts

Behaviour

  • Multiply an XFL by -1

  • Return a new XFL as an int64_t

  • Negates a float representation.

  • Returns an error code or the negated float as a bigint.

Definition

int64_t float_negate (
    int64_t float1
);

function float_negate(f1: bigint): ErrorCode | bigint

Example

int64_t negative_one =
    float_negate(float_one());

📘Special case

The negation of Canonical Zero is Canonical Zero. Unlike some floating point standards (such as IEEE) there is no "negative zero" in XFL.

const negative_one =
    float_negate(float_one());

Parameters

Name
Type
Description

float1

int64_t

An XFL floating point enclosing number

Name
Type
Description

f1

bigint

The float to negate.

Return Code

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

Type
Description

ErrorCode or bigint

An error code or The XFL (xls17) enclosing number.