Struct BinaryEncoder 

pub struct BinaryEncoder<F> { /* private fields */ }

An unfitted binary encoder.

Takes a matrix of categorical integer features and encodes each category as a sequence of binary digits. For k categories, each feature produces ceil(log2(k)) output columns.

Examples

use ferrolearn_preprocess::binary_encoder::BinaryEncoder;
use ferrolearn_core::traits::{Fit, Transform};
use ndarray::array;

let enc = BinaryEncoder::<f64>::new();
let x = array![[0usize], [1], [2], [3]];
let fitted = enc.fit(&x, &()).unwrap();
let out = fitted.transform(&x).unwrap();
// 4 categories → ceil(log2(4)) = 2 binary columns
assert_eq!(out.ncols(), 2);

Implementations

impl<F: Float + Send + Sync + 'static> BinaryEncoder<F>

pub fn new() -> Self

Create a new BinaryEncoder.

Trait Implementations

impl<F: Clone> Clone for BinaryEncoder<F>

fn clone(&self) -> BinaryEncoder<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for BinaryEncoder<F>

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

Formats the value using the given formatter.

impl<F: Float + Send + Sync + 'static> Default for BinaryEncoder<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<usize>, Dim<[usize; 2]>>, ()> for BinaryEncoder<F>

fn fit( &self, x: &Array2<usize>, _y: &(), ) -> Result<FittedBinaryEncoder<F>, FerroError>

Fit by determining the number of categories per column.

The number of categories for column j is max(x[:, j]) + 1.

Errors

Returns FerroError::InsufficientSamples if the input has zero rows.

type Fitted = FittedBinaryEncoder<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl<F: Float + Send + Sync + 'static> FitTransform<ArrayBase<OwnedRepr<usize>, Dim<[usize; 2]>>> for BinaryEncoder<F>

fn fit_transform(&self, x: &Array2<usize>) -> Result<Array2<F>, FerroError>

Fit and transform in one step.

Errors

Returns an error if fitting or transformation fails.

type FitError = FerroError

The error type for the combined fit-transform operation.

impl<F: Float + Send + Sync + 'static> Transform<ArrayBase<OwnedRepr<usize>, Dim<[usize; 2]>>> for BinaryEncoder<F>

Implement Transform on the unfitted encoder.

fn transform(&self, _x: &Array2<usize>) -> Result<Array2<F>, FerroError>

Always returns an error — the encoder must be fitted first.

type Output = ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>

The transformed output type.

type Error = FerroError

The error type returned by transform.