blob: 4435fec93f1ab8d05a7aaa6dbeed62e18770ab0f [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="The binary tree."><meta name="keywords" content="rust, rustlang, rust-lang, BinaryTree"><title>BinaryTree in gbdt::binary_tree - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../gbdt/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../gbdt/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">BinaryTree</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.add_left_node">add_left_node</a></li><li><a href="#method.add_right_node">add_right_node</a></li><li><a href="#method.add_root">add_root</a></li><li><a href="#method.get_left_child">get_left_child</a></li><li><a href="#method.get_node">get_node</a></li><li><a href="#method.get_node_mut">get_node_mut</a></li><li><a href="#method.get_right_child">get_right_child</a></li><li><a href="#method.get_root_index">get_root_index</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">new</a></li><li><a href="#method.print">print</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-BinaryTree%3CT%3E">Debug</a></li><li><a href="#impl-Default-for-BinaryTree%3CT%3E">Default</a></li><li><a href="#impl-Deserialize%3C%27de%3E-for-BinaryTree%3CT%3E">Deserialize&lt;&#39;de&gt;</a></li><li><a href="#impl-Serialize-for-BinaryTree%3CT%3E">Serialize</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-BinaryTree%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BinaryTree%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-BinaryTree%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-BinaryTree%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BinaryTree%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-BinaryTree%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-BinaryTree%3CT%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-BinaryTree%3CT%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-DeserializeOwned-for-BinaryTree%3CT%3E">DeserializeOwned</a></li><li><a href="#impl-From%3CT%3E-for-BinaryTree%3CT%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-BinaryTree%3CT%3E">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-BinaryTree%3CT%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-BinaryTree%3CT%3E">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-BinaryTree%3CT%3E">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In gbdt::binary_tree</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">gbdt</a>::<wbr><a href="index.html">binary_tree</a>::<wbr><a class="struct" href="#">BinaryTree</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/gbdt/binary_tree.rs.html#57-59">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct BinaryTree&lt;T&gt; { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The binary tree.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#67-333">source</a><a href="#impl-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#69-71">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Build a new empty binary tree</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#74-76">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&amp;self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns true when the binary tree is empty</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.add_root" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#89-91">source</a><h4 class="code-header">pub fn <a href="#method.add_root" class="fnname">add_root</a>(&amp;mut self, root: <a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;) -&gt; <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a></h4></section></summary><div class="docblock"><p>Add a node as the root node. Return the index of the root node.</p>
<h5 id="example"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="macro">assert_eq!</span>(<span class="number">0</span>, root_index);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, root_index)</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_root_index" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#103-105">source</a><h4 class="code-header">pub fn <a href="#method.get_root_index" class="fnname">get_root_index</a>(&amp;self) -&gt; <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a></h4></section></summary><div class="docblock"><p>Return the index of the root node.
Call this API after inserting root node.</p>
<h5 id="example-1"><a href="#example-1">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="macro">assert_eq!</span>(<span class="number">0</span>, tree.get_root_index());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_left_child" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#122-128">source</a><h4 class="code-header">pub fn <a href="#method.get_left_child" class="fnname">get_left_child</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;node: &amp;<a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;<br>) -&gt; Option&lt;&amp;<a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>Return the left child of the given <code>node</code></p>
<h5 id="example-2"><a href="#example-2">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>left_node = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let _ </span>= tree.add_left_node(root_index, left_node);
<span class="kw">let </span>root = tree.get_node(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
<span class="kw">let </span>left_node = tree.get_left_child(root).expect(<span class="string">&quot;Didn&#39;t find left child&quot;</span>);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, left_node.value);
<span class="macro">assert!</span>((left_node.value - <span class="number">5.0</span>) &lt; <span class="number">0.001</span>)</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_right_child" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#145-151">source</a><h4 class="code-header">pub fn <a href="#method.get_right_child" class="fnname">get_right_child</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;node: &amp;<a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;<br>) -&gt; Option&lt;&amp;<a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>Return the right child of the given <code>node</code></p>
<h5 id="example-3"><a href="#example-3">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>right_node = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let _ </span>= tree.add_right_node(root_index, right_node);
<span class="kw">let </span>root = tree.get_node(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
<span class="kw">let </span>right_node = tree.get_right_child(root).expect(<span class="string">&quot;Didn&#39;t find right child&quot;</span>);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, right_node.value);
<span class="macro">assert!</span>((right_node.value - <span class="number">5.0</span>) &lt; <span class="number">0.001</span>)</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_node" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#165-167">source</a><h4 class="code-header">pub fn <a href="#method.get_node" class="fnname">get_node</a>(&amp;self, index: <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a>) -&gt; Option&lt;&amp;<a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>Return the node with the given index</p>
<h5 id="example-4"><a href="#example-4">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;i32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10</span>);
<span class="kw">let _ </span>= tree.add_root(root);
<span class="kw">let </span>root_index = tree.get_root_index();
<span class="kw">let </span>root = tree.get_node(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
<span class="macro">assert_eq!</span>(<span class="number">10</span>, root.value);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_node_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#182-184">source</a><h4 class="code-header">pub fn <a href="#method.get_node_mut" class="fnname">get_node_mut</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a><br>) -&gt; Option&lt;&amp;mut <a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>Return the muttable reference of a node with the given index</p>
<h5 id="example-5"><a href="#example-5">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;i32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10</span>);
<span class="kw">let _ </span>= tree.add_root(root);
<span class="kw">let </span>root_index = tree.get_root_index();
<span class="kw">let </span>root = tree.get_node_mut(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
root.value = <span class="number">11</span>;
<span class="macro">assert_eq!</span>(<span class="number">11</span>, root.value);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.add_left_node" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#201-203">source</a><h4 class="code-header">pub fn <a href="#method.add_left_node" class="fnname">add_left_node</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;parent: <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;child: <a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;<br>) -&gt; <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a></h4></section></summary><div class="docblock"><p>Add a node as the left child of a given <code>parent</code> node. Return the index of the added node.</p>
<h5 id="example-6"><a href="#example-6">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>left_node = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let _ </span>= tree.add_left_node(root_index, left_node);
<span class="kw">let </span>root = tree.get_node(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
<span class="kw">let </span>left_node = tree.get_left_child(root).expect(<span class="string">&quot;Didn&#39;t find left child&quot;</span>);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, left_node.value);
<span class="macro">assert!</span>((left_node.value - <span class="number">5.0</span>) &lt; <span class="number">0.001</span>)</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.add_right_node" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#220-222">source</a><h4 class="code-header">pub fn <a href="#method.add_right_node" class="fnname">add_right_node</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;parent: <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;child: <a class="struct" href="struct.BinaryTreeNode.html" title="struct gbdt::binary_tree::BinaryTreeNode">BinaryTreeNode</a>&lt;T&gt;<br>) -&gt; <a class="type" href="type.TreeIndex.html" title="type gbdt::binary_tree::TreeIndex">TreeIndex</a></h4></section></summary><div class="docblock"><p>Add a node as the right child of a given <code>parent</code> node. Return the index of the added node.</p>
<h5 id="example-7"><a href="#example-7">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>right_node = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let _ </span>= tree.add_right_node(root_index, right_node);
<span class="kw">let </span>root = tree.get_node(root_index).expect(<span class="string">&quot;Didn&#39;t find root node&quot;</span>);
<span class="kw">let </span>right_node = tree.get_right_child(root).expect(<span class="string">&quot;Didn&#39;t find right child&quot;</span>);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, right_node.value);
<span class="macro">assert!</span>((right_node.value - <span class="number">5.0</span>) &lt; <span class="number">0.001</span>)</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.print" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#290-311">source</a><h4 class="code-header">pub fn <a href="#method.print" class="fnname">print</a>(&amp;self)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Debug,</span></h4></section></summary><div class="docblock"><p>For debug use. This API will print the whole tree.</p>
<h5 id="example-8"><a href="#example-8">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>n1 = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let </span>n2 = BinaryTreeNode::new(<span class="number">6.0</span>);
<span class="kw">let </span>n1_index = tree.add_left_node(root_index, n1);
<span class="kw">let </span>n2_index = tree.add_right_node(root_index, n2);
<span class="kw">let </span>n3 = BinaryTreeNode::new(<span class="number">7.0</span>);
<span class="kw">let </span>n4 = BinaryTreeNode::new(<span class="number">8.0</span>);
tree.add_left_node(n2_index, n3);
tree.add_right_node(n2_index, n4);
<span class="kw">let </span>n5 = BinaryTreeNode::new(<span class="number">9.0</span>);
tree.add_left_node(n1_index, n5);
tree.print();
<span class="comment">// Output:
//----10.0
// ----5.0
// ----9.0
// ----6.0
// ----7.0
// ----8.0</span></code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len" class="method has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#330-332">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fnname">len</a>(&amp;self) -&gt; usize</h4></section></summary><div class="docblock"><p>Get the amount of the nodes in this tree.</p>
<h5 id="example-9"><a href="#example-9">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::binary_tree::{BinaryTree, BinaryTreeNode};
<span class="kw">let </span><span class="kw-2">mut </span>tree: BinaryTree&lt;f32&gt; = BinaryTree::new();
<span class="kw">let </span>root = BinaryTreeNode::new(<span class="number">10.0</span>);
<span class="kw">let </span>root_index = tree.add_root(root);
<span class="kw">let </span>n1 = BinaryTreeNode::new(<span class="number">5.0</span>);
<span class="kw">let </span>n2 = BinaryTreeNode::new(<span class="number">6.0</span>);
<span class="kw">let </span>n1_index = tree.add_left_node(root_index, n1);
<span class="kw">let </span>n2_index = tree.add_right_node(root_index, n2);
<span class="macro">assert_eq!</span>(<span class="number">3</span>, tree.len());</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#impl-Debug-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Debug&gt; Debug for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#61-65">source</a><a href="#impl-Default-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Default for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#62-64">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -&gt; Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Deserialize%3C%27de%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#impl-Deserialize%3C%27de%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;'de, T&gt; <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt; for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deserialize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#method.deserialize" class="anchor"></a><h4 class="code-header">fn <a href="../../serde/de/trait.Deserialize.html#tymethod.deserialize" class="fnname">deserialize</a>&lt;__D&gt;(__deserializer: __D) -&gt; Result&lt;Self, __D::<a class="associatedtype" href="../../serde/de/trait.Deserializer.html#associatedtype.Error" title="type serde::de::Deserializer::Error">Error</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;__D: <a class="trait" href="../../serde/de/trait.Deserializer.html" title="trait serde::de::Deserializer">Deserializer</a>&lt;'de&gt;,</span></h4></section></summary><div class='docblock'>Deserialize this value from the given Serde deserializer. <a href="../../serde/de/trait.Deserialize.html#tymethod.deserialize">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Serialize-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#impl-Serialize-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.serialize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/gbdt/binary_tree.rs.html#56">source</a><a href="#method.serialize" class="anchor"></a><h4 class="code-header">fn <a href="../../serde/ser/trait.Serialize.html#tymethod.serialize" class="fnname">serialize</a>&lt;__S&gt;(&amp;self, __serializer: __S) -&gt; Result&lt;__S::<a class="associatedtype" href="../../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, __S::<a class="associatedtype" href="../../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;__S: <a class="trait" href="../../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</span></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; RefUnwindSafe for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Send for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Send,</span></h3></section><section id="impl-Sync-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Sync for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Sync,</span></h3></section><section id="impl-Unpin-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Unpin for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; UnwindSafe for <a class="struct" href="struct.BinaryTree.html" title="struct gbdt::binary_tree::BinaryTree">BinaryTree</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;V, T&gt; <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a>&lt;V&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -&gt; V</h4></section></div></details><section id="impl-DeserializeOwned-for-BinaryTree%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/serde/de/mod.rs.html#604">source</a><a href="#impl-DeserializeOwned-for-BinaryTree%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: for&lt;'de&gt; <a class="trait" href="../../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt;,</span></h3></section></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="gbdt" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>