Struct rust_code_analysis::abc::Stats

pub struct Stats { /* private fields */ }

The ABC metric.

The ABC metric measures the size of a source code by counting the number of Assignments (A), Branches (B) and Conditions (C). The metric defines an ABC score as a vector of three elements (<A,B,C>). The ABC score can be represented by its individual components (A, B and C) or by the magnitude of the vector (|<A,B,C>| = sqrt(A^2 + B^2 + C^2)).

Official paper and definition:

Fitzpatrick, Jerry (1997). “Applying the ABC metric to C, C++ and Java”. C++ Report. https://www.softwarerenovation.com/Articles.aspx

Implementations

impl Stats

pub fn merge(&mut self, other: &Stats)

Merges a second Abc metric into the first one.

pub fn assignments(&self) -> f64

Returns the Abc assignments metric value.

pub fn assignments_sum(&self) -> f64

Returns the Abc assignments sum metric value.

pub fn assignments_average(&self) -> f64

Returns the Abc assignments average value.

This value is computed dividing the Abc assignments value for the number of spaces.

pub fn assignments_min(&self) -> f64

Returns the Abc assignments minimum value.

pub fn assignments_max(&self) -> f64

Returns the Abc assignments maximum value.

pub fn branches(&self) -> f64

Returns the Abc branches metric value.

pub fn branches_sum(&self) -> f64

Returns the Abc branches sum metric value.

pub fn branches_average(&self) -> f64

Returns the Abc branches average value.

This value is computed dividing the Abc branches value for the number of spaces.

pub fn branches_min(&self) -> f64

Returns the Abc branches minimum value.

pub fn branches_max(&self) -> f64

Returns the Abc branches maximum value.

pub fn conditions(&self) -> f64

Returns the Abc conditions metric value.

pub fn conditions_sum(&self) -> f64

Returns the Abc conditions sum metric value.

pub fn conditions_average(&self) -> f64

Returns the Abc conditions average value.

This value is computed dividing the Abc conditions value for the number of spaces.

pub fn conditions_min(&self) -> f64

Returns the Abc conditions minimum value.

pub fn conditions_max(&self) -> f64

Returns the Abc conditions maximum value.

pub fn magnitude(&self) -> f64

Returns the Abc magnitude metric value.

pub fn magnitude_sum(&self) -> f64

Returns the Abc magnitude sum metric value.

Trait Implementations

impl Clone for Stats

fn clone(&self) -> Stats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

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

Formats the value using the given formatter.

impl Default for Stats

fn default() -> Self

Returns the “default value” for a type.

impl Display for Stats

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

Formats the value using the given formatter.

impl Serialize for Stats

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

Serialize this value into the given Serde serializer.