Inheritance diagram for psyclone.parse.algorithm.ParsedCall:

Public Member Functions
def	__init__ (self, ktype, args)

def	ktype (self)

def	args (self)

def	module_name (self)

Detailed Description

Base class for information about a user-supplied or built-in
kernel.

:param ktype: information about a kernel or builtin. Provides \
    access to the PSyclone description metadata and the code if it \
    exists.
:type ktype: API-specific specialisation of \
    :py:class:`psyclone.parse.kernel.KernelType`
:param args: a list of Arg instances which capture the relevant \
    information about the arguments associated with the call to the \
    kernel or builtin.
:type args: list of :py:class:`psyclone.parse.algorithm.Arg`

Definition at line 942 of file algorithm.py.

Member Function Documentation

◆ args()

def psyclone.parse.algorithm.ParsedCall.args ( self )

:returns: a list of Arg instances which capture the relevant \
information about the arguments associated with the call to the \
kernel or builtin
:rtype: list of :py:class:`psyclone.parse.algorithm.Arg`

Definition at line 986 of file algorithm.py.

     def args(self):
         '''
         :returns: a list of Arg instances which capture the relevant \
         information about the arguments associated with the call to the \
         kernel or builtin
         :rtype: list of :py:class:`psyclone.parse.algorithm.Arg`
  
         '''
         return self._args
  

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

Here is the caller graph for this function:

◆ ktype()

def psyclone.parse.algorithm.ParsedCall.ktype ( self )

:returns: information about a kernel or builtin. Provides \
    access to the PSyclone description metadata and the code if it \
    exists.
:rtype: API-specific specialisation of \
    :py:class:`psyclone.parse.kernel.KernelType`

Definition at line 974 of file algorithm.py.

     def ktype(self):
         '''
         :returns: information about a kernel or builtin. Provides \
             access to the PSyclone description metadata and the code if it \
             exists.
         :rtype: API-specific specialisation of \
             :py:class:`psyclone.parse.kernel.KernelType`
  
         '''
         return self._ktype
  

References psyclone.parse.algorithm.ParsedCall._ktype, and psyclone.parse.kernel.KernelType._ktype.

◆ module_name()

def psyclone.parse.algorithm.ParsedCall.module_name ( self )

This name is assumed to be set by the subclasses.

:returns: the name of the module containing the kernel code.
:rtype: str

Definition at line 997 of file algorithm.py.

     def module_name(self):
         '''This name is assumed to be set by the subclasses.
  
         :returns: the name of the module containing the kernel code.
         :rtype: str
  
         '''
         return self._module_name
  
  

References psyclone.dynamo0p3.DynKernelArgument._module_name, psyclone.parse.algorithm.ParsedCall._module_name, psyclone.parse.algorithm.KernelCall._module_name, psyclone.psyGen.CodedKern._module_name, psyclone.psyGen.Argument._module_name, and psyclone.psyir.nodes.psy_data_node.PSyDataNode._module_name.