11#ifndef EIGEN_GLOBAL_FUNCTIONS_H
12#define EIGEN_GLOBAL_FUNCTIONS_H
14#ifdef EIGEN_PARSED_BY_DOXYGEN
16#define EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(NAME,FUNCTOR,DOC_OP,DOC_DETAILS) \
23 template<typename Derived> \
24 inline const Eigen::CwiseUnaryOp<Eigen::internal::FUNCTOR<typename Derived::Scalar>, const Derived> \
25 NAME(const Eigen::ArrayBase<Derived>& x);
29#define EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(NAME,FUNCTOR,DOC_OP,DOC_DETAILS) \
30 template<typename Derived> \
31 inline const Eigen::CwiseUnaryOp<Eigen::internal::FUNCTOR<typename Derived::Scalar>, const Derived> \
32 (NAME)(const Eigen::ArrayBase<Derived>& x) { \
33 return Eigen::CwiseUnaryOp<Eigen::internal::FUNCTOR<typename Derived::Scalar>, const Derived>(x.derived()); \
38#define EIGEN_ARRAY_DECLARE_GLOBAL_EIGEN_UNARY(NAME,FUNCTOR) \
40 template<typename Derived> \
41 struct NAME##_retval<ArrayBase<Derived> > \
43 typedef const Eigen::CwiseUnaryOp<Eigen::internal::FUNCTOR<typename Derived::Scalar>, const Derived> type; \
45 template<typename Derived> \
46 struct NAME##_impl<ArrayBase<Derived> > \
48 static inline typename NAME##_retval<ArrayBase<Derived> >::type run(const Eigen::ArrayBase<Derived>& x) \
50 return typename NAME##_retval<ArrayBase<Derived> >::type(x.derived()); \
56 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(real,scalar_real_op,real part,\sa ArrayBase::real)
57 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(imag,scalar_imag_op,imaginary part,\sa
ArrayBase::imag)
58 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(conj,scalar_conjugate_op,complex conjugate,\sa
ArrayBase::conjugate)
59 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(inverse,scalar_inverse_op,inverse,\sa
ArrayBase::inverse)
60 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(sin,scalar_sin_op,sine,\sa
ArrayBase::sin)
61 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(cos,scalar_cos_op,cosine,\sa
ArrayBase::cos)
62 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(tan,scalar_tan_op,tangent,\sa
ArrayBase::tan)
63 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(atan,scalar_atan_op,arc-tangent,\sa
ArrayBase::atan)
64 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(asin,scalar_asin_op,arc-sine,\sa
ArrayBase::asin)
65 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(acos,scalar_acos_op,arc-consine,\sa
ArrayBase::acos)
66 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(sinh,scalar_sinh_op,hyperbolic sine,\sa
ArrayBase::sinh)
67 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(cosh,scalar_cosh_op,hyperbolic cosine,\sa
ArrayBase::cosh)
68 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(tanh,scalar_tanh_op,hyperbolic tangent,\sa
ArrayBase::tanh)
69#if EIGEN_HAS_CXX11_MATH
70 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(asinh,scalar_asinh_op,inverse hyperbolic sine,\sa ArrayBase::asinh)
71 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(acosh,scalar_acosh_op,inverse hyperbolic cosine,\sa
ArrayBase::acosh)
72 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(atanh,scalar_atanh_op,inverse hyperbolic tangent,\sa
ArrayBase::atanh)
74 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(logistic,scalar_logistic_op,logistic function,\sa ArrayBase::logistic)
75 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(lgamma,scalar_lgamma_op,natural logarithm of the gamma function,\sa
ArrayBase::lgamma)
76 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(digamma,scalar_digamma_op,derivative of lgamma,\sa
ArrayBase::digamma)
77 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(erf,scalar_erf_op,error function,\sa
ArrayBase::erf)
78 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(erfc,scalar_erfc_op,complement error function,\sa
ArrayBase::erfc)
79 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(ndtri,scalar_ndtri_op,inverse normal distribution function,\sa
ArrayBase::ndtri)
80 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(exp,scalar_exp_op,exponential,\sa
ArrayBase::exp)
81 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(expm1,scalar_expm1_op,exponential of a value minus 1,\sa
ArrayBase::expm1)
82 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(log,scalar_log_op,natural logarithm,\sa
Eigen::log10 DOXCOMMA
ArrayBase::log)
83 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(log1p,scalar_log1p_op,natural logarithm of 1 plus the value,\sa
ArrayBase::log1p)
84 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(log10,scalar_log10_op,base 10 logarithm,\sa
Eigen::log DOXCOMMA
ArrayBase::log10)
85 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(log2,scalar_log2_op,base 2 logarithm,\sa
Eigen::log DOXCOMMA
ArrayBase::log2)
86 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(abs,scalar_abs_op,absolute value,\sa
ArrayBase::abs DOXCOMMA
MatrixBase::cwiseAbs)
87 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(abs2,scalar_abs2_op,squared absolute value,\sa
ArrayBase::abs2 DOXCOMMA
MatrixBase::cwiseAbs2)
88 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(arg,scalar_arg_op,complex argument,\sa
ArrayBase::arg DOXCOMMA
MatrixBase::cwiseArg)
89 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(sqrt,scalar_sqrt_op,square root,\sa
ArrayBase::sqrt DOXCOMMA
MatrixBase::cwiseSqrt)
90 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(rsqrt,scalar_rsqrt_op,reciprocal square root,\sa
ArrayBase::rsqrt)
91 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(square,scalar_square_op,square (power 2),\sa
Eigen::abs2 DOXCOMMA
Eigen::pow DOXCOMMA
ArrayBase::square)
92 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(cube,scalar_cube_op,cube (power 3),\sa
Eigen::pow DOXCOMMA
ArrayBase::cube)
93 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(rint,scalar_rint_op,nearest integer,\sa
Eigen::floor DOXCOMMA
Eigen::ceil DOXCOMMA
ArrayBase::round)
94 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(round,scalar_round_op,nearest integer,\sa
Eigen::floor DOXCOMMA
Eigen::ceil DOXCOMMA
ArrayBase::round)
95 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(floor,scalar_floor_op,nearest integer not greater than the giben value,\sa
Eigen::ceil DOXCOMMA
ArrayBase::floor)
96 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(ceil,scalar_ceil_op,nearest integer not less than the giben value,\sa
Eigen::floor DOXCOMMA
ArrayBase::ceil)
97 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(isnan,scalar_isnan_op,not-a-number test,\sa
Eigen::isinf DOXCOMMA
Eigen::isfinite DOXCOMMA
ArrayBase::isnan)
98 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(isinf,scalar_isinf_op,infinite value test,\sa
Eigen::isnan DOXCOMMA
Eigen::isfinite DOXCOMMA
ArrayBase::isinf)
99 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(isfinite,scalar_isfinite_op,finite value test,\sa
Eigen::isinf DOXCOMMA
Eigen::isnan DOXCOMMA
ArrayBase::isfinite)
100 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY(sign,scalar_sign_op,sign (or 0),\sa
ArrayBase::sign)
110#ifdef EIGEN_PARSED_BY_DOXYGEN
111 template<
typename Derived,
typename ScalarExponent>
115 template <
typename Derived,
typename ScalarExponent>
116 EIGEN_DEVICE_FUNC
inline
117 EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(
118 const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived,
typename internal::promote_scalar_arg<
typename Derived::Scalar
119 EIGEN_COMMA ScalarExponent EIGEN_COMMA
120 EIGEN_SCALAR_BINARY_SUPPORTED(pow,
typename Derived::Scalar,ScalarExponent)>::type,pow))
123 typedef typename internal::promote_scalar_arg<
typename Derived::Scalar,ScalarExponent,
124 EIGEN_SCALAR_BINARY_SUPPORTED(pow,
typename Derived::Scalar,ScalarExponent)>::type PromotedExponent;
125 return EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived,PromotedExponent,pow)(x.
derived(),
141 template<
typename Derived,
typename ExponentDerived>
164#ifdef EIGEN_PARSED_BY_DOXYGEN
165 template<
typename Scalar,
typename Derived>
166 inline const CwiseBinaryOp<internal::scalar_pow_op<Scalar,Derived::Scalar>,Constant<Scalar>,Derived>
169 template <
typename Scalar,
typename Derived>
170 EIGEN_DEVICE_FUNC
inline
171 EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(
172 const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(
typename internal::promote_scalar_arg<
typename Derived::Scalar
173 EIGEN_COMMA Scalar EIGEN_COMMA
174 EIGEN_SCALAR_BINARY_SUPPORTED(pow,Scalar,
typename Derived::Scalar)>::type,Derived,pow))
176 typedef typename internal::promote_scalar_arg<
typename Derived::Scalar,Scalar,
177 EIGEN_SCALAR_BINARY_SUPPORTED(pow,Scalar,
typename Derived::Scalar)>::type PromotedScalar;
178 return EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(PromotedScalar,Derived,pow)(
179 typename internal::plain_constant_type<Derived,PromotedScalar>::type(exponents.
derived().rows(), exponents.
derived().cols(), internal::scalar_constant_op<PromotedScalar>(x)), exponents.
derived());
186 EIGEN_ARRAY_DECLARE_GLOBAL_EIGEN_UNARY(real,scalar_real_op)
187 EIGEN_ARRAY_DECLARE_GLOBAL_EIGEN_UNARY(imag,scalar_imag_op)
188 EIGEN_ARRAY_DECLARE_GLOBAL_EIGEN_UNARY(abs2,scalar_abs2_op)
Base class for all 1D and 2D array, and related expressions.
Definition: ArrayBase.h:41
Generic expression where a coefficient-wise binary operator is applied to two expressions.
Definition: CwiseBinaryOp.h:84
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:61
Derived & derived()
Definition: EigenBase.h:46
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:50
Namespace containing all symbols from the Eigen library.
Definition: Core:141