Skip to main content

OrdinalEncoder

Struct OrdinalEncoder 

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

Encode categorical features as ordinal integers (0, 1, 2, …), mirroring sklearn.preprocessing.OrdinalEncoder.

Input is a 2-D StrMatrix; output is a numeric Matrix of the same shape, where each cell is replaced by the ordinal index of its category.

Categories per column are sorted lexicographically by default (sklearn default), or can be user-specified via OrdinalCategories::Manual.

Implementations§

Source§

impl OrdinalEncoder

Source

pub fn new(categories: OrdinalCategories) -> Self

Creates a new ordinal encoder with the given category config.

Source

pub fn handle_unknown(self, h: OrdinalHandleUnknown) -> Self

Sets how unknown categories are handled during transform.

Source

pub fn categories(&self) -> &[Vec<String>]

Returns the learned categories per column.

Source

pub fn fit(&mut self, x: &StrMatrix) -> Result<()>

Learns the category-to-index mapping per column.

Source

pub fn transform(&self, x: &StrMatrix) -> Result<Matrix>

Encodes the input as ordinal integer codes.

Source

pub fn fit_transform(&mut self, x: &StrMatrix) -> Result<Matrix>

Fits the encoder and transforms the input in one step.

Source

pub fn inverse_transform(&self, y: &Matrix) -> Result<StrMatrix>

Decodes ordinal integer codes back to category strings.

Trait Implementations§

Source§

impl CategoricalTransformer for OrdinalEncoder

Source§

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

Human-readable name of the transformer.
Source§

fn fit(&mut self, x: &StrMatrix) -> Result<()>

Fit the transformer on categorical training data.
Source§

fn transform(&self, x: &StrMatrix) -> Result<Matrix>

Transform categorical data using fitted parameters, returning a numeric Matrix.
Source§

fn inverse_transform(&self, y: &Matrix) -> Result<StrMatrix>

Reverse the transformation, recovering category strings from numeric codes. Not all encoders support this; the default implementation returns an error.
Source§

fn is_fitted(&self) -> bool

Whether the transformer has been fitted.
Source§

fn fit_transform(&mut self, x: &StrMatrix) -> Result<Matrix>

Convenience: fit then transform.
Source§

impl Clone for OrdinalEncoder

Source§

fn clone(&self) -> OrdinalEncoder

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 OrdinalEncoder

Source§

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

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

impl Default for OrdinalEncoder

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for OrdinalEncoder

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Estimator for OrdinalEncoder

Source§

impl FeatureNames for OrdinalEncoder

Source§

fn feature_names_out(&self, input_features: Option<&[String]>) -> Vec<String>

Returns the output feature names given the optional input feature names.
Source§

impl Serialize for OrdinalEncoder

Source§

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

Serialize this value into the given Serde serializer. 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.