Struct SampleCount 

pub struct SampleCount(/* private fields */);

Type-safe sample count

Implementations

impl SampleCount

pub fn new(count: usize) -> Result<SampleCount, SklearsError>

Create a new sample count, must be positive

pub fn get(self) -> usize

Get the raw count value

pub fn as_i32(self) -> i32

Convert to other numeric types

pub fn as_f64(self) -> f64

pub fn percentage_of(self, total: SampleCount) -> Result<f64, SklearsError>

Calculate percentage of another sample count

pub fn is_valid_split_with( self, other: SampleCount, min_samples_per_split: usize, ) -> bool

Check if this is a valid train/test split ratio

Trait Implementations

impl Add for SampleCount

type Output = SampleCount

The resulting type after applying the + operator.

fn add(self, other: SampleCount) -> <SampleCount as Add>::Output

Performs the + operation.

impl Clone for SampleCount

fn clone(&self) -> SampleCount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleCount

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

Formats the value using the given formatter.

impl Display for SampleCount

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

Formats the value using the given formatter.

impl Hash for SampleCount

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SampleCount

fn cmp(&self, other: &SampleCount) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SampleCount

fn eq(&self, other: &SampleCount) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SampleCount

fn partial_cmp(&self, other: &SampleCount) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for SampleCount

type Output = Result<SampleCount, SklearsError>

The resulting type after applying the - operator.

fn sub(self, other: SampleCount) -> <SampleCount as Sub>::Output

Performs the - operation.

impl Copy for SampleCount

impl Eq for SampleCount

impl StructuralPartialEq for SampleCount