Skip to main content

PolynomialFeatures

Struct PolynomialFeatures 

Source
pub struct PolynomialFeatures<F> { /* private fields */ }
Expand description

A stateless polynomial feature generator.

Generates all polynomial combinations of the input features up to the specified degree.

§Configuration

  • degree: maximum polynomial degree (default 2).
  • interaction_only: if true, only cross-product terms are generated (no pure powers like ). Default false.
  • include_bias: if true, a constant column of ones is prepended. Default true.

§Examples

use ferrolearn_preprocess::polynomial_features::PolynomialFeatures;
use ferrolearn_core::traits::Transform;
use ndarray::array;

let poly = PolynomialFeatures::<f64>::new(2, false, true).unwrap();
let x = array![[2.0, 3.0]];
let out = poly.transform(&x).unwrap();
// out = [[1, 2, 3, 4, 6, 9]]

Implementations§

Source§

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

Source

pub fn new( degree: usize, interaction_only: bool, include_bias: bool, ) -> Result<Self, FerroError>

Create a new PolynomialFeatures transformer.

§Errors

Returns FerroError::InvalidParameter if degree == 0.

Source

pub fn default_config() -> Self

Create a PolynomialFeatures with default settings: degree=2, interaction_only=false, include_bias=true.

Source

pub fn degree(&self) -> usize

Return the configured degree.

Source

pub fn interaction_only(&self) -> bool

Return whether only interaction terms are generated.

Source

pub fn include_bias(&self) -> bool

Return whether a bias column is included.

Trait Implementations§

Source§

impl<F: Clone> Clone for PolynomialFeatures<F>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for PolynomialFeatures<F>

Source§

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

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

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

Source§

fn default() -> Self

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

impl FittedPipelineTransformer for PolynomialFeatures<f64>

Source§

fn transform_pipeline(&self, x: &Array2<f64>) -> Result<Array2<f64>, FerroError>

Transform data using the pipeline interface.

§Errors

Propagates errors from Transform::transform.

Source§

impl PipelineTransformer for PolynomialFeatures<f64>

Source§

fn fit_pipeline( &self, _x: &Array2<f64>, _y: &Array1<f64>, ) -> Result<Box<dyn FittedPipelineTransformer>, FerroError>

Fit the polynomial features transformer using the pipeline interface.

Because PolynomialFeatures is stateless, this simply boxes self as a FittedPipelineTransformer.

§Errors

This implementation never returns an error.

Source§

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

Source§

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

Generate polynomial and interaction features.

§Errors

Returns FerroError::InvalidParameter if the input has zero columns.

Source§

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

The transformed output type.
Source§

type Error = FerroError

The error type returned by transform.

Auto Trait Implementations§

§

impl<F> Freeze for PolynomialFeatures<F>

§

impl<F> RefUnwindSafe for PolynomialFeatures<F>
where F: RefUnwindSafe,

§

impl<F> Send for PolynomialFeatures<F>
where F: Send,

§

impl<F> Sync for PolynomialFeatures<F>
where F: Sync,

§

impl<F> Unpin for PolynomialFeatures<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for PolynomialFeatures<F>

§

impl<F> UnwindSafe for PolynomialFeatures<F>
where F: UnwindSafe,

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

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,