Compute the nth root of an XFL

Concepts

Behaviour

  • Compute a the nth root of an XFL number
  • Return the new XFL

Definition

int64_t float_root (
    int64_t float1,
    uint32_t n
);

Example

int64_t three =
    float_root(nine, 2);

🚧

Warning

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

Parameters

Name

Type

Description

float1

int64_t

An XFL floating point enclosing number representing the floating point number to take the square root of

n

uint32_t

The root to compute, for example 2 is a square root.

Return Code

Type

Description

int64_t

The computed nth root

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 root.