Skip to main content

ControlSchedule

Struct ControlSchedule 

Source
pub struct ControlSchedule<const C: usize> { /* private fields */ }
Expand description

A validated piecewise-constant control history.

controls[i] owns [boundaries[i], boundaries[i + 1]); the final boundary is included in the final segment. Boundaries are strictly increasing. Backward propagation traverses the same intervals in reverse, using the interval to the left of each encountered switching time.

Implementations§

Source§

impl<const C: usize> ControlSchedule<C>

Source

pub fn new(boundaries: Vec<f64>, controls: Vec<[f64; C]>) -> Result<Self>

Constructs and validates a zero-order-hold control schedule.

§Errors

Returns an error unless there is at least one non-empty segment, boundaries.len() == controls.len() + 1, every value is finite, and the boundaries are strictly increasing.

Source

pub fn boundaries(&self) -> &[f64]

Returns the switching boundaries.

Source

pub fn controls(&self) -> &[[f64; C]]

Returns the controls in chronological segment order.

Source

pub fn len(&self) -> usize

Returns the number of control segments.

Source

pub fn is_empty(&self) -> bool

Returns whether the schedule contains no segments.

Valid schedules are never empty; this method is supplied alongside Self::len for collection-like APIs.

Source

pub fn initial_time(&self) -> f64

Returns the first boundary.

Source

pub fn final_time(&self) -> f64

Returns the final boundary.

Source

pub fn control_at(&self, time: f64) -> Result<[f64; C]>

Returns the right-continuous control at a time inside the schedule.

At an internal switching time, the later segment owns the boundary. The final boundary returns the final segment’s control.

§Errors

Returns an error for non-finite times or times outside the closed schedule interval.

Trait Implementations§

Source§

impl<const C: usize> Clone for ControlSchedule<C>

Source§

fn clone(&self) -> ControlSchedule<C>

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<const C: usize> Debug for ControlSchedule<C>

Source§

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

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

impl<const C: usize> PartialEq for ControlSchedule<C>

Source§

fn eq(&self, other: &ControlSchedule<C>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<const C: usize> StructuralPartialEq for ControlSchedule<C>

Auto Trait Implementations§

§

impl<const C: usize> Freeze for ControlSchedule<C>

§

impl<const C: usize> RefUnwindSafe for ControlSchedule<C>

§

impl<const C: usize> Send for ControlSchedule<C>

§

impl<const C: usize> Sync for ControlSchedule<C>

§

impl<const C: usize> Unpin for ControlSchedule<C>

§

impl<const C: usize> UnsafeUnpin for ControlSchedule<C>

§

impl<const C: usize> UnwindSafe for ControlSchedule<C>

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<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 = 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.