Teh first one
[mldemos:kalians-mldemos.git] / _AlgorithmsPlugins / KPCA / Eigen / src / plugins / CommonCwiseBinaryOps.h
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 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 // This file is a base class plugin containing common coefficient wise functions.
27
28 /** \returns an expression of the difference of \c *this and \a other
29   *
30   * \note If you want to substract a given scalar from all coefficients, see Cwise::operator-().
31   *
32   * \sa class CwiseBinaryOp, operator-=()
33   */
34 EIGEN_MAKE_CWISE_BINARY_OP(operator-,internal::scalar_difference_op)
35
36 /** \returns an expression of the sum of \c *this and \a other
37   *
38   * \note If you want to add a given scalar to all coefficients, see Cwise::operator+().
39   *
40   * \sa class CwiseBinaryOp, operator+=()
41   */
42 EIGEN_MAKE_CWISE_BINARY_OP(operator+,internal::scalar_sum_op)
43
44 /** \returns an expression of a custom coefficient-wise operator \a func of *this and \a other
45   *
46   * The template parameter \a CustomBinaryOp is the type of the functor
47   * of the custom operator (see class CwiseBinaryOp for an example)
48   *
49   * Here is an example illustrating the use of custom functors:
50   * \include class_CwiseBinaryOp.cpp
51   * Output: \verbinclude class_CwiseBinaryOp.out
52   *
53   * \sa class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()
54   */
55 template<typename CustomBinaryOp, typename OtherDerived>
56 EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived>
57 binaryExpr(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other, const CustomBinaryOp& func = CustomBinaryOp()) const
58 {
59   return CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived>(derived(), other.derived(), func);
60 }
61