Struct CollocationResult

Source

pub struct CollocationResult<S: Scalar> {
    pub time: Vec<S>,
    pub states: Vec<S>,
    pub controls: Vec<S>,
    pub parameters: Vec<S>,
    pub objective: S,
    pub final_time: S,
    pub converged: bool,
    pub message: String,
    pub iterations: usize,
    pub wall_time_secs: f64,
    pub n_states: usize,
    pub n_controls: usize,
}

Expand description

Result of a direct collocation solve.

Fields§

§time: Vec<S>

Time grid at mesh nodes.

§states: Vec<S>

States at each mesh node (flat row-major: states[i * nx + j]).

§controls: Vec<S>

Controls at each mesh node (flat row-major: controls[i * nu + j]).

§parameters: Vec<S>

Optimal parameters (empty if no free parameters).

§objective: S

Optimal objective value.

§final_time: S

Final time (may differ from initial if free).

§converged: bool

Whether the optimizer converged.

§message: String

Human-readable status message.

§iterations: usize

Number of optimizer iterations.

§wall_time_secs: f64

Wall-clock time in seconds.

§n_states: usize

Number of states (for interpreting flat arrays).

§n_controls: usize

Number of controls (for interpreting flat arrays).

Trait Implementations§

Source §

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

Source §

fn clone(&self) -> CollocationResult<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 CollocationResult<S>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> UnwindSafe for CollocationResult<S>
where S: 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> 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 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 §