Skip to main content

NStepBuffer

Struct NStepBuffer 

Source
pub struct NStepBuffer { /* private fields */ }
Expand description

Circular accumulator for n-step returns.

Implementations§

Source§

impl NStepBuffer

Source

pub fn new(n: usize, gamma: f32) -> Self

Create an n-step buffer.

  • n — number of steps to accumulate.
  • gamma — discount factor γ ∈ (0, 1].
§Panics

Panics if n == 0.

Source

pub fn n(&self) -> usize

Number of steps n.

Source

pub fn gamma(&self) -> f32

Discount factor γ.

Source

pub fn count(&self) -> usize

Current number of accumulated steps.

Source

pub fn push( &mut self, obs: impl Into<Vec<f32>>, action: impl Into<Vec<f32>>, reward: f32, next_obs: impl Into<Vec<f32>>, done: bool, ) -> Option<NStepTransition>

Push a (obs, action, reward, next_obs, done) step.

Returns Some(NStepTransition) once n steps have been accumulated (or immediately on terminal). Returns None while the buffer is still filling up.

Source

pub fn flush(&mut self) -> Vec<NStepTransition>

Flush any remaining steps in the buffer (for end-of-episode cleanup).

Returns all remaining n-step transitions.

Source

pub fn reset(&mut self)

Clear the buffer (e.g. at episode reset).

Source

pub fn try_get(&self) -> RlResult<NStepTransition>

Attempt to produce an n-step transition from the current state.

§Errors

Trait Implementations§

Source§

impl Clone for NStepBuffer

Source§

fn clone(&self) -> NStepBuffer

Returns a duplicate 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 Debug for NStepBuffer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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<T> ToOwned for T
where T: Clone,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more