Skip to main content

FunctionTransformer

Struct FunctionTransformer 

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

Apply a user-defined function as a transformer, mirroring sklearn.preprocessing.FunctionTransformer.

The function is stored as a function pointer.

§Serialization

The function pointers are not serialized. After deserialization call set_func to restore the function before calling transform or inverse_transform.

Implementations§

Source§

impl FunctionTransformer

Source

pub fn new(func: fn(&Matrix) -> Result<Matrix>) -> Self

Creates a new transformer applying func during transform.

Source

pub fn with_inverse(self, inv_func: fn(&Matrix) -> Result<Matrix>) -> Self

Sets the inverse function used by inverse_transform.

Source

pub fn set_func(&mut self, func: fn(&Matrix) -> Result<Matrix>)

Replaces the forward function (e.g. after deserialization).

Source

pub fn set_inv_func(&mut self, inv_func: fn(&Matrix) -> Result<Matrix>)

Replaces the inverse function (e.g. after deserialization).

Trait Implementations§

Source§

impl Clone for FunctionTransformer

Source§

fn clone(&self) -> FunctionTransformer

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 FunctionTransformer

Source§

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

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

impl Default for FunctionTransformer

Default is an identity transformer (no function set).

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for FunctionTransformer

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 FunctionTransformer

Source§

impl FeatureNames for FunctionTransformer

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 FunctionTransformer

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

impl Transformer for FunctionTransformer

Source§

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

Name of the transformer, used for diagnostics.
Source§

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

Fit the transformer on training data.
Source§

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

Transform data using fitted parameters.
Source§

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

Reverse the transformation, recovering an approximation of the original input. Not all transformers 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: &Matrix) -> Result<Matrix>

Convenience: fit then transform.
Source§

fn fit_with_target(&mut self, x: &Matrix, _y: &[f64]) -> Result<()>

Fit the transformer with supervised target values when they are available. Unsupervised transformers ignore y by default. Supervised feature selectors override this method, allowing them to live safely in a SupervisedPipeline.

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.