prop_sdpredcost.c

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/* This file is part of SCIPSDP - a solving framework for mixed-integer      */
/* semidefinite programs based on SCIP.                                      */
/*                                                                           */
/* Copyright (C) 2011-2013 Discrete Optimization, TU Darmstadt               */
/*                         EDOM, FAU Erlangen-Nürnberg                       */
/*               2014-2020 Discrete Optimization, TU Darmstadt               */
/*                                                                           */
/*                                                                           */
/* This program 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 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 Lesser General Public License for more details.                       */
/*                                                                           */
/* You should have received a copy of the GNU Lesser General Public License  */
/* along with this program; if not, write to the Free Software               */
/* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/
/*                                                                           */
/*                                                                           */
/* Based on SCIP - Solving Constraint Integer Programs                       */
/* Copyright (C) 2002-2020 Zuse Institute Berlin                             */
/* SCIP is distributed under the terms of the SCIP Academic Licence,         */
/* see file COPYING in the SCIP distribution.                                */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*#define SCIP_DEBUG*/

/* TODO: might want to add sdpsolvergaptol to parameters and only cut off / change bounds if values differ by more than gaptol, since
 * the primal variable values may only be exact up to gaptol
 */

#include "prop_sdpredcost.h"
#include "scip/def.h"                        /* for SCIP_Real, _Bool, ... */
#include "relax_sdp.h"                       /* to get relaxation value */
#include "sdpi/sdpi.h"                       /* to get values of primal variables */

#include <string.h>
#include <assert.h>                          /*lint !e451*/

/* turn off lint warnings for whole file: */
/*lint --e{788,818}*/

#define PROP_NAME                   "sdpredcost"
#define PROP_DESC                   "sdp reduced cost strengthening propagator"
#define PROP_TIMING                 SCIP_PROPTIMING_AFTERLPLOOP
#define PROP_PRIORITY               +1000000 
#define PROP_FREQ                   1        
#define PROP_DELAY                  FALSE    
#define DEFAULT_SDPRCBIN            TRUE     
#define DEFAULT_SDPRCINTCONT        TRUE     
struct SCIP_PropData
{
   /* these could also be freshly allocated for each node, but allocating them only once saves time */
   SCIP_Real*            lbvarvals;          
   SCIP_Real*            ubvarvals;          
   int                   nvars;              
   SCIP_Bool             forbins;            
   SCIP_Bool             forintconts;        
};

static
SCIP_RETCODE sdpRedcostFixingBinary(
   SCIP*                 scip,               
   SCIP_VAR*             var,                
   SCIP_Real             primallbval,        
   SCIP_Real             primalubval,        
   SCIP_Real             cutoffbound,        
   SCIP_Real             relaxval,           
   SCIP_RESULT*          result              
   )
{
   assert( scip != NULL );
   assert( var != NULL );
   assert( result != NULL );

   /* skip binary variable if it is locally fixed */
   if (SCIPvarGetLbLocal(var) > 0.5 || SCIPvarGetUbLocal(var) < 0.5)
   {
      *result = SCIP_DIDNOTRUN;
      return SCIP_OKAY;
   }

   /* check if variable can be fixed to zero */
   if ( SCIPisGT(scip, primallbval, cutoffbound - relaxval) )
   {
      SCIP_CALL( SCIPchgVarUb(scip, var, 0.0) );
      SCIPdebugMsg(scip, "Variable %s fixed to zero by reduced cost fixing ! \n", SCIPvarGetName(var));
      *result = SCIP_REDUCEDDOM;

      /* check if we would also have to fix the variable to one, in that case, we can cut the node off, as there can't be a new optimal solution */
      if ( SCIPisGT(scip, primalubval, cutoffbound - relaxval) )
      {
         *result = SCIP_CUTOFF;
      }

      return SCIP_OKAY;
   }

   /* check if variable can be fixed to one */
   if ( SCIPisGT(scip, primalubval, cutoffbound - relaxval) )
   {
      SCIP_CALL( SCIPchgVarLb(scip, var, 1.0) );
      SCIPdebugMsg(scip, "Variable %s fixed to one by reduced cost fixing ! \n", SCIPvarGetName(var));
      *result = SCIP_REDUCEDDOM;
      return SCIP_OKAY;
   }

   *result = SCIP_DIDNOTFIND;
   return SCIP_OKAY;
}

static
SCIP_RETCODE sdpRedcostFixingIntCont(
   SCIP*                 scip,               
   SCIP_VAR*             var,                
   SCIP_Real             primallbval,        
   SCIP_Real             primalubval,        
   SCIP_Real             cutoffbound,        
   SCIP_Real             relaxval,           
   SCIP_RESULT*          result              
   )
{
   SCIP_Real lb;
   SCIP_Real ub;

   assert( scip != NULL );
   assert( var != NULL );
   assert( result != NULL );

   *result = SCIP_DIDNOTFIND;

   /* compute the new lower and upper bound, if we divide by zero (checking > 0 is sufficient, as the variabls are non-negative), the bounds are infinity */
   ub = SCIPisGT(scip, primallbval, 0.0) ? SCIPvarGetLbLocal(var) + (cutoffbound - relaxval) / primallbval : SCIPinfinity(scip);
   lb = SCIPisGT(scip, primalubval, 0.0) ? SCIPvarGetUbLocal(var) - (cutoffbound - relaxval) / primalubval : -SCIPinfinity(scip);

   /* if either bound is infinite, we set it to the corresponding SCIP value */
   if ( SCIPisInfinity(scip, ub) )
      ub = SCIPinfinity(scip);
   else if ( SCIPisInfinity(scip, -ub) )
      ub = -SCIPinfinity(scip);
   if ( SCIPisInfinity(scip, lb) )
      lb = SCIPinfinity(scip);
   else if ( SCIPisInfinity(scip, -lb) )
      lb = -SCIPinfinity(scip);

   /* if after propagation the upper bound is less than the lower bound, the current node is infeasible */
   if ( SCIPisFeasLT(scip, ub, lb) || SCIPisFeasLT(scip, ub, SCIPvarGetLbLocal(var)) || SCIPisFeasLT(scip, SCIPvarGetUbLocal(var), lb) )
   {
      SCIPdebugMsg(scip, "Infeasibility of current node detected by prop_sdpredcost! Updated bounds for variable %s: lb = %f > %f = ub !\n",
         SCIPvarGetName(var), SCIPisFeasGT(scip, lb, SCIPvarGetLbLocal(var))? lb : SCIPvarGetLbLocal(var),
         SCIPisFeasLT(scip, ub, SCIPvarGetLbLocal(var)) ? ub : SCIPvarGetUbLocal(var) );
      *result = SCIP_CUTOFF;
      return SCIP_OKAY;
   }

   /* if the new upper bound is an enhancement, update it */
   if ( SCIPisFeasLT(scip, ub, SCIPvarGetUbLocal(var)) )
   {
      SCIPdebugMsg(scip, "Changing upper bound of variable %s from %f to %f because of prop_sdpredcost \n",
         SCIPvarGetName(var), SCIPvarGetUbLocal(var), ub);
      SCIP_CALL( SCIPchgVarUb(scip, var, ub) );
      *result =  SCIP_REDUCEDDOM;
   }

   /* if the new lower bound is an enhancement, update it */
   if ( SCIPisFeasGT(scip, lb, SCIPvarGetLbLocal(var)) )
   {
      SCIPdebugMsg(scip, "Changing lower bound of variable %s from %f to %f because of prop_sdpredcost \n",
         SCIPvarGetName(var), SCIPvarGetLbLocal(var), lb);
      SCIP_CALL( SCIPchgVarLb(scip, var, lb) );
      *result =  SCIP_REDUCEDDOM;
   }

   return SCIP_OKAY;
}

static
SCIP_DECL_PROPEXEC(propExecSdpredcost)
{/*lint --e{715}*/
   int v;
   int nvars;
   SCIP_VAR** vars;
   SCIP_RELAX* relax;
   SCIP_RESULT varresult;
   SCIP_Real cutoffbound;
   SCIP_Real relaxval;
   SCIP_Bool sdpsolved;
   SCIP_PROPDATA* propdata;
   int length;

   SCIPdebugMsg(scip, "Calling propExecSdpredcost \n");

   assert( scip != NULL );
   assert( prop != NULL );
   assert( result != NULL );

   /* do not run if propagation w.r.t. objective is not allowed */
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
   if( ! SCIPallowWeakDualReds(scip) )
      return SCIP_OKAY;
#else
   if( ! SCIPallowObjProp(scip) )
      return SCIP_OKAY;
#endif

   if ( SCIPgetStage(scip) == SCIP_STAGE_PRESOLVING )
   {
      /* we can't run before the relaxator is properly initialized */
      *result = SCIP_DIDNOTRUN;
      return SCIP_OKAY;
   }

   relax = SCIPfindRelax(scip, "SDP"); /* get SDP relaxation handler */
   assert( relax != NULL );

   /* we can only propagate for the last node for which the SDP was solved */
   if ( SCIPrelaxSdpGetSdpNode(relax) != SCIPnodeGetNumber(SCIPgetCurrentNode(scip)) )
   {
      SCIPdebugMsg(scip, "Stopped propExecRedcost because current SDP-relaxation doesn't belong to the node the propagator was called for!\n");
      *result = SCIP_DIDNOTRUN;
      return SCIP_OKAY;
   }

   /* we can only propagate if the SDP in the last node was solved in its original formulation */
   if ( ! SCIPrelaxSdpSolvedOrig(relax) )
   {
      SCIPdebugMsg(scip, "Stopped propExecRedcost because current SDP-relaxation was solved using a penalty formulation!\n");
      *result = SCIP_DIDNOTRUN;
      return SCIP_OKAY;
   }

   SCIP_CALL( SCIPrelaxSdpRelaxVal(relax, &sdpsolved, &relaxval) );
   if ( ! sdpsolved )
   {
      SCIPdebugMsg(scip, "Stopped propExecRedcost because SDP-relaxation wasn't properly solved!\n");
      *result = SCIP_DIDNOTRUN;
      return SCIP_OKAY;
   }

   propdata = SCIPpropGetData(prop);
   assert( propdata != NULL );

   *result = SCIP_DIDNOTFIND;

   nvars = SCIPgetNVars(scip);
   vars = SCIPgetVars(scip);

   cutoffbound = SCIPgetCutoffbound(scip);

   length = nvars;

   SCIP_CALL( SCIPrelaxSdpGetPrimalBoundVars(relax, propdata->lbvarvals, propdata->ubvarvals, &length) );

   assert( length == nvars ); /* we should get exactly one value for lower and upper bound-variable per variable in scip */

   for (v = 0; v < nvars; v++)
   {
      if ( SCIPvarIsBinary(vars[v]) && propdata->forbins )
      {
         SCIP_CALL( sdpRedcostFixingBinary(scip, vars[v], propdata->lbvarvals[v], propdata->ubvarvals[v], cutoffbound, relaxval, &varresult) );

         if ( varresult == SCIP_REDUCEDDOM )
            *result = SCIP_REDUCEDDOM;
      }
      else if ( (! SCIPvarIsBinary(vars[v])) && propdata->forintconts )
      {
         SCIP_CALL( sdpRedcostFixingIntCont(scip, vars[v], propdata->lbvarvals[v], propdata->ubvarvals[v], cutoffbound, relaxval, &varresult) );

         if ( varresult == SCIP_REDUCEDDOM )
            *result = SCIP_REDUCEDDOM;
      }
   }

   return SCIP_OKAY;
}

static
SCIP_DECL_PROPFREE(propFreeSdpredcost)
{/*lint --e{715}*/
   SCIP_PROPDATA* propdata;

   propdata = SCIPpropGetData(prop);
   assert( propdata != NULL );
   SCIPfreeMemory(scip, &propdata);

   SCIPpropSetData(prop, NULL);

   return SCIP_OKAY;
}

static
SCIP_DECL_PROPINITSOL(propInitsolSdpredcost)
{
   SCIP_PROPDATA* propdata;

   propdata = SCIPpropGetData(prop);
   assert(propdata != NULL);

   propdata->nvars = SCIPgetNVars(scip);
   SCIP_CALL( SCIPallocBlockMemoryArray(scip, &(propdata->lbvarvals), propdata->nvars) );
   SCIP_CALL( SCIPallocBlockMemoryArray(scip, &(propdata->ubvarvals), propdata->nvars) );

   return SCIP_OKAY;
}

static
SCIP_DECL_PROPEXITSOL(propExitsolSdpredcost)
{
   SCIP_PROPDATA* propdata;

   propdata = SCIPpropGetData(prop);
   assert( propdata != NULL );

   SCIPfreeBlockMemoryArrayNull(scip, &(propdata->lbvarvals), propdata->nvars);
   SCIPfreeBlockMemoryArrayNull(scip, &(propdata->ubvarvals), propdata->nvars);

   return SCIP_OKAY;
}

static
SCIP_DECL_PROPCOPY(propCopySdpredcost)
{
   assert( scip != NULL );
   assert( prop != NULL );
   assert( strcmp(SCIPpropGetName(prop), PROP_NAME) == 0 );

   /* call inclusion method of constraint handler */
   SCIP_CALL( SCIPincludePropSdpredcost(scip) );

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPincludePropSdpredcost(
   SCIP*                 scip                
   )
{
   SCIP_PROPDATA* propdata = NULL;
   SCIP_PROP* prop;

   /* create propagator data */
   SCIP_CALL( SCIPallocMemory(scip, &propdata) );
   propdata->nvars = 0;
   propdata->lbvarvals = NULL;
   propdata->ubvarvals = NULL;

   /* include propagator */
   SCIP_CALL( SCIPincludePropBasic(scip, &prop, PROP_NAME, PROP_DESC, PROP_PRIORITY, PROP_FREQ, PROP_DELAY, PROP_TIMING,
         propExecSdpredcost, propdata) );
   assert( prop != NULL );

   /* set optional callbacks via setter functions */
   SCIP_CALL( SCIPsetPropCopy(scip, prop, propCopySdpredcost) );
   SCIP_CALL( SCIPsetPropInitsol(scip, prop, propInitsolSdpredcost) );
   SCIP_CALL( SCIPsetPropExitsol(scip, prop, propExitsolSdpredcost) );
   SCIP_CALL( SCIPsetPropFree(scip, prop, propFreeSdpredcost) );

   /* add additional parameters */
   SCIP_CALL( SCIPaddBoolParam(scip, "propagating/sdpredcost/forbins", "Should SDP reduced cost fixing be executed for binary variables?",
         &(propdata->forbins), TRUE, DEFAULT_SDPRCBIN, NULL, NULL) );
   SCIP_CALL( SCIPaddBoolParam(scip, "propagating/sdpredcost/forintconts", "Should SDP reduced cost fixing be executed for integer and continuous variables?",
         &(propdata->forintconts), TRUE, DEFAULT_SDPRCINTCONT, NULL, NULL) );

   return SCIP_OKAY;
}