Struct DebugDataWriter

struct DebugDataWriter {
    context: Option<String>,
    activity_writer: Writer<File>,
    commodity_balance_duals_writer: Writer<File>,
    activity_duals_writer: Writer<File>,
    solver_values_writer: Writer<File>,
    appraisal_results_writer: Writer<File>,
    reduced_costs_writer: Writer<File>,
}

For writing extra debug information about the model

Fields

context: Option<String>

activity_writer: Writer<File>

commodity_balance_duals_writer: Writer<File>

activity_duals_writer: Writer<File>

solver_values_writer: Writer<File>

appraisal_results_writer: Writer<File>

reduced_costs_writer: Writer<File>

Implementations

impl DebugDataWriter

fn create(output_path: &Path) -> Result<Self>

Open CSV files to write debug info to

Arguments

• output_path - Folder where files will be saved

fn with_context(&self, run_description: &str) -> String

Prepend the current context to the run description

fn write_dispatch_debug_info( &mut self, milestone_year: u32, run_description: &str, solution: &Solution<'_>, ) -> Result<()>

Write debug info about the dispatch optimisation

fn write_activity<'a, I>( &mut self, milestone_year: u32, run_description: &str, iter: I, ) -> Result<()>

where I: Iterator<Item = (&'a AssetRef, &'a TimeSliceID, Activity)>,

fn write_activity_duals<'a, I>( &mut self, milestone_year: u32, run_description: &str, iter: I, ) -> Result<()>

where I: Iterator<Item = (&'a AssetRef, &'a TimeSliceID, MoneyPerActivity)>,

Write activity duals to file

fn write_commodity_balance_duals<'a, I>( &mut self, milestone_year: u32, run_description: &str, iter: I, ) -> Result<()>

where I: Iterator<Item = (&'a CommodityID, &'a RegionID, &'a TimeSliceID, MoneyPerFlow)>,

Write commodity balance duals to file

fn write_solver_values( &mut self, milestone_year: u32, run_description: &str, objective_value: Money, ) -> Result<()>

Write additional solver output values to file

fn write_appraisal_results( &mut self, milestone_year: u32, run_description: &str, appraisal_results: &[AppraisalOutput], ) -> Result<()>

Write appraisal results to file

fn write_reduced_costs( &mut self, milestone_year: u32, reduced_costs: &ReducedCosts, ) -> Result<()>

Write reduced costs to file

fn flush(&mut self) -> Result<()>

Flush the underlying streams