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 (default2).interaction_only: iftrue, only cross-product terms are generated (no pure powers likea²). Defaultfalse.include_bias: iftrue, a constant column of ones is prepended. Defaulttrue.
§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>
impl<F: Float + Send + Sync + 'static> PolynomialFeatures<F>
Sourcepub fn new(
degree: usize,
interaction_only: bool,
include_bias: bool,
) -> Result<Self, FerroError>
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.
Sourcepub fn default_config() -> Self
pub fn default_config() -> Self
Create a PolynomialFeatures with default settings:
degree=2, interaction_only=false, include_bias=true.
Sourcepub fn interaction_only(&self) -> bool
pub fn interaction_only(&self) -> bool
Return whether only interaction terms are generated.
Sourcepub fn include_bias(&self) -> bool
pub fn include_bias(&self) -> bool
Return whether a bias column is included.
Trait Implementations§
Source§impl<F: Clone> Clone for PolynomialFeatures<F>
impl<F: Clone> Clone for PolynomialFeatures<F>
Source§fn clone(&self) -> PolynomialFeatures<F>
fn clone(&self) -> PolynomialFeatures<F>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<F: Debug> Debug for PolynomialFeatures<F>
impl<F: Debug> Debug for PolynomialFeatures<F>
Source§impl FittedPipelineTransformer<f64> for PolynomialFeatures<f64>
impl FittedPipelineTransformer<f64> for PolynomialFeatures<f64>
Source§fn transform_pipeline(&self, x: &Array2<f64>) -> Result<Array2<f64>, FerroError>
fn transform_pipeline(&self, x: &Array2<f64>) -> Result<Array2<f64>, FerroError>
Source§impl PipelineTransformer<f64> for PolynomialFeatures<f64>
impl PipelineTransformer<f64> for PolynomialFeatures<f64>
Source§fn fit_pipeline(
&self,
_x: &Array2<f64>,
_y: &Array1<f64>,
) -> Result<Box<dyn FittedPipelineTransformer<f64>>, FerroError>
fn fit_pipeline( &self, _x: &Array2<f64>, _y: &Array1<f64>, ) -> Result<Box<dyn FittedPipelineTransformer<f64>>, 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>
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>
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 Error = FerroError
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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