float_negate

Negate an XFL floating point number

Concepts

• Floating Point Numbers (XFL)

Behaviour

• Multiply an XFL by -1
• Return a new XFL as an int64_t

Definition

C

int64_t float_negate (
    int64_t float1
);

Example

C

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.

Parameters

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number

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