Struct KmeansOptions

pub struct KmeansOptions { /* private fields */ }

A builder struct to specify the parameters for k-means.

Examples

let options = KmeansOptions::new()
    .sampling_factor(0.25)
    .seed(42);

Implementations

impl KmeansOptions

pub const fn new() -> Self

Creates a new KmeansOptions with default values.

pub const fn sampling_factor(self, sampling_factor: f32) -> Self

Sets the sampling factor which controls what percentage of the image/unique colors to sample.

The default sampling factor is 0.5, that is, to sample half of the input.

Negative or NAN sampling factors will cause k-means to not be run.

pub const fn seed(self, seed: u64) -> Self

Sets the seed value for the random number generator.

The default seed is 0.

pub const fn batch_size(self, batch_size: u32) -> Self

Sets the batch size for the parallel implementation of the k-means quantizer (minibatch k-means).

Larger batch sizes are faster with dimishing returns. Smaller batch sizes are more accurate but slower to run. The batch is divided evenly among the number of threads.

The default batch size is 4096.

Trait Implementations

impl Clone for KmeansOptions

fn clone(&self) -> KmeansOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KmeansOptions

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

Formats the value using the given formatter.

impl Default for KmeansOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<KmeansOptions> for QuantizeMethod

fn from(options: KmeansOptions) -> Self

Converts to this type from the input type.

impl PartialEq for KmeansOptions

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

impl StructuralPartialEq for KmeansOptions