Struct soco::schedule::Schedule

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

source

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

source

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

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

source

impl<'a, T> Schedule<T> where
T: Value<'a>,

source

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

Trait Implementations

source

impl<'a, T, U> CastableSchedule<T> for Schedule where
T: Value<'a>,
U: Value<'a>,

source

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl<'a, T> DiscretizableSchedule for Schedule<T> where
T: Value<'a>,

source

fn to_i(&self) -> IntegralSchedule

Discretize a schedule.

source

impl<'a, T> FromIterator<Config<T>> for Schedule<T> where
T: Value<'a>,

source

fn from_iter(iter: I) -> Self where
I: IntoIterator<Item = Config<T>>,

Creates a value from an iterator. Read more

source

impl<'a, T> FromParallelIterator<Config<T>> for Schedule<T> where
T: Value<'a>,

source

fn from_par_iter(iter: I) -> Self where
I: IntoParallelIterator<Item = Config<T>>,

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

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<'a, T> Index<usize> for Schedule<T> where
T: Value<'a>,

type Output = Config<T>

The returned type after indexing.

source

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

Performs the indexing (container[index]) operation. Read more

source

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.

source

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator. Read more

source

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.

source

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl<'a, T> Resettable<'a> for Schedule<T> where
T: Value<'a>,

source

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

source

impl<T> Serialize for Schedule<T> where
T: Serialize,

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl<'a, T> VecWrapper for Schedule<T> where
T: Value<'a>,

type Item = Config<T>

source

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

source

fn iter(&self) -> Iter<'_, Self::Item>ⓘNotable traits for Iter<'a, T>`impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;`

source

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

source

impl<T> StructuralEq for Schedule<T>

source

impl<T> StructuralPartialEq for Schedule<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Schedule<T> where
T: RefUnwindSafe,

impl<T> Send for Schedule<T> where
T: Send,

impl<T> Sync for Schedule<T> where
T: Sync,

impl<T> Unpin for Schedule<T> where
T: Unpin,

impl<T> UnwindSafe for Schedule<T> where
T: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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<'data, I> IntoParallelRefIterator<'data> for I where
I: 'data + ?Sized,
&'data I: IntoParallelIterator,

type Iter = <&'data I as IntoParallelIterator>::Iter

The type of the parallel iterator that will be returned.

type Item = <&'data I as IntoParallelIterator>::Item

The type of item that the parallel iterator will produce. This will typically be an &'data T reference type. Read more

source

fn par_iter(&'data self) -> >::Iter

Converts self into a parallel iterator. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

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,

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

source

Struct soco::schedule::Schedule

Implementations

impl<'a, T> Schedule<T> where T: Value<'a>,

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

pub fn empty() -> Schedule<T>

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

pub fn is_empty(&self) -> bool

pub fn t_end(&self) -> i32

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

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

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

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

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

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

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

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

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

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

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

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>

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

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

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

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>,

impl<'a, T> DiscretizableSchedule for Schedule<T> where T: Value<'a>,

fn to_i(&self) -> IntegralSchedule

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>>,

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>>,

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

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

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

impl<'a, T> Index<usize> for Schedule<T> where T: Value<'a>,

type Output = Config<T>

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

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

type Item = &'a Config<T>

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

fn into_par_iter(self) -> Self::Iter

impl<'a, T> IntoParallelIterator for Schedule<T> where T: Value<'a>,

type Item = Config<T>

type Iter = IntoIter<Config<T>>

fn into_par_iter(self) -> Self::Iter

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

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

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

impl<'a, T> Resettable<'a> for Schedule<T> where T: Value<'a>,

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

impl<T> Serialize for Schedule<T> where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: 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>ⓘNotable traits for Iter<'a, T>impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

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

impl<T> StructuralEq for Schedule<T>

impl<T> StructuralPartialEq for Schedule<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Schedule<T> where T: RefUnwindSafe,

impl<T> Send for Schedule<T> where T: Send,

impl<T> Sync for Schedule<T> where T: Sync,

impl<T> Unpin for Schedule<T> where T: Unpin,

impl<T> UnwindSafe for Schedule<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<'a, T> Schedule<T> where
T: Value<'a>,

impl<'a, T> Schedule<T> where
T: Value<'a>,

impl<'a, T, U> CastableSchedule<T> for Schedule<U> where
T: Value<'a>,
U: Value<'a>,

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>,

impl<'a, T> DiscretizableSchedule for Schedule<T> where
T: Value<'a>,

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>>,

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>>,

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

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

impl<'a, T> Index<usize> for Schedule<T> where
T: Value<'a>,

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

impl<'a, T> IntoParallelIterator for Schedule<T> where
T: Value<'a>,

impl<'a, T> Resettable<'a> for Schedule<T> where
T: Value<'a>,

impl<T> Serialize for Schedule<T> where
T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<'a, T> VecWrapper for Schedule<T> where
T: Value<'a>,

fn iter(&self) -> Iter<'_, Self::Item>ⓘNotable traits for Iter<'a, T>`impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;`

impl<T> RefUnwindSafe for Schedule<T> where
T: RefUnwindSafe,

impl<T> Send for Schedule<T> where
T: Send,

impl<T> Sync for Schedule<T> where
T: Sync,

impl<T> Unpin for Schedule<T> where
T: Unpin,

impl<T> UnwindSafe for Schedule<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<'data, I> IntoParallelRefIterator<'data> for I where
I: 'data + ?Sized,
&'data I: IntoParallelIterator,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,