Inheritance diagram for psyclone.psyGen.Transformation:

[legend]

Collaboration diagram for psyclone.psyGen.Transformation:

Public Member Functions
def	name (self)

def	apply (self, node, options=None)

def	validate (self, node, options=None)

Detailed Description

Abstract baseclass for a transformation. Uses the abc module so it
can not be instantiated.

Definition at line 2743 of file psyGen.py.

Member Function Documentation

◆ apply()

def psyclone.psyGen.Transformation.apply	(	self,
		node,
		options = `None`
	)

Abstract method that applies the transformation. This function
must be implemented by each transform. As a minimum each apply
function must take a node to which the transform is applied, and
a dictionary of additional options, which will also be passed on
to the validate functions. This dictionary is used to provide
optional parameters, and also to modify the behaviour of
validation of transformations: for example, if the user knows that
a transformation can correctly be applied in a specific case, but
the more generic code validation would not allow this. Validation
functions should check for a key in the options dictionary to
disable certain tests. Those keys will be documented in each
apply() and validate() function.

Note that some apply() functions might take a slightly different
set of parameters.

:param node: The node (or list of nodes) for the transformation \
        - specific to the actual transform used.
:type node: depends on actual transformation
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Definition at line 2758 of file psyGen.py.

     def apply(self, node, options=None):
         '''Abstract method that applies the transformation. This function
         must be implemented by each transform. As a minimum each apply
         function must take a node to which the transform is applied, and
         a dictionary of additional options, which will also be passed on
         to the validate functions. This dictionary is used to provide
         optional parameters, and also to modify the behaviour of
         validation of transformations: for example, if the user knows that
         a transformation can correctly be applied in a specific case, but
         the more generic code validation would not allow this. Validation
         functions should check for a key in the options dictionary to
         disable certain tests. Those keys will be documented in each
         apply() and validate() function.
  
         Note that some apply() functions might take a slightly different
         set of parameters.
  
         :param node: The node (or list of nodes) for the transformation \
                 - specific to the actual transform used.
         :type node: depends on actual transformation
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         '''
  

◆ name()

def psyclone.psyGen.Transformation.name ( self )

:returns: the transformation's class name.
:rtype: str

Reimplemented in psyclone.transformations.KernelImportsToArguments, psyclone.transformations.ACCDataTrans, psyclone.transformations.ACCKernelsTrans, psyclone.transformations.ACCRoutineTrans, psyclone.transformations.ACCEnterDataTrans, psyclone.transformations.Dynamo0p3KernelConstTrans, psyclone.transformations.Dynamo0p3AsyncHaloExchangeTrans, psyclone.transformations.MoveTrans, psyclone.transformations.OMPParallelTrans, psyclone.transformations.OMPMasterTrans, psyclone.transformations.OMPSingleTrans, psyclone.psyir.transformations.psy_data_trans.PSyDataTrans, psyclone.psyir.transformations.omp_task_trans.OMPTaskTrans, psyclone.psyir.transformations.loop_trans.LoopTrans, psyclone.psyir.transformations.fold_conditional_return_expressions_trans.FoldConditionalReturnExpressionsTrans, psyclone.psyir.transformations.arrayrange2loop_trans.ArrayRange2LoopTrans, psyclone.psyir.transformations.allarrayaccess2loop_trans.AllArrayAccess2LoopTrans, psyclone.psyGen.DummyTransformation, psyclone.psyad.transformations.assignment_trans.AssignmentTrans, psyclone.domain.nemo.transformations.nemo_arrayrange2loop_trans.NemoArrayRange2LoopTrans, psyclone.domain.nemo.transformations.nemo_allarrayrange2loop_trans.NemoAllArrayRange2LoopTrans, psyclone.domain.gocean.transformations.gocean_opencl_trans.GOOpenCLTrans, psyclone.domain.gocean.transformations.gocean_move_iteration_boundaries_inside_kernel_trans.GOMoveIterationBoundariesInsideKernelTrans, and psyclone.domain.gocean.transformations.gocean_const_loop_bounds_trans.GOConstLoopBoundsTrans.

Definition at line 2749 of file psyGen.py.

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

Here is the caller graph for this function:

◆ validate()

def psyclone.psyGen.Transformation.validate	(	self,
		node,
		options = `None`
	)

Method that validates that the input data is correct.
It will raise exceptions if the input data is incorrect. This
function needs to be implemented by each transformation.

The validate function can be called by the user independent of
the apply() function, but it will automatically be executed as
part of an apply() call.

As minimum each validate function must take a node to which the
transform is applied and a dictionary of additional options.
This dictionary is used to provide optional parameters and also
to modify the behaviour of validation: for example, if the user
knows that a transformation can correctly be applied in a specific
case but the more generic code validation would not allow this.
Validation functions should check for particular keys in the options
dict in order to disable certain tests. Those keys will be documented
in each apply() and validate() function as 'options["option-name"]'.

Note that some validate functions might take a slightly different
set of parameters.

:param node: The node (or list of nodes) for the transformation \
        - specific to the actual transform used.
:type node: depends on actual transformation
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Definition at line 2783 of file psyGen.py.

     def validate(self, node, options=None):
         '''Method that validates that the input data is correct.
         It will raise exceptions if the input data is incorrect. This
         function needs to be implemented by each transformation.
  
         The validate function can be called by the user independent of
         the apply() function, but it will automatically be executed as
         part of an apply() call.
  
         As minimum each validate function must take a node to which the
         transform is applied and a dictionary of additional options.
         This dictionary is used to provide optional parameters and also
         to modify the behaviour of validation: for example, if the user
         knows that a transformation can correctly be applied in a specific
         case but the more generic code validation would not allow this.
         Validation functions should check for particular keys in the options
         dict in order to disable certain tests. Those keys will be documented
         in each apply() and validate() function as 'options["option-name"]'.
  
         Note that some validate functions might take a slightly different
         set of parameters.
  
         :param node: The node (or list of nodes) for the transformation \
                 - specific to the actual transform used.
         :type node: depends on actual transformation
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
         '''
         # pylint: disable=unused-argument
  
  