Struct ffsvm::Problem

source ·
pub struct Problem<V32> { /* private fields */ }
Expand description

A single problem a SVM should classify.

Creating a Problem

Problems are created via the Problem::from method and match the SVM type they were created for:

use ffsvm::*;
use std::convert::TryFrom;

fn main() -> Result<(), Error> {
    let svm = DenseSVM::try_from(SAMPLE_MODEL)?;

    let mut problem = Problem::from(&svm);

    Ok(())
}

Setting Features

A Problem is an instance of the SVM’s problem domain. Before it can be classified, all features need to be set, for example by:

use ffsvm::*;

fn set_features(problem: &mut DenseProblem) {
    let features = problem.features();
    features[0] = -0.221184;
    features[3] = 0.135713;
}

It can then be classified via the Predict trait.

Implementations§

source§

impl<T> Problem<T>

source

pub const fn solution(&self) -> Solution

After a Problem has been classified, this will hold the SVMs solution.

source

pub fn probabilities(&self) -> &[f64]

Returns the probability estimates. Only really useful if the model was trained with probability estimates and you classified with them.

source

pub fn features(&mut self) -> &mut Features<T>

Returns the features. You must set them first and classifiy the problem before you can get a solution.

source§

impl Problem<SparseVector<f32>>

source

pub fn clear(&mut self)

Clears the Problem when reusing it between calls. Only needed for SparseSVM problems.

Trait Implementations§

source§

impl<V32: Clone> Clone for Problem<V32>

source§

fn clone(&self) -> Problem<V32>

Returns a copy 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<V32: Debug> Debug for Problem<V32>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V32> RefUnwindSafe for Problem<V32>where V32: RefUnwindSafe,

§

impl<V32> Send for Problem<V32>where V32: Send,

§

impl<V32> Sync for Problem<V32>where V32: Sync,

§

impl<V32> Unpin for Problem<V32>where V32: Unpin,

§

impl<V32> UnwindSafe for Problem<V32>where V32: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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<U> for Twhere 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.

source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere 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<U>>::Error>

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.