Skip to main content

LinearSVC

Struct LinearSVC 

Source
pub struct LinearSVC<F> {
    pub c: F,
    pub max_iter: usize,
    pub tol: F,
    pub loss: LinearSVCLoss,
    pub penalty: LinearSVCPenalty,
    pub dual: DualMode,
    pub fit_intercept: bool,
    pub intercept_scaling: F,
    pub class_weight: ClassWeight<F>,
    pub multi_class: MultiClass,
}
Expand description

Linear Support Vector Classifier (liblinear dual CD).

Solves the L2-regularized hinge or squared-hinge objective 0.5*||w||^2 + C * sum_i L(y_i, w.x_i) via liblinear’s dual coordinate descent. Supports binary and multiclass (one-vs-rest) classification. Mirrors sklearn.svm.LinearSVC.

§Type Parameters

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

Fields§

§c: F

Inverse regularization strength. Larger values allow more misclassification. Must be strictly positive.

§max_iter: usize

Maximum number of dual coordinate descent iterations.

§tol: F

Convergence tolerance on the projected-gradient span.

§loss: LinearSVCLoss

Loss function to use.

§penalty: LinearSVCPenalty

Regularizer norm (l1 / l2). Default l2. l1 is only supported with squared_hinge + dual=false (liblinear solver type 5, _get_liblinear_solver_type, _base.py:1014).

§dual: DualMode

Dual / primal selector. Default Auto, resolved via _validate_dual_parameter (_classes.py:13-29). Observably immaterial for penalty=l2 (R-DEV-7 dual-invariance), load-bearing for the unsupported-combination rejects and the l1 primal solver.

§fit_intercept: bool

Whether to fit an intercept. When true, the design matrix is augmented with a synthetic constant column equal to intercept_scaling; the augmented weight is penalized like any feature (liblinear convention).

§intercept_scaling: F

Value of the synthetic intercept feature when fit_intercept is true. Must be strictly positive. intercept_ = intercept_scaling * w_last.

§class_weight: ClassWeight<F>

Per-class scaling of C. Default ClassWeight::None (all classes weighted 1.0). The effective penalty for class i is class_weight[i]·C (compute_class_weight, _base.py:1179; weighted_C[i] = C·class_weight[i], linear.cpp:2496-2507).

§multi_class: MultiClass

Multiclass strategy. Default MultiClass::Ovr (one-vs-rest). MultiClass::CrammerSinger runs the joint Crammer-Singer solver, ignoring penalty/loss/dual (_base.py:1017, _classes.py:239).

Implementations§

Source§

impl<F: Float> LinearSVC<F>

Source

pub fn new() -> Self

Create a new LinearSVC with scikit-learn’s default settings.

Defaults (matching sklearn.svm.LinearSVC, _classes.py): C = 1.0, max_iter = 1000, tol = 1e-4, loss = SquaredHinge, penalty = L2, dual = Auto, fit_intercept = true, intercept_scaling = 1.0, class_weight = None, multi_class = Ovr.

Source

pub fn with_c(self, c: F) -> Self

Set the regularization parameter C.

Source

pub fn with_max_iter(self, max_iter: usize) -> Self

Set the maximum number of iterations.

Source

pub fn with_tol(self, tol: F) -> Self

Set the convergence tolerance.

Source

pub fn with_loss(self, loss: LinearSVCLoss) -> Self

Set the loss function.

Source

pub fn with_penalty(self, penalty: LinearSVCPenalty) -> Self

Set the penalty (regularizer) norm (sklearn penalty). l1 requires squared_hinge + dual=false (_base.py:1014).

Source

pub fn with_dual(self, dual: DualMode) -> Self

Set the dual / primal selector (sklearn dual). Auto (default) resolves via _validate_dual_parameter (_classes.py:13-29).

Source

pub fn with_fit_intercept(self, fit_intercept: bool) -> Self

Set whether to fit an intercept (sklearn fit_intercept).

Source

pub fn with_intercept_scaling(self, intercept_scaling: F) -> Self

Set the intercept scaling (sklearn intercept_scaling). Must be strictly positive when fit_intercept is true.

Source

pub fn with_class_weight(self, class_weight: ClassWeight<F>) -> Self

Set the per-class C scaling (sklearn class_weight, _classes.py:118-124). ClassWeight::None (default) leaves every class at 1.0; ClassWeight::Balanced uses n_samples / (n_classes · count_c); ClassWeight::Explicit takes a (label, weight) map (unlisted classes default to 1.0).

Source

pub fn with_multi_class(self, multi_class: MultiClass) -> Self

Set the multiclass strategy (sklearn multi_class, _classes.py:239). MultiClass::Ovr (default) trains one-vs-rest binary classifiers; MultiClass::CrammerSinger runs the joint Crammer-Singer solver (ignoring penalty/loss/dual, _base.py:1017).

Trait Implementations§

Source§

impl<F: Clone> Clone for LinearSVC<F>

Source§

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

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

Source§

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

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

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

Source§

fn default() -> Self

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

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

Source§

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

Fit the linear SVC model using liblinear’s dual coordinate descent.

Minimizes 0.5*||w||^2 + C * sum_i L(y_i, w.x_i) (no 1/n). When fit_intercept is set, the design matrix is augmented with a constant column equal to intercept_scaling, the augmented weight is penalized like any feature, and intercept_ = intercept_scaling * w_last (_base.py:1188-1198,:1240-1245).

§Errors
Source§

type Fitted = FittedLinearSVC<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<F> UnwindSafe for LinearSVC<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> Imply<T> for U
where T: ?Sized, U: ?Sized,

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