Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit c6a8213e9b.
PrevUpHomeNext

cbrt

#include <boost/math/special_functions/cbrt.hpp>
namespace boost{ namespace math{

template <class T>
calculated-result-type cbrt(T x);

template <class T, class Policy>
calculated-result-type cbrt(T x, const Policy&);

}} // namespaces

Returns the cubed root of x: x1/3 or ∛x.

The return type of this function is computed using the result type calculation rules: the return is double when x is an integer type and T otherwise.

The final Policy argument is optional and can be used to control the behaviour of the function: how it handles errors, what level of precision to use etc. Refer to the policy documentation for more details.

Implemented using Halley iteration.

The following graph illustrates the behaviour of cbrt:

Accuracy

For built in floating-point types cbrt should have approximately 2 epsilon accuracy.

Table 8.83. Error rates for cbrt

GNU C++ version 7.1.0
linux
double

GNU C++ version 7.1.0
linux
long double

Sun compiler version 0x5150
Sun Solaris
long double

Microsoft Visual C++ version 14.1
Win32
double

cbrt Function

Max = 0ε (Mean = 0ε)

Max = 1.34ε (Mean = 0.471ε)

(<cmath>: Max = 1.34ε (Mean = 0.471ε))
(<math.h>: Max = 1.34ε (Mean = 0.471ε))

Max = 1.34ε (Mean = 0.471ε)

(<math.h>: Max = 1.34ε (Mean = 0.471ε))

Max = 1.7ε (Mean = 0.565ε)

(<math.h>: Max = 1.7ε (Mean = 0.565ε))


Testing

A mixture of spot test sanity checks, and random high precision test values calculated using NTL::RR at 1000-bit precision.


PrevUpHomeNext