Struct forust_ml::splitter::Splitter

source · [−]

pub struct Splitter {
    pub l2: f32,
    pub gamma: f32,
    pub min_leaf_weight: f32,
    pub learning_rate: f32,
    pub allow_missing_splits: bool,
    pub impute_missing: bool,
    pub constraints_map: ConstraintMap,
}

Fields

l2: f32gamma: f32min_leaf_weight: f32learning_rate: f32allow_missing_splits: boolimpute_missing: boolconstraints_map: ConstraintMap

Implementations

source

impl Splitter

source

pub fn new(
    l2: f32,
    gamma: f32,
    min_leaf_weight: f32,
    learning_rate: f32,
    allow_missing_splits: bool,
    impute_missing: bool,
    constraints_map: ConstraintMap
) -> Self

source

pub fn best_split(&self, node: &SplittableNode) -> Option<SplitInfo>

source

pub fn best_feature_split(
 &self,
 node: &SplittableNode,
 feature: usize
) -> Option<SplitInfo>

source

pub fn constrained_weight(
 &self,
 grad_sum: f32,
 hess_sum: f32,
 lower_bound: f32,
 upper_bound: f32,
 constraint: Option<&Constraint>
) -> f32

source

pub fn gain(&self, grad_sum: f32, hess_sum: f32) -> f32

source

pub fn gain_given_weight(&self, grad_sum: f32, hess_sum: f32, weight: f32) -> f32

source

pub fn cull_gain(
 &self,
 gain: f32,
 left_weight: f32,
 right_weight: f32,
 constraint: Option<&Constraint>
) -> f32

source

pub fn weight(&self, grad_sum: f32, hess_sum: f32) -> f32

Auto Trait Implementations

impl RefUnwindSafe for Splitter

impl Send for Splitter

impl Sync for Splitter

impl Unpin for Splitter

impl UnwindSafe for Splitter

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct forust_ml::splitter::Splitter

Fields

Implementations

impl Splitter

pub fn new( l2: f32, gamma: f32, min_leaf_weight: f32, learning_rate: f32, allow_missing_splits: bool, impute_missing: bool, constraints_map: ConstraintMap) -> Self

pub fn best_split(&self, node: &SplittableNode) -> Option<SplitInfo>

pub fn best_feature_split( &self, node: &SplittableNode, feature: usize) -> Option<SplitInfo>

pub fn constrained_weight( &self, grad_sum: f32, hess_sum: f32, lower_bound: f32, upper_bound: f32, constraint: Option<&Constraint>) -> f32

pub fn gain(&self, grad_sum: f32, hess_sum: f32) -> f32

pub fn gain_given_weight(&self, grad_sum: f32, hess_sum: f32, weight: f32) -> f32

pub fn cull_gain( &self, gain: f32, left_weight: f32, right_weight: f32, constraint: Option<&Constraint>) -> f32

pub fn weight(&self, grad_sum: f32, hess_sum: f32) -> f32

Auto Trait Implementations

impl RefUnwindSafe for Splitter

impl Send for Splitter

impl Sync for Splitter

impl Unpin for Splitter

impl UnwindSafe for Splitter

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

pub fn new(
l2: f32,
gamma: f32,
min_leaf_weight: f32,
learning_rate: f32,
allow_missing_splits: bool,
impute_missing: bool,
constraints_map: ConstraintMap
) -> Self

pub fn best_feature_split(
&self,
node: &SplittableNode,
feature: usize
) -> Option<SplitInfo>

pub fn constrained_weight(
&self,
grad_sum: f32,
hess_sum: f32,
lower_bound: f32,
upper_bound: f32,
constraint: Option<&Constraint>
) -> f32

pub fn cull_gain(
&self,
gain: f32,
left_weight: f32,
right_weight: f32,
constraint: Option<&Constraint>
) -> f32

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

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

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

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

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

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