Inheritance diagram for psyclone.domain.nemo.transformations.create_nemo_psy_trans.CreateNemoPSyTrans:

Collaboration diagram for psyclone.domain.nemo.transformations.create_nemo_psy_trans.CreateNemoPSyTrans:

Public Member Functions
def	name (self)

def	validate (self, node, options=None)

def	apply (self, psyir, options=None)

Detailed Description

Transform generic (language-level) PSyIR representation into a PSyclone
version with specialised, NEMO-specific nodes. For example:

>>> from psyclone.psyir.frontend.fortran import FortranReader
>>> from psyclone.psyir.nodes import Loop
>>> from psyclone.domain.nemo.transformations import CreateNemoPSyTrans
>>> code = '''
... subroutine sub()
...   integer :: ji, tmp(10)
...   do ji=1, 10
...     tmp(ji) = 2*ji
...   end do
... end subroutine sub'''
>>> psyir = FortranReader().psyir_from_source(code)
>>> loop = psyir.walk(Loop)[0]
>>> trans = CreateNemoPSyTrans()
>>> trans.apply(psyir)
>>> print(psyir.view(colour=False, indent="   "))
FileContainer[]
   NemoInvokeSchedule[invoke='sub']
      0: Loop[variable='ji']
         Literal[value:'1', Scalar<INTEGER, UNDEFINED>]
         Literal[value:'10', Scalar<INTEGER, UNDEFINED>]
         Literal[value:'1', Scalar<INTEGER, UNDEFINED>]
         Schedule[]
            0: Assignment[]
               ArrayReference[name:'tmp']
                  Reference[name:'ji']
               BinaryOperation[operator:'MUL']
                  Literal[value:'2', Scalar<INTEGER, UNDEFINED>]
                  Reference[name:'ji']
<BLANKLINE>

The result of this transformation is that the root `Routine` has
been converted into a `NemoInvokeSchedule`.

Definition at line 49 of file create_nemo_psy_trans.py.

Member Function Documentation

◆ apply()

def psyclone.domain.nemo.transformations.create_nemo_psy_trans.CreateNemoPSyTrans.apply	(	self,
		psyir,
		options = `None`
	)

Takes generic PSyIR and replaces recognised structures with
NEMO-specific PSyIR (in-place). Note that this may mean replacing
the top-level node itself and therefore this routine returns the
root of the modified tree.

:param psyir: the root node of the PSyIR tree to process.
:type psyir: :py:class:`psyclone.psyir.nodes.Node`
: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]]

Definition at line 122 of file create_nemo_psy_trans.py.

     def apply(self, psyir, options=None):
         '''
         Takes generic PSyIR and replaces recognised structures with
         NEMO-specific PSyIR (in-place). Note that this may mean replacing
         the top-level node itself and therefore this routine returns the
         root of the modified tree.
  
         :param psyir: the root node of the PSyIR tree to process.
         :type psyir: :py:class:`psyclone.psyir.nodes.Node`
         :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]]
  
         '''
         self.validate(psyir, options=options)
  
         invoke_trans = CreateNemoInvokeScheduleTrans()
  
         # Transform any Routines into NemoInvokeSchedules.
         for routine in psyir.walk(Routine):
             invoke_trans.apply(routine)
  
  
 # For AutoAPI documentation generation

Here is the call graph for this function:

◆ name()

def psyclone.domain.nemo.transformations.create_nemo_psy_trans.CreateNemoPSyTrans.name ( self )

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

TODO #1214 remove this method.

Definition at line 89 of file create_nemo_psy_trans.py.

     def name(self):
         '''
         :returns: the name of the transformation.
         :rtype: str
  
         TODO #1214 remove this method.
  
         '''
         return type(self).__name__
  

Here is the caller graph for this function:

◆ validate()

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

Check that the supplied node is a valid target for this transformation.

:param node: the root of the PSyIR tree to be transformed.
:type node: :py:class:`psyclone.psyir.nodes.Node`
: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 a PSyIR node.

Definition at line 99 of file create_nemo_psy_trans.py.

     def validate(self, node, options=None):
         '''
         Check that the supplied node is a valid target for this transformation.
  
         :param node: the root of the PSyIR tree to be transformed.
         :type node: :py:class:`psyclone.psyir.nodes.Node`
         :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 a PSyIR node.
  
         '''
         if not isinstance(node, Node):
             raise TransformationError(
                 f"Error in CreateNemoPSyTrans transformation. The supplied "
                 f"node should be a PSyIR Node but found "
                 f"'{type(node).__name__}'")
  
         super(CreateNemoPSyTrans, self).validate(node, options=options)
  