[−][src]Struct bacon_sci::ivp::RK45

pub struct RK45<N: ComplexField, S: DimName> where
    DefaultAllocator: Allocator<N, S>,
    DefaultAllocator: Allocator<N, U6>,
    DefaultAllocator: Allocator<N, U6, U6>,
    DefaultAllocator: Allocator<N, S, U6>,
    DefaultAllocator: Allocator<N::RealField, U6>,
    DefaultAllocator: Allocator<N::RealField, U6, U6>,  { /* fields omitted */ }

Runge-Kutta-Fehlberg method for solving an IVP.

Defines the Butch Tableaux for a 5(4) order adaptive runge-kutta method. Uses RKInfo to do the actual solving. Provides an interface for setting the conditions on RKInfo.

Examples

use nalgebra::{VectorN, U1};
use bacon_sci::ivp::{RK45, RungeKuttaSolver};
fn derivatives(_t: f64, state: &[f64], _p: &mut ()) -> Result<VectorN<f64, U1>, String> {
    Ok(VectorN::<f64, U1>::from_column_slice(state))
}

fn example() -> Result<(), String> {
    let rk45 = RK45::new()
        .with_dt_max(0.1)?
        .with_dt_min(0.001)?
        .with_start(0.0)?
        .with_end(10.0)?
        .with_tolerance(0.0001)?
        .with_initial_conditions(&[1.0])?
        .build();
    let path = rk45.solve_ivp(derivatives, &mut ())?;
    for (time, state) in &path {
        assert!((time.exp() - state.column(0)[0]).abs() < 0.001);
    }
    Ok(())
}

Implementations

`impl<N: ComplexField, S: DimName> RK45<N, S> where DefaultAllocator: Allocator<N, S>, DefaultAllocator: Allocator<N, U6>, DefaultAllocator: Allocator<N, U6, U6>, DefaultAllocator: Allocator<N, S, U6>, DefaultAllocator: Allocator<N::RealField, U6>, DefaultAllocator: Allocator<N::RealField, U6, U6>,` [src]

`pub fn new() -> Self`[src]

Trait Implementations

`impl<N: Clone + ComplexField, S: Clone + DimName> Clone for RK45<N, S> where DefaultAllocator: Allocator<N, S>, DefaultAllocator: Allocator<N, U6>, DefaultAllocator: Allocator<N, U6, U6>, DefaultAllocator: Allocator<N, S, U6>, DefaultAllocator: Allocator<N::RealField, U6>, DefaultAllocator: Allocator<N::RealField, U6, U6>,` [src]

`pub fn clone(&self) -> RK45<N, S>`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl<N: Debug + ComplexField, S: Debug + DimName> Debug for RK45<N, S> where DefaultAllocator: Allocator<N, S>, DefaultAllocator: Allocator<N, U6>, DefaultAllocator: Allocator<N, U6, U6>, DefaultAllocator: Allocator<N, S, U6>, DefaultAllocator: Allocator<N::RealField, U6>, DefaultAllocator: Allocator<N::RealField, U6, U6>,` [src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

`impl<N: ComplexField, S: DimName> From<RK45<N, S>> for RKInfo<N, S, U6> where DefaultAllocator: Allocator<N, S>, DefaultAllocator: Allocator<N, U6>, DefaultAllocator: Allocator<N, S, U6>, DefaultAllocator: Allocator<N, U6, U6>, DefaultAllocator: Allocator<N::RealField, U6>, DefaultAllocator: Allocator<N::RealField, U6>,` [src]

`pub fn from(rk: RK45<N, S>) -> RKInfo<N, S, U6>`[src]

`impl<N: ComplexField, S: DimName> RungeKuttaSolver<N, S, U6> for RK45<N, S> where DefaultAllocator: Allocator<N, S>, DefaultAllocator: Allocator<N, U6>, DefaultAllocator: Allocator<N, U6, U6>, DefaultAllocator: Allocator<N::RealField, U6>, DefaultAllocator: Allocator<N::RealField, U6, U6>, DefaultAllocator: Allocator<N, S, U6>,` [src]

`pub fn t_coefficients() -> VectorN<N::RealField, U6>`[src]

`pub fn k_coefficients() -> MatrixMN<N::RealField, U6, U6>`[src]

`pub fn avg_coefficients() -> VectorN<N::RealField, U6>`[src]

`pub fn error_coefficients() -> VectorN<N::RealField, U6>`[src]

`pub fn solve_ivp<T: Clone, F: FnMut(N::RealField, &[N], &mut T) -> Result<VectorN<N, S>, String>>( self, f: F, params: &mut T ) -> Result<Vec<(N::RealField, VectorN<N, S>)>, String>`[src]

`pub fn with_tolerance(self, tol: N::RealField) -> Result<Self, String>`[src]

`pub fn with_dt_max(self, max: N::RealField) -> Result<Self, String>`[src]

`pub fn with_dt_min(self, min: N::RealField) -> Result<Self, String>`[src]

`pub fn with_start(self, t_initial: N::RealField) -> Result<Self, String>`[src]

`pub fn with_end(self, t_final: N::RealField) -> Result<Self, String>`[src]

`pub fn with_initial_conditions(self, start: &[N]) -> Result<Self, String>`[src]

`pub fn build(self) -> Self`[src]

Auto Trait Implementations

`impl<N, S> !RefUnwindSafe for RK45<N, S>`[src]

`impl<N, S> !Send for RK45<N, S>`[src]

`impl<N, S> !Sync for RK45<N, S>`[src]

`impl<N, S> !Unpin for RK45<N, S>`[src]

`impl<N, S> !UnwindSafe for RK45<N, S>`[src]

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`pub fn to_subset(&self) -> Option<SS>`[src]

`pub fn is_in_subset(&self) -> bool`[src]

`pub unsafe fn to_subset_unchecked(&self) -> SS`[src]

`pub fn from_subset(element: &SS) -> SP`[src]

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,`

`pub fn to_subset(&self) -> Option<SS>`

`pub fn is_in_subset(&self) -> bool`

`pub fn to_subset_unchecked(&self) -> SS`

`pub fn from_subset(element: &SS) -> SP`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

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

`pub fn vzip(self) -> V`

[−][src]Struct bacon_sci::ivp::RK45

Examples

Implementations

pub fn new() -> Self[src]

Trait Implementations

pub fn clone(&self) -> RK45<N, S>[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

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

pub fn from(rk: RK45<N, S>) -> RKInfo<N, S, U6>[src]

pub fn t_coefficients() -> VectorN<N::RealField, U6>[src]

pub fn k_coefficients() -> MatrixMN<N::RealField, U6, U6>[src]

pub fn avg_coefficients() -> VectorN<N::RealField, U6>[src]

pub fn error_coefficients() -> VectorN<N::RealField, U6>[src]

pub fn solve_ivp<T: Clone, F: FnMut(N::RealField, &[N], &mut T) -> Result<VectorN<N, S>, String>>( self, f: F, params: &mut T) -> Result<Vec<(N::RealField, VectorN<N, S>)>, String>[src]

pub fn with_tolerance(self, tol: N::RealField) -> Result<Self, String>[src]

pub fn with_dt_max(self, max: N::RealField) -> Result<Self, String>[src]

pub fn with_dt_min(self, min: N::RealField) -> Result<Self, String>[src]

pub fn with_start(self, t_initial: N::RealField) -> Result<Self, String>[src]

pub fn with_end(self, t_final: N::RealField) -> Result<Self, String>[src]

pub fn with_initial_conditions(self, start: &[N]) -> Result<Self, String>[src]

pub fn build(self) -> Self[src]

Auto Trait Implementations

impl<N, S> !RefUnwindSafe for RK45<N, S>[src]

impl<N, S> !Send for RK45<N, S>[src]

impl<N, S> !Sync for RK45<N, S>[src]

impl<N, S> !Unpin for RK45<N, S>[src]

impl<N, S> !UnwindSafe for RK45<N, S>[src]

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

pub fn to_subset(&self) -> Option<SS>[src]

pub fn is_in_subset(&self) -> bool[src]

pub unsafe fn to_subset_unchecked(&self) -> SS[src]

pub fn from_subset(element: &SS) -> SP[src]

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

pub fn to_owned(&self) -> T[src]

pub fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

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

pub fn vzip(self) -> V