CommonCwiseBinaryOps.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

---

Function Documentation

template<typename CustomBinaryOp , typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> binaryExpr	(	const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &	other,
		const CustomBinaryOp &	func = CustomBinaryOp()
	)		const

Returns:

an expression of the difference of *this and other

Note:

If you want to substract a given scalar from all coefficients, see Cwise::operator-().

See also:

class CwiseBinaryOp, operator-=()

Returns:

an expression of the sum of *this and other

Note:

If you want to add a given scalar to all coefficients, see Cwise::operator+().

See also:

class CwiseBinaryOp, operator+=()

Returns:

an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template binary functor
template<typename Scalar> struct MakeComplexOp {
  EIGEN_EMPTY_STRUCT_CTOR(MakeComplexOp)
  typedef complex<Scalar> result_type;
  complex<Scalar> operator()(const Scalar& a, const Scalar& b) const { return complex<Scalar>(a,b); }
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random(), m2 = Matrix4d::Random();
  cout << m1.binaryExpr(m2, MakeComplexOp<double>()) << endl;
  return 0;
}

Output:

See also:

class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 57 of file CommonCwiseBinaryOps.h.