Skip to main content

StateTransitionResult

Struct StateTransitionResult 

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

Result of an initial-condition sensitivity solve.

Carries the state trajectory y(t) and the state-transition matrix Φ(t) = ∂y(t) / ∂y₀ ∈ ℝ^{N×N} of the linearised flow, evaluated at every output time the underlying solver produced.

§Φ(t) layout

Column-major within each per-time block: phi(i)[k*N + j] = Φ(t_i)_{j,k} = ∂y_j(t_i) / ∂y_{0,k}. The column-major flattening makes the j-th column (the trajectory’s response at time t_i to a unit perturbation of y_{0,k}) a free contiguous slice — see Self::phi_column.

§Vocabulary

All accessors speak state-transition-matrix vocabulary (Φ, ∂y_i/∂y_{0,j}, monodromy). The type holds the underlying SensitivityResult in a private field; it does not Deref to it and does not re-export the parameter-shaped accessors.

Implementations§

Source§

impl<S: Scalar> StateTransitionResult<S>

Source

pub fn t(&self) -> &[S]

Output time points (length n_times). t()[i] is the i-th output time; phi(i) is Φ(t()[i]).

Source

pub fn len(&self) -> usize

Number of output time points.

Source

pub fn is_empty(&self) -> bool

true iff the result has no output time points.

Source

pub fn dim(&self) -> usize

Underlying state dimension N.

Source

pub fn y(&self, i: usize) -> &[S]

State y(t_i) at output index i (length N).

Source

pub fn final_y(&self) -> &[S]

State at the final output time, length N. Empty slice when the result has no time points.

Source

pub fn phi(&self, i: usize) -> &[S]

Full state-transition matrix Φ(t_i) ∈ ℝ^{N×N} at output index i, column-major. phi(i)[k*N + j] = Φ(t_i)_{j,k} = ∂y_j(t_i)/∂y_{0,k}.

Source

pub fn phi_ij(&self, i: usize, row: usize, col: usize) -> S

Single entry Φ(t_i)_{row, col} = ∂y_row(t_i) / ∂y_{0, col}.

Source

pub fn phi_column(&self, i: usize, col: usize) -> &[S]

Contiguous slice Φ(t_i)_{:, col} of length N — the trajectory’s response at t_i to a unit perturbation of y_{0, col}. Free slice thanks to the column-major flattening.

Source

pub fn final_phi(&self) -> &[S]

Φ(t_f), the state-transition matrix at the final output time. When (t_f − t_0) equals one period of a periodic orbit this is the monodromy matrix, whose eigenvalues are the orbit’s characteristic (Floquet) multipliers. The type does not enforce periodicity; it only names the natural use. Empty slice when the result has no time points.

Source

pub fn success(&self) -> bool

true iff the underlying integration succeeded.

Source

pub fn message(&self) -> &str

Solver diagnostic message (empty on success).

Source

pub fn stats(&self) -> &SolverStats

Solver statistics from the underlying integration.

Trait Implementations§

Source§

impl<S: Clone + Scalar> Clone for StateTransitionResult<S>

Source§

fn clone(&self) -> StateTransitionResult<S>

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<S: Debug + Scalar> Debug for StateTransitionResult<S>

Source§

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

Formats the value using the given formatter. Read more

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

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

Source§

fn vzip(self) -> V