Struct UnitChangeQuery 

pub struct UnitChangeQuery {
    pub outcome: VariableId,
    pub unit_rows: Option<Arc<[usize]>>,
    pub components: AttributionComponents,
    pub allocation: AllocationMethod,
    pub max_units: usize,
}

Per-unit change attribution query.

Fields

outcome: VariableId

Outcome variable.

unit_rows: Option<Arc<[usize]>>

Optional factual row indices (None = all units up to max_units).

components: AttributionComponents

Components to attribute (inputs / mechanisms / both).

allocation: AllocationMethod

Allocation method.

max_units: usize

Hard unit count limit.

Implementations

impl UnitChangeQuery

pub fn new(outcome: VariableId, max_units: usize) -> Self

Attribute change for outcome across units.

pub fn with_unit_rows(self, rows: impl Into<Arc<[usize]>>) -> Self

Restrict to explicit rows.

pub const fn with_components(self, components: AttributionComponents) -> Self

Set components.

pub fn with_allocation(self, allocation: AllocationMethod) -> Self

Set allocation.

pub fn validate(&self) -> Result<(), QueryError>

Validate.

Errors

Zero max_units or invalid allocation.

Trait Implementations

impl Clone for UnitChangeQuery

fn clone(&self) -> UnitChangeQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitChangeQuery

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

Formats the value using the given formatter.

impl Eq for UnitChangeQuery

impl From<UnitChangeQuery> for CausalQuery

fn from(query: UnitChangeQuery) -> Self

Converts to this type from the input type.

impl Hash for UnitChangeQuery

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UnitChangeQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UnitChangeQuery