namespace Eigen { /** \eigenManualPage CoeffwiseMathFunctions Catalog of coefficient-wise math functions This table presents a catalog of the coefficient-wise math functions supported by %Eigen. In this table, \c a, \c b, refer to Array objects or expressions, and \c m refers to a linear algebra Matrix/Vector object. Standard scalar types are abbreviated as follows: - \c int: \c i32 - \c float: \c f - \c double: \c d - \c std::complex: \c cf - \c std::complex: \c cd For each row, the first column list the equivalent calls for arrays, and matrices when supported. Of course, all functions are available for matrices by first casting it as an array: \c m.array(). The third column gives some hints in the underlying scalar implementation. In most cases, %Eigen does not implement itself the math function but relies on the STL for standard scalar types, or user-provided functions for custom scalar types. For instance, some simply calls the respective function of the STL while preserving argument-dependent lookup for custom types. The following: \code using std::foo; foo(a[i]); \endcode means that the STL's function \c std::foo will be potentially called if it is compatible with the underlying scalar type. If not, then the user must ensure that an overload of the function foo is available for the given scalar type (usually defined in the same namespace as the given scalar type). This also means that, unless specified, if the function \c std::foo is available only in some recent c++ versions (e.g., c++11), then the respective %Eigen's function/method will be usable on standard types only if the compiler support the required c++ version.
APIDescriptionDefault scalar implementationSIMD
Basic operations
\anchor cwisetable_abs a.\link ArrayBase::abs abs\endlink(); \n \link Eigen::abs abs\endlink(a); \n m.\link MatrixBase::cwiseAbs cwiseAbs\endlink(); absolute value (\f$ |a_i| \f$) using std::abs; \n abs(a[i]); SSE2, AVX (i32,f,d)
\anchor cwisetable_inverse a.\link ArrayBase::inverse inverse\endlink(); \n \link Eigen::inverse inverse\endlink(a); \n m.\link MatrixBase::cwiseInverse cwiseInverse\endlink(); inverse value (\f$ 1/a_i \f$) 1/a[i]; All engines (f,d,fc,fd)
\anchor cwisetable_conj a.\link ArrayBase::conjugate conjugate\endlink(); \n \link Eigen::conj conj\endlink(a); \n m.\link MatrixBase::conjugate conjugate\endlink(); complex conjugate (\f$ \bar{a_i} \f$),\n no-op for real using std::conj; \n conj(a[i]); All engines (fc,fd)
\anchor cwisetable_arg a.\link ArrayBase::arg arg\endlink(); \n \link Eigen::arg arg\endlink(a); \n m.\link MatrixBase::cwiseArg cwiseArg\endlink(); phase angle of complex number using std::arg; \n arg(a[i]); All engines (fc,fd)
Exponential functions
\anchor cwisetable_exp a.\link ArrayBase::exp exp\endlink(); \n \link Eigen::exp exp\endlink(a); \f$ e \f$ raised to the given power (\f$ e^{a_i} \f$) using std::exp; \n exp(a[i]); SSE2, AVX (f,d)
\anchor cwisetable_log a.\link ArrayBase::log log\endlink(); \n \link Eigen::log log\endlink(a); natural (base \f$ e \f$) logarithm (\f$ \ln({a_i}) \f$) using std::log; \n log(a[i]); SSE2, AVX (f)
\anchor cwisetable_log1p a.\link ArrayBase::log1p log1p\endlink(); \n \link Eigen::log1p log1p\endlink(a); natural (base \f$ e \f$) logarithm of 1 plus \n the given number (\f$ \ln({1+a_i}) \f$) built-in generic implementation based on \c log,\n plus \c using \c std::log1p ; \cpp11
\anchor cwisetable_log10 a.\link ArrayBase::log10 log10\endlink(); \n \link Eigen::log10 log10\endlink(a); base 10 logarithm (\f$ \log_{10}({a_i}) \f$) using std::log10; \n log10(a[i]);
Power functions
\anchor cwisetable_pow a.\link ArrayBase::pow pow\endlink(b); \n \link ArrayBase::pow(const Eigen::ArrayBase< Derived > &x, const Eigen::ArrayBase< ExponentDerived > &exponents) pow\endlink(a,b); raises a number to the given power (\f$ a_i ^ {b_i} \f$) \n \c a and \c b can be either an array or scalar. using std::pow; \n pow(a[i],b[i]);\n (plus builtin for integer types)
\anchor cwisetable_sqrt a.\link ArrayBase::sqrt sqrt\endlink(); \n \link Eigen::sqrt sqrt\endlink(a);\n m.\link MatrixBase::cwiseSqrt cwiseSqrt\endlink(); computes square root (\f$ \sqrt a_i \f$) using std::sqrt; \n sqrt(a[i]); SSE2, AVX (f,d)
\anchor cwisetable_cbrt a.\link ArrayBase::cbrt cbrt\endlink(); \n \link Eigen::cbrt cbrt\endlink(a);\n m.\link MatrixBase::cwiseCbrt cwiseCbrt\endlink(); computes cube root (\f$ \sqrt[3]{ a_i }\f$) using std::cbrt; \n cbrt(a[i]);
\anchor cwisetable_rsqrt a.\link ArrayBase::rsqrt rsqrt\endlink(); \n \link Eigen::rsqrt rsqrt\endlink(a); reciprocal square root (\f$ 1/{\sqrt a_i} \f$) using std::sqrt; \n 1/sqrt(a[i]); \n SSE2, AVX, AltiVec, ZVector (f,d)\n (approx + 1 Newton iteration)
\anchor cwisetable_square a.\link ArrayBase::square square\endlink(); \n \link Eigen::square square\endlink(a); computes square power (\f$ a_i^2 \f$) a[i]*a[i] All (i32,f,d,cf,cd)
\anchor cwisetable_cube a.\link ArrayBase::cube cube\endlink(); \n \link Eigen::cube cube\endlink(a); computes cubic power (\f$ a_i^3 \f$) a[i]*a[i]*a[i] All (i32,f,d,cf,cd)
\anchor cwisetable_abs2 a.\link ArrayBase::abs2 abs2\endlink(); \n \link Eigen::abs2 abs2\endlink(a);\n m.\link MatrixBase::cwiseAbs2 cwiseAbs2\endlink(); computes the squared absolute value (\f$ |a_i|^2 \f$) real: a[i]*a[i] \n complex: real(a[i])*real(a[i]) \n        + imag(a[i])*imag(a[i]) All (i32,f,d)
Trigonometric functions
\anchor cwisetable_sin a.\link ArrayBase::sin sin\endlink(); \n \link Eigen::sin sin\endlink(a); computes sine using std::sin; \n sin(a[i]); SSE2, AVX (f)
\anchor cwisetable_cos a.\link ArrayBase::cos cos\endlink(); \n \link Eigen::cos cos\endlink(a); computes cosine using std::cos; \n cos(a[i]); SSE2, AVX (f)
\anchor cwisetable_tan a.\link ArrayBase::tan tan\endlink(); \n \link Eigen::tan tan\endlink(a); computes tangent using std::tan; \n tan(a[i]);
\anchor cwisetable_asin a.\link ArrayBase::asin asin\endlink(); \n \link Eigen::asin asin\endlink(a); computes arc sine (\f$ \sin^{-1} a_i \f$) using std::asin; \n asin(a[i]);
\anchor cwisetable_acos a.\link ArrayBase::acos acos\endlink(); \n \link Eigen::acos acos\endlink(a); computes arc cosine (\f$ \cos^{-1} a_i \f$) using std::acos; \n acos(a[i]);
\anchor cwisetable_atan a.\link ArrayBase::atan atan\endlink(); \n \link Eigen::atan atan\endlink(a); computes arc tangent (\f$ \tan^{-1} a_i \f$) using std::atan; \n atan(a[i]);
Hyperbolic functions
\anchor cwisetable_sinh a.\link ArrayBase::sinh sinh\endlink(); \n \link Eigen::sinh sinh\endlink(a); computes hyperbolic sine using std::sinh; \n sinh(a[i]);
\anchor cwisetable_cosh a.\link ArrayBase::cosh cohs\endlink(); \n \link Eigen::cosh cosh\endlink(a); computes hyperbolic cosine using std::cosh; \n cosh(a[i]);
\anchor cwisetable_tanh a.\link ArrayBase::tanh tanh\endlink(); \n \link Eigen::tanh tanh\endlink(a); computes hyperbolic tangent using std::tanh; \n tanh(a[i]);
\anchor cwisetable_asinh a.\link ArrayBase::asinh asinh\endlink(); \n \link Eigen::asinh asinh\endlink(a); computes inverse hyperbolic sine using std::asinh; \n asinh(a[i]);
\anchor cwisetable_acosh a.\link ArrayBase::acosh cohs\endlink(); \n \link Eigen::acosh acosh\endlink(a); computes hyperbolic cosine using std::acosh; \n acosh(a[i]);
\anchor cwisetable_atanh a.\link ArrayBase::atanh atanh\endlink(); \n \link Eigen::atanh atanh\endlink(a); computes hyperbolic tangent using std::atanh; \n atanh(a[i]);
Nearest integer floating point operations
\anchor cwisetable_ceil a.\link ArrayBase::ceil ceil\endlink(); \n \link Eigen::ceil ceil\endlink(a); nearest integer not less than the given value using std::ceil; \n ceil(a[i]); SSE4,AVX,ZVector (f,d)
\anchor cwisetable_floor a.\link ArrayBase::floor floor\endlink(); \n \link Eigen::floor floor\endlink(a); nearest integer not greater than the given value using std::floor; \n floor(a[i]); SSE4,AVX,ZVector (f,d)
\anchor cwisetable_round a.\link ArrayBase::round round\endlink(); \n \link Eigen::round round\endlink(a); nearest integer, \n rounding away from zero in halfway cases built-in generic implementation \n based on \c floor and \c ceil,\n plus \c using \c std::round ; \cpp11 SSE4,AVX,ZVector (f,d)
\anchor cwisetable_rint a.\link ArrayBase::rint rint\endlink(); \n \link Eigen::rint rint\endlink(a); nearest integer, \n rounding to nearest even in halfway cases built-in generic implementation using \c std::rint ; \cpp11 or \c rintf ; SSE4,AVX (f,d)
Floating point manipulation functions
Classification and comparison
\anchor cwisetable_isfinite a.\link ArrayBase::isFinite isFinite\endlink(); \n \link Eigen::isfinite isfinite\endlink(a); checks if the given number has finite value built-in generic implementation,\n plus \c using \c std::isfinite ; \cpp11
\anchor cwisetable_isinf a.\link ArrayBase::isInf isInf\endlink(); \n \link Eigen::isinf isinf\endlink(a); checks if the given number is infinite built-in generic implementation,\n plus \c using \c std::isinf ; \cpp11
\anchor cwisetable_isnan a.\link ArrayBase::isNaN isNaN\endlink(); \n \link Eigen::isnan isnan\endlink(a); checks if the given number is not a number built-in generic implementation,\n plus \c using \c std::isnan ; \cpp11
\anchor cwisetable_less a.\c operator<(b); \n a.\c operator<(s); coefficient-wise less than comparison (\f$ a_i \lt b_i \f$). \n \c a and \c b can be either an array or scalar. a[i] < b[i];
\anchor cwisetable_less_equal a.\c operator<=(b); \n a.\c operator<=(s); coefficient-wise less than or equal comparison (\f$ a_i \le b_i \f$). \n \c a and \c b can be either an array or scalar. a[i] <= b[i];
\anchor cwisetable_greater a.\c operator>(b); \n a.\c operator>(s); coefficient-wise greater than comparison (\f$ a_i \gt b_i \f$). \n \c a and \c b can be either an array or scalar. a[i] > b[i];
\anchor cwisetable_greater_equal a.\c operator>=(b); \n a.\c operator>=(s); coefficient-wise greater than or equal comparison (\f$ a_i \ge b_i \f$). \n \c a and \c b can be either an array or scalar. a[i] >= b[i];
\anchor cwisetable_equal a.\c operator==(b); \n a.\c operator==(s); coefficient-wise equality comparison (\f$ a_i = b_i \f$). \n \c a and \c b can be either an array or scalar. \n \warning Performs exact comparison; prefer \c isApprox() for floating-point types. a[i] == b[i];
\anchor cwisetable_not_equal a.\c operator!=(b); \n a.\c operator!=(s); coefficient-wise not-equal comparison (\f$ a_i \ne b_i \f$). \n \c a and \c b can be either an array or scalar. \n \warning Performs exact comparison; prefer \c isApprox() for floating-point types. a[i] != b[i];
Error and gamma functions
Require \c \#include \c
\anchor cwisetable_erf a.\link ArrayBase::erf erf\endlink(); \n \link Eigen::erf erf\endlink(a); error function using std::erf; \cpp11 \n erf(a[i]);
\anchor cwisetable_erfc a.\link ArrayBase::erfc erfc\endlink(); \n \link Eigen::erfc erfc\endlink(a); complementary error function using std::erfc; \cpp11 \n erfc(a[i]);
\anchor cwisetable_lgamma a.\link ArrayBase::lgamma lgamma\endlink(); \n \link Eigen::lgamma lgamma\endlink(a); natural logarithm of the gamma function using std::lgamma; \cpp11 \n lgamma(a[i]);
\anchor cwisetable_digamma a.\link ArrayBase::digamma digamma\endlink(); \n digamma(a); logarithmic derivative of the gamma function built-in for float and double
\anchor cwisetable_igamma igamma(a,x); lower incomplete gamma integral \n \f$ \gamma(a_i,x_i)= \frac{1}{|a_i|} \int_{0}^{x_i}e^{\text{-}t} t^{a_i-1} \mathrm{d} t \f$ built-in for float and double,\n but requires \cpp11
\anchor cwisetable_igammac igammac(a,x); upper incomplete gamma integral \n \f$ \Gamma(a_i,x_i) = \frac{1}{|a_i|} \int_{x_i}^{\infty}e^{\text{-}t} t^{a_i-1} \mathrm{d} t \f$ built-in for float and double,\n but requires \cpp11
Special functions
Require \c \#include \c
\anchor cwisetable_polygamma polygamma(n,x); n-th derivative of digamma at x built-in generic based on\n \c lgamma , \c digamma and \c zeta .
\anchor cwisetable_betainc betainc(a,b,x); regularized incomplete beta function built-in for float and double,\n but requires \cpp11
\anchor cwisetable_zeta zeta(a,b); \n a.\link ArrayBase::zeta zeta\endlink(b); Hurwitz zeta function \n \f$ \zeta(a_i,b_i)=\sum_{k=0}^{\infty}(b_i+k)^{\text{-}a_i} \f$ built-in for float and double
\anchor cwisetable_ndtri a.\link ArrayBase::ndtri ndtri\endlink(); \n \link Eigen::ndtri ndtri\endlink(a); Inverse of the CDF of the Normal distribution function built-in for float and double
\n \section CoeffwiseMathFunctionsAccuracy Accuracy of vectorized math functions The following tables summarize the accuracy of %Eigen's vectorized implementations measured in units of ULP (Unit in the Last Place) on an x86-64 system (Intel Xeon, GCC) with SSE2 SIMD target. The reference values were computed using MPFR at 128-bit precision. Float results are exhaustive over all ~4.28 billion finite representable values. Double results sample ~2.88 billion values using a geometric stepping factor of 10-6. These numbers may differ for other SIMD targets (AVX, AVX512, NEON, SVE, etc.) since each has its own packet math implementations. Functions marked "delegates to std" do not have a custom vectorized implementation for the tested SIMD target — they call the standard library function element-by-element. The full histograms for each function can be generated with the \c ulp_accuracy tool in test/ulp_accuracy/. \subsection CoeffwiseMathFunctionsAccuracy_float Float precision
FunctionMax |ULP|Mean |ULP|% ExactNotes
Trigonometric
sin 2 0.087 91.3% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
cos 2 0.088 91.2% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
tan 5 0.238 77.3% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
asin 4 0.726 51.3%
acos 4 0.057 95.0%
atan 4 0.061 94.0%
Hyperbolic
sinh 2 0.017 98.3%
cosh 2 0.004 99.6%
tanh 6 0.030 97.2%
asinh 2 0.145 85.5%
acosh 2 0.057 94.3%
atanh 2 0.004 99.6%
Exponential / Logarithmic
exp 1 0.018 98.2%
exp2 6 0.034 97.3%
expm1 5 0.060 94.6%
log 3 0.120 88.0%
log1p 5 0.134 87.5%
log10 2 0.007 99.3%
log2 5 0.005 99.5%
Error / Special
erf 7 0.332 67.5%
erfc 8 0.010 99.2%
lgamma delegates to std \ref CoeffwiseMathFunctionsAccuracy_note3 "3"
Other
logistic 7 0.040 97.0%
sqrt 0 0.000 100% Uses hardware sqrt
cbrt 2 0.552 49.1%
rsqrt 0.114 88.2% \ref CoeffwiseMathFunctionsAccuracy_note4 "4"
\subsection CoeffwiseMathFunctionsAccuracy_double Double precision
FunctionMax |ULP|Mean |ULP|% ExactNotes
Trigonometric
sin 13,879,755 0.093 93.2% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
cos 2,024,130 0.043 98.2% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
tan 13,879,755 0.128 92.7% \ref CoeffwiseMathFunctionsAccuracy_note1 "1"
asin 1 <0.001 >99.9%
acos 1 <0.001 100%
atan 5 0.013 98.8%
Hyperbolic
sinh 2 0.004 99.6%
cosh 2 0.001 99.9%
tanh 8 0.008 99.3%
asinh 2 0.098 90.2%
acosh 2 0.047 95.3%
atanh 2 <0.001 >99.9%
Exponential / Logarithmic
exp 2 0.001 99.9%
exp2 214 0.107 99.6% \ref CoeffwiseMathFunctionsAccuracy_note2 "2"
expm1 3 0.010 99.1%
log 2 0.147 85.3%
log1p 3 0.097 90.6%
log10 2 0.001 99.9%
log2 2 <0.001 99.9%
Error / Special
erf 0.050 70.5% \ref CoeffwiseMathFunctionsAccuracy_note5 "5"
erfc 11 0.002 99.9%
lgamma delegates to std \ref CoeffwiseMathFunctionsAccuracy_note3 "3"
Other
logistic 3 0.008 99.2%
sqrt 0 0.000 100% Uses hardware sqrt
cbrt 2 0.119 88.1%
rsqrt 0.135 86.5% \ref CoeffwiseMathFunctionsAccuracy_note4 "4"
\subsection CoeffwiseMathFunctionsAccuracy_notes Notes \anchor CoeffwiseMathFunctionsAccuracy_note1 1. sin/cos/tan argument reduction: %Eigen's vectorized sin, cos, and tan use a Cody-Waite argument reduction scheme that subtracts multiples of π/2 from the input. For very large arguments (|x| > ~104 in float, |x| > ~10 in double), this reduction loses precision, producing occasional large ULP errors. The mean error remains low because most representable values are small. Applications that need high accuracy for large arguments should perform argument reduction in user code before calling these functions. \anchor CoeffwiseMathFunctionsAccuracy_note2 2. exp2 double precision: The exp2 implementation for double shows a max error of 214 ULP near the overflow boundary (x ≈ 1022). The mean error is still low (0.107 ULP, 99.6% exact), so the large max error affects only inputs very close to overflow. \anchor CoeffwiseMathFunctionsAccuracy_note3 3. lgamma: The vectorized lgamma delegates to the standard library function \c std::lgamma for this SIMD target (SSE2) and therefore has the same accuracy as the platform's C math library. \anchor CoeffwiseMathFunctionsAccuracy_note4 4. rsqrt max=∞: The infinite max ULP is due to a sign disagreement at a single subnormal input: rsqrt(-0) returns -∞ in %Eigen but the MPFR reference produces NaN (rsqrt of a negative value). Ignoring this edge case, the implementation is accurate (< 2 ULP) everywhere else. For float, 16.8 million subnormal negative inputs (0.4%) also produce ±∞ vs NaN. The mean error excluding these outliers is well below 1 ULP. \anchor CoeffwiseMathFunctionsAccuracy_note5 5. erf double ∞: The vectorized erf for double returns NaN for ±∞ instead of the correct ±1. This produces an infinite max ULP error at a single input value. Excluding ±∞, the max error is 3 ULP and the mean is 0.050 ULP. */ }