Enum Strategy 

#[non_exhaustive]
pub enum Strategy {
    Exact,
    Prefix {
        depth: Option<u8>,
    },
    Top {
        n: u32,
    },
    Bands {
        count: u8,
    },
    Quantiles {
        count: u8,
    },
    Natural {
        count: u8,
    },
    Similar {
        algorithm: SimilarAlgorithm,
    },
}

Strategy applied to one axis.

Examples

use face_core::Strategy;

assert!(Strategy::Quantiles { count: 4 }.is_buffered());
assert!(!Strategy::Exact.is_buffered());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Exact

One cluster per distinct value (§5.3).

Prefix

Path / namespace grouping by directory depth (§5.3).

Fields

depth: Option<u8>

Optional fixed prefix depth; None means auto-pick.

Top

Top-N by frequency plus a synthetic (other) cluster (§5.3).

Fields

n: u32

How many top buckets to keep.

Bands

Equal-width bands over the numeric range (§5.2).

Fields

count: u8

Number of bands.

Quantiles

Equal-population quantile buckets (§5.2). Buffered (§12).

Fields

count: u8

Number of quantile buckets.

Natural

One-dimensional Jenks natural breaks (§5.2). Buffered (§12).

Fields

count: u8

Number of natural-break buckets.

Similar

Algorithmic free-form string clustering (§5.4). Buffered.

Fields

algorithm: SimilarAlgorithm

Similarity algorithm to use.

Implementations

impl Strategy

pub fn is_buffered(&self) -> bool

Whether this strategy requires buffering all input before emitting clusters (§12 memory model).

Quantiles and Natural need the full distribution; everything else can stream.

pub fn name(&self) -> &'static str

Lowercase wire-form name of this strategy, matching the serde tag used in the §7 envelope (exact, prefix, top, bands, quantiles, natural).

Strategy is #[non_exhaustive]; future variants added before their dispatch arms land here will return "unknown" until the arm is filled in.

Examples

use face_core::Strategy;

assert_eq!(Strategy::Exact.name(), "exact");
assert_eq!(Strategy::Bands { count: 5 }.name(), "bands");

Trait Implementations

impl Clone for Strategy

fn clone(&self) -> Strategy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strategy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Strategy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Strategy

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Strategy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Strategy