111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com pybind11/operator.h: Metatemplates for operator overloading 311986Sandreas.sandberg@arm.com 411986Sandreas.sandberg@arm.com Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> 511986Sandreas.sandberg@arm.com 611986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 711986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 811986Sandreas.sandberg@arm.com*/ 911986Sandreas.sandberg@arm.com 1011986Sandreas.sandberg@arm.com#pragma once 1111986Sandreas.sandberg@arm.com 1211986Sandreas.sandberg@arm.com#include "pybind11.h" 1311986Sandreas.sandberg@arm.com 1411986Sandreas.sandberg@arm.com#if defined(__clang__) && !defined(__INTEL_COMPILER) 1511986Sandreas.sandberg@arm.com# pragma clang diagnostic ignored "-Wunsequenced" // multiple unsequenced modifications to 'self' (when using def(py::self OP Type())) 1612391Sjason@lowepower.com#elif defined(_MSC_VER) 1712391Sjason@lowepower.com# pragma warning(push) 1812391Sjason@lowepower.com# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant 1911986Sandreas.sandberg@arm.com#endif 2011986Sandreas.sandberg@arm.com 2112391Sjason@lowepower.comNAMESPACE_BEGIN(PYBIND11_NAMESPACE) 2211986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 2311986Sandreas.sandberg@arm.com 2411986Sandreas.sandberg@arm.com/// Enumeration with all supported operator types 2511986Sandreas.sandberg@arm.comenum op_id : int { 2611986Sandreas.sandberg@arm.com op_add, op_sub, op_mul, op_div, op_mod, op_divmod, op_pow, op_lshift, 2711986Sandreas.sandberg@arm.com op_rshift, op_and, op_xor, op_or, op_neg, op_pos, op_abs, op_invert, 2811986Sandreas.sandberg@arm.com op_int, op_long, op_float, op_str, op_cmp, op_gt, op_ge, op_lt, op_le, 2911986Sandreas.sandberg@arm.com op_eq, op_ne, op_iadd, op_isub, op_imul, op_idiv, op_imod, op_ilshift, 3011986Sandreas.sandberg@arm.com op_irshift, op_iand, op_ixor, op_ior, op_complex, op_bool, op_nonzero, 3112391Sjason@lowepower.com op_repr, op_truediv, op_itruediv, op_hash 3211986Sandreas.sandberg@arm.com}; 3311986Sandreas.sandberg@arm.com 3411986Sandreas.sandberg@arm.comenum op_type : int { 3511986Sandreas.sandberg@arm.com op_l, /* base type on left */ 3611986Sandreas.sandberg@arm.com op_r, /* base type on right */ 3711986Sandreas.sandberg@arm.com op_u /* unary operator */ 3811986Sandreas.sandberg@arm.com}; 3911986Sandreas.sandberg@arm.com 4011986Sandreas.sandberg@arm.comstruct self_t { }; 4111986Sandreas.sandberg@arm.comstatic const self_t self = self_t(); 4211986Sandreas.sandberg@arm.com 4311986Sandreas.sandberg@arm.com/// Type for an unused type slot 4411986Sandreas.sandberg@arm.comstruct undefined_t { }; 4511986Sandreas.sandberg@arm.com 4611986Sandreas.sandberg@arm.com/// Don't warn about an unused variable 4711986Sandreas.sandberg@arm.cominline self_t __self() { return self; } 4811986Sandreas.sandberg@arm.com 4911986Sandreas.sandberg@arm.com/// base template of operator implementations 5011986Sandreas.sandberg@arm.comtemplate <op_id, op_type, typename B, typename L, typename R> struct op_impl { }; 5111986Sandreas.sandberg@arm.com 5211986Sandreas.sandberg@arm.com/// Operator implementation generator 5311986Sandreas.sandberg@arm.comtemplate <op_id id, op_type ot, typename L, typename R> struct op_ { 5411986Sandreas.sandberg@arm.com template <typename Class, typename... Extra> void execute(Class &cl, const Extra&... extra) const { 5512391Sjason@lowepower.com using Base = typename Class::type; 5612391Sjason@lowepower.com using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; 5712391Sjason@lowepower.com using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; 5812391Sjason@lowepower.com using op = op_impl<id, ot, Base, L_type, R_type>; 5911986Sandreas.sandberg@arm.com cl.def(op::name(), &op::execute, is_operator(), extra...); 6012391Sjason@lowepower.com #if PY_MAJOR_VERSION < 3 6112391Sjason@lowepower.com if (id == op_truediv || id == op_itruediv) 6212391Sjason@lowepower.com cl.def(id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", 6312391Sjason@lowepower.com &op::execute, is_operator(), extra...); 6412391Sjason@lowepower.com #endif 6511986Sandreas.sandberg@arm.com } 6611986Sandreas.sandberg@arm.com template <typename Class, typename... Extra> void execute_cast(Class &cl, const Extra&... extra) const { 6712391Sjason@lowepower.com using Base = typename Class::type; 6812391Sjason@lowepower.com using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; 6912391Sjason@lowepower.com using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; 7012391Sjason@lowepower.com using op = op_impl<id, ot, Base, L_type, R_type>; 7111986Sandreas.sandberg@arm.com cl.def(op::name(), &op::execute_cast, is_operator(), extra...); 7212391Sjason@lowepower.com #if PY_MAJOR_VERSION < 3 7312391Sjason@lowepower.com if (id == op_truediv || id == op_itruediv) 7412391Sjason@lowepower.com cl.def(id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", 7512391Sjason@lowepower.com &op::execute, is_operator(), extra...); 7612391Sjason@lowepower.com #endif 7711986Sandreas.sandberg@arm.com } 7811986Sandreas.sandberg@arm.com}; 7911986Sandreas.sandberg@arm.com 8012391Sjason@lowepower.com#define PYBIND11_BINARY_OPERATOR(id, rid, op, expr) \ 8111986Sandreas.sandberg@arm.comtemplate <typename B, typename L, typename R> struct op_impl<op_##id, op_l, B, L, R> { \ 8211986Sandreas.sandberg@arm.com static char const* name() { return "__" #id "__"; } \ 8311986Sandreas.sandberg@arm.com static auto execute(const L &l, const R &r) -> decltype(expr) { return (expr); } \ 8411986Sandreas.sandberg@arm.com static B execute_cast(const L &l, const R &r) { return B(expr); } \ 8511986Sandreas.sandberg@arm.com}; \ 8611986Sandreas.sandberg@arm.comtemplate <typename B, typename L, typename R> struct op_impl<op_##id, op_r, B, L, R> { \ 8711986Sandreas.sandberg@arm.com static char const* name() { return "__" #rid "__"; } \ 8811986Sandreas.sandberg@arm.com static auto execute(const R &r, const L &l) -> decltype(expr) { return (expr); } \ 8911986Sandreas.sandberg@arm.com static B execute_cast(const R &r, const L &l) { return B(expr); } \ 9011986Sandreas.sandberg@arm.com}; \ 9111986Sandreas.sandberg@arm.cominline op_<op_##id, op_l, self_t, self_t> op(const self_t &, const self_t &) { \ 9211986Sandreas.sandberg@arm.com return op_<op_##id, op_l, self_t, self_t>(); \ 9311986Sandreas.sandberg@arm.com} \ 9411986Sandreas.sandberg@arm.comtemplate <typename T> op_<op_##id, op_l, self_t, T> op(const self_t &, const T &) { \ 9511986Sandreas.sandberg@arm.com return op_<op_##id, op_l, self_t, T>(); \ 9611986Sandreas.sandberg@arm.com} \ 9711986Sandreas.sandberg@arm.comtemplate <typename T> op_<op_##id, op_r, T, self_t> op(const T &, const self_t &) { \ 9811986Sandreas.sandberg@arm.com return op_<op_##id, op_r, T, self_t>(); \ 9911986Sandreas.sandberg@arm.com} 10011986Sandreas.sandberg@arm.com 10112391Sjason@lowepower.com#define PYBIND11_INPLACE_OPERATOR(id, op, expr) \ 10211986Sandreas.sandberg@arm.comtemplate <typename B, typename L, typename R> struct op_impl<op_##id, op_l, B, L, R> { \ 10311986Sandreas.sandberg@arm.com static char const* name() { return "__" #id "__"; } \ 10411986Sandreas.sandberg@arm.com static auto execute(L &l, const R &r) -> decltype(expr) { return expr; } \ 10511986Sandreas.sandberg@arm.com static B execute_cast(L &l, const R &r) { return B(expr); } \ 10611986Sandreas.sandberg@arm.com}; \ 10711986Sandreas.sandberg@arm.comtemplate <typename T> op_<op_##id, op_l, self_t, T> op(const self_t &, const T &) { \ 10811986Sandreas.sandberg@arm.com return op_<op_##id, op_l, self_t, T>(); \ 10911986Sandreas.sandberg@arm.com} 11011986Sandreas.sandberg@arm.com 11112391Sjason@lowepower.com#define PYBIND11_UNARY_OPERATOR(id, op, expr) \ 11211986Sandreas.sandberg@arm.comtemplate <typename B, typename L> struct op_impl<op_##id, op_u, B, L, undefined_t> { \ 11311986Sandreas.sandberg@arm.com static char const* name() { return "__" #id "__"; } \ 11411986Sandreas.sandberg@arm.com static auto execute(const L &l) -> decltype(expr) { return expr; } \ 11511986Sandreas.sandberg@arm.com static B execute_cast(const L &l) { return B(expr); } \ 11611986Sandreas.sandberg@arm.com}; \ 11711986Sandreas.sandberg@arm.cominline op_<op_##id, op_u, self_t, undefined_t> op(const self_t &) { \ 11811986Sandreas.sandberg@arm.com return op_<op_##id, op_u, self_t, undefined_t>(); \ 11911986Sandreas.sandberg@arm.com} 12011986Sandreas.sandberg@arm.com 12111986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(sub, rsub, operator-, l - r) 12211986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(add, radd, operator+, l + r) 12311986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(mul, rmul, operator*, l * r) 12411986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(truediv, rtruediv, operator/, l / r) 12511986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(mod, rmod, operator%, l % r) 12611986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(lshift, rlshift, operator<<, l << r) 12711986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(rshift, rrshift, operator>>, l >> r) 12811986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(and, rand, operator&, l & r) 12911986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(xor, rxor, operator^, l ^ r) 13011986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(eq, eq, operator==, l == r) 13111986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(ne, ne, operator!=, l != r) 13211986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(or, ror, operator|, l | r) 13311986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(gt, lt, operator>, l > r) 13411986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(ge, le, operator>=, l >= r) 13511986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(lt, gt, operator<, l < r) 13611986Sandreas.sandberg@arm.comPYBIND11_BINARY_OPERATOR(le, ge, operator<=, l <= r) 13711986Sandreas.sandberg@arm.com//PYBIND11_BINARY_OPERATOR(pow, rpow, pow, std::pow(l, r)) 13811986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(iadd, operator+=, l += r) 13911986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(isub, operator-=, l -= r) 14011986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(imul, operator*=, l *= r) 14112391Sjason@lowepower.comPYBIND11_INPLACE_OPERATOR(itruediv, operator/=, l /= r) 14211986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(imod, operator%=, l %= r) 14311986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(ilshift, operator<<=, l <<= r) 14411986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(irshift, operator>>=, l >>= r) 14511986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(iand, operator&=, l &= r) 14611986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(ixor, operator^=, l ^= r) 14711986Sandreas.sandberg@arm.comPYBIND11_INPLACE_OPERATOR(ior, operator|=, l |= r) 14811986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(neg, operator-, -l) 14911986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(pos, operator+, +l) 15011986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(abs, abs, std::abs(l)) 15112391Sjason@lowepower.comPYBIND11_UNARY_OPERATOR(hash, hash, std::hash<L>()(l)) 15211986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(invert, operator~, (~l)) 15311986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(bool, operator!, !!l) 15411986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(int, int_, (int) l) 15511986Sandreas.sandberg@arm.comPYBIND11_UNARY_OPERATOR(float, float_, (double) l) 15611986Sandreas.sandberg@arm.com 15711986Sandreas.sandberg@arm.com#undef PYBIND11_BINARY_OPERATOR 15811986Sandreas.sandberg@arm.com#undef PYBIND11_INPLACE_OPERATOR 15911986Sandreas.sandberg@arm.com#undef PYBIND11_UNARY_OPERATOR 16011986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 16111986Sandreas.sandberg@arm.com 16211986Sandreas.sandberg@arm.comusing detail::self; 16311986Sandreas.sandberg@arm.com 16412391Sjason@lowepower.comNAMESPACE_END(PYBIND11_NAMESPACE) 16512391Sjason@lowepower.com 16612391Sjason@lowepower.com#if defined(_MSC_VER) 16712391Sjason@lowepower.com# pragma warning(pop) 16812391Sjason@lowepower.com#endif 169