psyclone.psyir.nodes.node.ChildrenList Class Reference

Inheritance diagram for psyclone.psyir.nodes.node.ChildrenList:

Collaboration diagram for psyclone.psyir.nodes.node.ChildrenList:

Public Member Functions
def	__init__ (self, node, validation_function, validation_text)
def	append (self, item)
def	__setitem__ (self, index, item)
def	insert (self, index, item)
def	extend (self, items)
def	__delitem__ (self, index)
def	remove (self, item)
def	pop (self, index=-1)
def	reverse (self)
def	clear (self)
def	sort (self, reverse=False, key=None)

Detailed Description

Customized list to keep track of the children nodes. It is initialised with
a callback function that allows the validation of the inserted children.
Since this is a subclass of the standard list, all operations (e.g. append,
insert, extend, comparisons, list arithmetic operations) are conserved and
make use of the validation. They also trigger an update of all ancestor
nodes so that action can be taken in order to keep the tree consistent when
necessary (e.g. to update the data-movement clauses on an OpenACC data
region).

:param node: reference to the node where the list belongs.
:type node: :py:class:`psyclone.psyir.nodes.Node`
:param validation_function: callback function to the validation method.
:type validation_function: \
        function(int, :py:class:`psyclone.psyir.nodes.Node`)
:param str validation_text: textual representation of the valid children.

Definition at line 94 of file node.py.

Member Function Documentation

__delitem__()

def psyclone.psyir.nodes.node.ChildrenList.__delitem__	(		self,
			index
	)

 Extends list __delitem__ method with children node validation.

:param int index: position where to insert the item.

Definition at line 266 of file node.py.

    def __delitem__(self, index):
        ''' Extends list __delitem__ method with children node validation.
 
        :param int index: position where to insert the item.
 
        '''
        positiveindex = index if index >= 0 else len(self) - index
        for position in range(positiveindex + 1, len(self)):
            self._validate_item(position - 1, self[position])
        self._del_parent_link(self[index])
        super().__delitem__(index)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._del_parent_link(), psyclone.psyir.nodes.node.ChildrenList._node_reference, and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

__setitem__()

def psyclone.psyir.nodes.node.ChildrenList.__setitem__	(		self,
			index,
			item
	)

 Extends list __setitem__ method with children node validation.

:param int index: position where to insert the item.
:param item: item to be inserted to the list.
:type item: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 216 of file node.py.

    def __setitem__(self, index, item):
        ''' Extends list __setitem__ method with children node validation.
 
        :param int index: position where to insert the item.
        :param item: item to be inserted to the list.
        :type item: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        self._validate_item(index, item)
        self._check_is_orphan(item)
        self._del_parent_link(self[index])
        super().__setitem__(index, item)
        self._set_parent_link(item)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._check_is_orphan(), psyclone.psyir.nodes.node.ChildrenList._del_parent_link(), psyclone.psyir.nodes.node.ChildrenList._node_reference, psyclone.psyir.nodes.node.ChildrenList._set_parent_link(), and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

append()

def psyclone.psyir.nodes.node.ChildrenList.append	(		self,
			item
	)

 Extends list append method with children node validation.

:param item: item to be appened to the list.
:type item: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 203 of file node.py.

    def append(self, item):
        ''' Extends list append method with children node validation.
 
        :param item: item to be appened to the list.
        :type item: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        self._validate_item(len(self), item)
        self._check_is_orphan(item)
        super().append(item)
        self._set_parent_link(item)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._check_is_orphan(), psyclone.psyir.nodes.node.ChildrenList._node_reference, psyclone.psyir.nodes.node.ChildrenList._set_parent_link(), and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

def psyclone.psyir.nodes.node.ChildrenList.clear

(

self

)

 Wipes the list. 

Definition at line 320 of file node.py.

    def clear(self):
        ''' Wipes the list. '''
        for item in self:
            self._del_parent_link(item)
        super().clear()
        # Signal that the tree has changed.
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._del_parent_link(), and psyclone.psyir.nodes.node.ChildrenList._node_reference.

Here is the call graph for this function:

extend()

def psyclone.psyir.nodes.node.ChildrenList.extend	(		self,
			items
	)

 Extends list extend method with children node validation.

:param items: list of items to be appened to the list.
:type items: list of :py:class:`psyclone.psyir.nodes.Node`

Definition at line 249 of file node.py.

    def extend(self, items):
        ''' Extends list extend method with children node validation.
 
        :param items: list of items to be appened to the list.
        :type items: list of :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        for index, item in enumerate(items):
            self._validate_item(len(self) + index, item)
            self._check_is_orphan(item)
        super().extend(items)
        for item in items:
            self._set_parent_link(item)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._check_is_orphan(), psyclone.psyir.nodes.node.ChildrenList._node_reference, psyclone.psyir.nodes.node.ChildrenList._set_parent_link(), and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

def psyclone.psyir.nodes.node.ChildrenList.insert	(		self,
			index,
			item
	)

 Extends list insert method with children node validation.

:param int index: position where to insert the item.
:param item: item to be inserted to the list.
:type item: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 231 of file node.py.

    def insert(self, index, item):
        ''' Extends list insert method with children node validation.
 
        :param int index: position where to insert the item.
        :param item: item to be inserted to the list.
        :type item: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        positiveindex = index if index >= 0 else len(self) - index
        self._validate_item(positiveindex, item)
        self._check_is_orphan(item)
        # Check that all displaced items will still in valid positions
        for position in range(positiveindex, len(self)):
            self._validate_item(position + 1, self[position])
        super().insert(index, item)
        self._set_parent_link(item)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._check_is_orphan(), psyclone.psyir.nodes.node.ChildrenList._node_reference, psyclone.psyir.nodes.node.ChildrenList._set_parent_link(), and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

pop()

def psyclone.psyir.nodes.node.ChildrenList.pop	(		self,
			index = -1
	)

 Extends list pop method with children node validation.

:param int index: position of the item that is popped out, if not \
    given, the last element is popped out.

:returns: the last value or the given index value from the list.
:rtype: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 292 of file node.py.

    def pop(self, index=-1):
        ''' Extends list pop method with children node validation.
 
        :param int index: position of the item that is popped out, if not \
            given, the last element is popped out.
 
        :returns: the last value or the given index value from the list.
        :rtype: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        positiveindex = index if index >= 0 else len(self) - index
        # Check if displaced items after 'positiveindex' will still be valid
        for position in range(positiveindex + 1, len(self)):
            self._validate_item(position - 1, self[position])
        self._del_parent_link(self[index])
        obj = super().pop(index)
        self._node_reference.update_signal()
        return obj
 

References psyclone.psyir.nodes.node.ChildrenList._del_parent_link(), psyclone.psyir.nodes.node.ChildrenList._node_reference, and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

remove()

def psyclone.psyir.nodes.node.ChildrenList.remove	(		self,
			item
	)

 Extends list remove method with children node validation.

:param item: item to be deleted the list.
:type item: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 279 of file node.py.

    def remove(self, item):
        ''' Extends list remove method with children node validation.
 
        :param item: item to be deleted the list.
        :type item: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        for position in range(self.index(item) + 1, len(self)):
            self._validate_item(position - 1, self[position])
        self._del_parent_link(item)
        super().remove(item)
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._del_parent_link(), psyclone.psyir.nodes.node.ChildrenList._node_reference, and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

Here is the caller graph for this function:

reverse()

def psyclone.psyir.nodes.node.ChildrenList.reverse

(

self

)

 Extends list reverse method with children node validation. 

Definition at line 311 of file node.py.

    def reverse(self):
        ''' Extends list reverse method with children node validation. '''
        for index, item in enumerate(self):
            self._validate_item(len(self) - index - 1, item)
        super().reverse()
        # Reversing the order of e.g. Statements may alter the read/write
        # properties of any References.
        self._node_reference.update_signal()
 

References psyclone.psyir.nodes.node.ChildrenList._node_reference, and psyclone.psyir.nodes.node.ChildrenList._validate_item().

Here is the call graph for this function:

sort()

def psyclone.psyir.nodes.node.ChildrenList.sort	(		self,
			reverse = False,
			key = None
	)

Override the default sort() implementation as this is not supported
for a ChildrenList.

:raises NotImplementedError: it makes no sense to sort the Children of
                             a Node.

Definition at line 328 of file node.py.

    def sort(self, reverse=False, key=None):
        '''Override the default sort() implementation as this is not supported
        for a ChildrenList.
 
        :raises NotImplementedError: it makes no sense to sort the Children of
                                     a Node.
        '''
        raise NotImplementedError("Sorting the Children of a Node is not "
                                  "supported.")
 
 

---

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/node.py