Struct CorrelationProfile 

pub struct CorrelationProfile {
    pub groups: Vec<CorrelationGroup>,
}

A named correlation profile containing one or more correlation groups.

A profile groups correlated entities into disjoint CorrelationGroups. Entities in different groups are treated as uncorrelated. Profiles are stored in CorrelationModel::profiles keyed by profile name.

See Input Scenarios §5.

Examples

use cobre_core::{EntityId, scenario::{CorrelationEntity, CorrelationGroup, CorrelationProfile}};

let profile = CorrelationProfile {
    groups: vec![CorrelationGroup {
        name: "All".to_string(),
        entities: vec![
            CorrelationEntity { entity_type: "inflow".to_string(), id: EntityId(1) },
            CorrelationEntity { entity_type: "inflow".to_string(), id: EntityId(2) },
            CorrelationEntity { entity_type: "inflow".to_string(), id: EntityId(3) },
        ],
        matrix: vec![
            vec![1.0, 0.0, 0.0],
            vec![0.0, 1.0, 0.0],
            vec![0.0, 0.0, 1.0],
        ],
    }],
};
assert_eq!(profile.groups[0].matrix.len(), 3);

Fields

groups: Vec<CorrelationGroup>

Disjoint groups of correlated entities within this profile.

Trait Implementations

impl Clone for CorrelationProfile

fn clone(&self) -> CorrelationProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationProfile

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

Formats the value using the given formatter.

impl PartialEq for CorrelationProfile

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