Skip to main content

ParamEstProblem

Struct ParamEstProblem 

Source
pub struct ParamEstProblem<S: Scalar> { /* private fields */ }
Expand description

Builder for ODE parameter estimation problems.

Implementations§

Source§

impl<S: Scalar> ParamEstProblem<S>

Source

pub fn new(n_params: usize, n_states: usize) -> Self

Create a new parameter estimation problem.

  • n_params: number of parameters to estimate.
  • n_states: dimension of the ODE state vector.
Source

pub fn model<F>(self, f: F) -> Self
where F: Fn(S, &[S], &mut [S], &[S]) + Send + Sync + 'static,

Set the ODE right-hand side: f(t, y, dydt, params).

Source

pub fn initial_state(self, y0: Vec<S>) -> Self

Set the initial state y(t0).

Source

pub fn params(self, p0: Vec<S>) -> Self

Set the initial parameter guess.

Source

pub fn param_bounds(self, i: usize, bounds: (S, S)) -> Self

Set bounds for parameter i.

Source

pub fn all_param_bounds(self, bounds: Vec<Option<(S, S)>>) -> Self

Set bounds for all parameters at once.

Source

pub fn data(self, t_data: Vec<S>, y_data: Vec<S>) -> Self

Set measurement data.

y_data is flat row-major: y_data[i * n_observed + j] for time index i and observed state j.

Source

pub fn observed(self, indices: Vec<usize>) -> Self

Specify which state indices are observed.

If not called, all states are assumed observed.

Source

pub fn ode_solver(self, choice: OdeSolverChoice) -> Self

Choose the ODE solver for forward integrations.

Source

pub fn ode_tolerances(self, rtol: S, atol: S) -> Self

Set ODE solver tolerances.

Source

pub fn max_iter(self, n: usize) -> Self

Set maximum optimizer iterations.

Source

pub fn solve(self) -> Result<ParamEstResult<S>, OcpError>
where S: SimpleEntity + Conjugate<Canonical = S> + ComplexField,

Run parameter estimation.

Auto Trait Implementations§

§

impl<S> Freeze for ParamEstProblem<S>
where S: Freeze,

§

impl<S> !RefUnwindSafe for ParamEstProblem<S>

§

impl<S> Send for ParamEstProblem<S>

§

impl<S> Sync for ParamEstProblem<S>

§

impl<S> Unpin for ParamEstProblem<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for ParamEstProblem<S>
where S: UnsafeUnpin,

§

impl<S> !UnwindSafe for ParamEstProblem<S>

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
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, 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