float_log

Concepts

Floating Point Numbers (XFL)

Behaviour

C

• Compute a the decimal logarithm of an XFL number
• Return the new XFL

Caution

Due to speed constraints,float_log converts the argument to an IEEE base-2 double precision floating point before applying base 10 log. Therefore the returned result will often contain less precision than expected.

JavaScript

• Calculates the logarithm of a float representation.
• Returns an error code or the logarithm as a bigint.

Definition

C

int64_t float_log (
    int64_t float1
);

JavaScript

function float_log(f1: bigint): ErrorCode | bigint

Example

C

int64_t zero =
    float_log(float_one());

Caution

If a negative number is passed the function will return COMPLEX_NOT_SUPPORTED if the root is an even root.

JavaScript

const zero =
    float_log(float_one())

Parameters

C

Name	Type	Description
float1	int64_t	An XFL floating point enclosing number representing the floating point number to take the logarithm of

JavaScript

Name	Type	Description
f1	bigint	The float to calculate the logarithm of.

Return Code

C

Type	Description
int64_t	The computed logarithm If negative, an error: INVALID_FLOAT - the supplied parameter was not a valid XFL enclosing number COMPLEX_NOT_SUPPORTED - the supplied parameter was a negative number which would result in a complex return value.

JavaScript

Type	Description
bigint or ErrorCode	Returns an error code or the logarithm as a bigint.