psyclone.gocean1p0.GOInvokes Class Reference

Inheritance diagram for psyclone.gocean1p0.GOInvokes:

Collaboration diagram for psyclone.gocean1p0.GOInvokes:

Public Member Functions
def	__init__ (self, alg_calls, psy)
def	gen_code (self, parent)
Public Member Functions inherited from psyclone.psyGen.Invokes
def	__init__ (self, alg_calls, invoke_cls, psy)
def	__str__ (self)
def	psy (self)
def	names (self)
def	get (self, invoke_name)

Additional Inherited Members
Public Attributes inherited from psyclone.psyGen.Invokes
	invoke_map
	invoke_list

Detailed Description

The GOcean specific invokes class. This passes the GOcean specific
invoke class to the base class so it creates the one we require.

:param alg_calls: The Invoke calls discovered in the Algorithm layer.
:type alg_calls: OrderedDict of :py:class:`psyclone.parse.InvokeCall` \
    objects.
:param psy: the PSy object containing this GOInvokes object.
:type psy: :py:class:`psyclone.gocean1p0.GOPSy`

Definition at line 127 of file gocean1p0.py.

Member Function Documentation

gen_code()

def psyclone.gocean1p0.GOInvokes.gen_code	(		self,
			parent
	)

GOcean redefines the Invokes.gen_code() to start using the PSyIR
backend when possible. In cases where the backend can not be used yet
(e.g. OpenCL and PSyDataNodes) the parent class will be called. This
is a temporary workaround to avoid modifying the generator file while
other APIs still use the f2pygen module for code generation.
Once the PSyIR backend has generated an output, this is added into a
f2pygen PSyIRGen block in the f2pygen AST for each Invoke in the
PSy layer.

:param parent: the parent node in the f2pygen AST to which to add \
               content.
:type parent: `psyclone.f2pygen.ModuleGen`

Reimplemented from psyclone.psyGen.Invokes.

Definition at line 169 of file gocean1p0.py.

    def gen_code(self, parent):
        '''
        GOcean redefines the Invokes.gen_code() to start using the PSyIR
        backend when possible. In cases where the backend can not be used yet
        (e.g. OpenCL and PSyDataNodes) the parent class will be called. This
        is a temporary workaround to avoid modifying the generator file while
        other APIs still use the f2pygen module for code generation.
        Once the PSyIR backend has generated an output, this is added into a
        f2pygen PSyIRGen block in the f2pygen AST for each Invoke in the
        PSy layer.
 
        :param parent: the parent node in the f2pygen AST to which to add \
                       content.
        :type parent: `psyclone.f2pygen.ModuleGen`
        '''
        if self.invoke_list:
            # We just need one invoke as they all have a common root.
            invoke = self.invoke_list[0]
 
            # Lower the GOcean PSyIR to language level so it can be visited
            # by the backends
            invoke.schedule.root.lower_to_language_level()
            # Then insert it into a f2pygen AST as a PSyIRGen node.
            # Note that other routines besides the Invoke could have been
            # inserted during the lowering (e.g. module-inlined kernels),
            # so have to iterate over all current children of root.
            for child in invoke.schedule.root.children:
                parent.add(PSyIRGen(parent, child))
 
 

References psyclone.nemo.NemoInvokes.invoke_list, and psyclone.psyGen.Invokes.invoke_list.

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/gocean1p0.py