Skip to main content

TreeNode

Enum TreeNode 

Source
#[non_exhaustive]
pub enum TreeNode { Leaf { prediction: f64, n_samples: usize, class_counts: Vec<usize>, impurity: f64, }, Split { feature_idx: usize, threshold: f64, left: Box<TreeNode>, right: Box<TreeNode>, n_samples: usize, impurity: f64, class_counts: Vec<usize>, prediction: f64, }, }
Expand description

A node in the decision tree (recursive representation).

Used during tree construction, then flattened into a FlatTree for cache-optimal prediction. Exposed publicly for visualization.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Leaf

A leaf node — produces a prediction.

Fields

§prediction: f64

Predicted class (classification) or value (regression).

§n_samples: usize

Number of training samples that reached this node.

§class_counts: Vec<usize>

Class distribution at this node (classification only).

§impurity: f64

Impurity at this node.

§

Split

An internal split node.

Fields

§feature_idx: usize

Index of the feature used for the split.

§threshold: f64

Threshold value: left if ≤ threshold, right if > threshold.

§left: Box<TreeNode>

Left child (≤ threshold).

§right: Box<TreeNode>

Right child (> threshold).

§n_samples: usize

Number of training samples that reached this node.

§impurity: f64

Impurity at this node (before split).

§class_counts: Vec<usize>

Class distribution at this node.

§prediction: f64

Majority class prediction at this node.

Implementations§

Source§

impl TreeNode

Source

pub fn predict(&self, sample: &[f64]) -> f64

Predict for a single sample by walking the tree.

Source

pub fn predict_proba(&self, sample: &[f64], n_classes: usize) -> Vec<f64>

Get class probabilities for a single sample.

Source

pub fn depth(&self) -> usize

Depth of this subtree.

Source

pub fn n_leaves(&self) -> usize

Number of leaf nodes in this subtree.

Source

pub fn n_samples(&self) -> usize

Number of samples at this node.

Source

pub fn total_leaf_impurity(&self) -> f64

Sum of weighted leaf impurities: Σ(impurity_leaf × n_samples_leaf).

This is R(T_t) in the cost-complexity pruning literature.

Source

pub fn prune_ccp(self, ccp_alpha: f64) -> TreeNode

Minimal cost-complexity pruning (MCCP).

Recursively prunes subtrees whose effective alpha is ≤ ccp_alpha. Effective alpha = (R(t) - R(T_t)) / (|T_t| - 1), where R(t) is the re-substitution error if this node were a leaf and R(T_t) is the total leaf impurity of the subtree.

This matches sklearn’s ccp_alpha parameter behavior.

Source

pub fn cost_complexity_pruning_path(&self) -> (Vec<f64>, Vec<f64>)

Compute the cost-complexity pruning path.

Returns (ccp_alphas, total_impurities) — a sequence of effective alpha values and the corresponding total tree impurity at each pruning step. Useful for elbow-method selection of ccp_alpha.

Trait Implementations§

Source§

impl Clone for TreeNode

Source§

fn clone(&self) -> TreeNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TreeNode

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.