prog_translator.cc

Go to the documentation of this file.

#include "prog_translator.h"

#include <algorithm>

#include "CoinPackedVector.hpp"
#include "OsiSolverInterface.hpp"

#include "cyc_limits.h"
#include "error.h"
#include "exchange_graph.h"
#include "exchange_solver.h"
#include "logger.h"

namespace cyclus {

ProgTranslator::ProgTranslator(ExchangeGraph* g, OsiSolverInterface* iface)
    : g_(g),
      iface_(iface),
      excl_(false),
      pseudo_cost_(std::numeric_limits<double>::max()) {
  Init();
}

ProgTranslator::ProgTranslator(ExchangeGraph* g, OsiSolverInterface* iface,
                               bool exclusive)
    : g_(g),
      iface_(iface),
      excl_(exclusive),
      pseudo_cost_(std::numeric_limits<double>::max()) {
  Init();
}

ProgTranslator::ProgTranslator(ExchangeGraph* g, OsiSolverInterface* iface,
                               double pseudo_cost)
    : g_(g),
      iface_(iface),
      excl_(false),
      pseudo_cost_(pseudo_cost) {
  Init();
}

ProgTranslator::ProgTranslator(ExchangeGraph* g, OsiSolverInterface* iface,
                               bool exclusive, double pseudo_cost)
    : g_(g),
      iface_(iface),
      excl_(exclusive),
      pseudo_cost_(pseudo_cost) {
  Init();
}

void ProgTranslator::Init() {
  arc_offset_ = g_->arcs().size();
  int n_cols = arc_offset_ + g_->request_groups().size();
  ctx_.obj_coeffs.resize(n_cols);
  ctx_.col_ubs.resize(n_cols);
  ctx_.col_lbs.resize(n_cols);
  ctx_.m = CoinPackedMatrix(false, 0, 0);
}

void ProgTranslator::CheckPref(double pref) {
  if (pref <= 0) {
    std::stringstream ss;
    ss << "Preference value found to be nonpositive (" << pref
       << "). Preferences must be positive when using an optimization solver."
       << " If using Cyclus in simulation mode (e.g., from the command line),"
       << " this error is likely a bug in Cyclus. Please report it to the developer's "
       << "list (https://groups.google.com/forum/#!forum/cyclus-dev).";
    throw ValueError(ss.str());
  }
}

void ProgTranslator::Translate() {
  // number of variables = number of arcs + 1 faux arc per request group with arcs
  int nfalse = 0;
  std::vector<RequestGroup::Ptr>& rgs = g_->request_groups();
  for (int i = 0; i != g_->request_groups().size(); ++i)
    nfalse += rgs[i].get()->HasArcs() ? 1 : 0;
  int n_cols = g_->arcs().size() + nfalse;
  ctx_.m.setDimensions(0, n_cols);

  bool request;
  std::vector<ExchangeNodeGroup::Ptr>& sgs = g_->supply_groups();
  for (int i = 0; i != sgs.size(); i++) {
    request = false;
    XlateGrp_(sgs[i].get(), request);
  }

  for (int i = 0; i != rgs.size(); i++) {
    request = true;
    XlateGrp_(rgs[i].get(), request);
  }

  // add each false arc
  CLOG(LEV_DEBUG1) << "Adding " << arc_offset_ - g_->arcs().size()
                   << " false arcs.";
  double inf = iface_->getInfinity();
  for (int i = g_->arcs().size(); i != arc_offset_; i++) {
    ctx_.obj_coeffs[i] = pseudo_cost_;
    ctx_.col_lbs[i] = 0;
    ctx_.col_ubs[i] = inf;
  }
}

void ProgTranslator::Populate() {
  iface_->setObjSense(1.0);  // minimize

  // load er up!
  iface_->loadProblem(ctx_.m, &ctx_.col_lbs[0], &ctx_.col_ubs[0],
                      &ctx_.obj_coeffs[0], &ctx_.row_lbs[0], &ctx_.row_ubs[0]);


  if (excl_) {
    std::vector<Arc>& arcs = g_->arcs();
    for (int i = 0; i != arcs.size(); i++) {
      Arc& a = arcs[i];
      if (a.exclusive()) {
        iface_->setInteger(g_->arc_ids()[a]);
      }
    }
  }

}

void ProgTranslator::ToProg() {
  Translate();
  Populate();
}

void ProgTranslator::XlateGrp_(ExchangeNodeGroup* grp, bool request) {
  double inf = iface_->getInfinity();
  std::vector<double>& caps = grp->capacities();

  if (request && !grp->HasArcs())
    return; // no arcs, no reason to add variables/constraints

  std::vector<CoinPackedVector> cap_rows;
  std::vector<CoinPackedVector> excl_rows;
  for (int i = 0; i != caps.size(); i++) {
    cap_rows.push_back(CoinPackedVector());
  }

  std::vector<ExchangeNode::Ptr>& nodes = grp->nodes();
  for (int i = 0; i != nodes.size(); i++) {
    std::map<Arc, std::vector<double> >& ucap_map = nodes[i]->unit_capacities;
    std::map<Arc, std::vector<double> >::iterator cap_it;

    // add each arc
    for (cap_it = ucap_map.begin(); cap_it != ucap_map.end(); ++cap_it) {
      const Arc& a = cap_it->first;
      std::vector<double>& ucaps = cap_it->second;
      int arc_id = g_->arc_ids()[a];

      // add each unit capacity coefficient
      for (int j = 0; j != ucaps.size(); j++) {
        double coeff = ucaps[j];
        if (excl_ && a.exclusive()) {
          coeff *= a.excl_val();
        }

        cap_rows[j].insert(arc_id, coeff);
      }

      if (request) {
        CheckPref(a.pref());
        ctx_.obj_coeffs[arc_id] = ExchangeSolver::Cost(a, excl_);
        ctx_.col_lbs[arc_id] = 0;
        ctx_.col_ubs[arc_id] = (excl_ && a.exclusive()) ? 1 :
                               std::min(nodes[i]->qty, inf);
      }
    }
  }

  int faux_id;
  if (request) {
    faux_id = arc_offset_++;
  }

  // add all capacity rows
  for (int i = 0; i != cap_rows.size(); i++) {
    if (request) {
      cap_rows[i].insert(faux_id, 1.0);  // faux arc
    }

    // 1e15 is the largest value that doesn't make the solver fall over
    // (by emperical testing)
    double rlb = std::min(caps[i], 1e15);
    ctx_.row_lbs.push_back(request ? rlb : 0);
    ctx_.row_ubs.push_back(request ? inf : caps[i]);
    ctx_.m.appendRow(cap_rows[i]);
  }

  if (excl_) {
    // add exclusive arcs
    std::vector< std::vector<ExchangeNode::Ptr> >& exngs =
        grp->excl_node_groups();
    for (int i = 0; i != exngs.size(); i++) {
      CoinPackedVector excl_row;
      std::vector<ExchangeNode::Ptr>& nodes = exngs[i];
      for (int j = 0; j != nodes.size(); j++) {
        std::vector<Arc>& arcs = g_->node_arc_map()[nodes[j]];
        for (int k = 0; k != arcs.size(); k++) {
          excl_row.insert(g_->arc_ids()[arcs[k]], 1.0);
        }
      }
      if (excl_row.getNumElements() > 0) {
        excl_rows.push_back(excl_row);
      }
    }

    // add all exclusive rows
    for (int i = 0; i != excl_rows.size(); i++) {
      ctx_.row_lbs.push_back(0.0);
      ctx_.row_ubs.push_back(1.0);
      ctx_.m.appendRow(excl_rows[i]);
    }
  }
}

void ProgTranslator::FromProg() {
  const double* sol = iface_->getColSolution();
  std::vector<Arc>& arcs = g_->arcs();
  double flow;
  for (int i = 0; i < arcs.size(); i++) {
    Arc& a = g_->arc_by_id().at(i);
    flow = sol[i];
    flow = (excl_ && a.exclusive()) ? flow * a.excl_val() : flow;
    if (flow > cyclus::eps()) {
      g_->AddMatch(a, flow);
    }
  }
}

ProgTranslator::Context::Context() {
  throw DepricationError("Class ProgTranslator::Context is now deprecated "
                         "in favor of ProgTranslatorContext.");
}

ProgTranslator::Context::~Context() {
  throw DepricationError("Class ProgTranslator::Context is now deprecated "
                         "in favor of ProgTranslatorContext.");
}


}  // namespace cyclus