#------------------------------------------------------------------------------------------#
# This file is part of Pyccel which is released under MIT License. See the LICENSE file or #
# go to https://github.com/pyccel/pyccel/blob/devel/LICENSE for full license details. #
#------------------------------------------------------------------------------------------#
"""
Module handling all Python builtin operators
These operators all have a precision as detailed here:
https://docs.python.org/3/reference/expressions.html#operator-precedence
They also have specific rules to determine the datatype, rank, shape
"""
from packaging.version import Version
import numpy
from .builtins import DtypePrecisionToCastFunction
from .datatypes import PrimitiveBooleanType, PrimitiveIntegerType
from .datatypes import PythonNativeInt
from .operators import PyccelUnaryOperator, PyccelBinaryOperator
from .numpytypes import NumpyInt8Type
numpy_v1 = Version(numpy.__version__) < Version("2.0.0")
__all__ = (
'PyccelBitAnd',
'PyccelBitComparisonOperator',
'PyccelBitOperator',
'PyccelBitOr',
'PyccelBitXor',
'PyccelInvert',
'PyccelLShift',
'PyccelRShift',
)
#==============================================================================
[docs]
class PyccelInvert(PyccelUnaryOperator):
"""
Class representing a call to the Python bitwise not operator.
Class representing a call to the Python bitwise not operator.
I.e:
~a
is equivalent to:
>>> PyccelInvert(a)
Parameters
----------
arg : TypedAstNode
The argument passed to the operator.
"""
__slots__ = ()
_precedence = 14
def _calculate_type(self, arg):
"""
Get the type of the result of the function.
Arguments must be integers or booleans. Any booleans are cast
to integers.
Parameters
----------
arg : TypedAstNode
The argument passed to the operator.
Returns
-------
DataType
The datatype of the result of the operation.
"""
if arg.class_type.rank:
class_type = arg.class_type
else:
class_type = arg.class_type.switch_basic_type(PythonNativeInt())
assert isinstance(getattr(arg.dtype, 'primitive_type', None), (PrimitiveBooleanType, PrimitiveIntegerType))
cast = DtypePrecisionToCastFunction[getattr(class_type, 'element_type', class_type)]
self._args = (cast(arg) if arg.dtype is not class_type else arg,)
return class_type
def __repr__(self):
return f'~{repr(self.args[0])}'
#==============================================================================
[docs]
class PyccelBitOperator(PyccelBinaryOperator):
"""
Abstract superclass representing a Python bitwise operator with two arguments.
Abstract superclass representing a Python bitwise operator with two arguments.
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
def __init__(self, arg1, arg2):
super().__init__(arg1, arg2)
def _set_order(self):
pass
def _calculate_type(self, arg1, arg2):
"""
Get the type of the result of the function.
If one argument is a string then all arguments must be strings.
If the arguments are numeric then the datatype
matches the broadest type.
e.g.
1 + 2j -> PyccelAdd(LiteralInteger, LiteralComplex) -> complex
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
Returns
-------
DataType
The datatype of the result of the operation.
"""
class_type = arg1.class_type + arg2.class_type
if isinstance(getattr(class_type, 'primitive_type', None), PrimitiveBooleanType):
assert class_type.rank > 0
class_type = class_type.switch_basic_type(NumpyInt8Type())
cast = DtypePrecisionToCastFunction[getattr(class_type, 'element_type', class_type)]
self._args = [cast(a) if a.dtype is not class_type else a for a in (arg1, arg2)]
return class_type
def __repr__(self):
return f'{self.args[0]} {self.op} {self.args[1]}' # pylint: disable=no-member
#==============================================================================
[docs]
class PyccelRShift(PyccelBitOperator):
"""
Class representing a call to the Python right shift operator.
Class representing a call to the Python right shift operator.
I.e:
a >> b
is equivalent to:
>>> PyccelRShift(a, b)
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
_precedence = 11
op = ">>"
#==============================================================================
[docs]
class PyccelLShift(PyccelBitOperator):
"""
Class representing a call to the Python right shift operator.
Class representing a call to the Python right shift operator.
I.e:
a << b
is equivalent to:
>>> PyccelRShift(a, b)
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
_precedence = 11
op = "<<"
#==============================================================================
[docs]
class PyccelBitComparisonOperator(PyccelBitOperator):
"""
Abstract superclass representing a bitwise comparison operator.
Abstract superclass representing a Python bitwise comparison
operator with two arguments
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
def _calculate_type(self, arg1, arg2):
"""
Get the type of the result of the function.
If one argument is a string then all arguments must be strings.
If the arguments are numeric then the dtype
matches the broadest type.
e.g.
1 + 2j -> PyccelAdd(LiteralInteger, LiteralComplex) -> complex
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
Returns
-------
DataType
The datatype of the result of the operation.
"""
class_type = None
if numpy_v1:
if arg1.rank > 0 and arg2.rank == 0:
class_type = arg1.class_type.switch_basic_type(arg2.class_type) \
if isinstance(arg1.class_type.primitive_type, PrimitiveBooleanType) \
else arg1.class_type
elif arg1.rank == 0 and arg2.rank > 0:
class_type = arg2.class_type.switch_basic_type(arg1.class_type) \
if isinstance(arg2.class_type.primitive_type, PrimitiveBooleanType) \
else arg2.class_type
if class_type is None:
try:
class_type = arg1.class_type & arg2.class_type
except NotImplementedError as err:
raise TypeError(f'Cannot determine the type of {arg1} {self.op} {arg2}') from err # pylint: disable=no-member
primitive_type = class_type.primitive_type
assert isinstance(primitive_type, (PrimitiveBooleanType, PrimitiveIntegerType))
cast = DtypePrecisionToCastFunction[getattr(class_type, 'element_type', class_type)]
self._args = [cast(a) if a.dtype is not class_type else a for a in (arg1, arg2)]
return class_type
#==============================================================================
[docs]
class PyccelBitXor(PyccelBitComparisonOperator):
"""
Class representing a call to the Python bitwise XOR operator.
Class representing a call to the Python bitwise XOR operator.
I.e:
a ^ b
is equivalent to:
>>> PyccelBitXor(a, b)
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
_precedence = 9
op = "^"
#==============================================================================
[docs]
class PyccelBitOr(PyccelBitComparisonOperator):
"""
Class representing a call to the Python bitwise OR operator.
Class representing a call to the Python bitwise OR operator.
I.e:
a | b
is equivalent to:
>>> PyccelBitOr(a, b)
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
_precedence = 8
op = "|"
#==============================================================================
[docs]
class PyccelBitAnd(PyccelBitComparisonOperator):
"""
Class representing a call to the Python bitwise AND operator.
Class representing a call to the Python bitwise AND operator.
I.e:
a & b
is equivalent to:
>>> PyccelBitAnd(a, b)
Parameters
----------
arg1 : TypedAstNode
The first argument passed to the operator.
arg2 : TypedAstNode
The second argument passed to the operator.
"""
__slots__ = ()
_precedence = 10
op = "&"
