Struct gym_rs::core::ActionReward

pub struct ActionReward<T, E> {
    pub observation: T,
    pub reward: O64,
    pub done: bool,
    pub truncated: bool,
    pub info: Option<E>,
}

Encapsulates and describes the state update experienced by an environment after acting on an action.

Fields

observation: T

The current observable state.

reward: O64

The value of the reward produced.

done: bool

Indicates whether the episode has terminated or not.

truncated: bool

Indicates whether the episode has termianted early or not.

info: Option<E>

Additional info implementations may provide for purposes beyond classical RL.

Trait Implementations

impl<T: Clone, E: Clone> Clone for ActionReward<T, E>

fn clone(&self) -> ActionReward<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for ActionReward<T, E>

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

Formats the value using the given formatter.

impl<T: Ord, E: Ord> Ord for ActionReward<T, E>

fn cmp(&self, other: &ActionReward<T, E>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq, E: PartialEq> PartialEq<ActionReward<T, E>> for ActionReward<T, E>

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

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

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

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

impl<T: PartialOrd, E: PartialOrd> PartialOrd<ActionReward<T, E>> for ActionReward<T, E>

fn partial_cmp(&self, other: &ActionReward<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy, E: Copy> Copy for ActionReward<T, E>

impl<T: Eq, E: Eq> Eq for ActionReward<T, E>

impl<T, E> StructuralEq for ActionReward<T, E>

impl<T, E> StructuralPartialEq for ActionReward<T, E>