esds

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: BST</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: BST</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>BST<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description">BST Class Binary Search Tree</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="BST"><span class="type-signature"></span>new BST<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> BST Constructor </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line31">line 31</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="isEmpty"><span class="type-signature"></span>isEmpty<span class="type-signature"></span></h4> <div class="description"> Indicates if the BST is empty </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line282">line 282</a> </li></ul></dd> </dl> <h4 class="name" id="max"><span class="type-signature"></span>max<span class="type-signature"></span></h4> <div class="description"> Returns max element in the BST </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line256">line 256</a> </li></ul></dd> </dl> <h4 class="name" id="min"><span class="type-signature"></span>min<span class="type-signature"></span></h4> <div class="description"> Returns min element in the BST </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line265">line 265</a> </li></ul></dd> </dl> <h4 class="name" id="size"><span class="type-signature"></span>size<span class="type-signature"></span></h4> <div class="description"> Returns number of element in the BST </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line274">line 274</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(key, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Insert a new element in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Unique key for the element</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Value of the element, null if not provided</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line54">line 54</a> </li></ul></dd> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> - If Element already exists in the BST </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - True - If element was added </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Clears the BST </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line42">line 42</a> </li></ul></dd> </dl> <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(key<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="TreeElement.html">TreeElement</a>}</span></h4> <div class="description"> Returns an existing element in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Unique key for the element, if null, return root of BST</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line189">line 189</a> </li></ul></dd> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> - If element is not found </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - Requested element, root of key is not provided </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="TreeElement.html">TreeElement</a></span> </dd> </dl> <h4 class="name" id="has"><span class="type-signature"></span>has<span class="signature">(key)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Indicates if an element exists in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">Unique key for the element</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line205">line 205</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - True if element exists, false if element does not exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(key, type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Removes an existing element in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Unique key for the element</td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> predecessor </td> <td class="description last">Specifies delete type, allows 'predecessor' (default) for in-order predecessor, and 'successor' for in-order successor</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line88">line 88</a> </li></ul></dd> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> - If delete type is invalid </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - True - If element was added; False if element does not exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="toArray"><span class="type-signature"></span>toArray<span class="signature">(key, traversal<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<number>}</span></h4> <div class="description"> Returns an array containing the key of the elements in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Unique key for the element</td> </tr> <tr> <td class="name"><code>traversal</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "in-order" </td> <td class="description last">Specifies Traversal type, allows 'in-order' (default), 'pre-order', 'post-order', and 'reverse-in-order</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line220">line 220</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - Array of element keys </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array.<number></span> </dd> </dl> <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(key, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Updates an existing element in the BST </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Unique key for the element</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Value of the element, null if not provided</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BST.mjs.html">BST.mjs</a>, <a href="BST.mjs.html#line171">line 171</a> </li></ul></dd> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> - If element is not found </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> <dd></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - True - If element was edited </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BloomFilter.html">BloomFilter</a></li><li><a href="BST.html">BST</a></li><li><a href="Element.html">Element</a></li><li><a href="Graph.html">Graph</a></li><li><a href="List.html">List</a></li><li><a href="Node.html">Node</a></li><li><a href="PriorityQueue.html">PriorityQueue</a></li><li><a href="Queue.html">Queue</a></li><li><a href="Stack.html">Stack</a></li><li><a href="TreeElement.html">TreeElement</a></li><li><a href="Trie.html">Trie</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Sep 23 2021 00:49:18 GMT-0700 (Pacific Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>