Michael Ernst Peter / Eigen

src/plugins/ArrayCwiseUnaryOps.h@0:13a5d365ba16, 2016-10-13 (annotated)

Committer:
ykuroda
Date:
Thu Oct 13 04:07:23 2016 +0000
Revision:
0:13a5d365ba16
First commint, Eigne Matrix Class Library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ykuroda 0:13a5d365ba16 1
ykuroda 0:13a5d365ba16 2
ykuroda 0:13a5d365ba16 3 /** \returns an expression of the coefficient-wise absolute value of \c *this
ykuroda 0:13a5d365ba16 4 *
ykuroda 0:13a5d365ba16 5 * Example: \include Cwise_abs.cpp
ykuroda 0:13a5d365ba16 6 * Output: \verbinclude Cwise_abs.out
ykuroda 0:13a5d365ba16 7 *
ykuroda 0:13a5d365ba16 8 * \sa abs2()
ykuroda 0:13a5d365ba16 9 */
ykuroda 0:13a5d365ba16 10 EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 11 abs() const
ykuroda 0:13a5d365ba16 12 {
ykuroda 0:13a5d365ba16 13 return derived();
ykuroda 0:13a5d365ba16 14 }
ykuroda 0:13a5d365ba16 15
ykuroda 0:13a5d365ba16 16 /** \returns an expression of the coefficient-wise squared absolute value of \c *this
ykuroda 0:13a5d365ba16 17 *
ykuroda 0:13a5d365ba16 18 * Example: \include Cwise_abs2.cpp
ykuroda 0:13a5d365ba16 19 * Output: \verbinclude Cwise_abs2.out
ykuroda 0:13a5d365ba16 20 *
ykuroda 0:13a5d365ba16 21 * \sa abs(), square()
ykuroda 0:13a5d365ba16 22 */
ykuroda 0:13a5d365ba16 23 EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 24 abs2() const
ykuroda 0:13a5d365ba16 25 {
ykuroda 0:13a5d365ba16 26 return derived();
ykuroda 0:13a5d365ba16 27 }
ykuroda 0:13a5d365ba16 28
ykuroda 0:13a5d365ba16 29 /** \returns an expression of the coefficient-wise exponential of *this.
ykuroda 0:13a5d365ba16 30 *
ykuroda 0:13a5d365ba16 31 * Example: \include Cwise_exp.cpp
ykuroda 0:13a5d365ba16 32 * Output: \verbinclude Cwise_exp.out
ykuroda 0:13a5d365ba16 33 *
ykuroda 0:13a5d365ba16 34 * \sa pow(), log(), sin(), cos()
ykuroda 0:13a5d365ba16 35 */
ykuroda 0:13a5d365ba16 36 inline const CwiseUnaryOp<internal::scalar_exp_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 37 exp() const
ykuroda 0:13a5d365ba16 38 {
ykuroda 0:13a5d365ba16 39 return derived();
ykuroda 0:13a5d365ba16 40 }
ykuroda 0:13a5d365ba16 41
ykuroda 0:13a5d365ba16 42 /** \returns an expression of the coefficient-wise logarithm of *this.
ykuroda 0:13a5d365ba16 43 *
ykuroda 0:13a5d365ba16 44 * Example: \include Cwise_log.cpp
ykuroda 0:13a5d365ba16 45 * Output: \verbinclude Cwise_log.out
ykuroda 0:13a5d365ba16 46 *
ykuroda 0:13a5d365ba16 47 * \sa exp()
ykuroda 0:13a5d365ba16 48 */
ykuroda 0:13a5d365ba16 49 inline const CwiseUnaryOp<internal::scalar_log_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 50 log() const
ykuroda 0:13a5d365ba16 51 {
ykuroda 0:13a5d365ba16 52 return derived();
ykuroda 0:13a5d365ba16 53 }
ykuroda 0:13a5d365ba16 54
ykuroda 0:13a5d365ba16 55 /** \returns an expression of the coefficient-wise square root of *this.
ykuroda 0:13a5d365ba16 56 *
ykuroda 0:13a5d365ba16 57 * Example: \include Cwise_sqrt.cpp
ykuroda 0:13a5d365ba16 58 * Output: \verbinclude Cwise_sqrt.out
ykuroda 0:13a5d365ba16 59 *
ykuroda 0:13a5d365ba16 60 * \sa pow(), square()
ykuroda 0:13a5d365ba16 61 */
ykuroda 0:13a5d365ba16 62 inline const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 63 sqrt() const
ykuroda 0:13a5d365ba16 64 {
ykuroda 0:13a5d365ba16 65 return derived();
ykuroda 0:13a5d365ba16 66 }
ykuroda 0:13a5d365ba16 67
ykuroda 0:13a5d365ba16 68 /** \returns an expression of the coefficient-wise cosine of *this.
ykuroda 0:13a5d365ba16 69 *
ykuroda 0:13a5d365ba16 70 * Example: \include Cwise_cos.cpp
ykuroda 0:13a5d365ba16 71 * Output: \verbinclude Cwise_cos.out
ykuroda 0:13a5d365ba16 72 *
ykuroda 0:13a5d365ba16 73 * \sa sin(), acos()
ykuroda 0:13a5d365ba16 74 */
ykuroda 0:13a5d365ba16 75 inline const CwiseUnaryOp<internal::scalar_cos_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 76 cos() const
ykuroda 0:13a5d365ba16 77 {
ykuroda 0:13a5d365ba16 78 return derived();
ykuroda 0:13a5d365ba16 79 }
ykuroda 0:13a5d365ba16 80
ykuroda 0:13a5d365ba16 81
ykuroda 0:13a5d365ba16 82 /** \returns an expression of the coefficient-wise sine of *this.
ykuroda 0:13a5d365ba16 83 *
ykuroda 0:13a5d365ba16 84 * Example: \include Cwise_sin.cpp
ykuroda 0:13a5d365ba16 85 * Output: \verbinclude Cwise_sin.out
ykuroda 0:13a5d365ba16 86 *
ykuroda 0:13a5d365ba16 87 * \sa cos(), asin()
ykuroda 0:13a5d365ba16 88 */
ykuroda 0:13a5d365ba16 89 inline const CwiseUnaryOp<internal::scalar_sin_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 90 sin() const
ykuroda 0:13a5d365ba16 91 {
ykuroda 0:13a5d365ba16 92 return derived();
ykuroda 0:13a5d365ba16 93 }
ykuroda 0:13a5d365ba16 94
ykuroda 0:13a5d365ba16 95 /** \returns an expression of the coefficient-wise arc cosine of *this.
ykuroda 0:13a5d365ba16 96 *
ykuroda 0:13a5d365ba16 97 * Example: \include Cwise_acos.cpp
ykuroda 0:13a5d365ba16 98 * Output: \verbinclude Cwise_acos.out
ykuroda 0:13a5d365ba16 99 *
ykuroda 0:13a5d365ba16 100 * \sa cos(), asin()
ykuroda 0:13a5d365ba16 101 */
ykuroda 0:13a5d365ba16 102 inline const CwiseUnaryOp<internal::scalar_acos_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 103 acos() const
ykuroda 0:13a5d365ba16 104 {
ykuroda 0:13a5d365ba16 105 return derived();
ykuroda 0:13a5d365ba16 106 }
ykuroda 0:13a5d365ba16 107
ykuroda 0:13a5d365ba16 108 /** \returns an expression of the coefficient-wise arc sine of *this.
ykuroda 0:13a5d365ba16 109 *
ykuroda 0:13a5d365ba16 110 * Example: \include Cwise_asin.cpp
ykuroda 0:13a5d365ba16 111 * Output: \verbinclude Cwise_asin.out
ykuroda 0:13a5d365ba16 112 *
ykuroda 0:13a5d365ba16 113 * \sa sin(), acos()
ykuroda 0:13a5d365ba16 114 */
ykuroda 0:13a5d365ba16 115 inline const CwiseUnaryOp<internal::scalar_asin_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 116 asin() const
ykuroda 0:13a5d365ba16 117 {
ykuroda 0:13a5d365ba16 118 return derived();
ykuroda 0:13a5d365ba16 119 }
ykuroda 0:13a5d365ba16 120
ykuroda 0:13a5d365ba16 121 /** \returns an expression of the coefficient-wise tan of *this.
ykuroda 0:13a5d365ba16 122 *
ykuroda 0:13a5d365ba16 123 * Example: \include Cwise_tan.cpp
ykuroda 0:13a5d365ba16 124 * Output: \verbinclude Cwise_tan.out
ykuroda 0:13a5d365ba16 125 *
ykuroda 0:13a5d365ba16 126 * \sa cos(), sin()
ykuroda 0:13a5d365ba16 127 */
ykuroda 0:13a5d365ba16 128 inline const CwiseUnaryOp<internal::scalar_tan_op<Scalar>, Derived>
ykuroda 0:13a5d365ba16 129 tan() const
ykuroda 0:13a5d365ba16 130 {
ykuroda 0:13a5d365ba16 131 return derived();
ykuroda 0:13a5d365ba16 132 }
ykuroda 0:13a5d365ba16 133
ykuroda 0:13a5d365ba16 134
ykuroda 0:13a5d365ba16 135 /** \returns an expression of the coefficient-wise power of *this to the given exponent.
ykuroda 0:13a5d365ba16 136 *
ykuroda 0:13a5d365ba16 137 * Example: \include Cwise_pow.cpp
ykuroda 0:13a5d365ba16 138 * Output: \verbinclude Cwise_pow.out
ykuroda 0:13a5d365ba16 139 *
ykuroda 0:13a5d365ba16 140 * \sa exp(), log()
ykuroda 0:13a5d365ba16 141 */
ykuroda 0:13a5d365ba16 142 inline const CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 143 pow(const Scalar& exponent) const
ykuroda 0:13a5d365ba16 144 {
ykuroda 0:13a5d365ba16 145 return CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 146 (derived(), internal::scalar_pow_op<Scalar>(exponent));
ykuroda 0:13a5d365ba16 147 }
ykuroda 0:13a5d365ba16 148
ykuroda 0:13a5d365ba16 149
ykuroda 0:13a5d365ba16 150 /** \returns an expression of the coefficient-wise inverse of *this.
ykuroda 0:13a5d365ba16 151 *
ykuroda 0:13a5d365ba16 152 * Example: \include Cwise_inverse.cpp
ykuroda 0:13a5d365ba16 153 * Output: \verbinclude Cwise_inverse.out
ykuroda 0:13a5d365ba16 154 *
ykuroda 0:13a5d365ba16 155 * \sa operator/(), operator*()
ykuroda 0:13a5d365ba16 156 */
ykuroda 0:13a5d365ba16 157 inline const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 158 inverse() const
ykuroda 0:13a5d365ba16 159 {
ykuroda 0:13a5d365ba16 160 return derived();
ykuroda 0:13a5d365ba16 161 }
ykuroda 0:13a5d365ba16 162
ykuroda 0:13a5d365ba16 163 /** \returns an expression of the coefficient-wise square of *this.
ykuroda 0:13a5d365ba16 164 *
ykuroda 0:13a5d365ba16 165 * Example: \include Cwise_square.cpp
ykuroda 0:13a5d365ba16 166 * Output: \verbinclude Cwise_square.out
ykuroda 0:13a5d365ba16 167 *
ykuroda 0:13a5d365ba16 168 * \sa operator/(), operator*(), abs2()
ykuroda 0:13a5d365ba16 169 */
ykuroda 0:13a5d365ba16 170 inline const CwiseUnaryOp<internal::scalar_square_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 171 square() const
ykuroda 0:13a5d365ba16 172 {
ykuroda 0:13a5d365ba16 173 return derived();
ykuroda 0:13a5d365ba16 174 }
ykuroda 0:13a5d365ba16 175
ykuroda 0:13a5d365ba16 176 /** \returns an expression of the coefficient-wise cube of *this.
ykuroda 0:13a5d365ba16 177 *
ykuroda 0:13a5d365ba16 178 * Example: \include Cwise_cube.cpp
ykuroda 0:13a5d365ba16 179 * Output: \verbinclude Cwise_cube.out
ykuroda 0:13a5d365ba16 180 *
ykuroda 0:13a5d365ba16 181 * \sa square(), pow()
ykuroda 0:13a5d365ba16 182 */
ykuroda 0:13a5d365ba16 183 inline const CwiseUnaryOp<internal::scalar_cube_op<Scalar>, const Derived>
ykuroda 0:13a5d365ba16 184 cube() const
ykuroda 0:13a5d365ba16 185 {
ykuroda 0:13a5d365ba16 186 return derived();
ykuroda 0:13a5d365ba16 187 }