Skip to main content

FrequencyEncoder

Struct FrequencyEncoder 

Source
pub struct FrequencyEncoder { /* private fields */ }
Expand description

Online frequency encoder for string features.

Maps each category to its observed frequency count / total.

Implementations§

Source§

impl FrequencyEncoder

Source

pub fn new() -> Self

Create a new empty encoder.

Source

pub fn category_counts(&self) -> &BTreeMap<String, u64>

The per-category counts.

Source

pub fn total(&self) -> u64

The total number of category observations seen.

Source

pub fn transform_strs(&self, features: &[&str]) -> Result<Vec<f64>, RillError>

Return the observed frequency for each input string.

Unknown categories map to 0.0. Before any sample has been seen, all outputs are 0.0.

§Errors

Returns RillError::EmptyFeatures if features is empty.

Source

pub fn update_strs(&mut self, features: &[&str]) -> Result<(), RillError>

Increment counts for each category in features and increment samples_seen.

§Errors

Returns RillError::EmptyFeatures if features is empty.

Source

pub fn samples_seen(&self) -> u64

How many samples have been seen.

Source

pub fn reset(&mut self)

Reset the encoder to its initial empty state.

Trait Implementations§

Source§

impl Clone for FrequencyEncoder

Source§

fn clone(&self) -> FrequencyEncoder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FrequencyEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FrequencyEncoder

Source§

fn default() -> FrequencyEncoder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V