Bridges-Python  3.4.4
Bridges(Python API)
Public Member Functions | List of all members
bridges.bst_element.BSTElement Class Reference
Inheritance diagram for bridges.bst_element.BSTElement:
bridges.bin_tree_element.BinTreeElement bridges.tree_element.TreeElement bridges.element.Element bridges.avl_tree_element.AVLTreeElement bridges.kd_tree_element.KDTreeElement

Detailed Description

The BSTElement class is the building block for creating binary search trees.

The BSTElement class is the building block for creating binary search tree structures. It contains two children (viz., left, right), and a search key, to be used in search operations .

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

BST 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
6/22/16, 1/7/17, 5/17/17, 7/23/19, 2021

This class extends the BinTreeElement class by adding a 'key' value for use in a binary search tree implementations.

Binary Search Tree tutorial, https://bridgesuncc.github.io/tutorials/BinarySearchTree.html

Public Member Functions

None __init__ (self, **kwargs)
 Constructor bst element. More...
 
str get_data_structure_type (self)
 Get the data structure representation. More...
 
str key (self)
 Getter for the bst element key. More...
 
None key (self, str k)
 Setter for the bst element key. More...
 
def left (self)
 Getter for the left element in BST. More...
 
def left (self, l)
 Setter for the left element in BST. More...
 
def right (self)
 Getter for the right child in BST. More...
 
def right (self, r)
 Setter for the right element in BST. More...
 
dict get_element_representation (self)
 Augment the element with the "key" field. 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_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.bst_element.BSTElement.__init__ (   self,
**  kwargs 
)

Constructor bst element.

       (str) key: The label for the tree element that shows in visualization
       (generic) e: the generic object that the tree element will hold
       (BinTreeElement) left: the tree element assigned to child 0
       (BinTreeElement) right: the tree element assigned to child 1
Returns
None

Reimplemented from bridges.bin_tree_element.BinTreeElement.

Reimplemented in bridges.kd_tree_element.KDTreeElement.

Member Function Documentation

◆ get_data_structure_type()

str bridges.bst_element.BSTElement.get_data_structure_type (   self)

Get the data structure representation.

Returns
str

Reimplemented from bridges.bin_tree_element.BinTreeElement.

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

◆ get_element_representation()

dict bridges.bst_element.BSTElement.get_element_representation (   self)

Augment the element with the "key" field.

Returns
dict representing the json of this tree

Reimplemented from bridges.element.Element.

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

◆ key() [1/2]

str bridges.bst_element.BSTElement.key (   self)

Getter for the bst element key.

Returns
str the key label

Reimplemented in bridges.avl_tree_element.AVLTreeElement.

◆ key() [2/2]

None bridges.bst_element.BSTElement.key (   self,
str  k 
)

Setter for the bst element key.

Parameters
kthe key for the element
Returns
None

◆ left() [1/2]

def bridges.bst_element.BSTElement.left (   self)

Getter for the left element in BST.

Returns
BSTElement the left child of this element

Reimplemented from bridges.bin_tree_element.BinTreeElement.

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

◆ left() [2/2]

def bridges.bst_element.BSTElement.left (   self,
  l 
)

Setter for the left element in BST.

Parameters
lthe value for the left child to be set as

Reimplemented from bridges.bin_tree_element.BinTreeElement.

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

◆ right() [1/2]

def bridges.bst_element.BSTElement.right (   self)

Getter for the right child in BST.

Returns
BSTElement the right child of the element

Reimplemented from bridges.bin_tree_element.BinTreeElement.

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

◆ right() [2/2]

def bridges.bst_element.BSTElement.right (   self,
  r 
)

Setter for the right element in BST.

Parameters
rthe value for the right child to be set as

Reimplemented from bridges.bin_tree_element.BinTreeElement.

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


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