source: pacpussensors/trunk/Vislab/lib3dv/eigen/Eigen/src/plugins/MatrixCwiseUnaryOps.h@ 136

Last change on this file since 136 was 136, checked in by ldecherf, 7 years ago

Doc

File size: 1.8 KB
Line 
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11// This file is a base class plugin containing matrix specifics coefficient wise functions.
12
13/** \returns an expression of the coefficient-wise absolute value of \c *this
14 *
15 * Example: \include MatrixBase_cwiseAbs.cpp
16 * Output: \verbinclude MatrixBase_cwiseAbs.out
17 *
18 * \sa cwiseAbs2()
19 */
20EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived>
21cwiseAbs() const { return derived(); }
22
23/** \returns an expression of the coefficient-wise squared absolute value of \c *this
24 *
25 * Example: \include MatrixBase_cwiseAbs2.cpp
26 * Output: \verbinclude MatrixBase_cwiseAbs2.out
27 *
28 * \sa cwiseAbs()
29 */
30EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived>
31cwiseAbs2() const { return derived(); }
32
33/** \returns an expression of the coefficient-wise square root of *this.
34 *
35 * Example: \include MatrixBase_cwiseSqrt.cpp
36 * Output: \verbinclude MatrixBase_cwiseSqrt.out
37 *
38 * \sa cwisePow(), cwiseSquare()
39 */
40inline const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived>
41cwiseSqrt() const { return derived(); }
42
43/** \returns an expression of the coefficient-wise inverse of *this.
44 *
45 * Example: \include MatrixBase_cwiseInverse.cpp
46 * Output: \verbinclude MatrixBase_cwiseInverse.out
47 *
48 * \sa cwiseProduct()
49 */
50inline const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived>
51cwiseInverse() const { return derived(); }
52
Note: See TracBrowser for help on using the repository browser.