Determines whether the given binary operation of two numeric types is allowed and what the scalar return type is.
This class permits to control the scalar return type of any binary operation performed on two different scalar types through (partial) template specializations.
For instance, let U1
, U2
and U3
be three user defined scalar types for which most operations between instances of U1
and U2
returns an U3
. You can let Eigen knows that by defining:
template<typename BinaryOp> struct ScalarBinaryOpTraits<U1,U2,BinaryOp> { typedef U3 ReturnType; }; template<typename BinaryOp> struct ScalarBinaryOpTraits<U2,U1,BinaryOp> { typedef U3 ReturnType; };
You can then explicitly disable some particular operations to get more explicit error messages:
template<> struct ScalarBinaryOpTraits<U1,U2,internal::scalar_max_op<U1,U2> > {};
Or customize the return type for individual operation:
template<> struct ScalarBinaryOpTraits<U1,U2,internal::scalar_sum_op<U1,U2> > { typedef U1 ReturnType; };
By default, the following generic combinations are supported:
ScalarA | ScalarB | BinaryOp | ReturnType | Note |
---|---|---|---|---|
T |
T |
* |
T |
|
NumTraits<T>::Real |
T |
* |
T |
Only if NumTraits<T>::IsComplex |
T |
NumTraits<T>::Real |
* |
T |
Only if NumTraits<T>::IsComplex |
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/structEigen_1_1ScalarBinaryOpTraits.html