Merge branch 'simplify_code_by_introducing_sortRealPtrPTr' into 'master'

Simplify code by introducing sort function RealPtrPtr

See merge request integer/scip!3815

Author: svigerske

CHANGELOG

@@ -72,6 +72,7 @@ Interface changes
 - the callback SCIP_DECL_EXPRINTEGRALITY, which returns the integrality of an expression, had its fourth argument change from SCIP_Bool* to SCIP_IMPLINTTYPE*, to represent implied integrality in nonlinear expressions, that is an implied integral type of an auxiliary variable if the expression were assigned to it
 - new event SCIP_EVENTTYPE_DUALBOUNDIMPROVED is generated whenever the global dual bound is improved
 - new event mask SCIP_EVENTTYPE_GAPUPDATED for catching updates in primal or dual bound
+- added new sorting functions SCIPsortRealPtrPtr(), ...
 
 ### Deleted and changed API methods
 

src/scip/cons_cardinality.c

@@ -3754,21 +3754,11 @@ SCIP_RETCODE SCIPcreateConsCardinality(
       /* check weights */
       if( weights != NULL )
       {
-         int* dummy;
-
          /* store weights */
          SCIP_CALL( SCIPduplicateBlockMemoryArray(scip, &consdata->weights, weights, nvars) );
 
-         /* create dummy array to make code compatible with SCIP 3.2.0
-          * (the function SCIPsortRealPtrPtr() is not available) */
-         SCIP_CALL( SCIPallocBufferArray(scip, &dummy, nvars) );
-         for( v = 0; v < nvars; ++v )
-            dummy[v] = 0;
-
          /* sort variables - ascending order */
-         SCIPsortRealPtrPtrInt(consdata->weights, (void**)consdata->vars, (void**)consdata->indvars, dummy, nvars);
-
-         SCIPfreeBufferArray(scip, &dummy);
+         SCIPsortRealPtrPtr(consdata->weights, (void**)consdata->vars, (void**)consdata->indvars, nvars);
       }
    }
    else

src/scip/misc.c

@@ -5846,6 +5846,14 @@ void SCIPsort(
 #include "scip/sorttpl.c" /*lint !e451*/
 
 
+/* SCIPsortRealPtrPtr(), SCIPsortedvecInsert...(), SCIPsortedvecDelPos...(), SCIPsortedvecFind...() via sort template */
+#define SORTTPL_NAMEEXT     RealPtrPtr
+#define SORTTPL_KEYTYPE     SCIP_Real
+#define SORTTPL_FIELD1TYPE  void*
+#define SORTTPL_FIELD2TYPE  void*
+#include "scip/sorttpl.c" /*lint !e451*/
+
+
 /* SCIPsortRealRealPtr(), SCIPsortedvecInsert...(), SCIPsortedvecDelPos...(), SCIPsortedvecFind...() via sort template */
 #define SORTTPL_NAMEEXT     RealRealPtr
 #define SORTTPL_KEYTYPE     SCIP_Real

src/scip/pub_misc_select.h

@@ -911,6 +911,34 @@ void SCIPselectWeightedRealIntPtr(
    );
 
 
+/** partial sort of three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-decreasing order around the \p k-th element,
+ *  see \ref SelectionAlgorithms for more information.
+ */
+SCIP_EXPORT
+void SCIPselectRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array to be sorted */
+   void**                ptrarray1,          /**< first pointer array to be permuted in the same way */
+   void**                ptrarray2,          /**< second pointer array to be permuted in the same way */
+   int                   k,                  /**< the index of the desired element, must be between 0 (search for maximum/minimum) and len - 1 */
+   int                   len                 /**< length of arrays */
+   );
+
+
+/** partial sort of three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-decreasing order around the weighted median w.r.t. \p weights and capacity,
+ *  see \ref SelectionAlgorithms for more information.
+ */
+SCIP_EXPORT
+void SCIPselectWeightedRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array to be sorted */
+   void**                ptrarray1,          /**< first pointer array to be permuted in the same way */
+   void**                ptrarray2,          /**< second pointer array to be permuted in the same way */
+   SCIP_Real*            weights,            /**< (optional), nonnegative weights array for weighted median, or NULL (all weights are equal to 1) */
+   SCIP_Real             capacity,           /**< the maximum capacity that is exceeded by the median */
+   int                   len,                /**< length of arrays */
+   int*                  medianpos           /**< pointer to store the index of the weighted median, or NULL, if not needed */
+   );
+
+
 /** partial sort of three joint arrays of Reals/Reals/Pointer, sorted by first array in non-decreasing order around the \p k-th element,
  *  see \ref SelectionAlgorithms for more information.
  */

src/scip/pub_misc_sort.h

@@ -361,6 +361,15 @@ void SCIPsortRealIntPtr(
    int                   len                 /**< length of arrays */
    );
 
+/** sort of three joint arrays of Reals/Pointers/Pointers, sorted by first array in non-decreasing order */
+SCIP_EXPORT
+void SCIPsortRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array to be sorted */
+   void**                ptrarray1,          /**< first pointer array to be permuted in the same way */
+   void**                ptrarray2,          /**< second pointer array to be permuted in the same way */
+   int                   len                 /**< length of arrays */
+   );
+
 /** sort of three joint arrays of Reals/Reals/Pointer, sorted by first array in non-decreasing order */
 SCIP_EXPORT
 void SCIPsortRealRealPtr(
@@ -943,6 +952,15 @@ void SCIPsortDownRealIntPtr(
    int                   len                 /**< length of arrays */
    );
 
+/** sort of three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-decreasing order */
+SCIP_EXPORT
+void SCIPsortDownRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array to be sorted */
+   void**                ptrarray1,          /**< first pointer array to be permuted in the same way */
+   void**                ptrarray2,          /**< second pointer array to be permuted in the same way */
+   int                   len                 /**< length of arrays */
+   );
+
 /** sort of three joint arrays of Reals/Reals/ints, sorted by first array in non-increasing order */
 SCIP_EXPORT
 void SCIPsortDownRealRealInt(
@@ -1033,15 +1051,6 @@ void SCIPsortDownRealRealRealPtr(
    int                   len                 /**< length of arrays */
    );
 
-/** sort of three joint arrays of Reals/pointers, sorted by first array in non-decreasing order */
-SCIP_EXPORT
-void SCIPsortDownRealPtrPtr(
-   SCIP_Real*            realarray,          /**< SCIP_Real array to be sorted */
-   void**                ptrarray1,          /**< pointer array to be permuted in the same way */
-   void**                ptrarray2,          /**< pointer array to be permuted in the same way */
-   int                   len                 /**< length of arrays */
-   );
-
 /** sort of five joint arrays of Reals/Reals/Reals/Bools/pointers, sorted by first array in non-increasing order */
 SCIP_EXPORT
 void SCIPsortDownRealRealRealBoolPtr(
@@ -1653,6 +1662,19 @@ void SCIPsortedvecInsertRealIntPtr(
    int*                  pos                 /**< pointer to store the insertion position, or NULL */
    );
 
+/** insert a new element into three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-decreasing order */
+SCIP_EXPORT
+void SCIPsortedvecInsertRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array where an element is to be inserted */
+   void**                ptrarray1,          /**< first pointer array where an element is to be inserted */
+   void**                ptrarray2,          /**< second pointer array where an element is to be inserted  */
+   SCIP_Real             keyval,             /**< key value of new element */
+   void*                 field1val,          /**< additional value of new element */
+   void*                 field2val,          /**< additional value of new element */
+   int*                  len,                /**< pointer to length of arrays (will be increased by 1) */
+   int*                  pos                 /**< pointer to store the insertion position, or NULL */
+   );
+
 /** insert a new element into three joint arrays of Reals/Reals/Pointer, sorted by first array in non-decreasing order */
 SCIP_EXPORT
 void SCIPsortedvecInsertRealRealPtr(
@@ -2435,19 +2457,6 @@ void SCIPsortedvecInsertDownRealPtr(
    int*                  pos                 /**< pointer to store the insertion position, or NULL */
    );
 
-/** insert a new element into three joint arrays of Reals/pointers, sorted by first array in non-increasing order */
-SCIP_EXPORT
-void SCIPsortedvecInsertDownRealPtrPtr(
-   SCIP_Real*            realarray,          /**< SCIP_Real array where an element is to be inserted */
-   void**                ptrarray1,          /**< first pointer array where an element is to be inserted */
-   void**                ptrarray2,          /**< second pointer array where an element is to be inserted */
-   SCIP_Real             keyval,             /**< key value of new element */
-   void*                 field1val,          /**< additional value of new element */
-   void*                 field2val,          /**< additional value of new element */
-   int*                  len,                /**< pointer to length of arrays (will be increased by 1) */
-   int*                  pos                 /**< pointer to store the insertion position, or NULL */
-   );
-
 /** insert a new element into two joint arrays of Reals/ints, sorted by first array in non-increasing order */
 SCIP_EXPORT
 void SCIPsortedvecInsertDownRealInt(
@@ -2511,6 +2520,18 @@ void SCIPsortedvecInsertDownRealIntPtr(
    int*                  pos                 /**< pointer to store the insertion position, or NULL */
    );
 
+/** insert a new element into three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-increasing order */
+SCIP_EXPORT
+void SCIPsortedvecInsertDownRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array where an element is to be inserted */
+   void**                ptrarray1,          /**< first pointer array where an element is to be inserted */
+   void**                ptrarray2,          /**< second pointer array where an element is to be inserted */
+   SCIP_Real             keyval,             /**< key value of new element */
+   void*                 field1val,          /**< additional value of new element */
+   void*                 field2val,          /**< additional value of new element */
+   int*                  len,                /**< pointer to length of arrays (will be increased by 1) */
+   int*                  pos                 /**< pointer to store the insertion position, or NULL */
+   );
 
 /** insert a new element into three joint arrays of Reals/Reals/Pointer, sorted by first array in non-increasing order */
 SCIP_EXPORT
@@ -3270,6 +3291,16 @@ void SCIPsortedvecDelPosRealIntPtr(
    int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
    );
 
+/** delete the element at the given position from three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-decreasing order */
+SCIP_EXPORT
+void SCIPsortedvecDelPosRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array where an element is to be deleted */
+   void**                ptrarray1,          /**< first pointer array where an element is to be deleted */
+   void**                ptrarray2,          /**< first pointer array where an element is to be deleted */
+   int                   pos,                /**< array position of element to be deleted */
+   int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
+   );
+
 /** delete the element at the given position from three joint arrays of Reals/Reals/Pointer, sorted by first array in non-decreasing order */
 SCIP_EXPORT
 void SCIPsortedvecDelPosRealRealPtr(
@@ -3903,6 +3934,16 @@ void SCIPsortedvecDelPosDownRealIntPtr(
    int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
    );
 
+/** delete the element at the given position from three joint arrays of Reals/Pointer/Pointer, sorted by first array in non-increasing order */
+SCIP_EXPORT
+void SCIPsortedvecDelPosDownRealPtrPtr(
+   SCIP_Real*            realarray,          /**< SCIP_Real array where an element is to be deleted */
+   void**                ptrarray1,          /**< first pointer array where an element is to be deleted */
+   void**                ptrarray2,          /**< second pointer array where an element is to be deleted */
+   int                   pos,                /**< array position of element to be deleted */
+   int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
+   );
+
 /** delete the element at the given position from three joint arrays of Reals/Reals/ints, sorted by first array in non-increasing order */
 SCIP_EXPORT
 void SCIPsortedvecDelPosDownRealRealInt(
@@ -3934,16 +3975,6 @@ void SCIPsortedvecDelPosDownRealRealPtrPtr(
    int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
    );
 
-/** delete the element at the given position from three joint arrays of Reals/Reals/Pointer, sorted by first array in non-increasing order */
-SCIP_EXPORT
-void SCIPsortedvecDelPosDownRealPtrPtr(
-   SCIP_Real*            realarray,          /**< first SCIP_Real array where an element is to be deleted */
-   void**                ptrarray1,          /**< first pointer array where an element is to be deleted */
-   void**                ptrarray2,          /**< second pointer array where an element is to be deleted */
-   int                   pos,                /**< array position of element to be deleted */
-   int*                  len                 /**< pointer to length of arrays (will be decreased by 1) */
-   );
-
 /** delete the element at the given position from four joint arrays of Reals/pointers/pointers/ints, sorted by first array in non-increasing order */
 SCIP_EXPORT
 void SCIPsortedvecDelPosDownRealPtrPtrInt(