Struct BinaryEncoder

pub struct BinaryEncoder { /* private fields */ }

BinaryEncoder for converting categorical features to binary representations

This transformer converts categorical features into binary representations, where each category is encoded as a unique binary number. This is more memory-efficient than one-hot encoding for high-cardinality categorical features.

For n unique categories, ceil(log2(n)) binary features are created.

Implementations

impl BinaryEncoder

pub fn new(handle_unknown: &str) -> Result<Self>

Creates a new BinaryEncoder

Arguments

• handle_unknown - How to handle unknown categories (‘error’ or ‘ignore’)
  • ‘error’: Raise an error if unknown categories are encountered
  • ‘ignore’: Encode unknown categories as all zeros

Returns

• Result<BinaryEncoder> - The new encoder instance

pub fn with_defaults() -> Self

Creates a BinaryEncoder with default settings (handle_unknown=‘error’)

pub fn fit<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<()>

where S: Data, S::Elem: Float + NumCast,

Fits the BinaryEncoder to the input data

Arguments

• x - The input categorical data, shape (n_samples, n_features)

Returns

• Result<()> - Ok if successful, Err otherwise

pub fn transform<S>(&self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Transforms the input data using the fitted encoder

Arguments

• x - The input categorical data to transform

Returns

• Result<Array2<f64>> - The binary-encoded data

pub fn fit_transform<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Fits the encoder and transforms the data in one step

Arguments

• x - The input categorical data

Returns

• Result<Array2<f64>> - The binary-encoded data

pub fn is_fitted(&self) -> bool

Returns whether the encoder has been fitted

pub fn categories(&self) -> Option<&Vec<HashMap<u64, Vec<u8>>>>

Returns the category mappings if fitted

pub fn n_binary_features(&self) -> Option<&Vec<usize>>

Returns the number of binary features per original feature

pub fn n_output_features(&self) -> Option<usize>

Returns the total number of output features

Trait Implementations

impl Clone for BinaryEncoder

fn clone(&self) -> BinaryEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryEncoder

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

Formats the value using the given formatter.