psyclone.core.signature.Signature Class Reference

Public Member Functions
def	__init__ (self, variable, sub_sig=None)
def	is_structure (self)
def	__len__ (self)
def	__getitem__ (self, indx)
def	__str__ (self)
def	to_language (self, component_indices=None, language_writer=None)
def	__repr__ (self)
def	__hash__ (self)
def	__eq__ (self, other)
def	__ne__ (self, other)
def	__lt__ (self, other)
def	__le__ (self, other)
def	__gt__ (self, other)
def	__ge__ (self, other)
def	var_name (self)

Detailed Description

Given a variable access of the form ``a(i,j)%b(k,l)%c``, the signature
of this access is the tuple ``(a,b,c)``. For a simple scalar variable
``a`` the signature would just be ``(a,)``.
The signature is the key used in `VariablesAccessInfo`. In order to make
sure two different signature objects containing the same variable
can be used as a key, this class implements `__hash__` and other special
functions.
The constructor also supports appending an existing signature to this
new signature using the `sub_sig` argument. This is used in
StructureReference to assemble the overall signature of a structure
access.

:param variable: the variable that is accessed.
:type variable: str or tuple of str or list of str

:param sub_sig: a signature that is to be added to this new signature.
:type sub_sig: :py:class:`psyclone.core.Signature`

Definition at line 46 of file signature.py.

Member Function Documentation

__eq__()

def psyclone.core.signature.Signature.__eq__	(		self,
			other
	)

Required in order to use a Signature instance as a key.
Compares two objects (one of which might not be a Signature).

Definition at line 205 of file signature.py.

    def __eq__(self, other):
        '''Required in order to use a Signature instance as a key.
        Compares two objects (one of which might not be a Signature).'''
        if not hasattr(other, "_signature"):
            return False
        return self._signature == other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__ge__()

def psyclone.core.signature.Signature.__ge__	(		self,
			other
	)

Required to compare signatures. It just compares the tuples.

Definition at line 245 of file signature.py.

    def __ge__(self, other):
        '''Required to compare signatures. It just compares the tuples.'''
        if not isinstance(other, Signature):
            raise TypeError(f"'>=' not supported between instances of "
                            f"'Signature' and '{type(other).__name__}'.")
        return self._signature >= other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__gt__()

def psyclone.core.signature.Signature.__gt__	(		self,
			other
	)

Required to compare signatures. It just compares the tuples.

Definition at line 237 of file signature.py.

    def __gt__(self, other):
        '''Required to compare signatures. It just compares the tuples.'''
        if not isinstance(other, Signature):
            raise TypeError(f"'>' not supported between instances of "
                            f"'Signature' and '{type(other).__name__}'.")
        return self._signature > other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__hash__()

def psyclone.core.signature.Signature.__hash__

(

self

)

This returns a hash value that is independent of the instance.
I.e. two instances with the same signature will have the same
hash key.

Definition at line 197 of file signature.py.

    def __hash__(self):
        '''This returns a hash value that is independent of the instance.
        I.e. two instances with the same signature will have the same
        hash key.
        '''
        return hash(self._signature)
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__le__()

def psyclone.core.signature.Signature.__le__	(		self,
			other
	)

Required to compare signatures. It just compares the tuples.

Definition at line 229 of file signature.py.

    def __le__(self, other):
        '''Required to compare signatures. It just compares the tuples.'''
        if not isinstance(other, Signature):
            raise TypeError(f"'<=' not supported between instances of "
                            f"'Signature' and '{type(other).__name__}'.")
        return self._signature <= other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__len__()

def psyclone.core.signature.Signature.__len__

(

self

)

:returns: the number of components of this signature.
:rtype: int

Definition at line 94 of file signature.py.

    def __len__(self):
        ''':returns: the number of components of this signature.
        :rtype: int'''
        return len(self._signature)
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__lt__()

def psyclone.core.signature.Signature.__lt__	(		self,
			other
	)

Required to sort signatures. It just compares the tuples.

Definition at line 221 of file signature.py.

    def __lt__(self, other):
        '''Required to sort signatures. It just compares the tuples.'''
        if not isinstance(other, Signature):
            raise TypeError(f"'<' not supported between instances of "
                            f"'Signature' and '{type(other).__name__}'.")
        return self._signature < other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

__ne__()

def psyclone.core.signature.Signature.__ne__	(		self,
			other
	)

Required for != comparisons of Signatures with python2.
Compares two objects (one of which might not be a Signature).

Definition at line 213 of file signature.py.

    def __ne__(self, other):
        '''Required for != comparisons of Signatures with python2.
        Compares two objects (one of which might not be a Signature).'''
        if not hasattr(other, "_signature"):
            return True
        return self._signature != other._signature
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

is_structure()

def psyclone.core.signature.Signature.is_structure

(

self

)

:returns: True if this signature represents a structure.
:rtype: bool

Definition at line 87 of file signature.py.

    def is_structure(self):
        ''':returns: True if this signature represents a structure.
        :rtype: bool
        '''
        return len(self._signature) > 1
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

to_language()

def psyclone.core.signature.Signature.to_language	(		self,
			component_indices = None,
			language_writer = None
	)

Converts this signature with the provided indices to a string
in the selected language.

TODO 1320 This subroutine can be removed when we stop supporting
strings - then we can use a PSyIR writer for the ReferenceNode
to provide the right string.

:param component_indices: the indices for each component of \
    the signature.
:type component_indices: None (default is scalar access), or \
    :py:class:`psyclone.core.component_indices.ComponentIndices`
:param language_writer: a backend visitor to convert PSyIR \
    expressions to a representation in the selected language. \
    This is used when creating error and warning messages.
:type language_writer: None (default is Fortran), or an instance of \
    :py:class:`psyclone.psyir.backend.language_writer.LanguageWriter`

:raises InternalError: if the number of components in this signature \
    is different from the number of indices in component_indices.

Definition at line 110 of file signature.py.

    def to_language(self, component_indices=None, language_writer=None):
        # pylint: disable=too-many-locals
        '''Converts this signature with the provided indices to a string
        in the selected language.
 
        TODO 1320 This subroutine can be removed when we stop supporting
        strings - then we can use a PSyIR writer for the ReferenceNode
        to provide the right string.
 
        :param component_indices: the indices for each component of \
            the signature.
        :type component_indices: None (default is scalar access), or \
            :py:class:`psyclone.core.component_indices.ComponentIndices`
        :param language_writer: a backend visitor to convert PSyIR \
            expressions to a representation in the selected language. \
            This is used when creating error and warning messages.
        :type language_writer: None (default is Fortran), or an instance of \
            :py:class:`psyclone.psyir.backend.language_writer.LanguageWriter`
 
        :raises InternalError: if the number of components in this signature \
            is different from the number of indices in component_indices.
        '''
 
        # Avoid circular import
        # pylint: disable=import-outside-toplevel
        from psyclone.core import ComponentIndices
 
        # By default, if component_indices is None, we assume a scalar access:
        if component_indices is None:
            component_indices = ComponentIndices([[]] * len(self))
 
        # Check if number of components between self and component_indices
        # is consistent:
        if len(self._signature) != len(component_indices):
            raise InternalError(f"Signature '{self}' has {len(self)} "
                                f"components, but component_indices "
                                f"{component_indices} has "
                                f"{len(component_indices)}.")
        # Avoid circular import
        # pylint: disable=import-outside-toplevel
        from psyclone.psyir.backend.debug_writer import DebugWriter
        from psyclone.psyir.nodes import Literal, Node, Reference
 
        if language_writer is None:
            writer = DebugWriter()
        else:
            writer = language_writer
 
        # out_list collects the string representation of the components
        # including indices
        out_list = []
        for i, component in enumerate(self._signature):
            indices = component_indices[i]
            if not indices:
                out_list.append(component)
            else:
                # If there are indices, add the "(ind1, ind2, ...)"
                # TODO 1320: since we support strings and integer, we cannot
                # simply pass the list of indices to writer.gen_indices
                # (since it only accepts PSyIR Nodes). Instead we convert each
                # string to a Reference, and each integer to a Literal
                index_list = []
 
                for dimension in indices:
                    if isinstance(dimension, Node):
                        index_list.append(dimension)
                    elif isinstance(dimension, int):
                        index_list.append(Literal(str(dimension),
                                                  INTEGER_TYPE))
                    else:
                        ref = Reference(DataSymbol(dimension, INTEGER_TYPE))
                        index_list.append(ref)
                dims = writer.gen_indices(index_list, component)
 
                parenthesis = writer.array_parenthesis
                out_list.append(component + parenthesis[0] +
                                ",".join(dims) +
                                parenthesis[1])
 
        # Combine the components in out_list to form the language string.
        return writer.structure_character.join(out_list)
 

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

var_name()

def psyclone.core.signature.Signature.var_name

(

self

)

:returns: the actual variable name, i.e. the first component of
    the signature.
:rtype: str

Definition at line 254 of file signature.py.

    def var_name(self):
        ''':returns: the actual variable name, i.e. the first component of
            the signature.
        :rtype: str
        '''
        return self._signature[0]
 
 
# ---------- Documentation utils -------------------------------------------- #
# The list of module members that we wish AutoAPI to generate
# documentation for. (See https://psyclone-ref.readthedocs.io)

References psyclone.core.signature.Signature._signature, and psyclone.core.single_variable_access_info.SingleVariableAccessInfo._signature.

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/core/signature.py