Inheritance diagram for psyclone.transformations.MoveTrans:

[legend]

Collaboration diagram for psyclone.transformations.MoveTrans:

[legend]

Public Member Functions
def	__str__ (self)

def	name (self)

def	validate (self, node, location, options=None)

def	apply (self, node, location, options=None)

Public Member Functions inherited from psyclone.psyGen.Transformation
def	apply (self, node, options=None)

def	validate (self, node, options=None)

Detailed Description

Provides a transformation to move a node in the tree. For
example:

>>> from psyclone.parse.algorithm import parse
>>> from psyclone.psyGen import PSyFactory
>>> ast,invokeInfo=parse("dynamo.F90")
>>> psy=PSyFactory("dynamo0.3").create(invokeInfo)
>>> schedule=psy.invokes.get('invoke_v3_kernel_type').schedule
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())
>>>
>>> from psyclone.transformations import MoveTrans
>>> trans=MoveTrans()
>>> trans.apply(schedule.children[0], schedule.children[2],
...             options = {"position":"after")
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())

Nodes may only be moved to a new location with the same parent
and must not break any dependencies otherwise an exception is
raised.

Definition at line 1665 of file transformations.py.

Member Function Documentation

◆ apply()

def psyclone.transformations.MoveTrans.apply	(	self,
		node,
		location,
		options = `None`
	)

Move the node represented by :py:obj:`node` before location
:py:obj:`location` (which is also a node) by default and after
if the optional `position` argument is set to 'after'.

:param node: the node to be moved.
:type node: :py:class:`psyclone.psyir.nodes.Node`
:param location: node before or after which the given node\
    should be moved.
:type location: :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param str options["position"]: either 'before' or 'after'.

:raises TransformationError: if the given node is not an instance \
    of :py:class:`psyclone.psyir.nodes.Node`
:raises TransformationError: if the location is not valid.

Definition at line 1730 of file transformations.py.

     def apply(self, node, location, options=None):
         '''Move the node represented by :py:obj:`node` before location
         :py:obj:`location` (which is also a node) by default and after
         if the optional `position` argument is set to 'after'.
  
         :param node: the node to be moved.
         :type node: :py:class:`psyclone.psyir.nodes.Node`
         :param location: node before or after which the given node\
             should be moved.
         :type location: :py:class:`psyclone.psyir.nodes.Node`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
         :param str options["position"]: either 'before' or 'after'.
  
         :raises TransformationError: if the given node is not an instance \
             of :py:class:`psyclone.psyir.nodes.Node`
         :raises TransformationError: if the location is not valid.
  
         '''
         # pylint:disable=arguments-differ
  
         self.validate(node, location, options)
  
         if not options:
             options = {}
         position = options.get("position", "before")
  
         parent = node.parent
  
         my_node = parent.children.pop(node.position)
  
         location_index = location.position
         if position == "before":
             location.parent.children.insert(location_index, my_node)
         else:
             location.parent.children.insert(location_index+1, my_node)
  
  

Here is the call graph for this function:

◆ name()

def psyclone.transformations.MoveTrans.name ( self )

 Returns the name of this transformation as a string.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 1692 of file transformations.py.

     def name(self):
         ''' Returns the name of this transformation as a string.'''
         return "Move"
  

Here is the caller graph for this function:

◆ validate()

def psyclone.transformations.MoveTrans.validate	(	self,
		node,
		location,
		options = `None`
	)

 validity checks for input arguments.

:param node: the node to be moved.
:type node: :py:class:`psyclone.psyir.nodes.Node`
:param location: node before or after which the given node\
    should be moved.
:type location: :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param str options["position"]: either 'before' or 'after'.

:raises TransformationError: if the given node is not an instance \
    of :py:class:`psyclone.psyir.nodes.Node`
:raises TransformationError: if the location is not valid.

Definition at line 1696 of file transformations.py.

     def validate(self, node, location, options=None):
         # pylint: disable=arguments-differ
         ''' validity checks for input arguments.
  
         :param node: the node to be moved.
         :type node: :py:class:`psyclone.psyir.nodes.Node`
         :param location: node before or after which the given node\
             should be moved.
         :type location: :py:class:`psyclone.psyir.nodes.Node`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
         :param str options["position"]: either 'before' or 'after'.
  
         :raises TransformationError: if the given node is not an instance \
             of :py:class:`psyclone.psyir.nodes.Node`
         :raises TransformationError: if the location is not valid.
         '''
  
         # Check that the first argument is a Node
         if not isinstance(node, Node):
             raise TransformationError(
                 "In the Move transformation apply method the first argument "
                 "is not a Node")
  
         # Check new location conforms to any data dependencies
         # This also checks the location and position arguments
         if not options:
             options = {}
         position = options.get("position", "before")
         if not node.is_valid_location(location, position=position):
             raise TransformationError(
                 "In the Move transformation apply method, data dependencies "
                 "forbid the move to the new location")
  