float_mulratio

Concepts

Floating Point Numbers (XFL)

Behaviour

C

• Compute the multiplication of an XFL (xls17) floating point number and the quotient of two integers
• Return a new XFL as an int64_t

JavaScript

• Multiplies a float by a ratio defined by a numerator and denominator.
• Returns an error code or new XFL as a bigint.

Definition

C

int64_t float_mulratio (
    int64_t float1,
    uint32_t round_up,
    uint32_t numerator,
    uint32_t denominator
);

JavaScript

function float_mulratio(
    f1: bigint,
    round_up: number,
    numerator: number,
    denominator: number
  ): ErrorCode | bigint

Example

C

int64_t max_vault_pusd =
    float_mulratio(max_vault_pusd, 0,
        COLLATERALIZATION_NUMERATOR, COLLATERALIZATION_DENOMINATOR);

JavaScript

const max_vault_pusd =
    float_mulratio(max_vault_pusd, 0,
        COLLATERALIZATION_NUMERATOR, COLLATERALIZATION_DENOMINATOR);

Parameters

C

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number representing the first operand to the multiplication
round_up	uint32_t	If non-zero all computations will be rounded up
numerator	uint32_t	The numerator of the quotient that the float will be multiplied by
denominator	uint32_t	The denominator of the quotient that the float will be multiplied by

Caution

Certain multiplications may overflow, which return with an INVALID_FLOAT error. However an underflow returns as XFL Canonical Zero (i.e. enclosing number = 0).

JavaScript

Name	Type	Description
f1	bigint	An XFL floating point enclosing number representing the first operand to the multiplication
round_up	number	If non-zero all computations will be rounded up
numerator	number	The numerator of the quotient that the float will be multiplied by
denominator	number	The denominator of the quotient that the float will be multiplied by

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 multiplication was too large to store in an XFL. DIVISION_BY_ZERO - the supplied denominator was zero.

JavaScript

Type	Description
ErrorCode or bigint	Returns an error code or tThe XFL (xls17) enclosing number.