psyclone.psyGen.KernelArgument Class Reference

Inheritance diagram for psyclone.psyGen.KernelArgument:

Collaboration diagram for psyclone.psyGen.KernelArgument:

Public Member Functions
def	__init__ (self, arg, arg_info, call)
def	space (self)
def	stencil (self)
def	is_scalar (self)
def	metadata_index (self)
Public Member Functions inherited from psyclone.psyGen.Argument
def	psyir_expression (self)
def	infer_datatype (self)
def	__str__ (self)
def	name (self)
def	text (self)
def	form (self)
def	is_literal (self)
def	access (self)
def	access (self, value)
def	argument_type (self)
def	intrinsic_type (self)
def	precision (self)
def	data_type (self)
def	module_name (self)
def	call (self)
def	call (self, value)
def	backward_dependence (self)
def	forward_write_dependencies (self, ignore_halos=False)
def	backward_write_dependencies (self, ignore_halos=False)
def	forward_dependence (self)
def	forward_read_dependencies (self)

Detailed Description

This class provides information about individual kernel-call
arguments as specified by the kernel argument metadata and the
kernel invocation in the Algorithm layer.

:param arg: information obtained from the metadata for this kernel \
            argument.
:type arg: :py:class:`psyclone.parse.kernel.Descriptor`
:param arg_info: information on how this argument is specified in \
                 the Algorithm layer.
:type arg_info: :py:class:`psyclone.parse.algorithm.Arg`
:param call: the PSyIR kernel node to which this argument pertains.
:type call: :py:class:`psyclone.psyGen.Kern`

Definition at line 2589 of file psyGen.py.

Member Function Documentation

is_scalar()

def psyclone.psyGen.KernelArgument.is_scalar

(

self

)

:returns: whether this variable is a scalar variable or not.
:rtype: bool

Reimplemented in psyclone.gocean1p0.GOKernelArgument, and psyclone.dynamo0p3.DynKernelArgument.

Definition at line 2619 of file psyGen.py.

    def is_scalar(self):
        ''':returns: whether this variable is a scalar variable or not.
        :rtype: bool'''
 

Here is the caller graph for this function:

metadata_index()

def psyclone.psyGen.KernelArgument.metadata_index

(

self

)

:returns: the position of the corresponding argument descriptor in \
          the kernel metadata.
:rtype: int

Definition at line 2624 of file psyGen.py.

    def metadata_index(self):
        '''
        :returns: the position of the corresponding argument descriptor in \
                  the kernel metadata.
        :rtype: int
        '''
        return self._arg.metadata_index
 
 

References psyclone.gocean1p0.GOKernelArgument._arg, psyclone.psyGen.DataAccess._arg, and psyclone.psyGen.KernelArgument._arg.

---

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