soco 1.0.0

Algorithms for Smoothed Online Convex Optimization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! Utilities for solving offline problems given a model.

use std::{panic, time::Instant};

use crate::{
    algorithms::{
        offline::{OfflineAlgorithm, OfflineOptions, OfflineResult},
        Options,
    },
    cost::Cost,
    model::{
        Model, ModelOutputFailure, ModelOutputSuccess, OfflineInput,
        OnlineInput,
    },
    problem::Problem,
    result::Result,
    schedule::Schedule,
    value::Value,
};
use backtrace::Backtrace;
use log::{info, warn};

/// Generates problem instance from model and solves it using an offline algorithm.
pub fn solve<'a, T, R, P, O, A, B, C, D>(
    model: &'a impl Model<T, P, A, B, C, D>,
    alg: &impl OfflineAlgorithm<T, R, P, O, C, D>,
    options: O,
    offline_options: OfflineOptions,
    input: A,
) -> Result<(Schedule<T>, Cost<C, D>, u128)>
where
    T: Value<'a>,
    R: OfflineResult<T>,
    P: Problem<T, C, D> + 'a,
    O: Options<T, P, C, D> + 'a,
    A: OfflineInput,
    B: OnlineInput,
    C: ModelOutputSuccess,
    D: ModelOutputFailure,
{
    panic::set_hook(Box::new(|_panic_info| {
        warn!("\n\n{:?}", Backtrace::new());
    }));

    let p = model.to(input);
    info!("Generated a problem instance: {:?}", p);
    p.verify()?;

    info!("Simulating until time slot {}.", p.t_end());
    let start = Instant::now();
    let result = alg.solve(p.clone(), options, offline_options)?;
    let runtime = start.elapsed().as_millis();

    let xs = result.xs();
    let cost = p.objective_function(&xs)?;
    info!("Completed with {:?} and {:?}", cost, xs);
    Ok((xs, cost, runtime))
}