Inheritance diagram for psyclone.psyir.symbols.datasymbol.DataSymbol:

[legend]

Collaboration diagram for psyclone.psyir.symbols.datasymbol.DataSymbol:

[legend]

Public Member Functions
def	__init__ (self, name, datatype, is_constant=False, initial_value=None, **kwargs)

def	is_constant (self)

def	is_constant (self, value)

def	initial_value (self)

def	initial_value (self, new_value)

def	__str__ (self)

def	copy (self)

def	copy_properties (self, symbol_in)

Public Member Functions inherited from psyclone.psyir.symbols.typed_symbol.TypedSymbol
def	__init__ (self, name, datatype, **kwargs)

def	datatype (self)

def	datatype (self, value)

def	resolve_type (self)

def	is_scalar (self)

def	is_array (self)

def	shape (self)

Public Member Functions inherited from psyclone.psyir.symbols.symbol.Symbol
def	__init__ (self, name, visibility=DEFAULT_VISIBILITY, interface=None)

def	specialise (self, subclass, **kwargs)

def	get_external_symbol (self)

def	name (self)

def	visibility (self)

def	visibility (self, value)

def	interface (self)

def	interface (self, value)

def	is_automatic (self)

def	is_modulevar (self)

def	is_import (self)

def	is_argument (self)

def	is_commonblock (self)

def	is_static (self)

def	is_unresolved (self)

def	is_unknown_interface (self)

def	find_symbol_table (self, node)

def	is_array_access (self, index_variable=None, access_info=None)

Public Attributes
	initial_value

	is_constant

	interface

Public Attributes inherited from psyclone.psyir.symbols.typed_symbol.TypedSymbol
	datatype

	interface

Public Attributes inherited from psyclone.psyir.symbols.symbol.Symbol
	interface

	visibility

Additional Inherited Members
Static Public Attributes inherited from psyclone.psyir.symbols.symbol.Symbol
	DEFAULT_VISIBILITY = Visibility.PUBLIC

Detailed Description

Symbol identifying a data element. It contains information about:
the datatype, the shape (in column-major order) and the interface
to that symbol (i.e. Local, Global, Argument).

:param str name: name of the symbol.
:param datatype: data type of the symbol.
:type datatype: :py:class:`psyclone.psyir.symbols.DataType`
:param bool is_constant: whether this DataSymbol is a compile-time
    constant (default is False). If True then an `initial_value` must
    also be provided.
:param initial_value: sets a fixed known expression as an initial
    value for this DataSymbol. If `is_constant` is True then this
    Symbol will always have this value. If the value is None then this
    symbol does not have an initial value (and cannot be a constant).
    Otherwise it can receive PSyIR expressions or Python intrinsic types
    available in the TYPE_MAP_TO_PYTHON map. By default it is None.
:type initial_value: Optional[item of TYPE_MAP_TO_PYTHON |
    :py:class:`psyclone.psyir.nodes.Node`]
:param kwargs: additional keyword arguments provided by
               :py:class:`psyclone.psyir.symbols.TypedSymbol`
:type kwargs: unwrapped dict.

Definition at line 45 of file datasymbol.py.

Member Function Documentation

◆ str()

def psyclone.psyir.symbols.datasymbol.DataSymbol.__str__ ( self )

 Abstract method. Must be overridden in sub-class.

Reimplemented from psyclone.psyir.symbols.typed_symbol.TypedSymbol.

Definition at line 287 of file datasymbol.py.

     def __str__(self):
         ret = self.name + ": DataSymbol<" + str(self.datatype)
         ret += ", " + str(self._interface)
         if self.initial_value is not None:
             ret += f", initial_value={self.initial_value}"
         if self.is_constant:
             ret += ", constant=True"
         return ret + ">"
  

Here is the call graph for this function:

◆ copy()

def psyclone.psyir.symbols.datasymbol.DataSymbol.copy ( self )

Create and return a copy of this object. Any references to the
original will not be affected so the copy will not be referred
to by any other object.

:returns: An object with the same properties as this symbol object.
:rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`

Reimplemented from psyclone.psyir.symbols.typed_symbol.TypedSymbol.

Definition at line 296 of file datasymbol.py.

     def copy(self):
         '''Create and return a copy of this object. Any references to the
         original will not be affected so the copy will not be referred
         to by any other object.
  
         :returns: An object with the same properties as this symbol object.
         :rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`
  
         '''
         if self.initial_value is not None:
             new_init_value = self.initial_value.copy()
         else:
             new_init_value = None
         return DataSymbol(self.name, self.datatype, visibility=self.visibility,
                           interface=self.interface,
                           is_constant=self.is_constant,
                           initial_value=new_init_value)
  

Here is the call graph for this function:

◆ copy_properties()

def psyclone.psyir.symbols.datasymbol.DataSymbol.copy_properties	(	self,
		symbol_in
	)

Replace all properties in this object with the properties from
symbol_in, apart from the name (which is immutable) and visibility.

:param symbol_in: the symbol from which the properties are copied.
:type symbol_in: :py:class:`psyclone.psyir.symbols.DataSymbol`

:raises TypeError: if the argument is not the expected type.

Reimplemented from psyclone.psyir.symbols.typed_symbol.TypedSymbol.

Definition at line 314 of file datasymbol.py.

     def copy_properties(self, symbol_in):
         '''Replace all properties in this object with the properties from
         symbol_in, apart from the name (which is immutable) and visibility.
  
         :param symbol_in: the symbol from which the properties are copied.
         :type symbol_in: :py:class:`psyclone.psyir.symbols.DataSymbol`
  
         :raises TypeError: if the argument is not the expected type.
  
         '''
         if not isinstance(symbol_in, DataSymbol):
             raise TypeError(f"Argument should be of type 'DataSymbol' but "
                             f"found '{type(symbol_in).__name__}'.")
         super().copy_properties(symbol_in)
         self._is_constant = symbol_in.is_constant
         self._initial_value = symbol_in.initial_value

References psyclone.psyir.symbols.datasymbol.DataSymbol._initial_value, and psyclone.psyir.symbols.datasymbol.DataSymbol._is_constant.

Here is the caller graph for this function:

◆ initial_value() [1/2]

def psyclone.psyir.symbols.datasymbol.DataSymbol.initial_value ( self )

:returns: the initial value associated with this symbol (if any).
:rtype: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 184 of file datasymbol.py.

     def initial_value(self):
         '''
         :returns: the initial value associated with this symbol (if any).
         :rtype: :py:class:`psyclone.psyir.nodes.Node`
  
         '''
         return self._initial_value
  

References psyclone.psyir.symbols.datasymbol.DataSymbol._initial_value.

Here is the caller graph for this function:

◆ initial_value() [2/2]

def psyclone.psyir.symbols.datasymbol.DataSymbol.initial_value	(	self,
		new_value
	)

:param new_value: set or change the initial value associated
    with this DataSymbol. If the value is None then this symbol does
    not have an initial value (and cannot be a constant). Otherwise it
    can receive PSyIR expressions or Python intrinsic types available
    in the TYPE_MAP_TO_PYTHON map.
:type new_value: Optional[item of TYPE_MAP_TO_PYTHON |
    :py:class:`psyclone.psyir.nodes.Node`]

:raises ValueError: if a non-None value is provided and 1) this
    DataSymbol instance represents an argument, or 2) this
    DataSymbol instance is not a scalar (as the shape attribute is
    not empty), or 3) an initial value is provided but the type of
    the value is not supported, or 4) the type of the value
    provided is not compatible with the datatype of this DataSymbol
    instance, or 5) the provided PSyIR expression is unsupported.
:raises ValueError: if a None value is provided and this DataSymbol
    represents a constant and is not imported.

Definition at line 193 of file datasymbol.py.

     def initial_value(self, new_value):
         '''
         :param new_value: set or change the initial value associated
             with this DataSymbol. If the value is None then this symbol does
             not have an initial value (and cannot be a constant). Otherwise it
             can receive PSyIR expressions or Python intrinsic types available
             in the TYPE_MAP_TO_PYTHON map.
         :type new_value: Optional[item of TYPE_MAP_TO_PYTHON |
             :py:class:`psyclone.psyir.nodes.Node`]
  
         :raises ValueError: if a non-None value is provided and 1) this
             DataSymbol instance represents an argument, or 2) this
             DataSymbol instance is not a scalar (as the shape attribute is
             not empty), or 3) an initial value is provided but the type of
             the value is not supported, or 4) the type of the value
             provided is not compatible with the datatype of this DataSymbol
             instance, or 5) the provided PSyIR expression is unsupported.
         :raises ValueError: if a None value is provided and this DataSymbol
             represents a constant and is not imported.
  
         '''
         # pylint: disable=import-outside-toplevel
         from psyclone.psyir.nodes import (Node, Literal, Operation, Reference,
                                           CodeBlock, IntrinsicCall)
         from psyclone.psyir.symbols.datatypes import (ScalarType, ArrayType,
                                                       UnsupportedType)
  
         if new_value is not None:
             if self.is_argument:
                 raise ValueError(
                     f"Error setting initial value for symbol '{self.name}'. "
                     f"A DataSymbol with an ArgumentInterface can not have an "
                     f"initial value.")
             if not isinstance(self.datatype,
                               (ScalarType, ArrayType, UnsupportedType)):
                 raise ValueError(
                     f"Error setting initial value for symbol '{self.name}'. "
                     f"A DataSymbol with an initial value must be a scalar or "
                     f"an array or of UnsupportedType but found "
                     f"'{type(self.datatype).__name__}'.")
  
             if isinstance(new_value, Node):
                 for node in new_value.walk(Node):
                     if not isinstance(node, (Literal, Operation, Reference,
                                              CodeBlock, IntrinsicCall)):
                         raise ValueError(
                             f"Error setting initial value for symbol "
                             f"'{self.name}'. PSyIR static expressions can only"
                             f" contain PSyIR Literal, Operation, Reference,"
                             f" IntrinsicCall or CodeBlock nodes but found: "
                             f"{node}")
                 new_initial_value = new_value
             else:
                 from psyclone.psyir.symbols.datatypes import TYPE_MAP_TO_PYTHON
                 # No need to check that self.datatype has an intrinsic
                 # attribute as we know it is a ScalarType or ArrayType
                 # due to an earlier test.
                 lookup = TYPE_MAP_TO_PYTHON[self.datatype.intrinsic]
                 if not isinstance(new_value, lookup):
                     raise ValueError(
                         f"Error setting initial value for symbol "
                         f"'{self.name}'. This DataSymbol instance datatype is "
                         f"'{self.datatype}' meaning the initial value should "
                         f"be '{lookup}' but found '{type(new_value)}'.")
                 if self.datatype.intrinsic == ScalarType.Intrinsic.BOOLEAN:
                     # In this case we know new_value is a Python boolean as it
                     # has passed the isinstance(new_value, lookup) check.
                     if new_value:
                         new_initial_value = Literal('true', self.datatype)
                     else:
                         new_initial_value = Literal('false', self.datatype)
                 else:
                     # Otherwise we convert the Python intrinsic to a PSyIR
                     # Literal using its string representation.
                     new_initial_value = Literal(str(new_value), self.datatype)
  
             # Add it to a properly formed Assignment parent, this implicitly
             # guarantees that the node is not attached anywhere else (and is
             # unexpectedly modified) and also makes it similar to any other RHS
             # expression, enabling some functionality without special cases.
             # Note that the parent dangles on top of the init value, and is not
             # referenced directly from anywhere else.
             from psyclone.psyir.nodes import Assignment
             parent = Assignment()
             parent.addchild(Reference(self))
             parent.addchild(new_initial_value)
             self._initial_value = new_initial_value
         else:
             if self.is_constant and not self.is_import:
                 raise ValueError(
                     f"DataSymbol '{self.name}' is a constant and not imported "
                     f"and therefore must have an initial value but got None")
             self._initial_value = None
  

References psyclone.psyir.symbols.datasymbol.DataSymbol._initial_value, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg.datatype(), psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata.datatype, psyclone.psyir.nodes.array_reference.ArrayReference.datatype(), psyclone.psyir.nodes.datanode.DataNode.datatype(), psyclone.psyir.nodes.literal.Literal.datatype, psyclone.psyir.nodes.operation.UnaryOperation.datatype(), psyclone.psyir.nodes.operation.BinaryOperation.datatype(), psyclone.psyir.nodes.reference.Reference.datatype(), psyclone.psyir.nodes.structure_reference.StructureReference.datatype(), psyclone.psyir.symbols.data_type_symbol.DataTypeSymbol.datatype, psyclone.psyir.symbols.datatypes.ArrayType.datatype(), psyclone.psyir.symbols.typed_symbol.TypedSymbol.datatype, psyclone.psyir.symbols.symbol.Symbol.is_argument(), psyclone.psyir.symbols.datasymbol.DataSymbol.is_constant, and psyclone.psyir.symbols.symbol.Symbol.is_import().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_constant() [1/2]

def psyclone.psyir.symbols.datasymbol.DataSymbol.is_constant ( self )

:returns: Whether the symbol is a compile-time constant (True) or
    not (False).
:rtype: bool

Definition at line 152 of file datasymbol.py.

     def is_constant(self):
         '''
         :returns: Whether the symbol is a compile-time constant (True) or
             not (False).
         :rtype: bool
         '''
         return self._is_constant
  

References psyclone.psyir.symbols.datasymbol.DataSymbol._is_constant.

Here is the caller graph for this function:

◆ is_constant() [2/2]

def psyclone.psyir.symbols.datasymbol.DataSymbol.is_constant	(	self,
		value
	)

:param bool value: whether or not this symbol is a compile-time
    constant.

:raises ValueError: if `value` is True but this symbol does not have an
    initial value or an import or unresolved interface.

Definition at line 161 of file datasymbol.py.

     def is_constant(self, value):
         '''
         :param bool value: whether or not this symbol is a compile-time
             constant.
  
         :raises ValueError: if `value` is True but this symbol does not have an
             initial value or an import or unresolved interface.
  
         '''
         if (value and not (self.is_import or self.is_unresolved) and
                 self.initial_value is None):
             # A Symbol of UnsupportedType could have initialisation within its
             # original declaration.
             # pylint: disable=import-outside-toplevel
             from psyclone.psyir.symbols.datatypes import UnsupportedType
             if not isinstance(self.datatype, UnsupportedType):
                 raise ValueError(
                     f"DataSymbol '{self.name}' cannot be a constant because it"
                     f" does not have an initial value or an import or "
                     f"unresolved interface.")
         self._is_constant = value
  