Struct Reward 

pub struct Reward(/* private fields */);

Quantitative reward for an MCTS state or simulation outcome.

Rewards are typically in [-1.0, 1.0] but the engine imposes no range restriction. Higher values indicate better outcomes.

Constants

• Reward::WIN — maximum positive outcome (1.0)
• Reward::LOSS — maximum negative outcome (-1.0)
• Reward::DRAW — neutral outcome (0.0)

Examples

use mctrust::Reward;

let r = Reward::new(0.75);
assert_eq!(r.value(), 0.75);
assert_eq!((Reward::WIN + Reward::DRAW).value(), 1.0);

Implementations

impl Reward

pub const WIN: Self

Maximum positive outcome.

pub const LOSS: Self

Maximum negative outcome.

pub const DRAW: Self

Neutral outcome.

pub fn new(value: f64) -> Self

Creates a reward wrapper from a raw floating-point value.

Parameters

• value: Reward magnitude to store.

Returns

Returns a new Reward containing value.

Panics

This function does not panic.

pub fn value(self) -> f64

Returns the underlying floating-point reward value.

Parameters

This function takes no additional parameters.

Returns

Returns the wrapped reward value.

Panics

This function does not panic.

Trait Implementations

impl Add for Reward

type Output = Reward

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for Reward

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Reward

fn clone(&self) -> Reward

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reward

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

Formats the value using the given formatter.

impl Default for Reward

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Reward

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reward

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

Formats the value using the given formatter.

impl From<f64> for Reward

fn from(value: f64) -> Self

Converts to this type from the input type.

impl PartialEq for Reward

fn eq(&self, other: &Reward) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Reward

fn partial_cmp(&self, other: &Reward) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Reward

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Reward

impl StructuralPartialEq for Reward