Inheritance diagram for psyclone.psyir.nodes.member.Member:

[legend]

Collaboration diagram for psyclone.psyir.nodes.member.Member:

Public Member Functions
def	__init__ (self, member_name, parent=None)

def	__eq__ (self, other)

def	name (self)

def	node_str (self, colour=True)

def	__str__ (self)

def	is_array (self)

def	get_signature_and_indices (self)

Public Member Functions inherited from psyclone.psyir.nodes.node.Node
def	__init__ (self, ast=None, children=None, parent=None, annotations=None)

def	coloured_name (self, colour=True)

def	ast (self)

def	ast_end (self)

def	ast (self, ast)

def	ast_end (self, ast_end)

def	annotations (self)

def	dag (self, file_name='dag', file_format='svg')

def	dag_gen (self, graph)

def	dag_name (self)

def	args (self)

def	backward_dependence (self)

def	forward_dependence (self)

def	is_valid_location (self, new_node, position="before")

def	depth (self)

def	view (self, depth=0, colour=True, indent=" ", _index=None)

def	addchild (self, child, index=None)

def	children (self)

def	children (self, my_children)

def	parent (self)

def	siblings (self)

def	has_constructor_parent (self)

def	position (self)

def	abs_position (self)

def	root (self)

def	sameParent (self, node_2)

def	walk (self, my_type, stop_type=None, depth=None)

def	get_sibling_lists (self, my_type, stop_type=None)

def	ancestor (self, my_type, excluding=None, include_self=False, limit=None, shared_with=None)

def	kernels (self)

def	following (self, routine=True)

def	preceding (self, reverse=False, routine=True)

def	immediately_precedes (self, node_2)

def	immediately_follows (self, node_1)

def	coded_kernels (self)

def	loops (self)

def	reductions (self, reprod=None)

def	is_openmp_parallel (self)

def	lower_to_language_level (self)

def	reference_accesses (self, var_accesses)

def	scope (self)

def	replace_with (self, node, keep_name_in_context=True)

def	pop_all_children (self)

def	detach (self)

def	copy (self)

def	validate_global_constraints (self)

def	debug_string (self)

def	origin_string (self)

def	update_signal (self)

def	path_from (self, ancestor)

Public Attributes
	name

Public Attributes inherited from psyclone.psyir.nodes.node.Node
	position

Additional Inherited Members
Static Public Attributes inherited from psyclone.psyir.nodes.node.Node
int	START_DEPTH = 0

int	START_POSITION = 0

	valid_annotations = tuple()

Detailed Description

Node representing a membership expression of a structure.
As such it is a leaf in the PSyIR tree.

:param str member_name: the name of the member of the structure that is \
                        being referenced.
:param parent: the parent of this node in the PSyIR tree.
:type parent: :py:class:`psyclone.psyir.nodes.StructureReference` or \
              :py:class:`psyclone.psyir.nodes.Member`

:raises TypeError: if the supplied parent is of the wrong type.

Definition at line 46 of file member.py.

Member Function Documentation

◆ eq()

def psyclone.psyir.nodes.member.Member.__eq__	(	self,
		other
	)

Members are assumed to be equivalent if they have the same
component name associated with them, and are the same type.

:param object other: the object to check equality to.

:returns: whether other is equal to self.
:rtype: bool

Reimplemented from psyclone.psyir.nodes.node.Node.

Definition at line 85 of file member.py.

     def __eq__(self, other):
         '''
         Members are assumed to be equivalent if they have the same
         component name associated with them, and are the same type.
  
         :param object other: the object to check equality to.
  
         :returns: whether other is equal to self.
         :rtype: bool
         '''
         is_eq = super().__eq__(other)
         is_eq = is_eq and self.name == other.name
         return is_eq
  

Here is the call graph for this function:

◆ get_signature_and_indices()

def psyclone.psyir.nodes.member.Member.get_signature_and_indices ( self )

:returns: the Signature of this member access, and a list \
of list of the indices used for each component, which is empty \
in this case since it is not an array access.
:rtype: tuple(:py:class:`psyclone.core.Signature`, list of \
    lists of indices)

Reimplemented in psyclone.psyir.nodes.structure_member.StructureMember.

Definition at line 129 of file member.py.

     def get_signature_and_indices(self):
         ''':returns: the Signature of this member access, and a list \
         of list of the indices used for each component, which is empty \
         in this case since it is not an array access.
         :rtype: tuple(:py:class:`psyclone.core.Signature`, list of \
             lists of indices)
         '''
         return (Signature(self.name), [[]])
  
  
 # For Sphinx AutoAPI documentation generation

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_array()

def psyclone.psyir.nodes.member.Member.is_array ( self )

:returns: whether this member is an array.
:rtype: bool

Definition at line 122 of file member.py.

     def is_array(self):
         ''':returns: whether this member is an array.
         :rtype: bool
  
         '''
         return False
  

Here is the caller graph for this function:

◆ name()

def psyclone.psyir.nodes.member.Member.name ( self )

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

Definition at line 100 of file member.py.

     def name(self):
         '''
         :returns: the name of this member.
         :rtype: str
         '''
         return self._component_name
  

References psyclone.psyir.nodes.member.Member._component_name.

Here is the caller graph for this function:

◆ node_str()

def psyclone.psyir.nodes.member.Member.node_str	(	self,
		colour = `True`
	)

 Create a text description of this node in the schedule, optionally
including control codes for colour.

:param bool colour: whether or not to include colour control codes.

:return: text description of this node.
:rtype: str

Reimplemented from psyclone.psyir.nodes.node.Node.

Definition at line 107 of file member.py.

     def node_str(self, colour=True):
         ''' Create a text description of this node in the schedule, optionally
         including control codes for colour.
  
         :param bool colour: whether or not to include colour control codes.
  
         :return: text description of this node.
         :rtype: str
         '''
         return self.coloured_name(colour) + "[name:'" + self.name + "']"
  

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/psyir/nodes/member.py

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __eq__()

◆ get_signature_and_indices()

◆ is_array()

◆ name()

◆ node_str()

◆ eq()