Skip to main content

OdeCallbacksDesc

diffsol_c::ode_callbacks

Struct OdeCallbacksDesc 

Source 
#[repr(C)]
pub struct OdeCallbacksDesc<T> {
Show 31 fields
    pub nstates: usize,
    pub nparams: usize,
    pub nout: usize,
    pub nroots: usize,
    pub user_data: *mut c_void,
    pub free_user_data: OdeCallbackFreeFn,
    pub rhs: OdeCallbackFn<T>,
    pub rhs_jac: OdeCallbackMulFn<T>,
    pub rhs_sens: OdeCallbackMulFn<T>,
    pub rhs_adjoint: OdeCallbackMulFn<T>,
    pub rhs_sens_adjoint: OdeCallbackMulFn<T>,
    pub init: OdeCallbackInitFn<T>,
    pub init_sens: OdeCallbackInitMulFn<T>,
    pub init_sens_adjoint: OdeCallbackInitMulFn<T>,
    pub mass: OdeCallbackMassFn<T>,
    pub mass_adjoint: OdeCallbackMassFn<T>,
    pub root: OdeCallbackFn<T>,
    pub root_jac: OdeCallbackMulFn<T>,
    pub root_sens: OdeCallbackMulFn<T>,
    pub root_adjoint: OdeCallbackMulFn<T>,
    pub root_sens_adjoint: OdeCallbackMulFn<T>,
    pub out: OdeCallbackFn<T>,
    pub out_jac: OdeCallbackMulFn<T>,
    pub out_sens: OdeCallbackMulFn<T>,
    pub out_adjoint: OdeCallbackMulFn<T>,
    pub out_sens_adjoint: OdeCallbackMulFn<T>,
    pub reset: OdeCallbackFn<T>,
    pub reset_jac: OdeCallbackMulFn<T>,
    pub reset_sens: OdeCallbackMulFn<T>,
    pub reset_adjoint: OdeCallbackMulFn<T>,
    pub reset_sens_adjoint: OdeCallbackMulFn<T>,

}
Expand description

The C callbacks (and the problem dimensions) that define an OdeCallbacks.

A NULL function pointer means the callback is not provided. Only rhs and init are required; see the module documentation for the meaning and argument lengths of each callback.

Fields§

§nstates: usize

Number of states.

§nparams: usize

Number of parameters.

§nout: usize

Number of outputs of out, which must be 0 exactly when out is not provided.

§nroots: usize

Number of root functions of root, which must be 0 exactly when root is not provided.

§user_data: *mut c_void

Passed as the last argument of every callback.

§free_user_data: OdeCallbackFreeFn

Called once with user_data when the equations are dropped. May be NULL.

§rhs: OdeCallbackFn<T>§rhs_jac: OdeCallbackMulFn<T>§rhs_sens: OdeCallbackMulFn<T>§rhs_adjoint: OdeCallbackMulFn<T>§rhs_sens_adjoint: OdeCallbackMulFn<T>§init: OdeCallbackInitFn<T>§init_sens: OdeCallbackInitMulFn<T>§init_sens_adjoint: OdeCallbackInitMulFn<T>§mass: OdeCallbackMassFn<T>§mass_adjoint: OdeCallbackMassFn<T>§root: OdeCallbackFn<T>§root_jac: OdeCallbackMulFn<T>§root_sens: OdeCallbackMulFn<T>§root_adjoint: OdeCallbackMulFn<T>§root_sens_adjoint: OdeCallbackMulFn<T>§out: OdeCallbackFn<T>§out_jac: OdeCallbackMulFn<T>§out_sens: OdeCallbackMulFn<T>§out_adjoint: OdeCallbackMulFn<T>§out_sens_adjoint: OdeCallbackMulFn<T>§reset: OdeCallbackFn<T>§reset_jac: OdeCallbackMulFn<T>§reset_sens: OdeCallbackMulFn<T>§reset_adjoint: OdeCallbackMulFn<T>§reset_sens_adjoint: OdeCallbackMulFn<T>

Implementations§

Source§

impl<T> OdeCallbacksDesc<T>

Source

pub fn new( nstates: usize, nparams: usize, rhs: unsafe extern "C" fn(x: *const T, p: *const T, t: T, y: *mut T, user_data: *mut c_void) -> i32, init: unsafe extern "C" fn(p: *const T, t: T, y: *mut T, user_data: *mut c_void) -> i32, ) -> Self

A descriptor with only the required callbacks set, and no user_data.

Trait Implementations§

Source§

impl<T: Clone> Clone for OdeCallbacksDesc<T>

Source§

fn clone(&self) -> Self

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<T: Copy> Copy for OdeCallbacksDesc<T>

Source§

impl<T: Debug> Debug for OdeCallbacksDesc<T>

Source§

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

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

impl<T: Send> Send for OdeCallbacksDesc<T>

Auto Trait Implementations§

§

impl<T> !Sync for OdeCallbacksDesc<T>

§

impl<T> Forget for OdeCallbacksDesc<T>

§

impl<T> Freeze for OdeCallbacksDesc<T>
where Option<unsafe extern "C" fn(*const T, *const T, T, *mut T, *mut c_void) -> i32>: Freeze, Option<unsafe extern "C" fn(*const T, *const T, T, *const T, *mut T, *mut c_void) -> i32>: Freeze, Option<unsafe extern "C" fn(*const T, T, *mut T, *mut c_void) -> i32>: Freeze, Option<unsafe extern "C" fn(*const T, T, *const T, *mut T, *mut c_void) -> i32>: Freeze, Option<unsafe extern "C" fn(*const T, *const T, T, T, *mut T, *mut c_void) -> i32>: Freeze,

§

impl<T> RefUnwindSafe for OdeCallbacksDesc<T>
where Option<unsafe extern "C" fn(*const T, *const T, T, *mut T, *mut c_void) -> i32>: RefUnwindSafe, Option<unsafe extern "C" fn(*const T, *const T, T, *const T, *mut T, *mut c_void) -> i32>: RefUnwindSafe, Option<unsafe extern "C" fn(*const T, T, *mut T, *mut c_void) -> i32>: RefUnwindSafe, Option<unsafe extern "C" fn(*const T, T, *const T, *mut T, *mut c_void) -> i32>: RefUnwindSafe, Option<unsafe extern "C" fn(*const T, *const T, T, T, *mut T, *mut c_void) -> i32>: RefUnwindSafe,

§

impl<T> Unpin for OdeCallbacksDesc<T>
where Option<unsafe extern "C" fn(*const T, *const T, T, *mut T, *mut c_void) -> i32>: Unpin, Option<unsafe extern "C" fn(*const T, *const T, T, *const T, *mut T, *mut c_void) -> i32>: Unpin, Option<unsafe extern "C" fn(*const T, T, *mut T, *mut c_void) -> i32>: Unpin, Option<unsafe extern "C" fn(*const T, T, *const T, *mut T, *mut c_void) -> i32>: Unpin, Option<unsafe extern "C" fn(*const T, *const T, T, T, *mut T, *mut c_void) -> i32>: Unpin,

§

impl<T> UnsafeUnpin for OdeCallbacksDesc<T>
where Option<unsafe extern "C" fn(*const T, *const T, T, *mut T, *mut c_void) -> i32>: UnsafeUnpin, Option<unsafe extern "C" fn(*const T, *const T, T, *const T, *mut T, *mut c_void) -> i32>: UnsafeUnpin, Option<unsafe extern "C" fn(*const T, T, *mut T, *mut c_void) -> i32>: UnsafeUnpin, Option<unsafe extern "C" fn(*const T, T, *const T, *mut T, *mut c_void) -> i32>: UnsafeUnpin, Option<unsafe extern "C" fn(*const T, *const T, T, T, *mut T, *mut c_void) -> i32>: UnsafeUnpin,

§

impl<T> UnwindSafe for OdeCallbacksDesc<T>
where Option<unsafe extern "C" fn(*const T, *const T, T, *mut T, *mut c_void) -> i32>: UnwindSafe, Option<unsafe extern "C" fn(*const T, *const T, T, *const T, *mut T, *mut c_void) -> i32>: UnwindSafe, Option<unsafe extern "C" fn(*const T, T, *mut T, *mut c_void) -> i32>: UnwindSafe, Option<unsafe extern "C" fn(*const T, T, *const T, *mut T, *mut c_void) -> i32>: UnwindSafe, Option<unsafe extern "C" fn(*const T, *const T, T, T, *mut T, *mut c_void) -> i32>: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.