SdpVarfixer.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-2021 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-2021 Zuse Institute Berlin                             */
/* SCIP is distributed under the terms of the SCIP Academic Licence,         */
/* see file COPYING in the SCIP distribution.                                */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#include "scip/type_misc.h"
#include "scip/def.h"
#include "scip/pub_message.h"                /* for debug and error message */
#include "scip/pub_misc.h" /* for sorting */
#include "SdpVarfixer.h"

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

/* defines for lexicographic sorting macros */
#define SORTTPL_NAMEEXT     IntIntReal
#define SORTTPL_KEYTYPE     int
#define SORTTPL_FIELD1TYPE  SCIP_Real
#include "sorttpllex.c" /*lint !e451*/


void SCIPsdpVarfixerSortRowCol(
   int*                  row,                
   int*                  col,                
   SCIP_Real*            val,                
   int                   length              
   )
{
   SCIPlexSortIntIntReal(row, col, val, length);

#ifndef NDEBUG
   {
      int j;
      for (j = 0; j < length-1; ++j)
      {
         assert( row[j] <= row[j+1] );
         assert( row[j] != row[j+1] || col[j] <= col[j+1] );
      }
   }
#endif
}

SCIP_RETCODE SCIPsdpVarfixerMergeArrays(
   BMS_BLKMEM*           blkmem,             
   SCIP_Real             epsilon,            
   int*                  originrow,          
   int*                  origincol,          
   SCIP_Real*            originval,          
   int                   originlength,       
   SCIP_Bool             originsorted,       
   SCIP_Real             scalar,             
   int*                  targetrow,          
   int*                  targetcol,          
   SCIP_Real*            targetval,          
   int*                  targetlength,       
   int                   targetmemory        
   )
{  /*lint --e{679}*/
   /*lint --e{850}*/
   int ind;
   int i;
   int nleftshifts; /* if some nonzeros of the target arrays get deleted, this saves the number of spots the following entries have to be moved
                     * to the left */
   int naddednonz;  /* this gives the number of nonzeros that were added to the end of the arrays (this does NOT include those that were added in
                     * the middle of the arrays by decreasing the number of leftshifts) */
   int insertionpos;
   SCIP_Bool debugmsg; /* should a debug message about insufficient length be thrown */

   assert ( blkmem != NULL );
   assert ( originlength == 0 || (originlength > 0 && originrow != NULL && origincol != NULL && originval != NULL) );
   assert ( targetrow != NULL );
   assert ( targetcol != NULL );
   assert ( targetval != NULL );
   assert ( targetlength != NULL );
   assert ( *targetlength >= 0 );

   /* sort the target and origin arrays first by row and then by col to make searching for entries easier */
   SCIPsdpVarfixerSortRowCol(targetrow, targetcol, targetval, *targetlength);

   if ( ! originsorted )
      SCIPsdpVarfixerSortRowCol(originrow, origincol, originval, originlength);

   ind = 0; /* this will be used to traverse the nonzeros of the target arrays */
   naddednonz = 0;
   nleftshifts = 0;
   debugmsg = FALSE;

   /* iterate over all nonzeroes */
   for (i = 0; i < originlength; i++)
   {
      /* search the target arrays for an entry at this position, as both the origin and the target arrays are sorted, we go on until
       * we find an entry that is not < as the current entry in the origin arrays according to this sorting, if this has equal row/col,
       * we have found the entry we have to edit, if it is >, then we know, that there is no identical entry, and we can just add a new
       * entry for this row and col */
      while (ind < *targetlength && (targetrow[ind] < originrow[i] || (targetrow[ind] == originrow[i] && targetcol[ind] < origincol[i])))
      {
         /* shift the target nonzeros to the left if needed */
         if ( nleftshifts > 0 )
         {
            targetrow[ind - nleftshifts] = targetrow[ind];
            targetcol[ind - nleftshifts] = targetcol[ind];
            targetval[ind - nleftshifts] = targetval[ind];
         }
         ind++;
      }

      if ( ind < *targetlength && (targetrow[ind] == originrow[i] && targetcol[ind] == origincol[i]) )
      {
         /* add to the old entry */

         /* shift the entry to the left if needed and change the value */
         if ( nleftshifts > 0 )
         {
            targetrow[ind - nleftshifts] = targetrow[ind];
            targetcol[ind - nleftshifts] = targetcol[ind];
         }
         targetval[ind - nleftshifts] = targetval[ind] + scalar * originval[i];

         /* there could be multiple entries to add with identical row and col, so look for further ones in the next entries until there
          * are no more */
         while (i + 1 < originlength && originrow[i + 1] == targetrow[ind - nleftshifts] && origincol[i + 1] == targetcol[ind - nleftshifts])
         {
            targetval[ind - nleftshifts] += scalar * originval[i + 1];
            i++;
         }

         if ( REALABS(targetval[ind - nleftshifts]) < epsilon )
         {
            /* the nonzero became zero */
            nleftshifts++;
         }
         ind++; /* as we already added all origin-entries belonging to this row/col and also shifted the entry, we can continue with the next one */
      }
      else  /* create a new entry */
      {
         if ( nleftshifts > 0 )
         {
            /* we can add the nonzero at one of the empty spots */
            insertionpos = ind - nleftshifts;
            nleftshifts--; /* as one empty spot was filled, all remaining nonzeros should be moved one less position to the left */
         }
         else
         {
            /* add it to the end */
            insertionpos = *targetlength + naddednonz;
            naddednonz++;
         }

         if ( insertionpos < targetmemory )
         {
            /* add the nonzero to the computed position */
            targetrow[insertionpos] = originrow[i];
            targetcol[insertionpos] = origincol[i];
            targetval[insertionpos] = scalar * originval[i];

            /* there could be multiple entries to add with identical row and col, so look for further ones in the next entries until there are no more */
            while (i + 1 < originlength && originrow[i + 1] == targetrow[insertionpos] && origincol[i + 1] == targetcol[insertionpos])
            {
               targetval[insertionpos] += scalar * originval[i + 1];
               i++;
            }

            /* if there were indeed multiple entries, check if they did cancel each other out, in that case remove the entry */
            if ( REALABS(targetval[insertionpos]) < epsilon )
            {
               /* depending on where this actually zero nonzero was added, either add another leftshift to overwrite it or decrease the number of addednonz */
               if ( insertionpos < ind )
                  nleftshifts++;
               else
                  naddednonz--;
            }
         }
         else  /* the memory was not sufficient, so we will throw a debug message, we only wait until we know the final needed size */
            debugmsg = TRUE;
      }
   }
   /* shift the remaining entries of the target arrays */
   if ( nleftshifts > 0 )
   {
      while (ind < *targetlength + naddednonz && ind < targetmemory)
      {
         targetrow[ind - nleftshifts] = targetrow[ind];
         targetcol[ind - nleftshifts] = targetcol[ind];
         targetval[ind - nleftshifts] = targetval[ind];
         ind++;
      }
   }

   if ( debugmsg )
      SCIPdebugMessage("insufficient memory given for SCIPsdpVarfixerMergeArrays, targetmemorys had length %d, would have needed up to %d\n",
         targetmemory, *targetlength + naddednonz);

   *targetlength = *targetlength + naddednonz - nleftshifts;

   return SCIP_OKAY;
}


SCIP_RETCODE SCIPsdpVarfixerMergeArraysIntoNew(
   BMS_BLKMEM*           blkmem,             
   SCIP_Real             epsilon,            
   int*                  firstrow,           
   int*                  firstcol,           
   SCIP_Real*            firstval,           
   int                   firstlength,        
   int*                  secondrow,          
   int*                  secondcol,          
   SCIP_Real*            secondval,          
   int                   secondlength,       
   int*                  targetrow,          
   int*                  targetcol,          
   SCIP_Real*            targetval,          
   int*                  targetlength        
   )
{
   int firstind;
   int secondind;
   int targetind;
   SCIP_Bool debugmsg; /* should we throw a debug message about insufficient memory */

   assert ( blkmem != NULL );
   assert ( firstlength == 0 || (firstlength > 0 && firstrow != NULL && firstcol != NULL && firstval != NULL ) );
   assert ( secondlength == 0 || (secondlength > 0 && secondrow != NULL && secondcol != NULL && secondval != NULL ) );
   assert ( targetrow != NULL );
   assert ( targetcol != NULL );
   assert ( targetval != NULL );
   assert ( targetlength != NULL );
   assert ( *targetlength >= 0 );

   debugmsg = FALSE;

   /* sort both arrays by non-decreasing row and then col indices to make comparisons easier */
   SCIPsdpVarfixerSortRowCol(firstrow, firstcol, firstval, firstlength);
   SCIPsdpVarfixerSortRowCol(secondrow, secondcol, secondval, secondlength);

   /* as both arrays are sorted, traverse them simultanously, always adding the current entry with the lower index of either array to the
    * target arrays (if they both have the same index, we have found entries that need to be merged) */
   firstind = 0;
   secondind = 0;
   targetind = 0;

   while (firstind < firstlength && secondind < secondlength)
   {
      /* if the next entry of the first arrays comes before the next entry of the second arrays according to the row then col sorting, then we can
       * insert the next entry of the first arrays, as there can't be an entry in the second arrays for the same row/col-combination */
      if ( firstrow[firstind] < secondrow[secondind] || (firstrow[firstind] == secondrow[secondind] && firstcol[firstind] < secondcol[secondind]) )
      {
         if ( targetind < *targetlength )
         {
            targetrow[targetind] = firstrow[firstind];
            targetcol[targetind] = firstcol[firstind];
            targetval[targetind] = firstval[firstind];
         }
         else
            debugmsg = TRUE;

         targetind++;
         firstind++;
      }
      /* if the next entry of the second array comes first, we insert it */
      else if ( firstrow[firstind] > secondrow[secondind] || (firstrow[firstind] == secondrow[secondind] && firstcol[firstind] > secondcol[secondind]) )
      {
         if ( targetind < *targetlength )
         {
            targetrow[targetind] = secondrow[secondind];
            targetcol[targetind] = secondcol[secondind];
            targetval[targetind] = secondval[secondind];
         }
         else
            debugmsg = TRUE;
         secondind++;

         /* as the second arrays may have duplicate entries, we have to check the next entry, if it has the same row/col combination, if yes, then we
          * add it's value to the created entry in the target entries and continue */
         while (secondind < secondlength && (secondrow[secondind] == targetrow[targetind] && secondcol[secondind] == targetcol[targetind]))
         {
            if ( targetind < *targetlength )
               targetval[targetind] += secondval[secondind];
            secondind++;
         }

         /* if we combined multiple fixed nonzeros, it is possible that they cancelled each other out, in that case, we shouldn't add a nonzero to the
          * target arrays (if the array was too short we didn't compute the entry, but we add it, as we want to get an upper bound on the needed size) */
         if ( targetind >= *targetlength || REALABS(targetval[targetind]) >= epsilon )
            targetind++;
      }
      /* if the next entries of both arrays are equal according to the row then col sorting, then they need to be combined */
      else
      {
         if ( targetind < *targetlength )
         {
            targetrow[targetind] = firstrow[firstind];
            targetcol[targetind] = firstcol[firstind];
            targetval[targetind] = firstval[firstind] + secondval[secondind];
         }
         else
            debugmsg = TRUE;
         firstind++;
         secondind++;

         /* as the second arrays may have duplicate entries, we have to check the next entry, if it has the same row/col combination, if yes, then we
          * add it's value to the created entry in the target entries and continue */
         while (secondind < secondlength && (secondrow[secondind] == targetrow[targetind] && secondcol[secondind] == targetcol[targetind]))
         {
            if ( targetind < *targetlength )
               targetval[targetind] += secondval[secondind];
            secondind++;
         }

         /* as we combined multiple entires, it is possible that they cancelled each other out, in that case, we shouldn't add a nonzero to the
          * target arrays (if the array was too short we didn't compute the entry, but we add it, as we want to get an upper bound on the needed size) */
         if ( targetind >= *targetlength || REALABS(targetval[targetind]) >= epsilon )
            targetind++;
      }
   }
   /* if we reach the end of one of the two arrays, we can just add the rest of the other array to the target arrays (in case of the second still
    * combining duplicate entries of this same array), so at most one of the following two while-queues will be non-empty, the contents of these
    * queues are exactly the same as the corresponding if-case in the above while-queue (+ checking for the length of the target arrays) */
   while (firstind < firstlength)
   {
      if ( targetind < *targetlength )
      {
         targetrow[targetind] = firstrow[firstind];
         targetcol[targetind] = firstcol[firstind];
         targetval[targetind] = firstval[firstind];
      }
      else
         debugmsg = TRUE;
      firstind++;
      targetind++;
   }

   while (secondind < secondlength)
   {
      if ( targetind < *targetlength )
      {
         targetrow[targetind] = secondrow[secondind];
         targetcol[targetind] = secondcol[secondind];
         targetval[targetind] = secondval[secondind];
      }
      else
         debugmsg = TRUE;
      secondind++;

      /* as the second arrays may have duplicate entries, we have to check the next entry, if it has the same row/col combination, if yes, then we
       * add it's value to the created entry in the target entries and continue */
      while (secondind < secondlength && (secondrow[secondind] == targetrow[targetind] && secondcol[secondind] == targetcol[targetind]))
      {
         if ( targetind < *targetlength )
            targetval[targetind] += secondval[secondind];
         secondind++;
      }

      /* if we combined multiple fixed nonzeros, it is possible that they cancelled each other out, in that case, we shouldn't add a nonzero to the
       * target arrays */
      if ( targetind >= *targetlength || REALABS(targetval[targetind]) >= epsilon )
         targetind++;
   }

   if ( debugmsg )
   {
      SCIPdebugMessage("Insufficient arraylength in SCIPsdpVarfixerMergeArraysIntoNew, given targetarray-length was %d, would have needed %d",
         *targetlength, targetind);
   }

   *targetlength = targetind;

   return SCIP_OKAY;
}