Skip to main content

ComplementNB

Struct ComplementNB 

Source
pub struct ComplementNB<F> {
    pub alpha: F,
    pub class_prior: Option<Vec<F>>,
}
Expand description

Complement Naive Bayes classifier.

A variant of Multinomial NB that uses complement-class statistics. More robust for imbalanced datasets.

§Type Parameters

  • F: The floating-point type (f32 or f64).

Fields§

§alpha: F

Additive (Laplace) smoothing parameter. Default: 1.0.

§class_prior: Option<Vec<F>>

Optional user-supplied class priors. Note: ComplementNB does not use priors in the standard way (it uses complement weights), but this field is provided for API consistency with other NB variants.

Implementations§

Source§

impl<F: Float> ComplementNB<F>

Source

pub fn new() -> Self

Create a new ComplementNB with Laplace smoothing (alpha = 1.0).

Source

pub fn with_alpha(self, alpha: F) -> Self

Set the Laplace smoothing parameter.

Source

pub fn with_class_prior(self, priors: Vec<F>) -> Self

Set user-supplied class priors.

The priors must have length equal to the number of classes discovered during fitting. Note: ComplementNB uses complement-class weights rather than direct class priors, but the priors are stored for API consistency.

Trait Implementations§

Source§

impl<F: Clone> Clone for ComplementNB<F>

Source§

fn clone(&self) -> ComplementNB<F>

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<F: Debug> Debug for ComplementNB<F>

Source§

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

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

impl<F: Float> Default for ComplementNB<F>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<usize>, Dim<[usize; 1]>>> for ComplementNB<F>

Source§

fn fit( &self, x: &Array2<F>, y: &Array1<usize>, ) -> Result<FittedComplementNB<F>, FerroError>

Fit the Complement NB model.

§Errors
Source§

type Fitted = FittedComplementNB<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl<F: Float + ToPrimitive + FromPrimitive + Send + Sync + 'static> PipelineEstimator<F> for ComplementNB<F>

Source§

fn fit_pipeline( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<Box<dyn FittedPipelineEstimator<F>>, FerroError>

Fit this estimator on the given data. Read more

Auto Trait Implementations§

§

impl<F> Freeze for ComplementNB<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ComplementNB<F>
where F: RefUnwindSafe,

§

impl<F> Send for ComplementNB<F>
where F: Send,

§

impl<F> Sync for ComplementNB<F>
where F: Sync,

§

impl<F> Unpin for ComplementNB<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for ComplementNB<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for ComplementNB<F>
where F: UnwindSafe,

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,