Struct Schedule

pub struct Schedule<T>(/* private fields */);

Includes all configurations from time $1$ to time $t_end$.

Implementations

impl<'a, T> Schedule<T>

where T: Value<'a>,

pub fn new(x: Vec<Config<T>>) -> Schedule<T>

Converts a vector of configurations to a schedule.

pub fn empty() -> Schedule<T>

Builds an empty schedule.

pub fn repeat(x: Config<T>, t: i32) -> Schedule<T>

pub fn is_empty(&self) -> bool

Returns true if the schedule is empty (i.e. does not include any config).

pub fn t_end(&self) -> i32

Returns the time of the latest time step.

pub fn now(&self) -> Config<T>

Returns the config of the latest time step.

pub fn now_with_default(&self, default: Config<T>) -> Config<T>

Returns the config of the latest time step.

pub fn get(&self, t: i32) -> Option<&Config<T>>

Returns the config at time $t$ if present.

pub fn shift(&mut self, x: Config<T>)

Extends schedule with a new initial config.

pub fn push(&mut self, x: Config<T>)

Extends schedule with a new final config.

pub fn extend(&self, x: Config<T>) -> Schedule<T>

Immutably Extends schedule with a new final config.

pub fn skip(&self, delta: i32) -> Self

Skips first $delta$ configurations.

pub fn to_vec(&self) -> Vec<Vec<T>>

Converts schedule to a vector of vectors.

pub fn from_raw(d: i32, w: i32, raw_xs: &[T]) -> Schedule<T>

Builds a schedule from a raw (flat) encoding $raw_xs$ (used for convex optimization). $d$ is the number of dimensions, $w$ is the length of the time window. The length of $raw_xs$ must therefore be $d \cdot w$.

pub fn build_raw(w: i32, x: &Config<T>) -> Vec<T>

Builds a raw (flat) encoding of a schedule (used for convex optimization) by stretching a config across the time window $w$.

pub fn raw_encoding_len(d: i32, w: i32) -> i32

Returns the length of the raw encoding of $d$ dimensions across time window $w$.

impl<'a, T> Schedule<T>

where T: Value<'a>,

pub fn verify(&self, t_end: i32, bounds: &Vec<T>) -> Result<()>

Trait Implementations

impl<'a, T, U> CastableSchedule<T> for Schedule<U>

where T: Value<'a>, U: Value<'a>,

fn to(&self) -> Schedule<T>

impl<T: Clone> Clone for Schedule<T>

fn clone(&self) -> Schedule<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Schedule<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Schedule<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> DiscretizableSchedule for Schedule<T>

where T: Value<'a>,

fn to_i(&self) -> IntegralSchedule

Discretize a schedule.

impl<'a, T> FromIterator<Config<T>> for Schedule<T>

where T: Value<'a>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Config<T>>,

Creates a value from an iterator.

impl<'a, T> FromParallelIterator<Config<T>> for Schedule<T>

where T: Value<'a>,

fn from_par_iter<I>(iter: I) -> Self

where I: IntoParallelIterator<Item = Config<T>>,

Creates an instance of the collection from the parallel iterator par_iter.

impl<T: Hash> Hash for Schedule<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> Index<usize> for Schedule<T>

where T: Value<'a>,

type Output = Config<T>

The returned type after indexing.

fn index(&self, t: usize) -> &Config<T>

Performs the indexing (container[index]) operation.

impl<'a, 'b, T> IntoParallelIterator for &'a Schedule<T>

where T: Value<'b>,

type Item = &'a Config<T>

The type of item that the parallel iterator will produce.

type Iter = Iter<'a, Config<T>>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.

impl<'a, T> IntoParallelIterator for Schedule<T>

where T: Value<'a>,

type Item = Config<T>

The type of item that the parallel iterator will produce.

type Iter = IntoIter<Config<T>>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.

impl<T: PartialEq> PartialEq for Schedule<T>

fn eq(&self, other: &Schedule<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T> Resettable<'a> for Schedule<T>

where T: Value<'a>,

fn reset(&'a self, t_start: i32) -> Schedule<T>

Shift object to some new initial time $t_start$. Here, $t_start$ is the time before first time slot (e.g., $t_start = 0$ is a no-op).

impl<T> Serialize for Schedule<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, T> VecWrapper for Schedule<T>

where T: Value<'a>,

type Item = Config<T>

fn to_vec(&self) -> &Vec<Self::Item>

fn iter(&self) -> Iter<'_, Self::Item>

impl<T: Eq> Eq for Schedule<T>

impl<T> StructuralPartialEq for Schedule<T>