Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Implement new generic terminator interface |
|---|---|
| Downloads: | Tarball | ZIP archive |
| Timelines: | family | ancestors | descendants | both | terminator |
| Files: | files | file ages | folders |
| SHA1: |
ff06564d0f10212a76625af58ab2fb14 |
| User & Date: | fifr 2019-07-20 13:56:00.702 |
Context
|
2019-07-20
| ||
| 13:58 | Merge terminator check-in: 071e757395 user: fifr tags: async | |
| 13:56 | Implement new generic terminator interface Closed-Leaf check-in: ff06564d0f user: fifr tags: terminator | |
| 12:32 | Merge weighter check-in: 0c89a8508c user: fifr tags: async | |
Changes
Changes to examples/cflp.rs.
| ︙ | ︙ | |||
28 29 30 31 32 33 34 |
use env_logger::{self, fmt::Color};
use ordered_float::NotNan;
use threadpool::ThreadPool;
use bundle::parallel::{EvalResult, FirstOrderProblem as ParallelProblem, ParallelSolver, ResultSender};
use bundle::{dvec, DVector, Minorant, Real};
| | | 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
use env_logger::{self, fmt::Color};
use ordered_float::NotNan;
use threadpool::ThreadPool;
use bundle::parallel::{EvalResult, FirstOrderProblem as ParallelProblem, ParallelSolver, ResultSender};
use bundle::{dvec, DVector, Minorant, Real};
use bundle::{DefaultSolver, FirstOrderProblem, SimpleEvaluation};
const Nfac: usize = 3;
const Ncus: usize = 5;
const F: [Real; Nfac] = [1000.0, 1000.0, 1000.0];
const CAP: [Real; Nfac] = [500.0, 500.0, 500.0];
const C: [[Real; Ncus]; Nfac] = [
[4.0, 5.0, 6.0, 8.0, 10.0], //
|
| ︙ | ︙ | |||
258 259 260 261 262 263 264 |
style.value("]"),
style.value(record.args())
)
})
.init();
{
let mut slv = DefaultSolver::new(CFLProblem::new())?;
| | < < | 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
style.value("]"),
style.value(record.args())
)
})
.init();
{
let mut slv = DefaultSolver::new(CFLProblem::new())?;
slv.terminator.termination_precision = 1e-9;
slv.solve()?;
for i in 0..Ncus {
let x = slv.aggregated_primals(Nfac + i);
let mut obj = 0.0;
let mut s = String::new();
write!(s, "x[{}] =", i)?;
|
| ︙ | ︙ |
Changes to examples/mmcf.rs.
| ︙ | ︙ | |||
16 17 18 19 20 21 22 | */ use bundle; use env_logger; use log::info; use bundle::mcf; | | | 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
*/
use bundle;
use env_logger;
use log::info;
use bundle::mcf;
use bundle::{DefaultSolver, FirstOrderProblem, SolverParams};
use std::env;
fn main() {
env_logger::init();
let mut args = env::args();
|
| ︙ | ︙ | |||
41 42 43 44 45 46 47 |
max_bundle_size: 25,
min_weight: 1e-3,
max_weight: 100.0,
..Default::default()
},
)
.unwrap();
| | < < | 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
max_bundle_size: 25,
min_weight: 1e-3,
max_weight: 100.0,
..Default::default()
},
)
.unwrap();
solver.terminator.termination_precision = 1e-6;
solver.solve().unwrap();
let costs: f64 = (0..solver.problem().num_subproblems())
.map(|i| {
let aggr_primals = solver.aggregated_primals(i);
solver.problem().get_primal_costs(i, &aggr_primals)
})
.sum();
info!("Primal costs: {}", costs);
} else {
panic!("Usage: {} FILENAME", program);
}
}
|
Changes to src/lib.rs.
| ︙ | ︙ | |||
32 33 34 35 36 37 38 |
pub mod minorant;
pub use crate::minorant::{Aggregatable, Minorant};
pub mod firstorderproblem;
pub use crate::firstorderproblem::{Evaluation, FirstOrderProblem, SimpleEvaluation, Update};
pub mod solver;
| < | < > > | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
pub mod minorant;
pub use crate::minorant::{Aggregatable, Minorant};
pub mod firstorderproblem;
pub use crate::firstorderproblem::{Evaluation, FirstOrderProblem, SimpleEvaluation, Update};
pub mod solver;
pub use crate::solver::{BundleState, DefaultSolver, IterationInfo, Solver, SolverParams, Step, UpdateState};
pub mod parallel;
pub mod weighter;
pub mod terminator;
pub mod master;
pub mod mcf;
|
Changes to src/parallel/solver.rs.
| ︙ | ︙ | |||
25 26 27 28 29 30 31 |
use std::time::Instant;
use threadpool::ThreadPool;
use crate::{DVector, Minorant, Real};
use super::problem::{EvalResult, FirstOrderProblem};
use crate::master::{BoxedMasterProblem, CplexMaster, MasterProblem, UnconstrainedMasterProblem};
| | > | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
use std::time::Instant;
use threadpool::ThreadPool;
use crate::{DVector, Minorant, Real};
use super::problem::{EvalResult, FirstOrderProblem};
use crate::master::{BoxedMasterProblem, CplexMaster, MasterProblem, UnconstrainedMasterProblem};
use crate::solver::{SolverParams, Step};
use crate::terminator::{StandardTerminatable, StandardTerminator, Terminator};
use crate::weighter::{HKWeightable, HKWeighter, Weighter};
/// The default iteration limit.
pub const DEFAULT_ITERATION_LIMIT: usize = 10_000;
type MasterProblemError = <BoxedMasterProblem<CplexMaster> as MasterProblem>::Err;
|
| ︙ | ︙ | |||
169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
/// Norm of current aggregated subgradient.
sgnorm: Real,
/// The currently used master problem weight.
cur_weight: Real,
}
impl HKWeightable for SolverData {
fn current_weight(&self) -> Real {
self.cur_weight
}
fn center(&self) -> &DVector {
| > > > > > > > > > > | 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
/// Norm of current aggregated subgradient.
sgnorm: Real,
/// The currently used master problem weight.
cur_weight: Real,
}
impl StandardTerminatable for SolverData {
fn center_value(&self) -> Real {
self.cur_val
}
fn expected_progress(&self) -> Real {
self.cur_val - self.nxt_mod
}
}
impl HKWeightable for SolverData {
fn current_weight(&self) -> Real {
self.cur_weight
}
fn center(&self) -> &DVector {
|
| ︙ | ︙ | |||
204 205 206 207 208 209 210 |
}
}
/// Implementation of a parallel bundle method.
pub struct Solver<P, T = StandardTerminator, W = HKWeighter>
where
P: FirstOrderProblem,
| < | 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
}
}
/// Implementation of a parallel bundle method.
pub struct Solver<P, T = StandardTerminator, W = HKWeighter>
where
P: FirstOrderProblem,
{
/// Parameters for the solver.
pub params: Parameters,
/// Termination predicate.
pub terminator: T,
|
| ︙ | ︙ | |||
256 257 258 259 260 261 262 |
}
impl<P, T, W> Solver<P, T, W>
where
P: FirstOrderProblem,
P::Primal: Send + Sync + 'static,
P::Err: std::error::Error + Send + Sync + 'static,
| | | 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
}
impl<P, T, W> Solver<P, T, W>
where
P: FirstOrderProblem,
P::Primal: Send + Sync + 'static,
P::Err: std::error::Error + Send + Sync + 'static,
T: Terminator<SolverData> + Default,
W: Weighter<SolverData> + Default,
{
/// Create a new parallel bundle solver.
pub fn new(problem: P) -> Self {
Solver {
params: Parameters::default(),
terminator: Default::default(),
|
| ︙ | ︙ | |||
626 627 628 629 630 631 632 |
recv(master_rx) -> msg => {
debug!("Receive master response");
// Receive result (new candidate) from the master
let master_res = msg
.map_err(|err| Error::Process(err.into()))?
.map_err(Error::Master)?;
| | < < < < < < < < < < < | 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 |
recv(master_rx) -> msg => {
debug!("Receive master response");
// Receive result (new candidate) from the master
let master_res = msg
.map_err(|err| Error::Process(err.into()))?
.map_err(Error::Master)?;
if self.data.cur_weight < Real::infinity() && self.terminator.terminate(&self.data) {
info!("Termination criterion satisfied");
return Ok(true)
}
// Compress bundle
master_tx.send(MasterTask::Compress).map_err(|err| Error::Process(err.into()))?;
|
| ︙ | ︙ |
Changes to src/solver.rs.
| ︙ | ︙ | |||
17 18 19 20 21 22 23 |
//! The main bundle method solver.
use crate::{Aggregatable, DVector, Real};
use crate::{Evaluation, FirstOrderProblem, Update};
use crate::master::CplexMaster;
use crate::master::{BoxedMasterProblem, MasterProblem, MinimalMaster};
| | | 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
//! The main bundle method solver.
use crate::{Aggregatable, DVector, Real};
use crate::{Evaluation, FirstOrderProblem, Update};
use crate::master::CplexMaster;
use crate::master::{BoxedMasterProblem, MasterProblem, MinimalMaster};
use crate::terminator::{StandardTerminatable, StandardTerminator, Terminator};
use crate::weighter::{HKWeightable, HKWeighter, Weighter};
use log::{debug, info, warn};
use std::error::Error;
use std::f64::{INFINITY, NEG_INFINITY};
use std::fmt;
|
| ︙ | ︙ | |||
194 195 196 197 198 199 200 |
}
fn sgnorm(&self) -> Real {
self.sgnorm
}
}
| < < < < < < < < < < < < < < | < < | < < < < | | | < < < < < > | 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
}
fn sgnorm(&self) -> Real {
self.sgnorm
}
}
impl<'a> StandardTerminatable for BundleState<'a> {
fn expected_progress(&self) -> Real {
self.expected_progress
}
fn center_value(&self) -> Real {
self.cur_val
}
}
/// An invalid value for some parameter has been passes.
#[derive(Debug)]
pub struct ParameterError(String);
|
| ︙ | ︙ | |||
406 407 408 409 410 411 412 |
/// This is the last primal generated by the oracle.
pub fn last_primal(&self, fidx: usize) -> Option<&Pr> {
self.minorants[fidx].last().and_then(|m| m.primal.as_ref())
}
}
/// The default bundle solver with general master problem.
| | | | | | 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
/// This is the last primal generated by the oracle.
pub fn last_primal(&self, fidx: usize) -> Option<&Pr> {
self.minorants[fidx].last().and_then(|m| m.primal.as_ref())
}
}
/// The default bundle solver with general master problem.
pub type DefaultSolver<P> = Solver<P, StandardTerminator, HKWeighter, BoxedMasterProblem<CplexMaster>>;
/// A bundle solver with a minimal cutting plane model.
pub type NoBundleSolver<P> = Solver<P, StandardTerminator, HKWeighter, BoxedMasterProblem<MinimalMaster>>;
/**
* Implementation of a bundle method.
*/
pub struct Solver<P, T, W, M = BoxedMasterProblem<CplexMaster>>
where
P: FirstOrderProblem,
{
/// The first order problem description.
problem: P,
/// The solver parameter.
pub params: SolverParams,
/// Termination predicate.
pub terminator: T,
/// Weighter heuristic.
pub weighter: W,
/// Lower and upper bounds of all variables.
bounds: Vec<(Real, Real)>,
|
| ︙ | ︙ | |||
506 507 508 509 510 511 512 |
/// The active minorant indices for each subproblem.
minorants: Vec<Vec<MinorantInfo<P::Primal>>>,
/// Accumulated information about the last iteration.
iterinfos: Vec<IterationInfo>,
}
| | > | | | 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
/// The active minorant indices for each subproblem.
minorants: Vec<Vec<MinorantInfo<P::Primal>>>,
/// Accumulated information about the last iteration.
iterinfos: Vec<IterationInfo>,
}
impl<P, T, W, M> Solver<P, T, W, M>
where
P: FirstOrderProblem,
P::Err: Into<Box<std::error::Error + Send + Sync + 'static>>,
T: for<'a> Terminator<BundleState<'a>> + Default,
W: for<'a> Weighter<BundleState<'a>> + Default,
M: MasterProblem<MinorantIndex = usize>,
M::Err: Into<Box<std::error::Error + Send + Sync + 'static>>,
{
/**
* Create a new solver for the given problem.
*
* Note that the solver owns the problem, so you cannot use the
* same problem description elsewhere as long as it is assigned to
* the solver. However, it is possible to get a reference to the
* internally stored problem using `Solver::problem()`.
*/
#[allow(clippy::type_complexity)]
pub fn new_params(problem: P, params: SolverParams) -> Result<Solver<P, T, W, M>, SolverError<P::Err, M::Err>> {
Ok(Solver {
problem,
params,
terminator: T::default(),
weighter: W::default(),
bounds: vec![],
cur_y: dvec![],
cur_val: 0.0,
cur_mod: 0.0,
cur_vals: dvec![],
cur_mods: dvec![],
|
| ︙ | ︙ | |||
556 557 558 559 560 561 562 |
minorants: vec![],
iterinfos: vec![],
})
}
/// A new solver with default parameter.
#[allow(clippy::type_complexity)]
| | | 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
minorants: vec![],
iterinfos: vec![],
})
}
/// A new solver with default parameter.
#[allow(clippy::type_complexity)]
pub fn new(problem: P) -> Result<Solver<P, T, W, M>, SolverError<P::Err, M::Err>> {
Solver::new_params(problem, SolverParams::default())
}
/**
* Set the first order problem description associated with this
* solver.
*
|
| ︙ | ︙ | |||
973 974 975 976 977 978 979 |
if !self.cur_valid {
// current point needs new evaluation
self.init_master()?;
}
self.solve_model()?;
| < < | < | 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 |
if !self.cur_valid {
// current point needs new evaluation
self.init_master()?;
}
self.solve_model()?;
if self.terminator.terminate(¤t_state!(self, Step::Term)) {
return Ok(Step::Term);
}
let m = self.problem.num_subproblems();
let descent_bnd = self.get_descent_bound();
let nullstep_bnd = if m == 1 { self.get_nullstep_bound() } else { INFINITY };
let relprec = if m == 1 { self.get_relative_precision() } else { 0.0 };
|
| ︙ | ︙ |
Added src/terminator.rs.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 59 60 |
/*
* Copyright (c) 2019 Frank Fischer <frank-fischer@shadow-soft.de>
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
//! Termination criteria for (proximal) bundle solvers.
use crate::Real;
/// Termination predicate.
///
/// Given the current state of the bundle method, this function returns
/// whether the solution process should be stopped.
pub trait Terminator<Terminatable> {
/// Return true if the method should stop.
fn terminate(&mut self, t: &Terminatable) -> bool;
}
/// Terminates if expected progress is small enough.
pub struct StandardTerminator {
pub termination_precision: Real,
}
impl Default for StandardTerminator {
fn default() -> Self {
StandardTerminator {
termination_precision: 1e-3,
}
}
}
pub trait StandardTerminatable {
/// Return the expected progress.
fn expected_progress(&self) -> Real;
/// Return the current center value.
fn center_value(&self) -> Real;
}
impl<T> Terminator<T> for StandardTerminator
where
T: StandardTerminatable,
{
fn terminate(&mut self, t: &T) -> bool {
assert!(self.termination_precision >= 0.0);
t.expected_progress() <= self.termination_precision * (t.center_value().abs() + 1.0)
}
}
|