bridges.circ_sl_element.CircSLelement Class Reference

This class can be used to instantiate Singly Linked Circular List Elements. More...

Inheritance diagram for bridges.circ_sl_element.CircSLelement:

Public Member Functions
None	__init__ (self, **kwargs)
	The constructor for a Circular Singly Linked Element.
str	get_data_structure_type (self)
	Gets the data structure type.
	iterator (self)
	list iterator for use in range loops
Public Member Functions inherited from bridges.sl_element.SLelement
	list_helper (start)
	helper method for graph adjacency list
dict	get_data_structure_representation (self)
	Getter for this data structure representation.
	get_list_elements (self, nodes)
	Get the elements of the list (for internal use only)
Public Member Functions inherited from bridges.element.Element
LinkVisualizer	get_link_visualizer (self, el)
	Getter for the link visualizer object that links this element to another element specified by the argument.
None	set_link_visualizer (self, el)
	Setter for the link visualizer of this element.
None	remove_link_visualizer (self, el)
	Deleter function for the lik visualizer of this element.
	set_location (self, locX, locY)
	Setter for the element's location.
	get_locationX (self)
	Getter for the element's location in X.
	get_locationY (self)
	Getter for the element's location in Y.
	get_element_representation (self)
	Getter for the element's JSON representation (for internal use)
	get_link_representation (self, lv, src, dest)
	Getter for the JSON representation of the element's link (for internal use)

Properties
	next = property
	Getter for the next element of this CircSLelement.
Properties inherited from bridges.sl_element.SLelement
	value = property
	Getter for the SLelement value to hold.
Properties inherited from bridges.element.Element
	identifier = property
	Getter for the element identifier.
	visualizer = property
	Getter for the element visualizer.
	label = property
	Getter for the element's label.
	size = property
	Getter for the element's size.
	color = property
	Getter for the element's color.
	opacity = property
	Getter for the element's opacity.
	shape = property
	Getter for the element's shape type.
	id = property
	Get numer of ids of element object.

Additional Inherited Members
Static Public Attributes inherited from bridges.element.Element
int	ids = 0
Protected Attributes inherited from bridges.sl_element.SLelement
	_next
Protected Attributes inherited from bridges.element.Element
	_link_visualizer
	_ids
	_identifier
	_visualizer
	_value
	_label

Detailed Description

This class can be used to instantiate Singly Linked Circular List Elements.

Structurally they are the same as singly linked elements except that each node constructed with the next point pointing to itself; User's implementation of the circularly linked list needs to ensure that the last node points to first node of the list, as the visualization generation is dependent on this.

Elements have labels (string) that are displayed on the visualization. Elements take an generic object as a user defined parameter, E, which can be any native type or object.

Elements contains a visualizer (ElementVisualizer) object for setting visual attributes (color, shape, opacity, size), necessary for displaying them in a web browser.

Elements also have a LinkVisualizer object that is used when they are linked to another element, appropriate for setting link attributes, between an element and its next element.

Author

Kalpathi Subramanian, Matthew McQuaigue

Date

6/22/16, 1/7/17, 5/17/17, 7/23/19, 12/29/20

Circular singly linked list tutorial: https://bridgesuncc.github.io/tutorials/CircularSinglyLinkedList.html

Constructor & Destructor Documentation

__init__()

None bridges.circ_sl_element.CircSLelement.__init__	(		self,
		**	kwargs
	)

The constructor for a Circular Singly Linked Element.

Parameters

e	the generic object that this CircSLelement will hold
label	The label of this CircSLelement
next	The CircSLelement that should be assigned to the next pointer

Returns

None

Reimplemented from bridges.sl_element.SLelement.

Member Function Documentation

get_data_structure_type()

str bridges.circ_sl_element.CircSLelement.get_data_structure_type

(

self

)

Gets the data structure type.

Returns

str representing the data structure type

Reimplemented from bridges.sl_element.SLelement.

iterator()

bridges.circ_sl_element.CircSLelement.iterator

(

self

)

list iterator for use in range loops

Reimplemented from bridges.sl_element.SLelement.

Property Documentation

next

bridges.circ_sl_element.CircSLelement.next = property

static

Getter for the next element of this CircSLelement.

Returns

CircSLelement the element that follows this element

---

The documentation for this class was generated from the following file:

• bridges-python/bridges/circ_sl_element.py