Struct peroxide::numerical::optimize::Optimizer

source ·
pub struct Optimizer<F>
where F: Fn(&Vec<f64>, Vec<AD>) -> Option<Vec<AD>>,
{ /* private fields */ }
Expand description

Optimizer for optimization (non-linear regression)

§Methods

  • Gradient Descent
  • Gauss Newton
  • Levenberg Marquardt

§Caution

  • func should be boxed. (This allows more generic function)

Implementations§

source§

impl<F> Optimizer<F>
where F: Fn(&Vec<f64>, Vec<AD>) -> Option<Vec<AD>>,

source

pub fn new(data: Matrix, func: F) -> Self

source

pub fn get_domain(&self) -> Vec<f64>

Get domain

source

pub fn get_error(&self) -> f64

Get error

source

pub fn get_hyperparam(&self, key: &str) -> Option<&f64>

Get hyperparameter (learning rate or lambda or etc.)

source

pub fn set_init_param(&mut self, p: Vec<f64>) -> &mut Self

Set initial parameter

source

pub fn set_max_iter(&mut self, n: usize) -> &mut Self

Set maximum iteration

source

pub fn set_method(&mut self, method: OptMethod) -> &mut Self

Set optimization method

source

pub fn set_lr(&mut self, lr: f64) -> &mut Self

Set learning rate for GradientDescent

source

pub fn set_lambda_init(&mut self, lambda_init: f64) -> &mut Self

Set initial lambda for LevenbergMarquardt

source

pub fn set_lambda_max(&mut self, lambda_max: f64) -> &mut Self

Set maximum lambda for LevenbergMarquardt

source

pub fn optimize(&mut self) -> Vec<f64>

Main function for optimization

Auto Trait Implementations§

§

impl<F> Freeze for Optimizer<F>

§

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

§

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

§

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

§

impl<F> Unpin for Optimizer<F>

§

impl<F> UnwindSafe for Optimizer<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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

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

§

fn vzip(self) -> V

§

impl<T> Ungil for T
where T: Send,