Inheritance diagram for psyclone.domain.nemo.transformations.nemo_allarrayrange2loop_trans.NemoAllArrayRange2LoopTrans:

[legend]

Collaboration diagram for psyclone.domain.nemo.transformations.nemo_allarrayrange2loop_trans.NemoAllArrayRange2LoopTrans:

[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 for all PSyIR Array Ranges in an
assignment to PSyIR Loops. 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 \
        NemoAllArrayRange2LoopTrans
>>>
>>> print(schedule.view())
>>> trans = NemoAllArrayRange2LoopTrans()
>>> for assignment in schedule.walk(Assignment):
>>>     trans.apply(assignment)
>>> print(schedule.view())

Definition at line 55 of file nemo_allarrayrange2loop_trans.py.

Member Function Documentation

◆ apply()

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

Apply the NemoAllArrayRange2Loop 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 all Range nodes within array references within
the assignment are replaced with references to the appropriate
loop indices. The appropriate number of Loops are also placed around
the modified assignment statement.

The name of each 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 each
loop are taken from the Range node if they are provided. If
not, the loop bounds are taken from the PSyclone configuration
file if a bounds value is supplied. If not, the LBOUND or
UBOUND intrinsics are used as appropriate. The type of the
Loop is also taken from the configuration file if it is
supplied for that index, otherwise it is specified as being
"unknown".

: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.
:param bool options["verbose"]: whether to print out the reason
    why the inner transformation was not applied. This is useful
    because this transfomation succeeds even if one of the inner
    transformations fails, and therefor the reason why the inner
    transformation failed is not propagated.
: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.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 78 of file nemo_allarrayrange2loop_trans.py.

     def apply(self, node, options=None):
         '''Apply the NemoAllArrayRange2Loop 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 all Range nodes within array references within
         the assignment are replaced with references to the appropriate
         loop indices. The appropriate number of Loops are also placed around
         the modified assignment statement.
  
         The name of each 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 each
         loop are taken from the Range node if they are provided. If
         not, the loop bounds are taken from the PSyclone configuration
         file if a bounds value is supplied. If not, the LBOUND or
         UBOUND intrinsics are used as appropriate. The type of the
         Loop is also taken from the configuration file if it is
         supplied for that index, otherwise it is specified as being
         "unknown".
  
         :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.
         :param bool options["verbose"]: whether to print out the reason
             why the inner transformation was not applied. This is useful
             because this transfomation succeeds even if one of the inner
             transformations fails, and therefor the reason why the inner
             transformation failed is not propagated.
         :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)
  
         trans = NemoOuterArrayRange2LoopTrans()
         try:
             while True:
                 trans.apply(node, options)
         except TransformationError as err:
             # TODO #11: Instead we could use proper logging
             if options and options.get("verbose", False):
                 errmsg = str(err)
                 # Skip the errors that are obious and are generated for any
                 # statement that is not an array expression
                 if "assignment node should be an expression with an array " \
                    "that has a Range node" not in errmsg and \
                    "be a Reference that contains an array access somewhere" \
                    not in errmsg:
                     print(errmsg)
  

Here is the call graph for this function:

◆ name()

def psyclone.domain.nemo.transformations.nemo_allarrayrange2loop_trans.NemoAllArrayRange2LoopTrans.name ( self )

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

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 137 of file nemo_allarrayrange2loop_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_allarrayrange2loop_trans.NemoAllArrayRange2LoopTrans.validate	(	self,
		node,
		options = `None`
	)

Perform various checks to ensure that it is valid to apply the
NemoArrayRange2LoopTrans 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.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 145 of file nemo_allarrayrange2loop_trans.py.

     def validate(self, node, options=None):
         '''Perform various checks to ensure that it is valid to apply the
         NemoArrayRange2LoopTrans 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.
  
         '''
         # Am I an assignment node?
         if not isinstance(node, Assignment):
             raise TransformationError(
                 f"Error in NemoAllArrayRange2LoopTrans transformation. The "
                 f"supplied node argument should be a PSyIR Assignment, but "
                 f"found '{type(node).__name__}'.")
  
  
 # For automatic document generation

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/domain/nemo/transformations/nemo_allarrayrange2loop_trans.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ apply()

◆ name()

◆ validate()