Struct MethodVectorAlgebraReport 

pub struct MethodVectorAlgebraReport { /* private fields */ }

Observable runtime vector-algebra results for two methods.

Examples

use whitaker_common::test_support::decomposition::{MethodInput, method_vector_algebra, profile};

let left = profile(MethodInput {
    name: "parse_tokens",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});
let right = profile(MethodInput {
    name: "parse_nodes",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});

let report = method_vector_algebra(&left, &right);
assert_eq!(report.left_dot_right(), report.right_dot_left());
assert!(report.left_norm_squared() > 0);

Implementations

impl MethodVectorAlgebraReport

pub fn left_dot_right(self) -> u64

Returns the result of MethodVectorAlgebraReport::left_dot_right.

This is the dot product of the left and right method vectors.

use whitaker_common::test_support::decomposition::{MethodInput, method_vector_algebra, profile};

let left = profile(MethodInput {
    name: "parse_tokens",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});
let right = profile(MethodInput {
    name: "parse_nodes",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});

let report = method_vector_algebra(&left, &right);
assert_eq!(report.left_dot_right(), 40);

pub fn right_dot_left(self) -> u64

Returns the result of MethodVectorAlgebraReport::right_dot_left.

This is the dot product of the right and left method vectors.

use whitaker_common::test_support::decomposition::{MethodInput, method_vector_algebra, profile};

let left = profile(MethodInput {
    name: "parse_tokens",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});
let right = profile(MethodInput {
    name: "parse_nodes",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});

let report = method_vector_algebra(&left, &right);
assert_eq!(report.right_dot_left(), 40);

pub fn left_norm_squared(self) -> u64

Returns the result of MethodVectorAlgebraReport::left_norm_squared.

This is the squared L2 norm of the left method vector.

use whitaker_common::test_support::decomposition::{MethodInput, method_vector_algebra, profile};

let left = profile(MethodInput {
    name: "parse_tokens",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});
let right = profile(MethodInput {
    name: "parse_nodes",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});

let report = method_vector_algebra(&left, &right);
assert_eq!(report.left_norm_squared(), 44);

pub fn right_norm_squared(self) -> u64

Returns the result of MethodVectorAlgebraReport::right_norm_squared.

This is the squared L2 norm of the right method vector.

use whitaker_common::test_support::decomposition::{MethodInput, method_vector_algebra, profile};

let left = profile(MethodInput {
    name: "parse_tokens",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});
let right = profile(MethodInput {
    name: "parse_nodes",
    fields: &["grammar"],
    signature_types: &[],
    local_types: &[],
    domains: &[],
});

let report = method_vector_algebra(&left, &right);
assert_eq!(report.right_norm_squared(), 44);

Trait Implementations

impl Clone for MethodVectorAlgebraReport

fn clone(&self) -> MethodVectorAlgebraReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MethodVectorAlgebraReport

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

Formats the value using the given formatter.

impl PartialEq for MethodVectorAlgebraReport

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MethodVectorAlgebraReport

impl Eq for MethodVectorAlgebraReport

impl StructuralPartialEq for MethodVectorAlgebraReport