Skip to main content

AlphaInvestor

Struct AlphaInvestor 

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

Alpha-Investing controller for sequential FDR control.

Maintains a wealth process that gates alert significance decisions. Each call to test either rejects (discovery) or fails to reject, updating the wealth accordingly.

Implementations§

Source§

impl AlphaInvestor

Source

pub fn new(config: AlphaInvestingConfig) -> Self

Create a new investor with the given configuration.

Source

pub fn with_defaults() -> Self

Create an investor with default configuration.

Source

pub fn wealth(&self) -> f64

Current wealth (remaining significance budget).

Source

pub fn tests_run(&self) -> usize

Number of hypotheses tested.

Source

pub fn discoveries(&self) -> usize

Number of discoveries (rejected hypotheses).

Source

pub fn discovery_rate(&self) -> f64

Empirical false discovery proportion: discoveries / tests_run. Returns 0.0 if no tests have been run.

Source

pub fn test(&mut self, p_value: f64) -> TestOutcome

Test a hypothesis with the given p-value.

The procedure invests investment_fraction * wealth as the alpha level for this test. If p_value ≤ alpha, the hypothesis is rejected (discovery) and wealth is replenished by reward_fraction * alpha.

Returns the outcome and updates internal state.

Source

pub fn test_with_investment( &mut self, p_value: f64, custom_alpha: Option<f64>, ) -> TestOutcome

Test with a custom investment amount (overrides investment_fraction).

custom_alpha is clamped to [0, current_wealth].

Source

pub fn test_batch(&mut self, p_values: &[f64]) -> Vec<TestOutcome>

Batch-test multiple hypotheses, returning outcomes for each.

P-values are tested in the order given. The wealth evolves sequentially, so ordering matters.

Source

pub fn reset(&mut self)

Reset the investor to its initial state.

Source

pub fn history(&self) -> &[TestRecord]

Access the test history.

Source

pub fn drain_history(&mut self) -> Vec<TestRecord>

Drain the test history (returns ownership, clears internal log).

Trait Implementations§

Source§

impl Clone for AlphaInvestor

Source§

fn clone(&self) -> AlphaInvestor

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 AlphaInvestor

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