Struct CorrelationModel 

pub struct CorrelationModel {
    pub method: String,
    pub profiles: BTreeMap<String, CorrelationProfile>,
    pub schedule: Vec<CorrelationScheduleEntry>,
}

Top-level correlation configuration for the scenario pipeline.

Holds all named correlation profiles and the optional stage-to-profile schedule. When schedule is empty, the solver uses a single profile (typically named "default") for all stages.

profiles uses BTreeMap rather than HashMap to preserve deterministic iteration order, satisfying the declaration-order invariance requirement (design-principles.md §3).

method is always "cholesky" for the minimal viable solver but stored as a String for forward compatibility with future decomposition methods.

Source: correlation.json. See Input Scenarios §5 and internal-structures.md §14.

Examples

use std::collections::BTreeMap;
use cobre_core::{EntityId, scenario::{
    CorrelationEntity, CorrelationGroup, CorrelationModel, CorrelationProfile,
    CorrelationScheduleEntry,
}};

let mut profiles = BTreeMap::new();
profiles.insert("default".to_string(), CorrelationProfile {
    groups: vec![CorrelationGroup {
        name: "All".to_string(),
        entities: vec![
            CorrelationEntity { entity_type: "inflow".to_string(), id: EntityId(1) },
        ],
        matrix: vec![vec![1.0]],
    }],
});

let model = CorrelationModel {
    method: "cholesky".to_string(),
    profiles,
    schedule: vec![],
};
assert!(model.profiles.contains_key("default"));

Fields

method: String

Decomposition method. Always "cholesky" for the minimal viable solver. Stored as String for forward compatibility.

profiles: BTreeMap<String, CorrelationProfile>

Named correlation profiles keyed by profile name. BTreeMap for deterministic ordering (declaration-order invariance).

schedule: Vec<CorrelationScheduleEntry>

Stage-to-profile schedule. Empty when a single profile applies to all stages.

Trait Implementations

impl Clone for CorrelationModel

fn clone(&self) -> CorrelationModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationModel

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

Formats the value using the given formatter.

impl Default for CorrelationModel

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CorrelationModel

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