Bridges-Python 3.5.1
Bridges(Python API)
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
bridges.bin_tree_element.BinTreeElement Class Reference

This class is extended from the TreeElement class and can be used to create binary tree element objects. More...

Inheritance diagram for bridges.bin_tree_element.BinTreeElement:
bridges.tree_element.TreeElement bridges.element.Element bridges.bst_element.BSTElement bridges.avl_tree_element.AVLTreeElement bridges.kd_tree_element.KDTreeElement

Public Member Functions

None __init__ (self, **kwargs)
 Constructor for an empty Binary Tree Element.
 
str get_data_structure_type (self)
 Get the data structure type.
 
- Public Member Functions inherited from bridges.tree_element.TreeElement
None add_child (self, child)
 Adds a child to this parent node.
 
int get_number_of_children (self)
 Get the number of children at this node.
 
None set_child (self, int index, child)
 Adds a child to the node that will be added at the next open position.
 
 get_child (self, int index)
 Gets a child at particular index.
 
dict get_data_structure_representation (self)
 Get the hierarchical JSON of the tree representation (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

 left = property
 Getter for the left element for the binary tree.
 
 right = property
 Getter for the right element for the binary tree.
 
- Properties inherited from bridges.element.Element
 value = property
 Getter for the value this element is holding.
 
 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

- Public Attributes inherited from bridges.tree_element.TreeElement
 children
 
- Static Public Attributes inherited from bridges.tree_element.TreeElement
str QUOTE = "\""
 
str COMMA = ","
 
str COLON = ":"
 
str OPEN_CURLY = "{"
 
str CLOSE_CURLY = "}"
 
str OPEN_PAREN = "("
 
str CLOSE_PAREN = ")"
 
str OPEN_BOX = "["
 
str CLOSE_BOX = "]"
 
- Static Public Attributes inherited from bridges.element.Element
int ids = 0
 
- Protected Member Functions inherited from bridges.tree_element.TreeElement
dict _pre_order (self, root)
 Use a preoreder traversal to directly extract a hierarchical JSON representation of the tree.
 
- Protected Attributes inherited from bridges.element.Element
 _link_visualizer
 
 _ids
 
 _identifier
 
 _visualizer
 
 _value
 
 _label
 

Detailed Description

This class is extended from the TreeElement class and can be used to create binary tree element objects.

The BinTree element class is the building block for creating binary tree structures. It contains two children (viz., left, right).

BinTreeElement 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, for instance, between the current element and its left or right child

Author
Kalpathi Subramanian, Mihai Mehedint, Matthew McQuaigue
Date
2018, 7/23/19, 1/6/21
See also
Binary tree tutorial, https://bridgesuncc.github.io/tutorials/BinTree.html

Constructor & Destructor Documentation

◆ __init__()

None bridges.bin_tree_element.BinTreeElement.__init__ (   self,
**  kwargs 
)

Constructor for an empty Binary Tree Element.

Parameters
labelThe label for the tree element that is displayed in the visualization
ethe generic object that the binary tree element will hold
leftthe binary tree element assigned to child 0
rightthe binary tree element assigned to child 1
Returns
None

Reimplemented from bridges.tree_element.TreeElement.

Reimplemented in bridges.bst_element.BSTElement, bridges.kd_tree_element.KDTreeElement, and bridges.avl_tree_element.AVLTreeElement.

Member Function Documentation

◆ get_data_structure_type()

str bridges.bin_tree_element.BinTreeElement.get_data_structure_type (   self)

Get the data structure type.

Returns
str representing the data structure type

Reimplemented from bridges.tree_element.TreeElement.

Reimplemented in bridges.avl_tree_element.AVLTreeElement, bridges.bst_element.BSTElement, and bridges.kd_tree_element.KDTreeElement.

Property Documentation

◆ left

bridges.bin_tree_element.BinTreeElement.left = property
static

Getter for the left element for the binary tree.

Returns
TreeElement left child of this element

◆ right

bridges.bin_tree_element.BinTreeElement.right = property
static

Getter for the right element for the binary tree.

Returns
TreeElement the right child of this element

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