psyclone.psyGen.Invokes Class Reference

Inheritance diagram for psyclone.psyGen.Invokes:

Public Member Functions
def	__init__ (self, alg_calls, invoke_cls, psy)
def	__str__ (self)
def	psy (self)
def	names (self)
def	get (self, invoke_name)
def	gen_code (self, parent)

Public Attributes
	invoke_map
	invoke_list

Detailed Description

Manage the invoke calls.

:param alg_calls: a list of invoke metadata extracted by the \
    parser.
:type alg_calls: list of \
:py:class:`psyclone.parse.algorithm.InvokeCall`
:param invoke_cls: an api-specific Invoke class.
:type invoke_cls: subclass of :py:class:`psyclone.psyGen.Invoke`
:param psy: the PSy instance containing this Invokes instance.
:type psy: subclass of :py:class`psyclone.psyGen.PSy`

Definition at line 282 of file psyGen.py.

Constructor & Destructor Documentation

__init__()

def psyclone.psyGen.Invokes.__init__	(		self,
			alg_calls,
			invoke_cls,
			psy
	)

Manage the invoke calls.

:param alg_calls: a list of invoke metadata extracted by the \
    parser.
:type alg_calls: list of \
:py:class:`psyclone.parse.algorithm.InvokeCall`
:param invoke_cls: an api-specific Invoke class.
:type invoke_cls: subclass of :py:class:`psyclone.psyGen.Invoke`
:param psy: the PSy instance containing this Invokes instance.
:type psy: subclass of :py:class`psyclone.psyGen.PSy`

Definition at line 295 of file psyGen.py.

    def __init__(self, alg_calls, invoke_cls, psy):
        self._psy = psy
        self.invoke_map = {}
        self.invoke_list = []
        for idx, alg_invocation in enumerate(alg_calls):
            my_invoke = invoke_cls(alg_invocation, idx, self)
            self.invoke_map[my_invoke.name] = my_invoke
            self.invoke_list.append(my_invoke)
 

References psyclone.alg_gen.Alg._psy, psyclone.nemo.NemoInvokes._psy, psyclone.psyGen.Invokes._psy, psyclone.nemo.NemoInvokes.invoke_list, psyclone.psyGen.Invokes.invoke_list, psyclone.nemo.NemoInvokes.invoke_map, psyclone.psyGen.Invokes.invoke_map, psyclone.expression.ExpressionNode.names, psyclone.f2pygen.BaseDeclGen.names(), psyclone.psyGen.Invokes.names(), and psyclone.psyGen.Arguments.names().

Here is the call graph for this function:

Member Function Documentation

gen_code()

def psyclone.psyGen.Invokes.gen_code	(		self,
			parent
	)

Create the f2pygen AST for each Invoke in the PSy layer.

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

:raises GenerationError: if an invoke_list schedule is not an \
    InvokeSchedule.

Reimplemented in psyclone.gocean1p0.GOInvokes.

Definition at line 348 of file psyGen.py.

    def gen_code(self, parent):
        '''
        Create the f2pygen AST for each Invoke in the PSy layer.
 
        :param parent: the parent node in the AST to which to add content.
        :type parent: `psyclone.f2pygen.ModuleGen`
 
        :raises GenerationError: if an invoke_list schedule is not an \
            InvokeSchedule.
        '''
        for invoke in self.invoke_list:
            if not isinstance(invoke.schedule, InvokeSchedule):
                raise GenerationError(
                    f"An invoke.schedule element of the invoke_list is a "
                    f"'{type(invoke.schedule).__name__}', but it should be an "
                    f"'InvokeSchedule'.")
            invoke.gen_code(parent)
 
 

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

Here is the caller graph for this function:

get()

def psyclone.psyGen.Invokes.get	(		self,
			invoke_name
	)

Gets the Invoke with the supplied name. If the name does not already
begin with ``invoke_`` then a new name with this prepended is included
in the search if no exact match is found initially.

:param str invoke_name: the name of the Invoke to get (not case-
                        sensitive).

:returns: the invoke with the specified name.
:rtype: :py:class:`psyclone.psyGen.Invoke`

:raises RuntimeError: if no Invoke with the supplied name (with or
                      without ``invoke_`` prepended) exists.

Definition at line 320 of file psyGen.py.

    def get(self, invoke_name):
        '''
        Gets the Invoke with the supplied name. If the name does not already
        begin with ``invoke_`` then a new name with this prepended is included
        in the search if no exact match is found initially.
 
        :param str invoke_name: the name of the Invoke to get (not case-
                                sensitive).
 
        :returns: the invoke with the specified name.
        :rtype: :py:class:`psyclone.psyGen.Invoke`
 
        :raises RuntimeError: if no Invoke with the supplied name (with or
                              without ``invoke_`` prepended) exists.
        '''
        search_names = [invoke_name.lower()]
        if not search_names[0].startswith("invoke_"):
            search_names.append("invoke_"+search_names[0])
        for name in search_names:
            try:
                return self.invoke_map[name]
            except KeyError:
                pass
 
        search_list = " or ".join(f"'{name}'" for name in search_names)
        raise RuntimeError(f"Cannot find an invoke named {search_list} "
                           f"in {list(self.names)}")
 

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

psy()

def psyclone.psyGen.Invokes.psy

(

self

)

:returns: the PSy instance that contains this instance.
:rtype: subclass of :py:class:`psyclone.psyGen.PSy`

Definition at line 308 of file psyGen.py.

    def psy(self):
        '''
        :returns: the PSy instance that contains this instance.
        :rtype: subclass of :py:class:`psyclone.psyGen.PSy`
 
        '''
        return self._psy
 

References psyclone.alg_gen.Alg._psy, psyclone.nemo.NemoInvokes._psy, psyclone.psyGen.Invokes._psy, psyclone.nemo.NemoInvokes.invoke_map, and psyclone.psyGen.Invokes.invoke_map.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/psyGen.py