Struct border_core::Step

source · [−]

pub struct Step<E: Env> {
    pub act: E::Act,
    pub obs: E::Obs,
    pub reward: Vec<f32>,
    pub is_done: Vec<i8>,
    pub info: E::Info,
    pub init_obs: E::Obs,
}

Expand description

All information given at every step of agent-envieronment interaction.

Old versions of the library support veectorized environments, which requires elements in Step to be able to handle multiple values. This is why reward and is_done are vector.

Fields

act: E::Act

Action.

obs: E::Obs

Observation.

reward: Vec<f32>

Reward.

is_done: Vec<i8>

Flag denoting if episode is done.

info: E::Info

Information defined by user.

init_obs: E::Obs

Initial observation. If is_done[i] == 0, the corresponding element will not be used.

Implementations

source

impl<E: Env> Step<E>

source

pub fn new(
 obs: E::Obs,
 act: E::Act,
 reward: Vec<f32>,
 is_done: Vec<i8>,
 info: E::Info,
 init_obs: E::Obs
) -> Self

Constructs a Step object.

Auto Trait Implementations

impl<E> RefUnwindSafe for Step<E> where
 <E as Env>::Act: RefUnwindSafe,
 <E as Env>::Info: RefUnwindSafe,
 <E as Env>::Obs: RefUnwindSafe,

impl<E> Send for Step<E> where
 <E as Env>::Act: Send,
 <E as Env>::Info: Send,
 <E as Env>::Obs: Send,

impl<E> Sync for Step<E> where
 <E as Env>::Act: Sync,
 <E as Env>::Info: Sync,
 <E as Env>::Obs: Sync,

impl<E> Unpin for Step<E> where
 <E as Env>::Act: Unpin,
 <E as Env>::Info: Unpin,
 <E as Env>::Obs: Unpin,

impl<E> UnwindSafe for Step<E> where
 <E as Env>::Act: UnwindSafe,
 <E as Env>::Info: UnwindSafe,
 <E as Env>::Obs: UnwindSafe,

Blanket Implementations

source

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

source

pub 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

pub 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

pub 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

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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

pub 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

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

Performs the conversion.

Struct border_core::Step

Fields

Implementations

impl<E: Env> Step<E>

pub fn new(
    obs: E::Obs,
    act: E::Act,
    reward: Vec<f32>,
    is_done: Vec<i8>,
    info: E::Info,
    init_obs: E::Obs
) -> Self

Auto Trait Implementations

impl<E> RefUnwindSafe for Step<E> where
    <E as Env>::Act: RefUnwindSafe,
    <E as Env>::Info: RefUnwindSafe,
    <E as Env>::Obs: RefUnwindSafe,

impl<E> Send for Step<E> where
    <E as Env>::Act: Send,
    <E as Env>::Info: Send,
    <E as Env>::Obs: Send,

impl<E> Sync for Step<E> where
    <E as Env>::Act: Sync,
    <E as Env>::Info: Sync,
    <E as Env>::Obs: Sync,

impl<E> Unpin for Step<E> where
    <E as Env>::Act: Unpin,
    <E as Env>::Info: Unpin,
    <E as Env>::Obs: Unpin,

impl<E> UnwindSafe for Step<E> where
    <E as Env>::Act: UnwindSafe,
    <E as Env>::Info: UnwindSafe,
    <E as Env>::Obs: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

Struct border_core::Step

Fields

Implementations

impl<E: Env> Step<E>

pub fn new( obs: E::Obs, act: E::Act, reward: Vec<f32>, is_done: Vec<i8>, info: E::Info, init_obs: E::Obs) -> Self

Auto Trait Implementations

impl<E> RefUnwindSafe for Step<E> where <E as Env>::Act: RefUnwindSafe, <E as Env>::Info: RefUnwindSafe, <E as Env>::Obs: RefUnwindSafe,

impl<E> Send for Step<E> where <E as Env>::Act: Send, <E as Env>::Info: Send, <E as Env>::Obs: Send,

impl<E> Sync for Step<E> where <E as Env>::Act: Sync, <E as Env>::Info: Sync, <E as Env>::Obs: Sync,

impl<E> Unpin for Step<E> where <E as Env>::Act: Unpin, <E as Env>::Info: Unpin, <E as Env>::Obs: Unpin,

impl<E> UnwindSafe for Step<E> where <E as Env>::Act: UnwindSafe, <E as Env>::Info: UnwindSafe, <E as Env>::Obs: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

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

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

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

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

pub fn new(
obs: E::Obs,
act: E::Act,
reward: Vec<f32>,
is_done: Vec<i8>,
info: E::Info,
init_obs: E::Obs
) -> Self

impl<E> RefUnwindSafe for Step<E> where
<E as Env>::Act: RefUnwindSafe,
<E as Env>::Info: RefUnwindSafe,
<E as Env>::Obs: RefUnwindSafe,

impl<E> Send for Step<E> where
<E as Env>::Act: Send,
<E as Env>::Info: Send,
<E as Env>::Obs: Send,

impl<E> Sync for Step<E> where
<E as Env>::Act: Sync,
<E as Env>::Info: Sync,
<E as Env>::Obs: Sync,

impl<E> Unpin for Step<E> where
<E as Env>::Act: Unpin,
<E as Env>::Info: Unpin,
<E as Env>::Obs: Unpin,

impl<E> UnwindSafe for Step<E> where
<E as Env>::Act: UnwindSafe,
<E as Env>::Info: UnwindSafe,
<E as Env>::Obs: 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<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>,