Skip to main content

DiVector

Struct DiVector 

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

Two-sided per-dimension attribution accumulator.

Implementations§

Source§

impl DiVector

Source

pub fn zeros(dim: usize) -> Self

Build a zeroed DiVector with dim dimensions.

§Examples
use anomstream_core::domain::DiVector;
let v = DiVector::zeros(4);
assert_eq!(v.dim(), 4);
assert_eq!(v.total(), 0.0);
Source

pub fn from_arrays(high: Vec<f64>, low: Vec<f64>) -> RcfResult<Self>

Build a DiVector from explicit high / low vectors. Useful for tests and downstream code that wants to pipe a ready-made attribution back into a triage helper (e.g. anomstream_triage::AlertClusterer).

§Errors

Returns RcfError::DimensionMismatch when high.len() != low.len().

Source

pub fn dim(&self) -> usize

Dimensionality.

Source

pub fn high(&self) -> &[f64]

Read-only view of the upper-side contributions.

Source

pub fn low(&self) -> &[f64]

Read-only view of the lower-side contributions.

Source

pub fn total(&self) -> f64

Sum of all high[d] and low[d] entries.

Source

pub fn per_dim_total(&self, d: usize) -> f64

Per-dimension total: high[d] + low[d].

§Panics

Panics when d >= self.dim() — call sites size-check first.

Source

pub fn argmax(&self) -> Option<usize>

Index of the dimension with the largest high[d] + low[d]. Returns None for an empty vector.

Source

pub fn add_high(&mut self, d: usize, value: f64) -> RcfResult<()>

Add value to the upper-side contribution for dimension d.

§Errors

Returns RcfError::OutOfBounds when d >= self.dim().

Source

pub fn add_low(&mut self, d: usize, value: f64) -> RcfResult<()>

Add value to the lower-side contribution for dimension d.

§Errors

Returns RcfError::OutOfBounds when d >= self.dim().

Source

pub fn accumulate(&mut self, other: &Self) -> RcfResult<()>

Element-wise add other into self.

§Errors

Returns RcfError::DimensionMismatch when dimensions differ.

Source

pub fn scale(&mut self, divisor: f64) -> RcfResult<()>

Divide every component by divisor in place. Used by the forest layer to convert a sum of per-tree attributions into a mean.

§Errors

Returns RcfError::InvalidConfig when divisor is zero or non-finite.

Trait Implementations§

Source§

impl Clone for DiVector

Source§

fn clone(&self) -> DiVector

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 DiVector

Source§

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

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

impl<'de> Deserialize<'de> for DiVector

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DiVector

Source§

fn eq(&self, other: &DiVector) -> 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 Serialize for DiVector

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DiVector

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,