Inheritance diagram for psyclone.domain.nemo.transformations.nemo_outerarrayrange2loop_trans.NemoOuterArrayRange2LoopTrans:

[legend]

Collaboration diagram for psyclone.domain.nemo.transformations.nemo_outerarrayrange2loop_trans.NemoOuterArrayRange2LoopTrans:

[legend]

Public Member Functions
def	apply (self, node, options=None)

def	__str__ (self)

def	name (self)

def	validate (self, node, options=None)

Detailed Description

Provides a transformation from the outermost PSyIR ArrayReference
Range to a PSyIR Loop. For example:

>>> from psyclone.parse.algorithm import parse
>>> from psyclone.psyGen import PSyFactory
>>> api = "nemo"
>>> filename = "tra_adv.F90" # examples/nemo/code
>>> ast, invoke_info = parse(filename, api=api)
>>> psy = PSyFactory(api).create(invoke_info)
>>> schedule = psy.invokes.invoke_list[0].schedule
>>>
>>> from psyclone.psyir.nodes import Assignment
>>> from psyclone.domain.nemo.transformations import \
        NemoOuterArrayRange2LoopTrans
>>> from psyclone.transformations import TransformationError
>>>
>>> print(schedule.view())
>>> trans = NemoOuterArrayRange2LoopTrans()
>>> for assignment in schedule.walk(Assignment):
>>>     while True:
>>>         try:
>>>             trans.apply(assignment)
>>>         except TransformationError:
>>>             break
>>> print(schedule.view())

Definition at line 56 of file nemo_outerarrayrange2loop_trans.py.

Member Function Documentation

◆ apply()

def psyclone.domain.nemo.transformations.nemo_outerarrayrange2loop_trans.NemoOuterArrayRange2LoopTrans.apply	(	self,
		node,
		options = `None`
	)

Apply the NemoOuterArrayRange2Loop transformation to the specified
node if the node is an Assignment and the left-hand-side of
the assignment is an Array Reference containing at least one
Range node specifying an access to an array index. If this is
the case then the outermost Range nodes within array
references within the assignment are replaced with references
to a loop index. A loop (with the same loop index) is
also placed around the modified assignment statement.

The name of the loop index is taken from the PSyclone
configuration file if a name exists for the particular array
index, otherwise a new name is generated. The bounds of the
loop are taken from the Range node if they are provided. If
not, the loop bounds are taken from the PSyclone configuration
file if bounds values are supplied. If not, the LBOUND or
UBOUND intrinsics are used as appropriate.

:param node: an Assignment node.
:type node: :py:class:`psyclone.psyir.nodes.Assignment`
:param options: a dictionary with options for \
    transformations. No options are used in this \
    transformation. This is an optional argument that defaults \
    to None.
:type options: Optional[Dict[str, Any]]
:param bool options["allow_string"]: whether to allow the
    transformation on a character type array range. Defaults to False.

Definition at line 84 of file nemo_outerarrayrange2loop_trans.py.

     def apply(self, node, options=None):
         '''Apply the NemoOuterArrayRange2Loop transformation to the specified
         node if the node is an Assignment and the left-hand-side of
         the assignment is an Array Reference containing at least one
         Range node specifying an access to an array index. If this is
         the case then the outermost Range nodes within array
         references within the assignment are replaced with references
         to a loop index. A loop (with the same loop index) is
         also placed around the modified assignment statement.
  
         The name of the loop index is taken from the PSyclone
         configuration file if a name exists for the particular array
         index, otherwise a new name is generated. The bounds of the
         loop are taken from the Range node if they are provided. If
         not, the loop bounds are taken from the PSyclone configuration
         file if bounds values are supplied. If not, the LBOUND or
         UBOUND intrinsics are used as appropriate.
  
         :param node: an Assignment node.
         :type node: :py:class:`psyclone.psyir.nodes.Assignment`
         :param options: a dictionary with options for \
             transformations. No options are used in this \
             transformation. This is an optional argument that defaults \
             to None.
         :type options: Optional[Dict[str, Any]]
         :param bool options["allow_string"]: whether to allow the
             transformation on a character type array range. Defaults to False.
  
         '''
         self.validate(node, options)
  
         # Get deepest array in LHS (excluding inside Ranges)
         deepest_range = node.lhs.walk(Range, stop_type=Range)[-1]
         lhs_array_ref = deepest_range.parent
         index = lhs_array_ref.get_outer_range_index()
         nemo_arrayrange2loop = NemoArrayRange2LoopTrans()
         nemo_arrayrange2loop.apply(lhs_array_ref.children[index], options)
  

Here is the call graph for this function:

◆ name()

def psyclone.domain.nemo.transformations.nemo_outerarrayrange2loop_trans.NemoOuterArrayRange2LoopTrans.name ( self )

:returns: the name of the transformation.
:rtype: str

Definition at line 127 of file nemo_outerarrayrange2loop_trans.py.

     def name(self):
         '''
         :returns: the name of the transformation.
         :rtype: str
  
         '''
         return type(self).__name__
  

Here is the caller graph for this function:

◆ validate()

def psyclone.domain.nemo.transformations.nemo_outerarrayrange2loop_trans.NemoOuterArrayRange2LoopTrans.validate	(	self,
		node,
		options = `None`
	)

Perform various checks to ensure that it is valid to apply the
NemoOuterArrayRange2LoopTrans transformation to the supplied
PSyIR Node.

:param node: the node that is being checked.
:type node: :py:class:`psyclone.psyir.nodes.Assignment`
:param options: a dictionary with options for \
    transformations. No options are used in this \
    transformation. This is an optional argument that defaults \
    to None.
:type options: Optional[Dict[str, Any]]

:raises TransformationError: if the supplied node is not an \
    Assignment node, if the Assignment node does not have an \
    Array-type Reference node on its left hand side or if the \
    Array-type node does not contain at least one Range \
    node.

Definition at line 135 of file nemo_outerarrayrange2loop_trans.py.

     def validate(self, node, options=None):
         '''Perform various checks to ensure that it is valid to apply the
         NemoOuterArrayRange2LoopTrans transformation to the supplied
         PSyIR Node.
  
         :param node: the node that is being checked.
         :type node: :py:class:`psyclone.psyir.nodes.Assignment`
         :param options: a dictionary with options for \
             transformations. No options are used in this \
             transformation. This is an optional argument that defaults \
             to None.
         :type options: Optional[Dict[str, Any]]
  
         :raises TransformationError: if the supplied node is not an \
             Assignment node, if the Assignment node does not have an \
             Array-type Reference node on its left hand side or if the \
             Array-type node does not contain at least one Range \
             node.
  
         '''
         # Am I an assignment node?
         if not isinstance(node, Assignment):
             raise TransformationError(
                 f"Error in NemoOuterArrayRange2LoopTrans transformation. The "
                 f"supplied node argument should be a PSyIR Assignment, but "
                 f"found '{type(node).__name__}'.")
  
         # Is the LHS an array reference?
         if not (isinstance(node.lhs, Reference) and node.lhs.walk(ArrayMixin)):
             raise TransformationError(
                 f"Error in NemoOuterArrayRange2LoopTrans transformation. The "
                 f"LHS of the supplied assignment node should be a Reference "
                 f"that contains an array access somewhere in the expression, "
                 f"but found '{node.lhs}'.")
         # Has the array reference got a range?
         if not node.lhs.walk(Range):
             raise TransformationError(
                 f"Error in NemoOuterArrayRange2LoopTrans transformation. The "
                 f"LHS of the supplied assignment node should be an expression "
                 f"with an array that has a Range node, but found "
                 f"'{node.lhs}'.")
  
  
 # For automatic document generation