These docs are for v2.0. Click to read the latest docs for v3.0.

Compute the decimal log of an XFL

Concepts

Behaviour

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

❗️

Warning

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.

Definition

int64_t float_log (
    int64_t float1
);

Example

int64_t zero =
    float_log(float_one());

🚧

Warning

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

Parameters

NameTypeDescription
float1int64_tAn XFL floating point enclosing number representing the floating point number to take the logarithm of

Return Code

TypeDescription
int64_tThe 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.