Enum Partition 

pub enum Partition {
    KFold(KFold),
    Stratified(Stratified),
    Grouped(Grouped),
    StratifiedGrouped(StratifiedGrouped),
    TimeSeries(TimeSeries),
}

Whichever of the schemes a cut is.

use somatize_study::{Partition, Samples, Stratified};

let cut: Partition = Stratified { k: 5, shuffle: None }.into();
assert_eq!(cut.to_string(), "stratified:5");

Variants

KFold(KFold)

KFold: the plain cut.

Stratified(Stratified)

Stratified: every class keeps its share.

Grouped(Grouped)

Grouped: a group never splits.

StratifiedGrouped(StratifiedGrouped)

StratifiedGrouped: both, as far as both can be had.

TimeSeries(TimeSeries)

TimeSeries: growing prefixes.

Implementations

impl Partition

pub fn folds(&self, samples: &Samples) -> Result<Vec<Fold>, PartitionError>

The folds, in order — whichever scheme this is.

Everything that cannot be honoured is an error here, before a single index comes out: too few folds, more folds than samples, a class or a group that cannot reach every fold. None of it is a warning, because a silently degraded cut is a result you cannot tell from a good one.

pub fn k(&self) -> usize

How many folds it produces, without producing them.

Trait Implementations

impl Clone for Partition

fn clone(&self) -> Partition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Partition

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

Formats the value using the given formatter.

impl Display for Partition

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

As text, which is the form that goes into a cache key and into the record of a trial. Written by the scheme itself, because the name belongs with the thing it names.

impl From<Grouped> for Partition

fn from(cut: Grouped) -> Self

Converts to this type from the input type.

impl From<KFold> for Partition

fn from(cut: KFold) -> Self

Converts to this type from the input type.

impl From<Stratified> for Partition

fn from(cut: Stratified) -> Self

Converts to this type from the input type.

impl From<StratifiedGrouped> for Partition

fn from(cut: StratifiedGrouped) -> Self

Converts to this type from the input type.

impl From<TimeSeries> for Partition

fn from(cut: TimeSeries) -> Self

Converts to this type from the input type.

impl Hash for Partition

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

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 PartialEq for Partition

fn eq(&self, other: &Partition) -> 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 Eq for Partition

impl StructuralPartialEq for Partition