SdpVarmapper.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.                                */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#include "scip/scip.h"
#include "scip/type_misc.h" /* for SCIP Hashmap */
#include "SdpVarmapper.h"

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

struct Sdpvarmapper
{
   SCIP_VAR**            sdptoscip;          
   SCIP_HASHMAP*         sciptosdp;          
   int                   nvars;              
};

SCIP_RETCODE SCIPsdpVarmapperCreate(
   SCIP*                 scip,               
   SdpVarmapper**        varmapper,          
   int                   size                
   )
{
   assert ( scip != NULL );
   assert ( varmapper != NULL );
   assert ( size >= 0 );

   SCIP_CALL( SCIPallocBlockMemory(scip, varmapper) );
   (*varmapper)->nvars = 0;
   (*varmapper)->sdptoscip = NULL;

   if ( size == 0 )
   {
      SCIPdebugMsg(scip, "SCIPsdpVarmapperCreate called for size 0!\n");

      return SCIP_OKAY;
   }

   SCIP_CALL( SCIPhashmapCreate(&((*varmapper)->sciptosdp), SCIPblkmem(scip), size) );

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPsdpVarmapperFree(
   SCIP*                 scip,               
   SdpVarmapper**        varmapper           
   )
{
   int i;

   SCIPdebugMsg(scip, "Freeing SdpVarmapper \n");

   assert ( scip != NULL );
   assert ( varmapper != NULL );

   /* release all vars */
   for (i = 0; i < (*varmapper)->nvars; i++)
   {
      SCIP_CALL( SCIPreleaseVar(scip, &((*varmapper)->sdptoscip[i])) );
   }

   if ( (*varmapper)->nvars )
      SCIPhashmapFree(&((*varmapper)->sciptosdp));

   SCIPfreeBlockMemoryArrayNull(scip, &(*varmapper)->sdptoscip, (*varmapper)->nvars);
   SCIPfreeBlockMemory(scip, varmapper);

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPsdpVarmapperAddVars(
   SCIP*                 scip,               
   SdpVarmapper*         varmapper,          
   int                   nvars,              
   SCIP_VAR**            vars                
   )
{  /*lint --e{818}*/
   int i;
   SCIP_Bool reallocneeded; /* we allocate memory to add nvars variables, but if some of them already existed in the varmapper, we don't add them and
                             * should reallocate later */
   int allocsize;

   if ( nvars == 0 )
      return SCIP_OKAY;

   assert ( scip != NULL );
   assert ( varmapper != NULL );
   assert ( nvars >= 0 );
   assert ( vars != NULL );

   allocsize = varmapper->nvars + nvars;
   SCIP_CALL( SCIPreallocBlockMemoryArray(scip, &(varmapper->sdptoscip), varmapper->nvars, allocsize) );

   reallocneeded = FALSE;

   for (i = 0; i < nvars; i++)
   {
      if ( ! (SCIPhashmapExists(varmapper->sciptosdp, vars[i])) ) /* make sure, that there are no duplicates in the lists */
      {
         varmapper->sdptoscip[varmapper->nvars] = vars[i];
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
         SCIP_CALL( SCIPhashmapInsertInt(varmapper->sciptosdp, (void*) vars[i], varmapper->nvars) );
#else
         SCIP_CALL( SCIPhashmapInsert(varmapper->sciptosdp, (void*) vars[i], (void*) (size_t) varmapper->nvars) );
#endif
         varmapper->nvars++;
         SCIP_CALL( SCIPcaptureVar(scip, vars[i]) );
      }
      else
      {
         SCIPdebugMsg(scip, "variable %s was not added to the varmapper as it was already part of it \n", SCIPvarGetName(vars[i]));
         reallocneeded = TRUE;
      }
   }

   if ( reallocneeded )
   {
      SCIP_CALL( SCIPreallocBlockMemoryArray(scip, &(varmapper->sdptoscip), allocsize, varmapper->nvars) );
   }

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPsdpVarmapperInsertVar(
   SCIP*                 scip,               
   SdpVarmapper*         varmapper,          
   SCIP_VAR*             var,                
   int                   pos                 
   )
{
   int i;

   assert ( scip != NULL );
   assert ( varmapper != NULL );
   assert ( var != NULL );
   assert ( pos >= 0 );
   assert ( pos <= varmapper->nvars );

   if ( ! SCIPhashmapExists(varmapper->sciptosdp, var) ) /* make sure, that there are no duplicates in the lists */
   {
      if ( pos == varmapper->nvars )   /* add it to the end */
      {
         SCIP_CALL(SCIPsdpVarmapperAddVars(scip, varmapper, 1, &var));
      }
      else
      {
         SCIP_CALL( SCIPreallocBlockMemoryArray(scip, &varmapper->sdptoscip, varmapper->nvars, varmapper->nvars + 1) );

         /* move all variables after pos one spot to the right to make room for the new one */
         for (i = varmapper->nvars - 1; i >= pos; i--)
         {
            varmapper->sdptoscip[i + 1] = varmapper->sdptoscip[i]; /*lint !e679*/
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
            SCIP_CALL( SCIPhashmapSetImageInt(varmapper->sciptosdp, varmapper->sdptoscip[i + 1], i + 1) );
#else
            SCIP_CALL( SCIPhashmapSetImage(varmapper->sciptosdp, varmapper->sdptoscip[i + 1], (void*) (size_t) (i + 1)) );
#endif
         }

         varmapper->sdptoscip[pos] = var;
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
         SCIP_CALL( SCIPhashmapInsertInt(varmapper->sciptosdp, var, pos) );
#else
         SCIP_CALL( SCIPhashmapInsert(varmapper->sciptosdp, var, (void*) (size_t) pos) );
#endif
         varmapper->nvars++;
         SCIP_CALL( SCIPcaptureVar(scip, var) );
      }
   }
   else
      SCIPdebugMsg(scip, "variable %s was not added to the varmapper as it was already part of it.\n", SCIPvarGetName(var));

   return SCIP_OKAY;
}

int SCIPsdpVarmapperGetNVars(
   SdpVarmapper*         varmapper           
   )
{
   assert ( varmapper != NULL );

   return varmapper->nvars;
}

SCIP_Bool SCIPsdpVarmapperExistsSCIPvar(
   SdpVarmapper*         varmapper,          
   SCIP_VAR*             var                 
   )
{
   assert ( varmapper != NULL );
   assert ( var != NULL );

   return SCIPhashmapExists(varmapper->sciptosdp, var);
}

int SCIPsdpVarmapperGetSdpIndex(
   SdpVarmapper*         varmapper,          
   SCIP_VAR*             var                 
   )
{
   assert ( varmapper != NULL );
   assert ( var != NULL );

#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
   return SCIPhashmapGetImageInt(varmapper->sciptosdp, (void*) var);
#else
   return (int) (size_t) SCIPhashmapGetImage(varmapper->sciptosdp, (void*) var);
#endif
}

SCIP_VAR* SCIPsdpVarmapperGetSCIPvar(
   SdpVarmapper*         varmapper,          
   int                   ind                 
   )
{
   assert ( varmapper != NULL );
   assert ( 0 <= ind && ind < varmapper->nvars );

   return varmapper->sdptoscip[ind];
}

SCIP_RETCODE SCIPsdpVarmapperRemoveSdpIndex(
   SCIP*                 scip,               
   SdpVarmapper*         varmapper,          
   int                   ind                 
   )
{
   SCIP_VAR* var;
   int i;

   assert ( scip != NULL );
   assert ( varmapper != NULL );
   assert ( 0 <= ind && ind < varmapper->nvars );

   var = varmapper->sdptoscip[ind];

   assert ( SCIPhashmapExists(varmapper->sciptosdp, var) );

   SCIP_CALL( SCIPhashmapRemove(varmapper->sciptosdp, var) );
   SCIP_CALL( SCIPreleaseVar(scip, &(varmapper)->sdptoscip[ind]) );

   /* shift all entries of the sdptoscip-array behind ind one to the left and update their sciptosdp-entries */
   for (i = ind + 1; i < varmapper->nvars; i++)
   {
      varmapper->sdptoscip[i - 1] = varmapper->sdptoscip[i];
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
      SCIP_CALL( SCIPhashmapSetImageInt(varmapper->sciptosdp, varmapper->sdptoscip[i - 1], i - 1) );
#else
      SCIP_CALL( SCIPhashmapSetImage(varmapper->sciptosdp, varmapper->sdptoscip[i - 1], (void*) (size_t) (i - 1)) );
#endif
   }

   /* reallocate memory */
   SCIP_CALL( SCIPreallocBlockMemoryArray(scip, &varmapper->sdptoscip, varmapper->nvars, varmapper->nvars - 1) );

   varmapper->nvars--;

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPsdpVarmapperTransform(
   SCIP*                 scip,               
   SdpVarmapper*         varmapper           
   )
{
   SCIP_VAR* var;
   int k;

   assert ( scip != NULL );
   assert ( varmapper != NULL );

   for (k = 0; k < varmapper->nvars; ++k)
   {
      SCIP_CALL( SCIPgetTransformedVar(scip, varmapper->sdptoscip[k], &var) );
      SCIP_CALL( SCIPcaptureVar(scip, var) );

      SCIP_CALL( SCIPhashmapRemove(varmapper->sciptosdp, varmapper->sdptoscip[k]) );
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
      SCIP_CALL( SCIPhashmapInsertInt(varmapper->sciptosdp, var, k) );
#else
      SCIP_CALL( SCIPhashmapInsert(varmapper->sciptosdp, var, (void*) (size_t) k) );
#endif
      SCIP_CALL( SCIPreleaseVar(scip, &varmapper->sdptoscip[k]) );

      varmapper->sdptoscip[k] = var;
   }

   return SCIP_OKAY;
}

SCIP_RETCODE SCIPsdpVarmapperClone(
   SCIP*                 scip,               
   SdpVarmapper*         oldmapper,          
   SdpVarmapper*         newmapper           
   )
{
   int nvars;
   int i;

   nvars = oldmapper->nvars;

   newmapper->nvars = nvars;

   /* allocate memory */
   SCIP_CALL( SCIPallocBlockMemory(scip, &newmapper) );
   SCIP_CALL( SCIPallocBlockMemoryArray(scip, &newmapper->sdptoscip, nvars) );

   /* copy entries */
   for (i = 0; i < nvars; i++)
   {
      newmapper->sdptoscip[i] = oldmapper->sdptoscip[i];
#if ( SCIP_VERSION >= 700 || (SCIP_VERSION >= 602 && SCIP_SUBVERSION > 0) )
      SCIP_CALL( SCIPhashmapInsertInt(newmapper->sciptosdp, oldmapper->sdptoscip[i], i) );
#else
      SCIP_CALL( SCIPhashmapInsert(newmapper->sciptosdp, oldmapper->sdptoscip[i], (void*) (size_t) i) );
#endif
      SCIP_CALL( SCIPcaptureVar(scip, newmapper->sdptoscip[i]) );
   }

   return SCIP_OKAY;
}