Struct relearn::simulation::Step

pub struct Step<O, A, F = Reward, U = O> {
    pub observation: O,
    pub action: A,
    pub feedback: F,
    pub next: Successor<O, U>,
}

Description of an environment step.

There are a few different forms that this structure can take in terms of describing the next observation when next is Successor::Continue. These are determined by the value of the fourth generic parameter U:

• Step<O, A, F> - U = O - The continuing successor observation is owned.
• TransientStep<O, A, F> - U = &O - The continuing successor observation is borrowed.
• PartialStep<O, A, F> - U = () - The continuing successor observation is omitted.

If next is Successor::Interrupt then the observation is owned in all cases.

Fields

observation: O

The initial observation.

action: A

The action taken from the initial state given the initial observation.

feedback: F

The resulting feedback.

next: Successor<O, U>

The next observation or outcome; how the episode progresses.

Implementations

impl<O, A, F, U> Step<O, A, F, U>

pub const fn new(
    observation: O,
    action: A,
    feedback: F,
    next: Successor<O, U>
) -> Self

pub const fn episode_done(&self) -> bool

Whether this step is the last of an episode.

pub fn into_partial(self) -> PartialStep<O, A, F>

impl<O: Clone, A, F> Step<O, A, F, &'a O>

pub fn into_owned(self) -> Step<O, A, F>

Convert a transient step into an owned step by cloning any borrowed successor observation.

impl<O, A, F> Step<O, A, F, ()>

pub fn into_transient_with(self, next: &Self) -> TransientStep<'_, O, A, F>

Convert a partial step into a transient step using the given reference to the next step.

pub fn try_into_transient<'a>(self) -> Option<TransientStep<'a, O, A, F>>

Try to convert into a transient step with no successor.

Succeeds so long as self.next is not Successor::Continue.

Trait Implementations

impl<O: Clone, A: Clone, F: Clone, U: Clone> Clone for Step<O, A, F, U>

fn clone(&self) -> Step<O, A, F, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug, A: Debug, F: Debug, U: Debug> Debug for Step<O, A, F, U>

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

Formats the value using the given formatter.

impl<'a, O, A, F> Extend<&'a Step<O, A, F, ()>> for OnlineStepsSummary<F> where
    O: 'a,
    A: 'a,
    F: Feedback + 'a, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a PartialStep<O, A, F>>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<O, A, F: Feedback> Extend<Step<O, A, F, ()>> for OnlineStepsSummary<F>

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = PartialStep<O, A, F>>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a, O, A, F> FromIterator<&'a Step<O, A, F, ()>> for OnlineStepsSummary<F> where
    O: 'a,
    A: 'a,
    F: Feedback + 'a, 

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'a PartialStep<O, A, F>>, 

Creates a value from an iterator.

impl<'a, O, A, F> FromIterator<&'a Step<O, A, F, ()>> for StepsSummary<F> where
    O: 'a,
    A: 'a,
    F: Feedback + 'a, 

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'a PartialStep<O, A, F>>, 

Creates a value from an iterator.

impl<O, A, F: Feedback> FromIterator<Step<O, A, F, ()>> for OnlineStepsSummary<F>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = PartialStep<O, A, F>>, 

Creates a value from an iterator.

impl<O, A, F: Feedback> FromIterator<Step<O, A, F, ()>> for StepsSummary<F>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = PartialStep<O, A, F>>, 

Creates a value from an iterator.

impl<O, A, F> FromIterator<Step<O, A, F, ()>> for VecBuffer<O, A, F>

fn from_iter<I>(steps: I) -> Self where
    I: IntoIterator<Item = PartialStep<O, A, F>>, 

Creates a value from an iterator.

impl<O: PartialEq, A: PartialEq, F: PartialEq, U: PartialEq> PartialEq<Step<O, A, F, U>> for Step<O, A, F, U>

fn eq(&self, other: &Step<O, A, F, U>) -> bool

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

fn ne(&self, other: &Step<O, A, F, U>) -> bool

This method tests for !=.

impl<O: Copy, A: Copy, F: Copy, U: Copy> Copy for Step<O, A, F, U>

impl<O, A, F, U> StructuralPartialEq for Step<O, A, F, U>