float_root

Concepts

Floating Point Numbers (XFL)

Behaviour

C

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

Caution

Due to speed constraints,float_root converts the argument to an IEEE base-2 double precision floating point before applying n-th root. Therefore the returned result will often contain less precision than expected. If you need better precision you should consider dividing your XFL into a high and a low product then individually take the square roots of those products and multiply the results together.

JavaScript

• Calculates the nth root of a float representation.
• An error code or the resulting root as a bigint.

Definition

C

int64_t float_root (
    int64_t float1,
    uint32_t n
);

JavaScript

function float_root(f1: bigint, n: number): ErrorCode | bigint

Example

C

int64_t three =
    float_root(nine, 2);

Caution

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

JavaScript

const three =
  float_root(nine, 2)

Parameters

C

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.

JavaScript

Name	Type	Description
f1	bigint	The float to calculate the root of.
n	number	The degree of the root to calculate.

Return Code

C

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.

JavaScript

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