BCP_problem_core_change Class Reference

#include <BCP_problem_core.hpp>

List of all members.

Public Member Functions
Constructors and destructor
	BCP_problem_core_change (BCP_storage_t store=BCP_Storage_WrtCore)
	BCP_problem_core_change (int bvarnum, BCP_var_set &vars, int bcutnum, BCP_cut_set &cuts)
	BCP_problem_core_change (BCP_storage_t storage, BCP_problem_core_change &ocore, BCP_problem_core_change &ncore)
	~BCP_problem_core_change ()
Query methods
BCP_storage_t	storage () const
size_t	varnum () const
size_t	cutnum () const
Modifying methods
BCP_problem_core_change &	operator= (const BCP_problem_core &core)
void	ensure_explicit (const BCP_problem_core_change &expl_core)
void	make_wrtcore_if_shorter (const BCP_problem_core_change &orig_core)
void	swap (BCP_problem_core_change &other)
void	update (const BCP_problem_core_change &expl_core, const BCP_problem_core_change &core_change)
Packing and unpacking
int	pack_size () const
void	pack (BCP_buffer &buf) const
void	unpack (BCP_buffer &buf)
Public Attributes
Data members
BCP_storage_t	_storage
BCP_vec< int >	var_pos
BCP_vec< BCP_obj_change >	var_ch
BCP_vec< int >	cut_pos
BCP_vec< BCP_obj_change >	cut_ch
Private Member Functions
Private and disabled methods
void	clear ()
	BCP_problem_core_change (const BCP_problem_core_change &)
BCP_problem_core_change &	operator= (const BCP_problem_core_change &x)

---

Detailed Description

This class describes changes in the core of the problem. While the set of core variables and cuts always remains the same, their bounds and stati may change during processing. An object of this type may store the description of the bounds and stati of the core of three possible ways:

• explicitly: the bounds and stati of everything in the core is stored in this class. In this case ..._pos is empty and ..._ch stores the bounds and stati.
• with respect to parent: this is the case when a sequence of core changes have to be applied to get the current state. Each core change in the sequence describes the changes to be done after the previous change has been applied.
• with respect to core: the current state of the core is given as one set of changes with respect to the very original state of the core.

This class is internal to the framework, the user shouldn't worry about it.

Definition at line 116 of file BCP_problem_core.hpp.

---

Constructor & Destructor Documentation

BCP_problem_core_change::BCP_problem_core_change (  const BCP_problem_core_change &   )  [private]

The copy constructor is disabled by declaring it private and not defining it.

BCP_problem_core_change::BCP_problem_core_change (  BCP_storage_t  store = BCP_Storage_WrtCore  )  [inline]

This constructor creates a core change with the given storage. The other members are empty, i.e., the created object contains NoData; is Explicit and empty; is WrtCore or WrtParent but there's no change. Note that the argument defaults to WrtCore, this constructor is the default constructor as well, and as the default constructor it creates a "no change WrtCore" core change. Definition at line 172 of file BCP_problem_core.hpp. References _storage, cut_ch, cut_pos, var_ch, and var_pos. 00172 : 00173 _storage(store), var_pos(), var_ch(), cut_pos(), cut_ch() {}

BCP_problem_core_change::BCP_problem_core_change (  int  bvarnum, BCP_var_set &  vars, int  bcutnum, BCP_cut_set &  cuts )

This constructor creates an Explicit core change description. The first bvarnum variables in vars are the core variables. Similarly for the cuts. Definition at line 157 of file BCP_problem_core.cpp. References _storage, BCP_vec< BCP_var * >::begin(), cut_ch, BCP_vec< BCP_var * >::entry(), BCP_var::lb(), BCP_vec< BCP_obj_change >::reserve(), BCP_var::status(), BCP_var::ub(), BCP_vec< BCP_obj_change >::unchecked_push_back(), and var_ch. : _storage(BCP_Storage_Explicit), var_pos(), var_ch(), cut_pos(), cut_ch() { _storage = BCP_Storage_Explicit; var_ch.reserve(bvarnum); #if 0 BCP_var_set::const_iterator vari; const BCP_var_set::const_iterator lastvari = vars.entry(bvarnum); for (vari = vars.begin(); vari != lastvari; ++vari) var_ch.unchecked_push_back(BCP_obj_change((*vari)->lb(), (*vari)->ub(), (*vari)->status())); #else for (int i = 0; i < bvarnum; ++i) { const BCP_var* v = vars[i]; var_ch.unchecked_push_back(BCP_obj_change(v->lb(),v->ub(), v->status())); } #endif cut_ch.reserve(bcutnum); BCP_cut_set::const_iterator cuti; const BCP_cut_set::const_iterator lastcuti = cuts.entry(bcutnum); for (cuti = cuts.begin(); cuti != lastcuti; ++cuti) cut_ch.unchecked_push_back(BCP_obj_change((*cuti)->lb(), (*cuti)->ub(), (*cuti)->status())); }

BCP_problem_core_change::BCP_problem_core_change (  BCP_storage_t  storage, BCP_problem_core_change &  ocore, BCP_problem_core_change &  ncore )

Create a core change describing the changes from old_bc to new_bc. Both core change arguments must have explicit storage. The only reason for passing storage as an argument (and not setting it automatically to WrtParent) is that old_bc might be the original core in which case storage must be set to WrtCore. Definition at line 188 of file BCP_problem_core.cpp. References cut_ch, cut_pos, BCP_vec< BCP_obj_change >::reserve(), BCP_vec< int >::reserve(), storage(), BCP_vec< BCP_obj_change >::unchecked_push_back(), BCP_vec< int >::unchecked_push_back(), var_ch, and var_pos. : _storage(storage), var_pos(), var_ch(), cut_pos(), cut_ch() { if (storage != BCP_Storage_WrtParent && storage != BCP_Storage_WrtCore) { throw BCP_fatal_error("\ BCP_problem_core_change() : bad proposed storage\n"); } if (ocore.storage() != BCP_Storage_Explicit) throw BCP_fatal_error("BCP_problem_core_change() : bad ocore storage\n"); if (ncore.storage() != BCP_Storage_Explicit) throw BCP_fatal_error("BCP_problem_core_change() : bad ncore storage\n"); int i; const int bvarnum = ncore.varnum(); var_pos.reserve(bvarnum); var_ch.reserve(bvarnum); for (i = 0; i < bvarnum; ++i) { if (ocore.var_ch[i] != ncore.var_ch[i]) { var_pos.unchecked_push_back(i); var_ch.unchecked_push_back(ncore.var_ch[i]); } } const int bcutnum = ncore.cutnum(); cut_pos.reserve(bcutnum); cut_ch.reserve(bcutnum); for (i = 0; i < bcutnum; ++i) { if (ocore.cut_ch[i] != ncore.cut_ch[i]) { cut_pos.unchecked_push_back(i); cut_ch.unchecked_push_back(ncore.cut_ch[i]); } } }

BCP_problem_core_change::~BCP_problem_core_change (   )  [inline]

The destructor deletes all data members. Definition at line 192 of file BCP_problem_core.hpp. {}

---

Member Function Documentation

void BCP_problem_core_change::clear (   )  [inline, private]

Clear all vector data members. Definition at line 116 of file BCP_problem_core.cpp. References BCP_vec< BCP_obj_change >::clear(), BCP_vec< int >::clear(), cut_ch, cut_pos, var_ch, and var_pos. Referenced by operator=(). { var_pos.clear(); var_ch.clear(); cut_pos.clear(); cut_ch.clear(); }

size_t BCP_problem_core_change::cutnum (   )  const [inline]

Return the number of changed cuts (the length of the array cut_ch). Definition at line 204 of file BCP_problem_core.hpp. References cut_ch, and BCP_vec< BCP_obj_change >::size(). Referenced by make_wrtcore_if_shorter(). { return cut_ch.size(); }

void BCP_problem_core_change::ensure_explicit (  const BCP_problem_core_change &  expl_core  )

If the current storage is not already explicit then replace it with an explicit description of the core generated by applying the currently stored changes to expl_core (which of course, must be explicitly stored). NOTE: An exception is thrown if the currently stored change is not stored as explicit or WrtCore; or the storage of expl_core is not explicit. Definition at line 229 of file BCP_problem_core.cpp. References _storage, storage(), swap(), and update(). { if (_storage == BCP_Storage_Explicit) return; if (_storage != BCP_Storage_WrtCore) throw BCP_fatal_error("\ BCP_problem_core_change::ensure_explicit() : bad current storage\n"); if (ecore.storage() != BCP_Storage_Explicit) throw BCP_fatal_error("\ BCP_problem_core_change::ensure_explicit() : bad ecore storage\n"); BCP_problem_core_change new_core; new_core.update(ecore, *this); swap(new_core); }

void BCP_problem_core_change::make_wrtcore_if_shorter (  const BCP_problem_core_change &  orig_core  )

Replace the current explicitly stored core change with one stored with respect to the explicitly stored original core change in orig_core if the WrtCore description is shorter (requires less space to pack into a buffer). NOTE: An exception is thrown if either the current storage or that of expl_core is not explicit. Definition at line 249 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, cutnum(), BCP_vec< BCP_obj_change >::keep_by_index(), BCP_vec< T >::reserve(), BCP_vec< T >::size(), BCP_vec< BCP_obj_change >::size(), storage(), BCP_vec< int >::swap(), BCP_vec< T >::unchecked_push_back(), var_ch, var_pos, and varnum(). { if (_storage != BCP_Storage_Explicit) throw BCP_fatal_error("\ BCP_problem_core_change::make_wrtcore_if_shorter() : bad storage\n"); if (ecore.storage() != BCP_Storage_Explicit) throw BCP_fatal_error("\ BCP_problem_core_change::make_wrtcore_if_shorter() : bad ecore storage\n"); if (varnum() != ecore.varnum()) throw BCP_fatal_error("\ BCP_problem_core_change::make_wrtcore_if_shorter() : nonequal sizes\n"); int i; // save the positions of the changed vars / cuts BCP_vec<int> chvar; chvar.reserve(ecore.varnum()); const int bvarnum = var_ch.size(); for (i = 0; i < bvarnum; ++i) if (var_ch[i] != ecore.var_ch[i]) chvar.unchecked_push_back(i); BCP_vec<int> chcut; chcut.reserve(ecore.cutnum()); const int bcutnum = cut_ch.size(); for (i = 0; i < bcutnum; ++i) if (cut_ch[i] != ecore.cut_ch[i]) chcut.unchecked_push_back(i); if ((chvar.size() + chcut.size()) * sizeof(int) < (ecore.varnum() - chvar.size() + ecore.cutnum() - chcut.size()) * BCP_obj_change::pack_size()) { // wrt core is shorter _storage = BCP_Storage_WrtCore; var_pos.swap(chvar); var_ch.keep_by_index(var_pos); cut_pos.swap(chcut); cut_ch.keep_by_index(cut_pos); } }

BCP_problem_core_change & BCP_problem_core_change::operator= (  const BCP_problem_core &  core  )

Set the core change description to be an explicit description (in the form of a change) of the given core. Definition at line 136 of file BCP_problem_core.cpp. References _storage, BCP_vec< BCP_cut_core * >::begin(), BCP_vec< BCP_var_core * >::begin(), clear(), cut_ch, BCP_problem_core::cutnum(), BCP_problem_core::cuts, BCP_vec< BCP_cut_core * >::end(), BCP_vec< BCP_var_core * >::end(), BCP_vec< BCP_obj_change >::reserve(), BCP_vec< BCP_obj_change >::unchecked_push_back(), var_ch, BCP_problem_core::varnum(), and BCP_problem_core::vars. { clear(); _storage = BCP_Storage_Explicit; var_ch.reserve(core.varnum()); BCP_vec<BCP_var_core*>::const_iterator vi = core.vars.begin(); const BCP_vec<BCP_var_core*>::const_iterator lastvi = core.vars.end(); for ( ; vi != lastvi; ++vi) var_ch.unchecked_push_back(BCP_obj_change((*vi)->lb(), (*vi)->ub(), BCP_ObjNotRemovable)); cut_ch.reserve(core.cutnum()); BCP_vec<BCP_cut_core*>::const_iterator ci = core.cuts.begin(); const BCP_vec<BCP_cut_core*>::const_iterator lastci = core.cuts.end(); for ( ; ci != lastci; ++ci) cut_ch.unchecked_push_back(BCP_obj_change((*ci)->lb(), (*ci)->ub(), BCP_ObjNotRemovable)); return *this; }

BCP_problem_core_change & BCP_problem_core_change::operator= (  const BCP_problem_core_change &  x  )  [private]

The assignment operator is disabled by declaring it private and not defining it. Definition at line 124 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, var_ch, and var_pos. Referenced by update(). { _storage = x._storage; var_pos = x.var_pos; var_ch = x.var_ch; cut_pos = x.cut_pos; cut_ch = x.cut_ch; return *this; }

void BCP_problem_core_change::pack (  BCP_buffer &  buf  )  const

Pack the core change into the buffer. Definition at line 353 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, BCP_buffer::pack(), var_ch, and var_pos. { buf.pack(_storage); if (_storage != BCP_Storage_NoData) buf.pack(var_pos).pack(cut_pos).pack(var_ch).pack(cut_ch); }

int BCP_problem_core_change::pack_size (   )  const

Return the buffer size needed to pack the data in the core change. Definition at line 342 of file BCP_problem_core.cpp. References cut_ch, cut_pos, BCP_vec< BCP_obj_change >::size(), BCP_vec< int >::size(), var_ch, and var_pos. { int siz = sizeof(BCP_storage_t); siz += sizeof(int) + sizeof(int) * var_pos.size(); siz += sizeof(int) + BCP_obj_change::pack_size() * var_ch.size(); siz += sizeof(int) + sizeof(int) * cut_pos.size(); siz += sizeof(int) + BCP_obj_change::pack_size() * cut_ch.size(); return siz; }

BCP_storage_t BCP_problem_core_change::storage (   )  const [inline]

Return the storage type. Definition at line 198 of file BCP_problem_core.hpp. References _storage. Referenced by BCP_problem_core_change(), ensure_explicit(), make_wrtcore_if_shorter(), and update(). { return _storage; }

void BCP_problem_core_change::swap (  BCP_problem_core_change &  other  )

Swap the contents of the current core change with that of other. Definition at line 294 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, BCP_vec< BCP_obj_change >::swap(), BCP_vec< int >::swap(), var_ch, and var_pos. Referenced by ensure_explicit(). { std::swap(_storage, other._storage); var_pos.swap(other.var_pos); var_ch.swap(other.var_ch); cut_pos.swap(other.cut_pos); cut_ch.swap(other.cut_ch); }

void BCP_problem_core_change::unpack (  BCP_buffer &  buf  )

Unpack the core change data from the buffer. Definition at line 361 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, BCP_buffer::unpack(), var_ch, and var_pos. { buf.unpack(_storage); if (_storage != BCP_Storage_NoData) buf.unpack(var_pos).unpack(cut_pos).unpack(var_ch).unpack(cut_ch); }

void BCP_problem_core_change::update (  const BCP_problem_core_change &  expl_core, const BCP_problem_core_change &  core_change )

Update the current change according to core_change. If the storage type of core_change is NoData or Explicit then it is simply copied over into this change. WrtParent then the current change is supposed to be the parent and this explicitly stored core change will be updated with the changes in core_change (an exception is thrown if the current change is not explicitly stored). WrtCore storage then the current change will be replaced by expl_core updated with core_change (the storage of expl_core must be explicit or an exception is thrown). NOTE: When this function exits the stored change will have either explicit or NoData storage. Definition at line 306 of file BCP_problem_core.cpp. References _storage, cut_ch, cut_pos, operator=(), storage(), BCP_vec< BCP_obj_change >::update(), var_ch, and var_pos. Referenced by ensure_explicit(). { switch (ch_core._storage){ case BCP_Storage_Explicit: operator=(ch_core); // _storage becomes Explicit break; case BCP_Storage_NoData: _storage = BCP_Storage_NoData; break; case BCP_Storage_WrtCore: if (expl_core.storage() != BCP_Storage_Explicit) throw BCP_fatal_error("BCP_problem_core_change::update():\n\ ch_core's WrtCore, but expl_core's not Explicit\n"); operator=(expl_core); // _storage becomes Explicit // deliberate fall-through case BCP_Storage_WrtParent: if (_storage != BCP_Storage_Explicit) throw BCP_fatal_error("BCP_problem_core_change::update():\n\ _storage isn't Explicit && ch_core's WrtParent\n"); var_ch.update(ch_core.var_pos, ch_core.var_ch); cut_ch.update(ch_core.cut_pos, ch_core.cut_ch); break; default: throw BCP_fatal_error("\ BCP_problem_core_change::update(): bad ch_core storage!\n"); break; } }

size_t BCP_problem_core_change::varnum (   )  const [inline]

Return the number of changed variables (the length of the array var_ch). Definition at line 201 of file BCP_problem_core.hpp. References BCP_vec< BCP_obj_change >::size(), and var_ch. Referenced by make_wrtcore_if_shorter(). { return var_ch.size(); }

---

Member Data Documentation

BCP_storage_t BCP_problem_core_change::_storage

Describes how the change is stored. The interpretation of the other data members depends on the storage type. BCP_Storage_NoData: when no data is stored (i.e., the change is not described yet) the other members are undefined. BCP_Storage_WrtCore: with respect to core storage (as explained in the class description). BCP_Storage_WrtParent: with respect to parent storage (as explained in the class description). BCP_Storage_Explicit: Explicit storage (as explained in the class description). Definition at line 146 of file BCP_problem_core.hpp. Referenced by BCP_problem_core_change(), ensure_explicit(), make_wrtcore_if_shorter(), operator=(), pack(), storage(), swap(), unpack(), and update().

BCP_vec<BCP_obj_change> BCP_problem_core_change::cut_ch

The new lb/ub/status triplet for each cut for which any of those three have changed. Definition at line 160 of file BCP_problem_core.hpp. Referenced by BCP_problem_core_change(), clear(), cutnum(), make_wrtcore_if_shorter(), operator=(), pack(), pack_size(), swap(), unpack(), and update().

BCP_vec<int> BCP_problem_core_change::cut_pos

The positions of the core cuts (in the cuts member of [BCP_problem_core]{BCP_problem_core.html}) whose bounds and/or stati have changed. Definition at line 157 of file BCP_problem_core.hpp. Referenced by BCP_problem_core_change(), clear(), make_wrtcore_if_shorter(), operator=(), pack(), pack_size(), swap(), unpack(), and update().

BCP_vec<BCP_obj_change> BCP_problem_core_change::var_ch

The new lb/ub/status triplet for each variable for which any of those three have changed. Definition at line 153 of file BCP_problem_core.hpp. Referenced by BCP_problem_core_change(), clear(), make_wrtcore_if_shorter(), operator=(), pack(), pack_size(), swap(), unpack(), update(), and varnum().

BCP_vec<int> BCP_problem_core_change::var_pos

The positions of the core variables (in the vars member of [BCP_problem_core]{BCP_problem_core.html}) whose bounds and/or stati have changed. Definition at line 150 of file BCP_problem_core.hpp. Referenced by BCP_problem_core_change(), clear(), make_wrtcore_if_shorter(), operator=(), pack(), pack_size(), swap(), unpack(), and update().

---

The documentation for this class was generated from the following files:

• BCP_problem_core.hpp
• BCP_problem_core.cpp

---