float_mulratio

Conceitos

Números de Ponto Flutuante (XFL)

Comportamento

C

• Calcula a multiplicação de um número de ponto flutuante XFL (xls17) pelo quociente de dois inteiros
• Retorna um novo XFL como um int64_t

JavaScript

• Multiplica um float por uma razão definida por um numerador e um denominador.
• Retorna um código de erro ou um novo XFL como um bigint.

Definição

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

Exemplo

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);

Parâmetros

C

Nome	Tipo	Descrição
float1	int64_t	Um número de ponto flutuante de envoltório XFL representando o primeiro operando da multiplicação
round_up	uint32_t	Se diferente de zero, todos os cálculos serão arredondados para cima
numerator	uint32_t	O numerador do quociente pelo qual o float será multiplicado
denominator	uint32_t	O denominador do quociente pelo qual o float será multiplicado

Cuidado

Certas multiplicações podem causar overflow, retornando um erro INVALID_FLOAT. No entanto, um underflow retorna como XFL Canonical Zero (ou seja, número de envoltório = 0).

JavaScript

Nome	Tipo	Descrição
f1	bigint	Um número de ponto flutuante de envoltório XFL representando o primeiro operando da multiplicação
round_up	number	Se diferente de zero, todos os cálculos serão arredondados para cima
numerator	number	O numerador do quociente pelo qual o float será multiplicado
denominator	number	O denominador do quociente pelo qual o float será multiplicado

Código de Retorno

C

Tipo	Descrição
int64_t	O número de envoltório XFL (xls17) Se negativo, um erro: INVALID_FLOAT - um dos parâmetros fornecidos não era um número de envoltório XFL válido OVERFLOW - o resultado da multiplicação era muito grande para ser armazenado em um XFL. DIVISION_BY_ZERO - o denominador fornecido era zero.

JavaScript

Tipo	Descrição
ErrorCode ou bigint	Retorna um código de erro ou o número de envoltório XFL (xls17).