Detailed Description
a very simple interface for solving translated resource exchanges
Definition at line 15 of file exchange_solver.h.
#include <exchange_solver.h>
Public Member Functions | |
| double | ArcCost (const Arc &a) |
| ExchangeSolver (bool exclusive_orders=kDefaultExclusive) | |
| void | graph (ExchangeGraph *graph) |
| ExchangeGraph * | graph () const |
| double | Solve (ExchangeGraph *graph=NULL) |
| void | verbose () |
| virtual | ~ExchangeSolver () |
| void | sim_ctx (Context *c) |
| Context * | sim_ctx () |
| double | PseudoCost () |
| double | PseudoCost (double cost_factor) |
| double | PseudoCostByCap (double cost_factor) |
| double | PseudoCostByPref (double cost_factor) |
Static Public Member Functions | |
| static double | Cost (const Arc &a, bool exclusive_orders=kDefaultExclusive) |
Static Public Attributes | |
| static const bool | kDefaultExclusive = true |
Protected Member Functions | |
| virtual double | SolveGraph ()=0 |
Protected Attributes | |
| bool | exclusive_orders_ |
| ExchangeGraph * | graph_ |
| Context * | sim_ctx_ |
| bool | verbose_ |
Constructor & Destructor Documentation
◆ ExchangeSolver()
|
inlineexplicit |
Definition at line 23 of file exchange_solver.h.
◆ ~ExchangeSolver()
|
inlinevirtual |
Definition at line 27 of file exchange_solver.h.
Member Function Documentation
◆ ArcCost()
|
inline |
return the cost of an arc
Definition at line 62 of file exchange_solver.h.
◆ Cost()
|
static |
return the cost of an arc
Definition at line 11 of file exchange_solver.cc.
◆ graph() [1/2]
|
inline |
Definition at line 37 of file exchange_solver.h.
◆ graph() [2/2]
|
inline |
Definition at line 38 of file exchange_solver.h.
◆ PseudoCost() [1/2]
| double cyclus::ExchangeSolver::PseudoCost | ( | ) |
Calculates the ratio of the maximum objective coefficient to minimum unit capacity plus an added cost.
This is guaranteed to be larger than any other arc cost measure and can be used as a cost for unmet demand.
- Parameters
-
cost_factor the additional cost for false arc costs, i.e., max_cost - (1 + cost_factor)
Definition at line 16 of file exchange_solver.cc.
◆ PseudoCost() [2/2]
| double cyclus::ExchangeSolver::PseudoCost | ( | double | cost_factor | ) |
Definition at line 20 of file exchange_solver.cc.
◆ PseudoCostByCap()
| double cyclus::ExchangeSolver::PseudoCostByCap | ( | double | cost_factor | ) |
Definition at line 24 of file exchange_solver.cc.
◆ PseudoCostByPref()
| double cyclus::ExchangeSolver::PseudoCostByPref | ( | double | cost_factor | ) |
Definition at line 86 of file exchange_solver.cc.
◆ sim_ctx() [1/2]
|
inline |
simulation context get/set
Definition at line 31 of file exchange_solver.h.
◆ sim_ctx() [2/2]
|
inline |
Definition at line 32 of file exchange_solver.h.
◆ Solve()
|
inline |
interface for solving a given exchange graph
- Parameters
-
a pointer to the graph to be solved
Definition at line 42 of file exchange_solver.h.
◆ SolveGraph()
|
protectedpure virtual |
Worker function for solving a graph.
This must be implemented by any solver.
Implemented in cyclus::GreedySolver, and cyclus::ProgSolver.
◆ verbose()
|
inline |
tell the solver to be verbose
Definition at line 36 of file exchange_solver.h.
Member Data Documentation
◆ exclusive_orders_
|
protected |
Definition at line 69 of file exchange_solver.h.
◆ graph_
|
protected |
Definition at line 68 of file exchange_solver.h.
◆ kDefaultExclusive
|
static |
default value to allow exclusive orders or not
Definition at line 18 of file exchange_solver.h.
◆ sim_ctx_
|
protected |
Definition at line 71 of file exchange_solver.h.
◆ verbose_
|
protected |
Definition at line 70 of file exchange_solver.h.
The documentation for this class was generated from the following files:
