Struct UtilityBreakdown 

pub struct UtilityBreakdown { /* private fields */ }

Explainable inputs and result of one utility calculation.

Example

use termivar_core::Probability;
use termivar_scanner::{ActionCost, BenefitScore, RiskScore, UtilityBreakdown};

let utility = UtilityBreakdown::calculate(
    BenefitScore::from_percent(80)?,
    Probability::from_percent(75)?,
    BenefitScore::from_percent(90)?,
    ActionCost::new(100)?,
    RiskScore::from_percent(20)?,
);

assert_eq!(utility.score().units(), 270_000_000);

Implementations

impl UtilityBreakdown

pub fn calculate( gain: BenefitScore, confidence: Probability, business_value: BenefitScore, cost: ActionCost, risk: RiskScore, ) -> Self

Calculates utility with integer arithmetic and half-up rounding.

pub fn gain(&self) -> BenefitScore

Returns expected information or security gain.

pub fn confidence(&self) -> Probability

Returns the selected Bayesian hypothesis posterior.

pub fn business_value(&self) -> BenefitScore

Returns target business value.

pub fn cost(&self) -> ActionCost

Returns estimated execution cost.

pub fn risk(&self) -> RiskScore

Returns normalized operational risk.

pub fn score(&self) -> UtilityScore

Returns the final fixed-point utility.

Trait Implementations

impl Clone for UtilityBreakdown

fn clone(&self) -> UtilityBreakdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UtilityBreakdown

impl Debug for UtilityBreakdown

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UtilityBreakdown

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UtilityBreakdown

impl PartialEq for UtilityBreakdown

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UtilityBreakdown

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UtilityBreakdown