Skip to main content

ScenarioSource

Struct ScenarioSource 

Source
pub struct ScenarioSource {
    pub sampling_scheme: SamplingScheme,
    pub seed: Option<i64>,
    pub selection_mode: Option<ExternalSelectionMode>,
}
Expand description

Top-level scenario source configuration, parsed from stages.json.

Groups the sampling scheme, random seed, and external selection mode that govern how forward-pass scenarios are produced. Populated during case loading by cobre-io from the scenario_source field in stages.json. Distinct from ScenarioSourceConfig, which also holds the branching factor (num_scenarios).

See Input Scenarios §1.4, §1.8.

§Examples

use cobre_core::scenario::{SamplingScheme, ScenarioSource};

let source = ScenarioSource {
    sampling_scheme: SamplingScheme::InSample,
    seed: Some(42),
    selection_mode: None,
};
assert_eq!(source.sampling_scheme, SamplingScheme::InSample);

Fields§

§sampling_scheme: SamplingScheme

Noise source used during the forward pass.

§seed: Option<i64>

Random seed for reproducible opening tree generation. None means non-deterministic (OS entropy).

§selection_mode: Option<ExternalSelectionMode>

Selection mode when sampling_scheme is SamplingScheme::External. None for InSample and Historical schemes.

Trait Implementations§

Source§

impl Clone for ScenarioSource

Source§

fn clone(&self) -> ScenarioSource

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 ScenarioSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScenarioSource

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ScenarioSource

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for ScenarioSource

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, 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.