psyclone.parse.algorithm.BuiltInCall Class Reference

Inheritance diagram for psyclone.parse.algorithm.BuiltInCall:

Collaboration diagram for psyclone.parse.algorithm.BuiltInCall:

Public Member Functions
def	__init__ (self, ktype, args)
def	func_name (self)
def	type (self)
def	__repr__ (self)
Public Member Functions inherited from psyclone.parse.algorithm.ParsedCall
def	ktype (self)
def	args (self)
def	module_name (self)

Detailed Description

Store information about a system-supplied (builtin)
kernel. Specialises the generic ParsedCall class adding a function
name method (the name of the builtin) and a type for
distinguishing this class.

:param ktype: information about this builtin. Provides \
access to the PSyclone description metadata.
: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 1041 of file algorithm.py.

Member Function Documentation

func_name()

def psyclone.parse.algorithm.BuiltInCall.func_name

(

self

)

:returns: the name of this builtin.
:rtype: str

Definition at line 1062 of file algorithm.py.

    def func_name(self):
        '''
        :returns: the name of this builtin.
        :rtype: str
 
        '''
        return self._func_name
 

References psyclone.parse.algorithm.BuiltInCall._func_name.

type()

def psyclone.parse.algorithm.BuiltInCall.type

(

self

)

Specifies that this is a builtin call.

:returns: the type of call as a string.
:rtype: str

Definition at line 1071 of file algorithm.py.

    def type(self):
        '''Specifies that this is a builtin call.
 
        :returns: the type of call as a string.
        :rtype: str
 
        '''
        return "BuiltInCall"
 

---

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

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