Skip to main content

CollocationProblem

Struct CollocationProblem 

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

Builder for direct collocation optimal control problems.

Implementations§

Source§

impl<S: Scalar> CollocationProblem<S>

Source

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

Create a new collocation problem.

Source

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

Set the dynamics: f(t, x, u, p, dxdt).

Source

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

Set the number of free parameters.

Source

pub fn x0(self, x0: &[S]) -> Self

Set the initial state.

Source

pub fn time_span(self, t0: S, tf: S) -> Self

Set the time span [t0, tf].

Source

pub fn free_final_time(self, tf_init: S, tf_bounds: (S, S)) -> Self

Enable free final time.

Source

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

Set the number of collocation intervals.

Source

pub fn scheme(self, scheme: CollocationScheme) -> Self

Set the collocation scheme.

Source

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

Set the terminal cost phi(x(tf), tf).

Source

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

Set the running cost L(t, x, u).

Source

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

Set terminal equality constraints psi(x(tf)) = 0.

Source

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

Set path constraints with bounds: lo <= c(t, x, u) <= hi.

Source

pub fn control_bounds(self, bounds: &[(S, S)]) -> Self

Set bounds for each control variable (applied at every node).

Source

pub fn state_bounds(self, bounds: &[(S, S)]) -> Self

Set bounds for each state variable (applied at every node).

Source

pub fn params0(self, p0: &[S]) -> Self

Set initial guess for free parameters.

Source

pub fn param_bound(self, idx: usize, lo: S, hi: S) -> Self

Set bounds for a specific parameter.

Source

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

Set maximum optimizer iterations.

Source

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

Solve the collocation problem.

Auto Trait Implementations§

§

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

§

impl<S> !RefUnwindSafe for CollocationProblem<S>

§

impl<S> Send for CollocationProblem<S>

§

impl<S> Sync for CollocationProblem<S>

§

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

§

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

§

impl<S> !UnwindSafe for CollocationProblem<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