DecisionTreeRegressor

Struct DecisionTreeRegressor 

Source
pub struct DecisionTreeRegressor<T: RealNumber> { /* private fields */ }
Expand description

Decision Tree Regressor

Implementations§

Source§

impl<T: RealNumber> DecisionTreeRegressor<T>

Source

pub fn new() -> Self

Creates a new instance of the decision tree regressor with default parameters.

Source

pub fn with_params( min_samples_split: Option<u16>, max_depth: Option<u16>, ) -> Result<Self, Box<dyn Error>>

Creates a new instance of the decision tree regressor with custom parameters.

§Arguments
  • min_samples_split - The minimum number of samples required to split an internal node.
  • max_depth - The maximum depth of the tree.
§Returns

A new instance of the decision tree regressor with the specified parameters.

§Errors

This method will return an error if the minimum number of samples to split is less than 2 or if the maximum depth is less than 1.

Source

pub fn set_min_samples_split( &mut self, min_samples_split: u16, ) -> Result<(), Box<dyn Error>>

Sets the minimum number of samples required to split an internal node.

§Arguments
  • min_samples_split - The minimum number of samples required to split an internal node.
§Errors

This method will return an error if the minimum number of samples to split is less than 2.

Source

pub fn set_max_depth( &mut self, max_depth: Option<u16>, ) -> Result<(), Box<dyn Error>>

Sets the maximum depth of the tree.

§Arguments
  • max_depth - The maximum depth of the tree.
§Errors

This method will return an error if the maximum depth is less than 1.

Source

pub fn max_depth(&self) -> Option<u16>

Returns the maximum depth of the tree.

Source

pub fn min_samples_split(&self) -> u16

Returns the minimum number of samples required to split an internal node.

Source

pub fn fit(&mut self, dataset: &Dataset<T, T>) -> Result<String, Box<dyn Error>>

Builds the decision tree from a dataset.

§Arguments
  • dataset - The dataset containing features and labels.
§Returns

A string indicating that the tree was built successfully.

§Errors

This method will return an error if the tree couldn’t be built.

Source

pub fn predict( &self, prediction_features: &DMatrix<T>, ) -> Result<DVector<T>, String>

Predicts the labels for new data.

§Arguments
  • features - The matrix of features for the new data.
§Returns

A vector containing the predicted target values for the new data.

§Errors

This method will return an error if the tree wasn’t built yet.

Trait Implementations§

Source§

impl<T: Clone + RealNumber> Clone for DecisionTreeRegressor<T>

Source§

fn clone(&self) -> DecisionTreeRegressor<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + RealNumber> Debug for DecisionTreeRegressor<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: RealNumber> Default for DecisionTreeRegressor<T>

Source§

fn default() -> Self

Creates a new instance of the decision tree regressor with default parameters.

Source§

impl<T: RealNumber> RegressionMetrics<T> for DecisionTreeRegressor<T>

Source§

fn mse( &self, y_true: &DVector<T>, y_pred: &DVector<T>, ) -> Result<T, Box<dyn Error>>

Computes the mean squared error (MSE) between the true values and the predicted values. Read more
Source§

fn mae( &self, y_true: &DVector<T>, y_pred: &DVector<T>, ) -> Result<T, Box<dyn Error>>

Computes the mean absolute error (MAE) between the true values and the predicted values. Read more
Source§

fn r2( &self, y_true: &DVector<T>, y_pred: &DVector<T>, ) -> Result<T, Box<dyn Error>>

Computes the coefficient of determination (R^2) between the true values and the predicted values. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V