mt_cutpool.h

Go to the documentation of this file.

/* MTgomory "multi tableau gomory cut" provides an implementation for gomory
 * cuts derived from multiple tableau rows in the spirit of the work of
 * Andersen et al (IPCO 2007), Cornuejols (es presented in George Nemhauser
 * Birthday Conference in Atlanta 2007) and Gomory (presented in the same
 * conference).
 *
 * Copyright (C) 2007 Daniel Espinoza.
 * 
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library 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 Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
 * */
/* ========================================================================= */
#ifndef __MT_CUTPOOL_H__
#define __MT_CUTPOOL_H__
#include "EGlib.h"
#include "mt_gomory.h"
#include "mt_types.h"
#include "mt_cplex_cbk.h"
/** @file 
 * @ingroup MTgomory */
/** @addtogroup MTgomory */
/** @{ */
/* ========================================================================= */
/** @brief initialize a cut structure 
 * @param __cut pointer to an #MTcut_t structure 
 * */
#define MTcut_init(__cut) memset(__cut,0,sizeof(MTcut_t))
/* ========================================================================= */
/** @brief resize a cut structure
 * @param MTcut pointer to an #MTcut_t structure 
 * @param MTnsz new space for the cut */
void MTcut_rsz(MTcut_t*const MTcut, const int MTnsz);
/* ========================================================================= */
/** @brief free any internal memory asociated with an #MTcut_t structure 
 * @param MTcut pointer to an #MTcut_t structure 
 * */
void MTcut_clear(MTcut_t*const MTcut);
/* ========================================================================= */
/** @brief initialize an #MTcutHeapCn_t structure */
#define MTcutHeapCnInit(__chcn) do{\
  MTcutHeapCn_t*const __MTchcn = (__chcn);\
  dbl_EGeHeapCnInit(&(__MTchcn->hcn));\
  MTcut_init(&(__MTchcn->cut));}while(0)
/* ========================================================================= */
/** @brief clear all internally allocated memory */
#define MTcutHeapCnClear(__chcn) do{\
  MTcutHeapCn_t*const __MTchcn = (__chcn);\
  dbl_EGeHeapCnClear(&(__MTchcn->hcn));\
  MTcut_clear(&(__MTchcn->cut));}while(0)
/* ========================================================================= */
/** @brief set the dominance strategy */
#define MTcutHeapSetDominance(__cuth,__dom) ((__cuth)->control.dominance_check = (__dom))
/* ========================================================================= */
/** @brief set the cutselection strategy */
#define MTcutHeapSetCS(__cuth,__cutsel) ((__cuth)->control.cut_score = (__cutsel))
/* ========================================================================= */
/** @brief return a pointer to the next free #MTcut_t structure in the set 
 * @param __cuth structure to initialize
 * */
#define MTcutHeap_get_free_cut(__cuth) ((__cuth)->next_free)
/* ========================================================================= */
/** @brief initialize an #MTcutHeap_t structure 
 * @param cuth structure to initialize
 * @param sz how many cuts to store 
 * */
void MTcutHeapInit(MTcutHeap_t*const cuth,size_t sz);
/* ========================================================================= */
/** @brief Clear any internal memory asociated with an #MTcutHeap_t structure.
 * Note that after a call to this function a new call to #MTcutHeapInit should
 * be made before using any other function over the strucutre 
 * @param cuth structure to clear 
 * */
void MTcutHeapClear(MTcutHeap_t*const cuth);
/* ========================================================================= */
/** @brief add the cut (obtained by #MTcutHeap_get_free_cut) to the structure,
 * and possibly discard a worst cut from the heap 
 * @param cuth structure where we perform the operation
 * @return zero on success, non-zero otherwise.
 * */
int MTcutHeap_add_cut(const MTlp_t*const lp, MTcutHeap_t*const cuth);
/* ========================================================================= */
/** @brief pop the worst remaining cut within an #MTcutHeap_t structure. 
 * Note that the memory asociated with the returned #MTcut_t structure is
 * handled by the #MTcutHeap_t structure, and should not be freed by the user.
 * @param cuth structure where we perform the operation
 * @return pointer to the worst #MTcut_t structure (acording to the socre
 * function selected) still in the heap, NULL if no more cuts are left.
 * */
MTcut_t* MTcutHeap_pop_cut(MTcutHeap_t*const cuth);
/* ========================================================================= */
/** @brief return the number of stored cuts in the given #MTcutHeap_t
 * structure. 
 * @param __cuth structure where we perform the operation
 * @return the number of cuts in the given #MTcutHeap_t structure.
 * */
#define MTcutHeap_get_ncuts(__cuth) (__cuth->heap.sz)
/* ========================================================================= */
/** @brief check for dominance between cuts.
 * @param cut1 First cut to compare 
 * @param cut2 Second cut to compare
 * @return zero if neither dominates the other. 1 if cut1 dominates cut2, -1
 * if cut2 dominates cut1. 
 * */
int MTcut_check_dominance(const MTcut_t*const cut1, const MTcut_t*const cut2);
/* ========================================================================= */
/** @brief copy a cut from one structure to the next 
 * @param orig cut to copy
 * @param dest where to copy the cut, all previous information will be lost.
 * */
void MTcut_copy(MTcut_t*const dest,const MTcut_t*const src);
/** @} */
/* end of mt_cutpool.h */
/* ========================================================================= */
#endif

---