Merge branch 'fix-docstrings-1000' into 'master'

Some more docstring fixes

See merge request integer/scip!3821

Author: svigerske

applications/Coloring/src/heur_init.c

@@ -32,7 +32,7 @@
  *
  * The heuristic is called only one time: before solving the root node.
  *
- * It checks, whether a solution-file was read in and a starting solution already exists.  If this
+ * It checks whether a solution-file was read in and a starting solution already exists.  If this
  * is not the case, an initial possible coloring is computed by a greedy method.  After that, a
  * tabu-search is called, which tries to reduce the number of colors needed. The tabu-search algorithm
  * follows the description in

applications/Coloring/src/heur_init.h

@@ -32,7 +32,7 @@
  *
  * The heuristic is called only one time: before solving the root node.
  *
- * It checks, whether a solution-file was read in and there already is a starting solution.  If this
+ * It checks whether a solution-file was read in and there already is a starting solution.  If this
  * is not the case, an initial possible coloring is computed by a greedy method.  After that, a
  * tabu-search is called, which tries to reduce the number of colors needed. The tabu-search algorithm
  * follows the description in

doc/xternal.c

@@ -3451,7 +3451,7 @@
  * \n
  * Note that this property only defines the default value of the priority. The user may change this value arbitrarily by
  * adjusting the corresponding parameter setting. Whenever, even during solving, the priority of a cut selector is
- * changed, the cut selectors are resorted by the new priorities.
+ * changed, the cut selectors are re-sorted by the new priorities.
  *
  *
  * @section CUTSEL_DATA Cut Selector Data
@@ -3507,7 +3507,7 @@
  * @subsection CUTSELSELECT
  *
  * The CUTSELSELECT callback should decide which cuts should be added to the relaxation.
- * The callback receives the arrays of cuts to select from. This array must be resorted and the first nselectedcuts from
+ * The callback receives the arrays of cuts to select from. This array must be re-sorted and the first nselectedcuts from
  * the sorted array are going to be selected.
  * In addition to the aforementioned cuts, the list of forced cuts is also given as an argument. This array can be used
  * to help with the selection algorithm. Note, however, that this array should not be tampered with.

src/blockmemshell/memory.c

@@ -158,7 +158,7 @@ static MEMLIST*          memlist = NULL;     /**< global memory list for debuggi
 static size_t            memused = 0;        /**< number of allocated bytes */
 
 #ifdef CHECKMEM
-/** checks, whether the number of allocated bytes match the entries in the memory list */
+/** checks whether the number of allocated bytes match the entries in the memory list */
 static
 void checkMemlist(
    void
@@ -783,7 +783,7 @@ int BMSisAligned(
 }
 
 #ifndef NDEBUG
-/** checks, if the given pointer belongs to the given chunk */
+/** checks if the given pointer belongs to the given chunk */
 static
 int isPtrInChunk(
    const CHUNK*          chunk,              /**< memory chunk */
@@ -819,7 +819,7 @@ CHUNK* findChunk(
    return NULL;
 }
 
-/** checks, if a pointer belongs to a chunk of the given chunk block */
+/** checks if a pointer belongs to a chunk of the given chunk block */
 static
 int isPtrInChkmem(
    const BMS_CHKMEM*     chkmem,             /**< chunk block */

src/lpi/lpi.h

@@ -946,7 +946,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    SCIP_LPISTATE**       lpistate            /**< pointer to LPi state information (like basis information) */
    );
 
-/** checks, whether the given LPi state contains simplex basis information */
+/** checks whether the given LPi state contains simplex basis information */
 SCIP_EXPORT
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */

src/lpi/lpi_clp.cpp

@@ -3518,7 +3518,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL*/
@@ -3951,7 +3951,7 @@ SCIP_Bool SCIPlpiIsInfinity(
 /**@name File Interface Methods */
 /**@{ */
 
-/** returns, whether the given file exists */
+/** returns whether the given file exists */
 static
 SCIP_Bool fileExists(
    const char*           filename            /**< file name */

src/lpi/lpi_cpx.c

@@ -4125,7 +4125,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_glop.cpp

@@ -2746,7 +2746,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_grb.c

@@ -5362,7 +5362,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_highs.cpp

@@ -2602,7 +2602,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_msk.c

@@ -4922,7 +4922,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_none.c

@@ -1437,7 +1437,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_qso.c

@@ -3306,7 +3306,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/lpi/lpi_spx1.cpp

@@ -4961,7 +4961,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */
@@ -5444,7 +5444,7 @@ SCIP_Bool SCIPlpiIsInfinity(
 /**@name File Interface Methods */
 /**@{ */
 
-/** returns, whether the given file exists */
+/** returns whether the given file exists */
 static
 SCIP_Bool fileExists(
    const char*           filename            /**< file name */

src/lpi/lpi_spx2.cpp

@@ -4055,7 +4055,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */
@@ -4603,7 +4603,7 @@ SCIP_Bool SCIPlpiIsInfinity(
 /**@name File Interface Methods */
 /**@{ */
 
-/** returns, whether the given file exists */
+/** returns whether the given file exists */
 static
 SCIP_Bool fileExists(
    const char*           filename            /**< file name */

src/lpi/lpi_xprs.c

@@ -3370,7 +3370,7 @@ SCIP_RETCODE SCIPlpiFreeState(
    return SCIP_OKAY;
 }
 
-/** checks, whether the given LP state contains simplex basis information */
+/** checks whether the given LP state contains simplex basis information */
 SCIP_Bool SCIPlpiHasStateBasis(
    SCIP_LPI*             lpi,                /**< LP interface structure */
    SCIP_LPISTATE*        lpistate            /**< LP state information (like basis information), or NULL */

src/scip/cons_cardinality.c

@@ -3799,7 +3799,7 @@ SCIP_RETCODE SCIPcreateConsCardinality(
 /** creates and captures a cardinality constraint with all constraint flags set to their default values.
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method \ref SCIPreleaseCons()
  */

src/scip/cons_cardinality.h

@@ -122,7 +122,7 @@ SCIP_RETCODE SCIPcreateConsCardinality(
  *  @see SCIPcreateConsCardinality() for the default constraint flag configuration
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
  */

src/scip/cons_countsols.c

@@ -28,7 +28,7 @@
  * @author Stefan Heinz
  * @author Michael Winkler
  *
- * If this constraint handler is activated than it counts or collects all feasible solutions. We refer to \ref COUNTER for
+ * If this constraint handler is activated then it counts or collects all feasible solutions. We refer to \ref COUNTER for
  * more details about using SCIP for counting feasible solutions.
  *
  * @todo In the last round of presolving we should check if variables exist, which have up and down lock one. In this

src/scip/cons_countsols.h

@@ -63,7 +63,7 @@ SCIP_RETCODE SCIPincludeConshdlrCountsols(
  *
  * @{
  *
- * If this constraint handler is activated than it counts or collects all feasible solutions. We refer to \ref COUNTER for
+ * If this constraint handler is activated then it counts or collects all feasible solutions. We refer to \ref COUNTER for
  * more details about using SCIP for counting feasible solutions.
  */
 

src/scip/cons_cumulative.c

@@ -11097,7 +11097,7 @@ TCLIQUE_GETWEIGHTS(tcliqueGetweightsClique)
    return tcliquegraph->weights;
 }
 
-/** returns, whether the edge (node1, node2) is in the graph */
+/** returns whether the edge (node1, node2) is in the graph */
 static
 TCLIQUE_ISEDGE(tcliqueIsedgeClique)
 {

src/scip/cons_knapsack.c

@@ -4946,7 +4946,7 @@ SCIP_RETCODE separateSequLiftedMinimalCoverInequality(
       SCIPfreeBufferArray(scip, &gubconsGC1);
    }
 
-   /* checks, if lifting yielded a violated cut */
+   /* checks if lifting yielded a violated cut */
    if( SCIPisEfficacious(scip, (cutact - liftrhs)/sqrt((SCIP_Real)MAX(liftrhs, 1))) )
    {
       SCIP_ROW* row;
@@ -5003,7 +5003,7 @@ SCIP_RETCODE separateSequLiftedMinimalCoverInequality(
       }
       SCIP_CALL( SCIPflushRowExtensions(scip, row) );
 
-      /* checks, if cut is violated enough */
+      /* checks if cut is violated enough */
       if( SCIPisCutEfficacious(scip, sol, row) )
       {
          if( cons != NULL )
@@ -5114,7 +5114,7 @@ SCIP_RETCODE separateSequLiftedExtendedWeightInequality(
    SCIP_CALL( sequentialUpAndDownLifting(scip, vars, nvars, ntightened, weights, capacity, solvals, varsT1, varsT2, varsF, varsR,
          nvarsT1, nvarsT2, nvarsF, nvarsR, nvarsT1, liftcoefs, &cutact, &liftrhs) );
 
-   /* checks, if lifting yielded a violated cut */
+   /* checks if lifting yielded a violated cut */
    if( SCIPisEfficacious(scip, (cutact - liftrhs)/sqrt((SCIP_Real)MAX(liftrhs, 1))) )
    {
       SCIP_ROW* row;
@@ -5170,7 +5170,7 @@ SCIP_RETCODE separateSequLiftedExtendedWeightInequality(
       }
       SCIP_CALL( SCIPflushRowExtensions(scip, row) );
 
-      /* checks, if cut is violated enough */
+      /* checks if cut is violated enough */
       if( SCIPisCutEfficacious(scip, sol, row) )
       {
          if( cons != NULL )
@@ -5240,7 +5240,7 @@ SCIP_RETCODE separateSupLiftedMinimalCoverInequality(
          nonmincovervars, nmincovervars, nnonmincovervars, mincoverweight, realliftcoefs, &cutact) );
    liftrhs = nmincovervars - 1;
 
-   /* checks, if lifting yielded a violated cut */
+   /* checks if lifting yielded a violated cut */
    if( SCIPisEfficacious(scip, (cutact - liftrhs)/sqrt((SCIP_Real)MAX(liftrhs, 1))) )
    {
       SCIP_ROW* row;
@@ -5284,7 +5284,7 @@ SCIP_RETCODE separateSupLiftedMinimalCoverInequality(
       }
       SCIP_CALL( SCIPflushRowExtensions(scip, row) );
 
-      /* checks, if cut is violated enough */
+      /* checks if cut is violated enough */
       if( SCIPisCutEfficacious(scip, sol, row) )
       {
          if( cons != NULL )
@@ -13064,7 +13064,7 @@ SCIP_DECL_CONSRESPROP(consRespropKnapsack)
       else
       {
          /* locate the inference variable and calculate the capacity that has to be used up to conclude infervar == 0;
-          * inferinfo stores the position of the inference variable (but maybe the variables were resorted)
+          * inferinfo stores the position of the inference variable (but maybe the variables were re-sorted)
           */
          if( inferinfo < consdata->nvars && consdata->vars[inferinfo] == infervar )
             capsum = consdata->weights[inferinfo];

src/scip/cons_sos1.c

@@ -550,7 +550,7 @@ SCIP_Bool varIsSOS1(
 }
 
 
-/** returns SOS1 index of variable or -1 if variable is not part of the SOS1 conflict graph */
+/** returns node of variable in the conflict graph or -1 if variable is not part of the SOS1 conflict graph */
 static
 int varGetNodeSOS1(
    SCIP_CONSHDLRDATA*    conshdlrdata,       /**< SOS1 constraint handler */
@@ -10702,7 +10702,7 @@ SCIP_RETCODE SCIPcreateConsSOS1(
 /** creates and captures a SOS1 constraint with all constraint flags set to their default values.
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
  */
@@ -10936,7 +10936,7 @@ SCIP_Bool SCIPvarIsSOS1(
 }
 
 
-/** returns SOS1 index of variable or -1 if variable is not part of the SOS1 conflict graph */
+/** returns node of variable in the conflict graph or -1 if variable is not part of the SOS1 conflict graph */
 int SCIPvarGetNodeSOS1(
    SCIP_CONSHDLR*        conshdlr,           /**< SOS1 constraint handler */
    SCIP_VAR*             var                 /**< variable */

src/scip/cons_sos1.h

@@ -116,7 +116,7 @@ SCIP_RETCODE SCIPcreateConsSOS1(
  *  @see SCIPcreateConsSOS1() for the default constraint flag configuration
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
  */

src/scip/cons_sos2.c

@@ -2664,7 +2664,7 @@ SCIP_RETCODE SCIPcreateConsSOS2(
 /** creates and captures a SOS2 constraint with all constraint flags set to their default values.
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
  */

src/scip/cons_sos2.h

@@ -109,7 +109,7 @@ SCIP_RETCODE SCIPcreateConsSOS2(
 /** creates and captures a SOS2 constraint with all constraint flags set to their default values.
  *
  *  @warning Do NOT set the constraint to be modifiable manually, because this might lead
- *  to wrong results as the variable array will not be resorted
+ *  to wrong results as the variable array will not be re-sorted
  *
  *  @note the constraint gets captured, hence at one point you have to release it using the method SCIPreleaseCons()
  */

src/scip/cuts.c

@@ -9587,7 +9587,7 @@ void buildFlowCover(
 
 #ifndef NO_EXACT_KNAPSACK
 
-/** checks, whether the given scalar scales the given value to an integral number with error in the given bounds */
+/** checks whether the given scalar scales the given value to an integral number with error in the given bounds */
 static
 SCIP_Bool isIntegralScalar(
    SCIP_Real             val,                /**< value that should be scaled to an integral value */

src/scip/cutsel_dynamic.c

@@ -533,7 +533,7 @@ SCIP_RETCODE SCIPincludeCutselDynamic(
  *
  *  This is the selection method of the dynamic cut selector which implements
  *  the dynamic orthognality filtering based on the ratio of efficacies.
- *  The input cuts array gets resorted s.t the selected cuts come first and the remaining
+ *  The input cuts array gets re-sorted s.t the selected cuts come first and the remaining
  *  ones are the end.
  */
 SCIP_RETCODE SCIPselectCutsDynamic(

src/scip/cutsel_dynamic.h

@@ -37,7 +37,7 @@
  *
  *  The selector allows the user to specify a filtering strategy during cut selection ('d'ynamic- and 'f'ull dynamic),
  *  which determines how the orthogonality filtering is applied.
- *  In both cases, after a cut is selected, the remaining cuts are resorted by computing their relative efficacy to the
+ *  In both cases, after a cut is selected, the remaining cuts are re-sorted by computing their relative efficacy to the
  *  selected cut. The efficacy ratio is then used to filter the cuts based on the filtering strategy:
  *  - 'd'ynamic-parallelism: The dynamic parallelism strategy filters cuts based on the efficacy ratio between cut
  *  pairs. It only filters cuts that are not theoretically improving the efficacy of the pair given the first cut, i.e.,
@@ -80,7 +80,7 @@ SCIP_RETCODE SCIPincludeCutselDynamic(
  *  This is an extension of the hybrid cutselector to employ a dynamic range
  *  when applying orthogonality filtering, dependent on the efficacy ratio between cuts.
  *
- *  The input cuts array should be resorted such that the selected cuts come first.
+ *  The input cuts array should be re-sorted such that the selected cuts come first.
  */
 SCIP_EXPORT
 SCIP_RETCODE SCIPselectCutsDynamic(