1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program */
/* GCG --- Generic Column Generation */
/* a Dantzig-Wolfe decomposition based extension */
/* of the branch-cut-and-price framework */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright (C) 2010-2022 Operations Research, RWTH Aachen University */
/* Zuse Institute Berlin (ZIB) */
/* */
/* 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.*/
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file pub_decomp.h
* @ingroup PUBLICCOREAPI
* @brief public methods for working with decomposition structures
* @author Martin Bergner
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef GCG_PUB_DECOMP_H__
#define GCG_PUB_DECOMP_H__
#include "type_decomp.h"
#include "scip/type_scip.h"
#include "scip/type_retcode.h"
#include "scip/type_var.h"
#include "scip/type_cons.h"
#include "scip/type_misc.h"
#include "type_detector.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @ingroup DECOMP
* @{
*/
/** score data structure
* @ingroup DATASTRUCTURES
**/
struct Dec_Scores
{
SCIP_Real borderscore; /**< score of the border */
SCIP_Real densityscore; /**< score of block densities */
SCIP_Real linkingscore; /**< score related to interlinking blocks */
SCIP_Real totalscore; /**< accumulated score */
SCIP_Real maxwhitescore; /**< score related to max white measure (i.e. fraction of white (nonblock and nonborder) matrix area ) */
};
typedef struct Dec_Scores DEC_SCORES;
/** converts the DEC_DECTYPE enum to a string */
const char *DECgetStrType(
DEC_DECTYPE type /**< decomposition type */
);
/** initializes the decomposition to absolutely nothing */
extern
SCIP_RETCODE DECdecompCreate(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP** decomp /**< pointer to the decomposition data structure */
);
/** frees the decomposition */
extern
SCIP_RETCODE DECdecompFree(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP** decomp /**< pointer to the decomposition data structure */
);
/** sets the type of the decomposition */
extern
SCIP_RETCODE DECdecompSetType(
DEC_DECOMP* decomp, /**< decomposition data structure */
DEC_DECTYPE type /**< type of the decomposition */
);
/** gets the type of the decomposition */
extern
DEC_DECTYPE DECdecompGetType(
DEC_DECOMP* decomp /**< decomposition data structure */
);
extern
SCIP_Real DECdecompGetMaxwhiteScore(
DEC_DECOMP* decomp /**< decomposition data structure */
);
extern
void DECsetMaxWhiteScore(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real maxwhitescore /**< score related to max white measure (i.e. fraction of white (nonblock and nonborder) matrix area ) */
);
/** sets the presolved flag for decomposition */
extern
void DECdecompSetPresolved(
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Bool presolved /**< presolved flag for decomposition */
);
/** gets the presolved flag for decomposition */
extern
SCIP_Bool DECdecompGetPresolved(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the number of blocks for decomposition */
extern
void DECdecompSetNBlocks(
DEC_DECOMP* decomp, /**< decomposition data structure */
int nblocks /**< number of blocks for decomposition */
);
/** gets the number of blocks for decomposition */
extern
int DECdecompGetNBlocks(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** copies the input subscipvars array to the given decomposition */
extern
SCIP_RETCODE DECdecompSetSubscipvars(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_VAR*** subscipvars, /**< subscipvars array */
int* nsubscipvars /**< number of subscipvars per block */
);
/** returns the subscipvars array of the given decomposition */
extern
SCIP_VAR*** DECdecompGetSubscipvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nsubscipvars array of the given decomposition */
extern
int* DECdecompGetNSubscipvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** copies the input subscipconss array to the given decomposition */
extern
SCIP_RETCODE DECdecompSetSubscipconss(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_CONS*** subscipconss, /**< subscipconss array */
int* nsubscipconss /**< number of subscipconss per block */
);
/** returns the subscipconss array of the given decomposition */
extern
SCIP_CONS*** DECdecompGetSubscipconss(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nsubscipconss array of the given decomposition */
extern
int* DECdecompGetNSubscipconss(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** copies the input linkingconss array to the given decomposition */
extern
SCIP_RETCODE DECdecompSetLinkingconss(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_CONS** linkingconss, /**< linkingconss array */
int nlinkingconss /**< number of linkingconss per block */
);
/** returns the linkingconss array of the given decomposition */
extern
SCIP_CONS** DECdecompGetLinkingconss(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nlinkingconss array of the given decomposition */
extern
int DECdecompGetNLinkingconss(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** copies the input linkingvars array to the given decomposition */
extern
SCIP_RETCODE DECdecompSetLinkingvars(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_VAR** linkingvars, /**< linkingvars array */
int nlinkingvars, /**< number of linkingvars per block */
int nfixedlinkingvars, /**< number of linking variables that are fixed */
int nmastervars /**< number of linkingvars that are purely master variables */
);
/** returns the linkingvars array of the given decomposition */
extern
SCIP_VAR** DECdecompGetLinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the number of master variables of the given decomposition */
extern
int DECdecompGetNMastervars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nlinkingvars array of the given decomposition */
extern
int DECdecompGetNLinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nlinkingvars array of the given decomposition */
extern
int DECdecompGetNFixedLinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** copies the input stairlinkingvars array to the given decomposition */
extern
SCIP_RETCODE DECdecompSetStairlinkingvars(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_VAR*** stairlinkingvars, /**< stairlinkingvars array */
int* nstairlinkingvars /**< number of linkingvars per block */
);
/** returns the stairlinkingvars array of the given decomposition */
extern
SCIP_VAR*** DECdecompGetStairlinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the nstairlinkingvars array of the given decomposition */
extern
int* DECdecompGetNStairlinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** returns the total number of stairlinkingvars array of the given decomposition */
int DECdecompGetNTotalStairlinkingvars(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the vartoblock hashmap of the given decomposition */
extern
void DECdecompSetVartoblock(
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* vartoblock /**< Vartoblock hashmap */
);
/** returns the vartoblock hashmap of the given decomposition */
extern
SCIP_HASHMAP* DECdecompGetVartoblock(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the constoblock hashmap of the given decomposition */
void DECdecompSetConstoblock(
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* constoblock /**< Constoblock hashmap */
);
/** returns the constoblock hashmap of the given decomposition */
extern
SCIP_HASHMAP* DECdecompGetConstoblock(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the varindex hashmap of the given decomposition */
void DECdecompSetVarindex(
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* varindex /**< Varindex hashmap */
);
/** returns the varindex hashmap of the given decomposition */
SCIP_HASHMAP* DECdecompGetVarindex(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the consindex hashmap of the given decomposition */
extern
void DECdecompSetConsindex(
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* consindex /**< Consindex hashmap */
);
/** returns the consindex hashmap of the given decomposition */
extern
SCIP_HASHMAP* DECdecompGetConsindex(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** completely initializes decomposition structure from the values of the hashmaps */
extern
SCIP_RETCODE DECfilloutDecompFromHashmaps(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* vartoblock, /**< variable to block hashmap */
SCIP_HASHMAP* constoblock, /**< constraint to block hashmap */
int nblocks, /**< number of blocks */
SCIP_Bool staircase /**< should the decomposition be a staircase structure */
);
/** completely fills out decomposition structure from only the constraint partition */
extern
SCIP_RETCODE DECfilloutDecompFromConstoblock(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_HASHMAP* constoblock, /**< constraint to block hashmap, start with 1 for first block and nblocks+1 for linking constraints */
int nblocks, /**< number of blocks */
SCIP_Bool staircase /**< should the decomposition be a staircase structure */
);
/** sets the detector for the given decomposition */
extern
void DECdecompSetDetector(
DEC_DECOMP* decomp, /**< decomposition data structure */
DEC_DETECTOR* detector /**< detector data structure */
);
/** gets the detector for the given decomposition */
extern
DEC_DETECTOR* DECdecompGetDetector(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** gets the detectors for the given decomposition */
extern
DEC_DETECTOR** DECdecompGetDetectorChain(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** gets the number of detectors for the given decomposition */
extern
int DECdecompGetDetectorChainSize(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** gets the id of the original partialdec */
extern
int DECdecompGetPartialdecID(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the detector clock times of the detectors of the detector chain */
extern
void DECdecompSetDetectorClockTimes(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* detectorClockTimes /**< time used by the detectors */
);
/** gets the detector clock times of the detectors of the detector chain */
extern
SCIP_Real* DECdecompGetDetectorClockTimes(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the detector clock times of the detectors of the detector chain */
extern
SCIP_RETCODE DECdecompSetDetectorChainString(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
const char* detectorchainstring /**< string for the detector information working on that decomposition */
);
extern
char* DECdecompGetDetectorChainString(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of variables assigned to the border of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctVarsToBorder(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctVarsToBorder
);
/** gets the percentages of variables assigned to the border of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctVarsToBorder(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of constraints assigned to the border of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctConssToBorder(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctConssToBorder
);
/** gets the percentages of constraints assigned to the border of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctConssToBorder(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of variables assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctVarsToBlock(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctVarsToBlock
);
/** gets the percentages of variables assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctVarsToBlock(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of constraints assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctConssToBlock(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctConssToBlock
);
/** gets the percentages of constraints assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctConssToBlock(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of variables assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctVarsFromOpen(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctVarsFromOpen
);
/** gets the percentages of variables assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctVarsFromOpen(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the percentages of constraints assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetDetectorPctConssFromOpen(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_Real* pctConssToBorder
);
/** gets the percentages of constraints assigned to some block of the corresponding detectors (of the detector chain) on this decomposition */
extern
SCIP_Real* DECdecompGetDetectorPctConssFromOpen(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** sets the number of new blocks of the corresponding detectors (of the detector chain) on this decomposition */
extern
void DECdecompSetNNewBlocks(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
int* nNewBlocks /**< number of new blocks on this decomposition */
);
/** gets the number of new blocks corresponding detectors (of the detector chain) on this decomposition */
extern
int* DECdecompGetNNewBlocks(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** transforms all constraints and variables, updating the arrays */
extern
SCIP_RETCODE DECdecompTransform(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/**
* Remove all those constraints that were removed from the problem after the decomposition had been created
*/
extern
SCIP_RETCODE DECdecompRemoveDeletedConss(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/**
* Adds all those constraints that were added to the problem after the decomposition as created
*/
extern
SCIP_RETCODE DECdecompAddRemainingConss(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** checks the validity of the decomposition data structure */
extern
SCIP_RETCODE DECdecompCheckConsistency(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** creates a decomposition with all constraints in the master */
extern
SCIP_RETCODE DECcreateBasicDecomp(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP** decomp, /**< decomposition data structure */
SCIP_Bool solveorigprob /**< is the original problem being solved? */
);
/** creates a decomposition with provided constraints in the master
* The function will put the remaining constraints in one or more pricing problems
* depending on whether the subproblems decompose with no variables in common.
*/
extern
SCIP_RETCODE DECcreateDecompFromMasterconss(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP** decomp, /**< decomposition data structure */
SCIP_CONS** conss, /**< constraints to be put in the master */
int nconss /**< number of constraints in the master */
);
/** return the number of variables and binary, integer, implied integer, continuous variables of all subproblems */
extern
void DECgetSubproblemVarsData(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
int* nvars, /**< pointer to array of size nproblems to store number of subproblem vars or NULL */
int* nbinvars, /**< pointer to array of size nproblems to store number of binary subproblem vars or NULL */
int* nintvars, /**< pointer to array of size nproblems to store number of integer subproblem vars or NULL */
int* nimplvars, /**< pointer to array of size nproblems to store number of implied subproblem vars or NULL */
int* ncontvars, /**< pointer to array of size nproblems to store number of continuous subproblem vars or NULL */
int nproblems /**< size of the arrays*/
);
/** return the number of variables and binary, integer, implied integer, continuous variables of the master */
extern
void DECgetLinkingVarsData(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
int* nvars, /**< pointer to store number of linking vars or NULL */
int* nbinvars, /**< pointer to store number of binary linking vars or NULL */
int* nintvars, /**< pointer to store number of integer linking vars or NULL */
int* nimplvars, /**< pointer to store number of implied linking vars or NULL */
int* ncontvars /**< pointer to store number of continuous linking vars or NULL */
);
/**
* returns the number of nonzeros of each column of the constraint matrix both in the subproblem and in the master
* @note For linking variables, the number of nonzeros in the subproblems corresponds to the number on nonzeros
* in the border
*
* @note The arrays have to be allocated by the caller
*
* @pre This function assumes that constraints are partitioned in the decomp structure, no constraint is present in more than one block
*
*/
extern
SCIP_RETCODE DECgetDensityData(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_VAR** vars, /**< pointer to array store variables belonging to density */
int nvars, /**< number of variables */
SCIP_CONS** conss, /**< pointer to array to store constraints belonging to the density */
int nconss, /**< number of constraints */
int* varsubproblemdensity, /**< pointer to array to store the nonzeros for the subproblems */
int* varmasterdensity, /**< pointer to array to store the nonzeros for the master */
int* conssubproblemdensity, /**< pointer to array to store the nonzeros for the subproblems */
int* consmasterdensity /**< pointer to array to store the nonzeros for the master */
);
/**
* calculates the number of up and down locks of variables for a given decomposition in both the original problem and the pricingproblems
*
* @note All arrays need to be allocated by the caller
*
* @warning This function needs a lot of memory (nvars*nblocks+1) array entries
*/
SCIP_RETCODE DECgetVarLockData(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_VAR** vars, /**< pointer to array store variables belonging to density */
int nvars, /**< number of variables */
int nsubproblems, /**< number of sub problems */
int** subsciplocksdown, /**< pointer to two dimensional array to store the down locks for the subproblems */
int** subsciplocksup, /**< pointer to two dimensional array to store the down locks for the subproblems */
int* masterlocksdown, /**< pointer to array to store the down locks for the master */
int* masterlocksup /**< pointer to array to store the down locks for the master */
);
/**
* returns the maximum white score ( if it is not calculated yet is decomp is evaluated)
*/
SCIP_Real DECgetMaxWhiteScore(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** computes the score of the given decomposition based on the border, the average density score and the ratio of
* linking variables
*/
extern
SCIP_RETCODE DECevaluateDecomposition(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
DEC_SCORES* score /**< returns the score of the decomposition */
);
/** returns the number of constraints saved in the decomposition */
int DECdecompGetNConss(
DEC_DECOMP* decomp /**< decomposition data structure */
);
/** display statistics about the decomposition */
extern
SCIP_RETCODE GCGprintDecompStatistics(
SCIP* scip, /**< SCIP data structure */
FILE* file, /**< output file or NULL for standard output */
DEC_DECOMP* decomp /**< decomp that should be evaluated */
);
/** returns whether both structures lead to the same decomposition */
extern
SCIP_Bool DECdecompositionsAreEqual(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp1, /**< first decomp data structure */
DEC_DECOMP* decomp2 /**< second decomp data structure */
);
/** filters similar decompositions from a given list and moves them to the end
* @return the number of unique decompositions
*/
extern
int DECfilterSimilarDecompositions(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP** decs, /**< array of decompositions */
int ndecs /**< number of decompositions */
);
/** returns the number of the block that the constraint is with respect to the decomposition */
extern
SCIP_RETCODE DECdetermineConsBlock(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_CONS* cons, /**< constraint to check */
int *block /**< block of the constraint (or nblocks for master) */
);
/** move a master constraint to pricing problem */
extern
SCIP_RETCODE DECdecompMoveLinkingConsToPricing(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
int consindex, /**< index of constraint to move */
int block /**< block of the pricing problem where to move */
);
/** tries to assign masterconss to pricing problem */
extern
SCIP_RETCODE DECtryAssignMasterconssToExistingPricing(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
int* transferred /**< number of master constraints reassigned */
);
/** tries to assign masterconss to new pricing problem */
extern
SCIP_RETCODE DECtryAssignMasterconssToNewPricing(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
DEC_DECOMP** newdecomp, /**< new decomposition, if successful */
int* transferred /**< number of master constraints reassigned */
);
/** polish the decomposition and try to greedily assign master constraints to pricing problem where useful */
extern
SCIP_RETCODE DECcreatePolishedDecomp(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
DEC_DECOMP** newdecomp /**< new decomposition, if successful */
);
/** permutes the decomposition according to the permutation seed */
extern
SCIP_RETCODE DECpermuteDecomp(
SCIP* scip, /**< SCIP data structure */
DEC_DECOMP* decomp, /**< decomposition data structure */
SCIP_RANDNUMGEN* randnumgen /**< random number generator */
);
/** gets the number of existing decompositions
*
* @returns number of decompositions
*/
extern
int DECgetNDecomps(
SCIP* scip /**< SCIP data structure */
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif