Bridges-Python  3.4.3
Bridges(Python API)
Public Member Functions | List of all members
bridges.bin_tree_element.BinTreeElement Class Reference
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

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

Public Member Functions

None __init__ (self, **kwargs)
 Constructor for an empty Binary Tree Element. More...
 
str get_data_structure_type (self)
 Get the data structure type. More...
 
def left (self)
 Getter for the left element for the binary tree. More...
 
None left (self, l)
 Setter for the left element of a binary tree. More...
 
def right (self)
 Getter for the right element for the binary tree. More...
 
None right (self, r)
 Setter for the right element of a binary tree. More...
 
- Public Member Functions inherited from bridges.tree_element.TreeElement
None add_child (self, child)
 Adds a child to this parent node. More...
 
int get_number_of_children (self)
 Get the number of children at this node. More...
 
None set_child (self, int index, child)
 Adds a child to the node that will be added at the next open position. More...
 
def get_child (self, int index)
 Gets a child at particular index. More...
 
dict get_data_structure_representation (self)
 Get the hierarchical JSON of the tree representation (internal use only) More...
 
- Public Member Functions inherited from bridges.element.Element
object value (self)
 Getter for the value this element is holding. More...
 
None value (self, val)
 Setter for the value of an element. More...
 
str identifier (self)
 Getter for the element identifier. More...
 
None identifier (self, int id)
 Setter for the element identifier. More...
 
ElementVisualizer visualizer (self)
 Getter for the element visualizer. More...
 
None visualizer (self, ElementVisualizer vis)
 Setter function for this element visualizer. More...
 
LinkVisualizer get_link_visualizer (self, el)
 
None set_link_visualizer (self, el)
 Setter for the link visualizer of this element. More...
 
None remove_link_visualizer (self, el)
 Deleter function for the lik visualizer of this element. More...
 
def label (self)
 Getter for the element's label. More...
 
def label (self, label)
 Setter for the element's label. More...
 
def size (self)
 Getter for the element's size. More...
 
def size (self, sz)
 Setter for the element's size. More...
 
def color (self)
 Getter for the element's color. More...
 
def color (self, col)
 Setter for the element's size. More...
 
def opacity (self)
 Getter for the element's opacity. More...
 
def opacity (self, op)
 Setter for the element's opacity. More...
 
def shape (self)
 Getter for the element's shape type. More...
 
def shape (self, shp)
 Setter for the element's shape. More...
 
int id (self)
 Get numer of ids of element object. More...
 
def set_location (self, locX, locY)
 Setter for the element's location. More...
 
def get_locationX (self)
 Getter for the element's location in X. More...
 
def get_locationY (self)
 Getter for the element's location in Y. More...
 
def get_element_representation (self)
 Getter for the element's JSON representation (for internal use) More...
 
def get_link_representation (self, lv, src, dest)
 Getter for the JSON representation of the element's link (for internal use) More...
 

Additional Inherited Members

- Public Attributes inherited from bridges.tree_element.TreeElement
 children
 
- Public Attributes inherited from bridges.element.Element
 color
 
 opacity
 
- Static Public Attributes inherited from bridges.tree_element.TreeElement
string QUOTE = "\""
 
string COMMA = ","
 
string COLON = ":"
 
string OPEN_CURLY = "{"
 
string CLOSE_CURLY = "}"
 
string OPEN_PAREN = "("
 
string CLOSE_PAREN = ")"
 
string OPEN_BOX = "["
 
string CLOSE_BOX = "]"
 
- Static Public Attributes inherited from bridges.element.Element
int ids = 0
 

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.kd_tree_element.KDTreeElement, and bridges.bst_element.BSTElement.

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.kd_tree_element.KDTreeElement, bridges.bst_element.BSTElement, and bridges.avl_tree_element.AVLTreeElement.

◆ left() [1/2]

def bridges.bin_tree_element.BinTreeElement.left (   self)

Getter for the left element for the binary tree.

Returns
TreeElement left child of this element

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

◆ left() [2/2]

None bridges.bin_tree_element.BinTreeElement.left (   self,
  l 
)

Setter for the left element of a binary tree.

Parameters
lthe left element to set
Returns
None

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

◆ right() [1/2]

def bridges.bin_tree_element.BinTreeElement.right (   self)

Getter for the right element for the binary tree.

Returns
TreeElement the right child of this element

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

◆ right() [2/2]

None bridges.bin_tree_element.BinTreeElement.right (   self,
  r 
)

Setter for the right element of a binary tree.

Parameters
rthe right element to set
Returns
None

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


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