/usr/include/gecode/set.hh is in libgecode-dev 4.4.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 | /* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Guido Tack <tack@gecode.org>
* Christian Schulte <schulte@gecode.org>
*
* Contributing authors:
* Gabor Szokoli <szokoli@gecode.org>
*
* Copyright:
* Guido Tack, 2004
* Christian Schulte, 2004
* Gabor Szokoli, 2004
*
* Last modified:
* $Date: 2014-04-28 20:54:50 +0200 (Mon, 28 Apr 2014) $ by $Author: schulte $
* $Revision: 14116 $
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#ifndef __GECODE_SET_HH__
#define __GECODE_SET_HH__
#include <gecode/kernel.hh>
#include <gecode/int.hh>
#include <gecode/iter.hh>
/*
* Configure linking
*
*/
#if !defined(GECODE_STATIC_LIBS) && \
(defined(__CYGWIN__) || defined(__MINGW32__) || defined(_MSC_VER))
#ifdef GECODE_BUILD_SET
#define GECODE_SET_EXPORT __declspec( dllexport )
#else
#define GECODE_SET_EXPORT __declspec( dllimport )
#endif
#else
#ifdef GECODE_GCC_HAS_CLASS_VISIBILITY
#define GECODE_SET_EXPORT __attribute__ ((visibility("default")))
#else
#define GECODE_SET_EXPORT
#endif
#endif
// Configure auto-linking
#ifndef GECODE_BUILD_SET
#define GECODE_LIBRARY_NAME "Set"
#include <gecode/support/auto-link.hpp>
#endif
/**
* \namespace Gecode::Set
* \brief Finite integer sets
*
* The Gecode::Set namespace contains all functionality required
* to program propagators and branchers for finite integer sets.
* In addition, all propagators and branchers for finite integer
* sets provided by %Gecode are contained as nested namespaces.
*
*/
#include <gecode/set/exception.hpp>
namespace Gecode { namespace Set {
/// Numerical limits for set variables
namespace Limits {
/// Largest allowed integer in integer set
const int max = (Gecode::Int::Limits::max / 2) - 1;
/// Smallest allowed integer in integer set
const int min = -max;
/// Maximum cardinality of an integer set
const unsigned int card = max-min+1;
/// Check whether integer \a n is in range, otherwise throw overflow exception with information \a l
void check(int n, const char* l);
/// Check whether unsigned int \a n is in range for cardinality, otherwise throw overflow exception with information \a l
void check(unsigned int n, const char* l);
/// Check whether minimum and maximum of IntSet \a s is in range, otherwise throw overflow exception with information \a l
void check(const IntSet& s, const char* l);
}
}}
#include <gecode/set/limits.hpp>
#include <gecode/set/var-imp.hpp>
namespace Gecode {
namespace Set {
class SetView;
}
/**
* \brief %Set variables
*
* \ingroup TaskModelSetVars
*/
class SetVar : public VarImpVar<Set::SetVarImp> {
friend class SetVarArray;
friend class SetVarArgs;
using VarImpVar<Set::SetVarImp>::x;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVar(void);
/// Initialize from set variable \a y
SetVar(const SetVar& y);
/// Initialize from set view \a y
SetVar(const Set::SetView& y);
/// Initialize variable with empty greatest lower and full least upper bound
GECODE_SET_EXPORT SetVar(Space& home);
/**
* \brief Initialize variable with given bounds and cardinality
*
* The variable is created with
* greatest lower bound \f$\{\mathit{glbMin},\dots,\mathit{glbMax}\}\f$,
* least upper bound \f$\{\mathit{lubMin},\dots,\mathit{lubMax}\}\f$, and
* cardinality minimum \a cardMin and maximum \a cardMax.
* The following exceptions might be thrown:
* - If the bounds are no legal set bounds (between Set::Limits::min
* and Set::Limits::max), an exception of type
* Gecode::Set::OutOfLimits is thrown.
* - If the cardinality is greater than Set::Limits::max_set_size, an
* exception of type Gecode::Set::OutOfLimits is
* thrown.
* - If \a cardMin > \a cardMax, an exception of type
* Gecode::Set::VariableEmptyDomain is thrown.
*/
GECODE_SET_EXPORT
SetVar(Space& home,int glbMin,int glbMax,int lubMin,int lubMax,
unsigned int cardMin = 0,
unsigned int cardMax = Set::Limits::card);
/**
* \brief Initialize variable with given bounds and cardinality
*
* The variable is created with greatest lower bound \a glbD,
* least upper bound \f$\{\mathit{lubMin},\dots,\mathit{lubMax}\}\f$, and
* cardinality minimum \a cardMin and maximum \a cardMax.
* The following exceptions might be thrown:
* - If the bounds are no legal set bounds (between Set::Limits::min
* and Set::Limits::max), an exception of type
* Gecode::Set::OutOfLimits is thrown.
* - If the cardinality is greater than Set::Limits::max_set_size, an
* exception of type Gecode::Set::OutOfLimits is
* thrown.
* - If \a cardMin > \a cardMax, an exception of type
* Gecode::Set::VariableEmptyDomain is thrown.
*/
GECODE_SET_EXPORT
SetVar(Space& home,const IntSet& glbD,int lubMin,int lubMax,
unsigned int cardMin = 0,
unsigned int cardMax = Set::Limits::card);
/**
* \brief Initialize variable with given bounds and cardinality
*
* The variable is created with
* greatest lower bound \f$\{\mathit{glbMin},\dots,\mathit{glbMax}\}\f$,
* least upper bound \a lubD, and
* cardinality minimum \a cardMin and maximum \a cardMax.
* The following exceptions might be thrown:
* - If the bounds are no legal set bounds (between Set::Limits::min
* and Set::Limits::max), an exception of type
* Gecode::Set::OutOfLimits is thrown.
* - If the cardinality is greater than Set::Limits::max_set_size, an
* exception of type Gecode::Set::OutOfLimits is
* thrown.
* - If \a minCard > \a maxCard, an exception of type
* Gecode::Set::VariableEmptyDomain is thrown.
*/
GECODE_SET_EXPORT
SetVar(Space& home,int glbMin,int glbMax,const IntSet& lubD,
unsigned int cardMin = 0,
unsigned int cardMax = Set::Limits::card);
/**
* \brief Initialize variable with given bounds and cardinality
*
* The variable is created with
* greatest lower bound \a glbD,
* least upper bound \a lubD, and
* cardinality minimum \a cardMin and maximum \a cardMax.
* The following exceptions might be thrown:
* - If the bounds are no legal set bounds (between Set::Limits::min
* and Set::Limits::max), an exception of type
* Gecode::Set::OutOfLimits is thrown.
* - If the cardinality is greater than Set::Limits::max_set_size, an
* exception of type Gecode::Set::OutOfLimits is
* thrown.
* - If \a minCard > \a maxCard, an exception of type
* Gecode::Set::VariableEmptyDomain is thrown.
*/
GECODE_SET_EXPORT
SetVar(Space& home,const IntSet& glbD,const IntSet& lubD,
unsigned int cardMin = 0,
unsigned int cardMax = Set::Limits::card);
//@}
/// \name Value access
//@{
/// Return number of elements in the greatest lower bound
unsigned int glbSize(void) const;
/// Return number of elements in the least upper bound
unsigned int lubSize(void) const;
/// Return number of unknown elements (elements in lub but not in glb)
unsigned int unknownSize(void) const;
/// Return cardinality minimum
unsigned int cardMin(void) const;
/// Return cardinality maximum
unsigned int cardMax(void) const;
/// Return minimum element of least upper bound
int lubMin(void) const;
/// Return maximum element of least upper bound
int lubMax(void) const;
/// Return minimum element of greatest lower bound
int glbMin(void) const;
/// Return maximum of greatest lower bound
int glbMax(void) const;
//@}
/// \name Domain tests
//@{
/// Test whether \a i is in greatest lower bound
bool contains(int i) const;
/// Test whether \a i is not in the least upper bound
bool notContains(int i) const;
//@}
};
/**
* \defgroup TaskModelSetIter Range and value iterators for set variables
* \ingroup TaskModelSet
*/
//@{
/// Iterator for the greatest lower bound ranges of a set variable
class SetVarGlbRanges {
private:
Set::GlbRanges<Set::SetVarImp*> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarGlbRanges(void);
/// Initialize to iterate ranges of variable \a x
SetVarGlbRanges(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a range or done
bool operator ()(void) const;
/// Move iterator to next range (if possible)
void operator ++(void);
//@}
/// \name Range access
//@{
/// Return smallest value of range
int min(void) const;
/// Return largest value of range
int max(void) const;
/// Return width of range (distance between minimum and maximum)
unsigned int width(void) const;
//@}
};
/// Iterator for the least upper bound ranges of a set variable
class SetVarLubRanges {
private:
Set::LubRanges<Set::SetVarImp*> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarLubRanges(void);
/// Initialize to iterate ranges of variable \a x
SetVarLubRanges(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a range or done
bool operator ()(void) const;
/// Move iterator to next range (if possible)
void operator ++(void);
//@}
/// \name Range access
//@{
/// Return smallest value of range
int min(void) const;
/// Return largest value of range
int max(void) const;
/// Return width of range (distance between minimum and maximum)
unsigned int width(void) const;
//@}
};
/// Iterator for the unknown ranges of a set variable
class SetVarUnknownRanges {
private:
Set::UnknownRanges<Set::SetVarImp*> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarUnknownRanges(void);
/// Initialize to iterate ranges of variable \a x
SetVarUnknownRanges(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a range or done
bool operator ()(void) const;
/// Move iterator to next range (if possible)
void operator ++(void);
//@}
/// \name Range access
//@{
/// Return smallest value of range
int min(void) const;
/// Return largest value of range
int max(void) const;
/// Return width of range (distance between minimum and maximum)
unsigned int width(void) const;
//@}
};
/// Iterator for the values in the greatest lower bound of a set variable
class SetVarGlbValues {
private:
Iter::Ranges::ToValues<SetVarGlbRanges> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarGlbValues(void);
/// Initialize to iterate values of variable \a x
SetVarGlbValues(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a value or done
bool operator ()(void) const;
/// Move iterator to next value (if possible)
void operator ++(void);
//@}
/// \name Value access
//@{
/// Return current value
int val(void) const;
//@}
};
/// Iterator for the values in the least upper bound of a set variable
class SetVarLubValues {
private:
Iter::Ranges::ToValues<SetVarLubRanges> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarLubValues(void);
/// Initialize to iterate values of variable \a x
SetVarLubValues(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a value or done
bool operator ()(void) const;
/// Move iterator to next value (if possible)
void operator ++(void);
//@}
/// \name Value access
//@{
/// Return current value
int val(void) const;
//@}
};
/// Iterator for the values in the unknown set of a set variable
class SetVarUnknownValues {
private:
Iter::Ranges::ToValues<SetVarUnknownRanges> iter;
public:
/// \name Constructors and initialization
//@{
/// Default constructor
SetVarUnknownValues(void);
/// Initialize to iterate values of variable \a x
SetVarUnknownValues(const SetVar& x);
//@}
/// \name Iteration control
//@{
/// Test whether iterator is still at a value or done
bool operator ()(void) const;
/// Move iterator to next value (if possible)
void operator ++(void);
//@}
/// \name Value access
//@{
/// Return current value
int val(void) const;
//@}
};
//@}
/**
* \brief Print set variable \a x
* \relates Gecode::SetVar
*/
template<class Char, class Traits>
std::basic_ostream<Char,Traits>&
operator <<(std::basic_ostream<Char,Traits>& os, const SetVar& x);
}
#include <gecode/set/view.hpp>
namespace Gecode {
/**
* \defgroup TaskModelSetArgs Argument arrays
*
* Argument arrays are just good enough for passing arguments
* with automatic memory management.
* \ingroup TaskModelSet
*/
//@{
}
#include <gecode/set/array-traits.hpp>
namespace Gecode {
/** \brief Passing set variables
*
* We could have used a simple typedef instead, but doxygen cannot
* resolve some overloading then, leading to unusable documentation for
* important parts of the library. As long as there is no fix for this,
* we will keep this workaround.
*
*/
class SetVarArgs : public VarArgArray<SetVar> {
public:
/// \name Constructors and initialization
//@{
/// Allocate empty array
SetVarArgs(void) {}
/// Allocate array with \a n elements
explicit SetVarArgs(int n) : VarArgArray<SetVar>(n) {}
/// Initialize from variable argument array \a a (copy elements)
SetVarArgs(const SetVarArgs& a) : VarArgArray<SetVar>(a) {}
/// Initialize from variable array \a a (copy elements)
SetVarArgs(const VarArray<SetVar>& a) : VarArgArray<SetVar>(a) {}
/// Initialize from vector \a a
SetVarArgs(const std::vector<SetVar>& a) : VarArgArray<SetVar>(a) {}
/// Initialize from InputIterator \a first and \a last
template<class InputIterator>
SetVarArgs(InputIterator first, InputIterator last)
: VarArgArray<SetVar>(first,last) {}
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArgs(Space& home,int n,int glbMin,int glbMax,
int lubMin,int lubMax,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArgs(Space& home,int n,const IntSet& glb,
int lubMin, int lubMax,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArgs(Space& home,int n,int glbMin,int glbMax,
const IntSet& lub,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArgs(Space& home,int n,
const IntSet& glb,const IntSet& lub,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
//@}
};
//@}
/**
* \defgroup TaskModelSetVarArrays Variable arrays
*
* Variable arrays can store variables. They are typically used
* for storing the variables being part of a solution. However,
* they can also be used for temporary purposes (even though
* memory is not reclaimed until the space it is created for
* is deleted).
* \ingroup TaskModelSet
*/
/**
* \brief %Set variable array
* \ingroup TaskModelSetVarArrays
*/
class SetVarArray : public VarArray<SetVar> {
public:
/// \name Creation and initialization
//@{
/// Default constructor (array of size 0)
SetVarArray(void);
/// Initialize from set variable array \a a (share elements)
SetVarArray(const SetVarArray&);
/// Initialize from set variable argument array \a a (copy elements)
SetVarArray(Space& home, const SetVarArgs&);
/// Allocate array for \a n set variables (variables are uninitialized)
GECODE_SET_EXPORT SetVarArray(Space& home, int n);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArray(Space& home,int n,int glbMin,int glbMax,int lubMin,int lubMax,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArray(Space& home,int n,const IntSet& glb, int lubMin, int lubMax,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArray(Space& home,int n,int glbMin,int glbMax,const IntSet& lub,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
/**
* \brief Create an array of size \a n.
*
* Each variable is initialized with the bounds and cardinality as
* given by the arguments.
*/
GECODE_SET_EXPORT
SetVarArray(Space& home,int n,
const IntSet& glb,const IntSet& lub,
unsigned int minCard = 0,
unsigned int maxCard = Set::Limits::card);
//@}
};
}
#include <gecode/set/array.hpp>
namespace Gecode {
/**
* \brief Common relation types for sets
*
* The total order on sets is defined as the lexicographic
* order on their characteristic functions, e.g.,
* \f$x\leq y\f$ means that either \f$x\f$ is empty or
* the minimal element of the symmetric difference
* \f$x\ominus y\f$ is in \f$y\f$.
*
* \ingroup TaskModelSet
*/
enum SetRelType {
SRT_EQ, ///< Equality (\f$=\f$)
SRT_NQ, ///< Disequality (\f$\neq\f$)
SRT_SUB, ///< Subset (\f$\subseteq\f$)
SRT_SUP, ///< Superset (\f$\supseteq\f$)
SRT_DISJ, ///< Disjoint (\f$\parallel\f$)
SRT_CMPL, ///< Complement
SRT_LQ, ///< Less or equal (\f$\leq\f$)
SRT_LE, ///< Less (\f$<\f$)
SRT_GQ, ///< Greater or equal (\f$\geq\f$)
SRT_GR ///< Greater (\f$>\f$)
};
/**
* \brief Common operations for sets
* \ingroup TaskModelSet
*/
enum SetOpType {
SOT_UNION, ///< Union
SOT_DUNION, ///< Disjoint union
SOT_INTER, ///< %Intersection
SOT_MINUS ///< Difference
};
/**
* \defgroup TaskModelSetDom Domain constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Propagates \f$ x \sim_r \{i\}\f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType r, int i);
/// Propagates \f$ x_i \sim_r \{i\}\f$ for all \f$0\leq i<|x|\f$
GECODE_SET_EXPORT void
dom(Home home, const SetVarArgs& x, SetRelType r, int i);
/// Propagates \f$ x \sim_r \{i,\dots,j\}\f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType r, int i, int j);
/// Propagates \f$ x \sim_r \{i,\dots,j\}\f$ for all \f$0\leq i<|x|\f$
GECODE_SET_EXPORT void
dom(Home home, const SetVarArgs& x, SetRelType r, int i, int j);
/// Propagates \f$ x \sim_r s\f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType r, const IntSet& s);
/// Propagates \f$ x \sim_r s\f$ for all \f$0\leq i<|x|\f$
GECODE_SET_EXPORT void
dom(Home home, const SetVarArgs& x, SetRelType r, const IntSet& s);
/// Propagates \f$ i \leq |s| \leq j \f$
GECODE_SET_EXPORT void
cardinality(Home home, SetVar x, unsigned int i, unsigned int j);
/// Propagates \f$ i \leq |s| \leq j \f$ for all \f$0\leq i<|x|\f$
GECODE_SET_EXPORT void
cardinality(Home home, const SetVarArgs& x, unsigned int i, unsigned int j);
/// Post propagator for \f$ (x \sim_{rt} \{i\}) \equiv r \f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType rt, int i, Reify r);
/// Post propagator for \f$ (x \sim_{rt} \{i,\dots,j\}) \equiv r \f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType rt, int i, int j, Reify r);
/// Post propagator for \f$ (x \sim_{rt} s) \equiv r \f$
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetRelType rt, const IntSet& s, Reify r);
/// Constrain domain of \a x according to domain of \a d
GECODE_SET_EXPORT void
dom(Home home, SetVar x, SetVar d);
/// Constrain domain of \f$ x_i \f$ according to domain of \f$ d_i \f$ for all \f$0\leq i<|x|\f$
GECODE_SET_EXPORT void
dom(Home home, const SetVarArgs& x, const SetVarArgs& d);
//@}
/**
* \defgroup TaskModelSetRel Relation constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator for \f$ x \sim_r y\f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetRelType r, SetVar y);
/// Post propagator for \f$ (x \sim_{rt} y) \equiv r\f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetRelType rt, SetVar y, Reify r);
/// Post propagator for \f$ s \sim_r \{x\}\f$
GECODE_SET_EXPORT void
rel(Home home, SetVar s, SetRelType r, IntVar x);
/// Post propagator for \f$ \{x\} \sim_r s\f$
GECODE_SET_EXPORT void
rel(Home home, IntVar x, SetRelType r, SetVar s);
/// Post propagator for \f$ (s \sim_{rt} \{x\}) \equiv r\f$
GECODE_SET_EXPORT void
rel(Home home, SetVar s, SetRelType rt, IntVar x, Reify r);
/// Post propagator for \f$ (\{x\} \sim_{rt} s) \equiv r \f$
GECODE_SET_EXPORT void
rel(Home home, IntVar x, SetRelType rt, SetVar s, Reify r);
/// Post propagator for \f$|s|\geq 1 \land \forall i\in s:\ i \sim_r x\f$
GECODE_SET_EXPORT void
rel(Home home, SetVar s, IntRelType r, IntVar x);
/// Post propagator for \f$|s|\geq 1 \land \forall i\in s:\ x \sim_r i\f$
GECODE_SET_EXPORT void
rel(Home home, IntVar x, IntRelType r, SetVar s);
//@}
/**
* \defgroup TaskModelSetRelOp Set operation/relation constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetOpType op, SetVar y, SetRelType r, SetVar z);
/// Post propagator for \f$ y = \diamond_{\mathit{op}} x\f$
GECODE_SET_EXPORT void
rel(Home home, SetOpType op, const SetVarArgs& x, SetVar y);
/// Post propagator for \f$ y = \diamond_{\mathit{op}} x \diamond_{\mathit{op}} z\f$
GECODE_SET_EXPORT void
rel(Home home, SetOpType op, const SetVarArgs& x, const IntSet& z, SetVar y);
/// Post propagator for \f$ y = \diamond_{\mathit{op}} x \diamond_{\mathit{op}} z\f$
GECODE_SET_EXPORT void
rel(Home home, SetOpType op, const IntVarArgs& x, const IntSet& z, SetVar y);
/// Post propagator for \f$ y = \diamond_{\mathit{op}} x\f$
GECODE_SET_EXPORT void
rel(Home home, SetOpType op, const IntVarArgs& x, SetVar y);
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, const IntSet& x, SetOpType op, SetVar y,
SetRelType r, SetVar z);
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetOpType op, const IntSet& y,
SetRelType r, SetVar z);
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetOpType op, SetVar y,
SetRelType r, const IntSet& z);
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, const IntSet& x, SetOpType op, SetVar y, SetRelType r,
const IntSet& z);
/// Post propagator for \f$ (x \diamond_{\mathit{op}} y) \sim_r z \f$
GECODE_SET_EXPORT void
rel(Home home, SetVar x, SetOpType op, const IntSet& y, SetRelType r,
const IntSet& z);
//@}
/**
* \defgroup TaskModelSetConvex Convexity constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator that propagates that \a x is convex
GECODE_SET_EXPORT void
convex(Home home, SetVar x);
/// Post propagator that propagates that \a y is the convex hull of \a x
GECODE_SET_EXPORT void
convex(Home home, SetVar x, SetVar y);
//@}
/**
* \defgroup TaskModelSetSequence Sequence constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator for \f$\forall 0\leq i< |x|-1 : \max(x_i)<\min(x_{i+1})\f$
GECODE_SET_EXPORT void
sequence(Home home, const SetVarArgs& x);
/// Post propagator for \f$\forall 0\leq i< |x|-1 : \max(x_i)<\min(x_{i+1})\f$ and \f$ x = \bigcup_{i\in\{0,\dots,n-1\}} y_i \f$
GECODE_SET_EXPORT void
sequence(Home home, const SetVarArgs& y, SetVar x);
//@}
/**
* \defgroup TaskModelSetDistinct Distinctness constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator for \f$\forall 0\leq i\leq |x| : |x_i|=c\f$ and \f$\forall 0\leq i<j\leq |x| : |x_i\cap x_j|\leq 1\f$
GECODE_SET_EXPORT void
atmostOne(Home home, const SetVarArgs& x, unsigned int c);
//@}
/**
* \defgroup TaskModelSetConnect Connection constraints to integer variables
* \ingroup TaskModelSet
*
*/
//@{
/** \brief Post propagator that propagates that \a x is the
* minimal element of \a s, and that \a s is not empty */
GECODE_SET_EXPORT void
min(Home home, SetVar s, IntVar x);
/** \brief Post propagator that propagates that \a x is not the
* minimal element of \a s */
GECODE_SET_EXPORT void
notMin(Home home, SetVar s, IntVar x);
/** \brief Post reified propagator for \a b iff \a x is the
* minimal element of \a s */
GECODE_SET_EXPORT void
min(Home home, SetVar s, IntVar x, Reify r);
/** \brief Post propagator that propagates that \a x is the
* maximal element of \a s, and that \a s is not empty */
GECODE_SET_EXPORT void
max(Home home, SetVar s, IntVar x);
/** \brief Post propagator that propagates that \a x is not the
* maximal element of \a s */
GECODE_SET_EXPORT void
notMax(Home home, SetVar s, IntVar x);
/** \brief Post reified propagator for \a b iff \a x is the
* maximal element of \a s */
GECODE_SET_EXPORT void
max(Home home, SetVar s, IntVar x, Reify r);
/// Post propagator for \f$ |s|=x \f$
GECODE_SET_EXPORT void
cardinality(Home home, SetVar s, IntVar x);
/**
* \brief Post propagator for \f$y = \mathrm{weight}(x)\f$
*
* The weights are given as pairs of elements and their weight:
* \f$\mathrm{weight}(\mathrm{elements}_i) = \mathrm{weights}_i\f$
*
* The upper bound of \a x is constrained to contain only elements from
* \a elements. The weight of a set is the sum of the weights of its
* elements.
*/
GECODE_SET_EXPORT void
weights(Home home, IntSharedArray elements, IntSharedArray weights,
SetVar x, IntVar y);
//@}
/**
* \defgroup TaskModelSetChannel Channel constraints
* \ingroup TaskModelSet
*
*/
//@{
/// Post propagator for \f$x_i=j \Leftrightarrow i\in y_j\f$
GECODE_SET_EXPORT void
channel(Home home, const IntVarArgs& x,const SetVarArgs& y);
/// Post propagator for \f$\{x_0,\dots,x_{n-1}\}=y\f$ and \f$x_i<x_{i+1}\f$
GECODE_SET_EXPORT void
channelSorted(Home home, const IntVarArgs& x, SetVar y);
/// Post propagator for \f$x_i=1 \Leftrightarrow i\in y\f$
GECODE_SET_EXPORT void
channel(Home home, const BoolVarArgs& x, SetVar y);
/// Post propagator for \f$j\in x_i \Leftrightarrow i\in y_j\f$
GECODE_SET_EXPORT void
channel(Home home, const SetVarArgs& x, const SetVarArgs& y);
//@}
/**
* \defgroup TaskModelSetPrecede Value precedence constraints over set variables
* \ingroup TaskModelSet
*/
/** \brief Post propagator that \a s precedes \a t in \a x
*
* This constraint enforces that if there exists \f$j\f$ such that
* \f$s\notin x_j\land t\in x_j\f$, then there exists \f$i<j\f$ such that
* \f$s\in x_i\land t\notin x_i\f$.
* \ingroup TaskModelSetPrecede
*/
GECODE_SET_EXPORT void
precede(Home home, const SetVarArgs& x, int s, int t);
/** \brief Post propagator that successive values in \a c precede each other in \a x
* \ingroup TaskModelSetPrecede
*/
GECODE_SET_EXPORT void
precede(Home home, const SetVarArgs& x, const IntArgs& c);
/**
* \defgroup TaskModelSetElement Element constraints
* \ingroup TaskModelSet
*
* An element constraint selects zero, one or more elements out of a
* sequence. We write \f$ \langle x_0,\dots, x_{n-1} \rangle \f$ for the
* sequence, and \f$ [y] \f$ for the index variable.
*
* Set element constraints are closely related to the ::element constraint
* on integer variables.
*/
//@{
/**
* \brief Post propagator for \f$ z=\diamond_{\mathit{op}}\langle x_0,\dots,x_{n-1}\rangle[y] \f$
*
* If \a y is the empty set, the usual conventions for set operations apply:
* an empty union is empty, while an empty intersection is the universe,
* which can be given as the optional parameter \a u.
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, SetOpType op, const SetVarArgs& x, SetVar y, SetVar z,
const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));
/**
* \brief Post propagator for \f$ z=\diamond_{\mathit{op}}\langle \{x_0\},\dots,\{x_{n-1}\}\rangle[y] \f$
*
* If \a y is the empty set, the usual conventions for set operations apply:
* an empty union is empty, while an empty intersection is the universe,
* which can be given as the optional parameter \a u.
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, SetOpType op, const IntVarArgs& x, SetVar y, SetVar z,
const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));
/**
* \brief Post propagator for \f$ z=\diamond_{\mathit{op}}\langle x_0,\dots,x_{n-1}\rangle[y] \f$
*
* If \a y is the empty set, the usual conventions for set operations apply:
* an empty union is empty, while an empty intersection is the universe,
* which can be given as the optional parameter \a u.
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, SetOpType op, const IntSetArgs& x, SetVar y, SetVar z,
const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));
/**
* \brief Post propagator for \f$ z=\diamond_{\mathit{op}}\langle \{x_0\},\dots,\{x_{n-1}\}\rangle[y] \f$
*
* If \a y is the empty set, the usual conventions for set operations apply:
* an empty union is empty, while an empty intersection is the universe,
* which can be given as the optional parameter \a u.
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, SetOpType op, const IntArgs& x, SetVar y, SetVar z,
const IntSet& u = IntSet(Set::Limits::min,Set::Limits::max));
/**
* \brief Post propagator for \f$ z=\langle x_0,\dots,x_{n-1}\rangle[y] \f$
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, const SetVarArgs& x, IntVar y, SetVar z);
/**
* \brief Post propagator for \f$ z=\langle s_0,\dots,s_{n-1}\rangle[y] \f$
*
* The indices for \a y start at 0.
*/
GECODE_SET_EXPORT void
element(Home home, const IntSetArgs& s, IntVar y, SetVar z);
/** \brief Post propagator for \f$ a_{x+w\cdot y}=z\f$
*
* Throws an exception of type Set::ArgumentSizeMismatch, if
* \f$ w\cdot h\neq|a|\f$.
*/
GECODE_SET_EXPORT void
element(Home home, const IntSetArgs& a,
IntVar x, int w, IntVar y, int h, SetVar z);
/** \brief Post propagator for \f$ a_{x+w\cdot y}=z\f$
*
* Throws an exception of type Set::ArgumentSizeMismatch, if
* \f$ w\cdot h\neq|a|\f$.
*/
GECODE_SET_EXPORT void
element(Home home, const SetVarArgs& a,
IntVar x, int w, IntVar y, int h, SetVar z);
//@}
/**
* \defgroup TaskModelSetExec Synchronized execution
* \ingroup TaskModelSet
*
* Synchronized execution executes a function or a static member function
* when a certain event happends.
*
* \ingroup TaskModelSet
*/
//@{
/// Execute \a c when \a x becomes assigned
GECODE_SET_EXPORT void
wait(Home home, SetVar x, void (*c)(Space& home));
/// Execute \a c when all variables in \a x become assigned
GECODE_SET_EXPORT void
wait(Home home, const SetVarArgs& x, void (*c)(Space& home));
//@}
}
namespace Gecode {
/**
* \defgroup TaskModelSetBranch Branching
* \ingroup TaskModelSet
*/
/**
* \brief Branch filter function type for set variables
*
* The variable \a x is considered for selection and \a i refers to the
* variable's position in the original array passed to the brancher.
*
* \ingroup TaskModelSetBranch
*/
typedef bool (*SetBranchFilter)(const Space& home, SetVar x, int i);
/**
* \brief Branch merit function type for set variables
*
* The function must return a merit value for the variable
* \a x.
* The value \a i refers to the variable's position in the original array
* passed to the brancher.
*
* \ingroup TaskModelSetBranch
*/
typedef double (*SetBranchMerit)(const Space& home, SetVar x, int i);
/**
* \brief Branch value function type for set variables
*
* Returns a value for the variable \a x that is to be used in the
* corresponding branch commit function. The integer \a i refers
* to the variable's position in the original array passed to the
* brancher.
*
* \ingroup TaskModelSetBranch
*/
typedef int (*SetBranchVal)(const Space& home, SetVar x, int i);
/**
* \brief Branch commit function type for set variables
*
* The function must post a constraint on the variable \a x which
* corresponds to the alternative \a a. The integer \a i refers
* to the variable's position in the original array passed to the
* brancher. The value \a n is the value
* computed by the corresponding branch value function.
*
* \ingroup TaskModelSetBranch
*/
typedef void (*SetBranchCommit)(Space& home, unsigned int a,
SetVar x, int i, int n);
}
#include <gecode/set/branch/traits.hpp>
namespace Gecode {
/**
* \brief Recording AFC information for set variables
*
* \ingroup TaskModelSetBranch
*/
class SetAFC : public AFC {
public:
/**
* \brief Construct as not yet initialized
*
* The only member functions that can be used on a constructed but not
* yet initialized AFC storage is init or the assignment operator.
*
*/
SetAFC(void);
/// Copy constructor
SetAFC(const SetAFC& a);
/// Assignment operator
SetAFC& operator =(const SetAFC& a);
/// Initialize for set variables \a x with decay factor \a d
SetAFC(Home home, const SetVarArgs& x, double d=1.0);
/**
* \brief Initialize for set variables \a x with decay factor \a d
*
* This member function can only be used once and only if the
* AFC storage has been constructed with the default constructor.
*
*/
void init(Home, const SetVarArgs& x, double d=1.0);
};
}
#include <gecode/set/branch/afc.hpp>
namespace Gecode {
/**
* \brief Recording activities for set variables
*
* \ingroup TaskModelSetBranch
*/
class SetActivity : public Activity {
public:
/**
* \brief Construct as not yet initialized
*
* The only member functions that can be used on a constructed but not
* yet initialized activity storage is init or the assignment operator.
*
*/
SetActivity(void);
/// Copy constructor
SetActivity(const SetActivity& a);
/// Assignment operator
SetActivity& operator =(const SetActivity& a);
/**
* \brief Initialize for set variables \a x with decay factor \a d
*
* If the branch merit function \a bm is different from NULL, the
* activity for each variable is initialized with the merit returned
* by \a bm.
*
*/
GECODE_SET_EXPORT
SetActivity(Home home, const SetVarArgs& x, double d=1.0,
SetBranchMerit bm=NULL);
/**
* \brief Initialize for set variables \a x with decay factor \a d
*
* If the branch merit function \a bm is different from NULL, the
* activity for each variable is initialized with the merit returned
* by \a bm.
*
* This member function can only be used once and only if the
* activity storage has been constructed with the default constructor.
*
*/
GECODE_SET_EXPORT void
init(Home, const SetVarArgs& x, double d=1.0,
SetBranchMerit bm=NULL);
};
}
#include <gecode/set/branch/activity.hpp>
namespace Gecode {
/// Function type for printing branching alternatives for set variables
typedef void (*SetVarValPrint)(const Space &home, const BrancherHandle& bh,
unsigned int a,
SetVar x, int i, const int& n,
std::ostream& o);
}
namespace Gecode {
/**
* \brief Which variable to select for branching
*
* \ingroup TaskModelSetBranch
*/
class SetVarBranch : public VarBranch {
public:
/// Which variable selection
enum Select {
SEL_NONE = 0, ///< First unassigned
SEL_RND, ///< Random (uniform, for tie breaking)
SEL_MERIT_MIN, ///< With least merit
SEL_MERIT_MAX, ///< With highest merit
SEL_DEGREE_MIN, ///< With smallest degree
SEL_DEGREE_MAX, ///< With largest degree
SEL_AFC_MIN, ///< With smallest accumulated failure count
SEL_AFC_MAX, ///< With largest accumulated failure count
SEL_ACTIVITY_MIN, ///< With lowest activity
SEL_ACTIVITY_MAX, ///< With highest activity
SEL_MIN_MIN, ///< With smallest minimum unknown element
SEL_MIN_MAX, ///< With largest minimum unknown element
SEL_MAX_MIN, ///< With smallest maximum unknown element
SEL_MAX_MAX, ///< With largest maximum unknown element
SEL_SIZE_MIN, ///< With smallest unknown set
SEL_SIZE_MAX, ///< With largest unknown set
SEL_DEGREE_SIZE_MIN, ///< With smallest degree divided by domain size
SEL_DEGREE_SIZE_MAX, ///< With largest degree divided by domain size
SEL_AFC_SIZE_MIN, ///< With smallest accumulated failure count divided by domain size
SEL_AFC_SIZE_MAX, ///< With largest accumulated failure count divided by domain size
SEL_ACTIVITY_SIZE_MIN, ///< With smallest activity divided by domain size
SEL_ACTIVITY_SIZE_MAX ///< With largest activity divided by domain size
};
protected:
/// Which variable to select
Select s;
public:
/// Initialize with strategy SEL_NONE
SetVarBranch(void);
/// Initialize with random number generator \a r
SetVarBranch(Rnd r);
/// Initialize with selection strategy \a s and tie-break limit function \a t
SetVarBranch(Select s, BranchTbl t);
/// Initialize with selection strategy \a s, decay factor \a d, and tie-break limit function \a t
SetVarBranch(Select s, double d, BranchTbl t);
/// Initialize with selection strategy \a s, afc \a a, and tie-break limit function \a t
SetVarBranch(Select s, AFC a, BranchTbl t);
/// Initialize with selection strategy \a s, activity \a a, and tie-break limit function \a t
SetVarBranch(Select s, Activity a, BranchTbl t);
/// Initialize with selection strategy \a s, branch merit function \a mf, and tie-break limit function \a t
SetVarBranch(Select s, VoidFunction mf, BranchTbl t);
/// Return selection strategy
Select select(void) const;
/// Expand decay factor into AFC or activity
void expand(Home home, const SetVarArgs& x);
};
/**
* \defgroup TaskModelSetBranchVar Selecting set variables
* \ingroup TaskModelSetBranch
*/
//@{
/// Select first unassigned variable
SetVarBranch SET_VAR_NONE(void);
/// Select random variable (uniform distribution, for tie breaking)
SetVarBranch SET_VAR_RND(Rnd r);
/// Select variable with least merit according to branch merit function \a bm
SetVarBranch SET_VAR_MERIT_MIN(SetBranchMerit bm, BranchTbl tbl=NULL);
/// Select variable with highest merit according to branch merit function \a bm
SetVarBranch SET_VAR_MERIT_MAX(SetBranchMerit bm, BranchTbl tbl=NULL);
/// Select variable with smallest degree
SetVarBranch SET_VAR_DEGREE_MIN(BranchTbl tbl=NULL);
/// Select variable with largest degree
SetVarBranch SET_VAR_DEGREE_MAX(BranchTbl tbl=NULL);
/// Select variable with smallest accumulated failure count with decay factor \a d
SetVarBranch SET_VAR_AFC_MIN(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with smallest accumulated failure count
SetVarBranch SET_VAR_AFC_MIN(SetAFC a, BranchTbl tbl=NULL);
/// Select variable with largest accumulated failure count with decay factor \a d
SetVarBranch SET_VAR_AFC_MAX(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with largest accumulated failure count
SetVarBranch SET_VAR_AFC_MAX(SetAFC a, BranchTbl tbl=NULL);
/// Select variable with lowest activity with decay factor \a d
SetVarBranch SET_VAR_ACTIVITY_MIN(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with lowest activity
SetVarBranch SET_VAR_ACTIVITY_MIN(SetActivity a, BranchTbl tbl=NULL);
/// Select variable with highest activity with decay factor \a d
SetVarBranch SET_VAR_ACTIVITY_MAX(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with highest activity
SetVarBranch SET_VAR_ACTIVITY_MAX(SetActivity a, BranchTbl tbl=NULL);
/// Select variable with smallest minimum unknown element
SetVarBranch SET_VAR_MIN_MIN(BranchTbl tbl=NULL);
/// Select variable with largest minimum unknown element
SetVarBranch SET_VAR_MIN_MAX(BranchTbl tbl=NULL);
/// Select variable with smallest maximum unknown element
SetVarBranch SET_VAR_MAX_MIN(BranchTbl tbl=NULL);
/// Select variable with largest maximum unknown element
SetVarBranch SET_VAR_MAX_MAX(BranchTbl tbl=NULL);
/// Select variable with smallest unknown set
SetVarBranch SET_VAR_SIZE_MIN(BranchTbl tbl=NULL);
/// Select variable with largest unknown set
SetVarBranch SET_VAR_SIZE_MAX(BranchTbl tbl=NULL);
/// Select variable with smallest degree divided by domain size
SetVarBranch SET_VAR_DEGREE_SIZE_MIN(BranchTbl tbl=NULL);
/// Select variable with largest degree divided by domain size
SetVarBranch SET_VAR_DEGREE_SIZE_MAX(BranchTbl tbl=NULL);
/// Select variable with smallest accumulated failure count divided by domain size with decay factor \a d
SetVarBranch SET_VAR_AFC_SIZE_MIN(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with smallest accumulated failure count divided by domain size
SetVarBranch SET_VAR_AFC_SIZE_MIN(SetAFC a, BranchTbl tbl=NULL);
/// Select variable with largest accumulated failure count divided by domain size with decay factor \a d
SetVarBranch SET_VAR_AFC_SIZE_MAX(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with largest accumulated failure count divided by domain size
SetVarBranch SET_VAR_AFC_SIZE_MAX(SetAFC a, BranchTbl tbl=NULL);
/// Select variable with smallest activity divided by domain size with decay factor \a d
SetVarBranch SET_VAR_ACTIVITY_SIZE_MIN(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with smallest activity divided by domain size
SetVarBranch SET_VAR_ACTIVITY_SIZE_MIN(SetActivity a, BranchTbl tbl=NULL);
/// Select variable with largest activity divided by domain size with decay factor \a d
SetVarBranch SET_VAR_ACTIVITY_SIZE_MAX(double d=1.0, BranchTbl tbl=NULL);
/// Select variable with largest activity divided by domain size
SetVarBranch SET_VAR_ACTIVITY_SIZE_MAX(SetActivity a, BranchTbl tbl=NULL);
//@}
}
#include <gecode/set/branch/var.hpp>
namespace Gecode {
/**
* \brief Which values to select for branching first
*
* \ingroup TaskModelSetBranch
*/
class SetValBranch : public ValBranch {
public:
/// Which value selection
enum Select {
SEL_MIN_INC, ///< Include smallest element
SEL_MIN_EXC, ///< Exclude smallest element
SEL_MED_INC, ///< Include median element (rounding downwards)
SEL_MED_EXC, ///< Exclude median element (rounding downwards)
SEL_MAX_INC, ///< Include largest element
SEL_MAX_EXC, ///< Exclude largest element
SEL_RND_INC, ///< Include random element
SEL_RND_EXC, ///< Exclude random element
SEL_VAL_COMMIT ///< Select value according to user-defined functions
};
protected:
/// Which value to select
Select s;
public:
/// Initialize with selection strategy \a s
SetValBranch(Select s = SEL_MIN_INC);
/// Initialize with random number generator \a r
SetValBranch(Select s, Rnd r);
/// Initialize with value function \a f and commit function \a c
SetValBranch(VoidFunction v, VoidFunction c);
/// Return selection strategy
Select select(void) const;
};
/**
* \defgroup TaskModelSetBranchVal Value selection for set variables
* \ingroup TaskModelSetBranch
*/
//@{
/// Include smallest element
SetValBranch SET_VAL_MIN_INC(void);
/// Exclude smallest element
SetValBranch SET_VAL_MIN_EXC(void);
/// Include median element (rounding downwards)
SetValBranch SET_VAL_MED_INC(void);
/// Exclude median element (rounding downwards)
SetValBranch SET_VAL_MED_EXC(void);
/// Include largest element
SetValBranch SET_VAL_MAX_INC(void);
/// Exclude largest element
SetValBranch SET_VAL_MAX_EXC(void);
/// Include random element
SetValBranch SET_VAL_RND_INC(Rnd r);
/// Exclude random element
SetValBranch SET_VAL_RND_EXC(Rnd r);
/**
* \brief Select value as defined by the value function \a v and commit function \a c
*
* The default commit function posts the constraint that the value \a n
* must be included in the set variable \a x for the first alternative,
* and that \a n must be excluded from \a x otherwise.
*/
SetValBranch SET_VAL(SetBranchVal v, SetBranchCommit c=NULL);
//@}
}
#include <gecode/set/branch/val.hpp>
namespace Gecode {
/**
* \brief Which value to select for assignment
*
* \ingroup TaskModelSetBranch
*/
class SetAssign : public ValBranch {
public:
/// Which value selection
enum Select {
SEL_MIN_INC, ///< Include smallest element
SEL_MIN_EXC, ///< Exclude smallest element
SEL_MED_INC, ///< Include median element (rounding downwards)
SEL_MED_EXC, ///< Exclude median element (rounding downwards)
SEL_MAX_INC, ///< Include largest element
SEL_MAX_EXC, ///< Exclude largest element
SEL_RND_INC, ///< Include random element
SEL_RND_EXC, ///< Exclude random element
SEL_VAL_COMMIT ///< Select value according to user-defined functions
};
protected:
/// Which value to select
Select s;
public:
/// Initialize with selection strategy \a s
SetAssign(Select s = SEL_MIN_INC);
/// Initialize with random number generator \a r
SetAssign(Select s, Rnd r);
/// Initialize with value function \a f and commit function \a c
SetAssign(VoidFunction v, VoidFunction c);
/// Return selection strategy
Select select(void) const;
};
/**
* \defgroup TaskModelSetBranchAssign Assigning set variables
* \ingroup TaskModelSetBranch
*/
//@{
/// Include smallest element
SetAssign SET_ASSIGN_MIN_INC(void);
/// Exclude smallest element
SetAssign SET_ASSIGN_MIN_EXC(void);
/// Include median element (rounding downwards)
SetAssign SET_ASSIGN_MED_INC(void);
/// Exclude median element (rounding downwards)
SetAssign SET_ASSIGN_MED_EXC(void);
/// Include largest element
SetAssign SET_ASSIGN_MAX_INC(void);
/// Exclude largest element
SetAssign SET_ASSIGN_MAX_EXC(void);
/// Include random element
SetAssign SET_ASSIGN_RND_INC(Rnd r);
/// Exclude random element
SetAssign SET_ASSIGN_RND_EXC(Rnd r);
/**
* \brief Select value as defined by the value function \a v and commit function \a c
*
* The default commit function posts the constraint that the value \a n
* must be included in the set variable \a x.
*/
SetAssign SET_ASSIGN(SetBranchVal v, SetBranchCommit c=NULL);
//@}
}
#include <gecode/set/branch/assign.hpp>
namespace Gecode {
/**
* \brief Branch over \a x with variable selection \a vars and value selection \a vals
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
branch(Home home, const SetVarArgs& x,
SetVarBranch vars, SetValBranch vals,
SetBranchFilter bf=NULL,
SetVarValPrint vvp=NULL);
/**
* \brief Branch over \a x with tie-breaking variable selection \a vars and value selection \a vals
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
branch(Home home, const SetVarArgs& x,
TieBreak<SetVarBranch> vars, SetValBranch vals,
SetBranchFilter bf=NULL,
SetVarValPrint vvp=NULL);
/**
* \brief Branch over \a x with value selection \a vals
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
branch(Home home, SetVar x, SetValBranch vals,
SetVarValPrint vvp=NULL);
/**
* \brief Assign all \a x with value selection \a vals
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
assign(Home home, const SetVarArgs& x, SetAssign vals,
SetBranchFilter bf=NULL,
SetVarValPrint vvp=NULL);
/**
* \brief Assign \a x with value selection \a vals
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
assign(Home home, SetVar x, SetAssign vals,
SetVarValPrint vvp=NULL);
}
// LDSB-related declarations.
namespace Gecode {
/// Variables in \a x are interchangeable
GECODE_SET_EXPORT SymmetryHandle VariableSymmetry(const SetVarArgs& x);
/**
* \brief Variable sequences in \a x of size \a ss are interchangeable
*
* The size of \a x must be a multiple of \a ss.
*/
GECODE_SET_EXPORT
SymmetryHandle VariableSequenceSymmetry(const SetVarArgs& x, int ss);
/**
* \brief Branch over \a x with variable selection \a vars and value
* selection \a vals with symmetry breaking
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
branch(Home home, const SetVarArgs& x,
SetVarBranch vars, SetValBranch vals,
const Symmetries& syms,
SetBranchFilter bf=NULL,
SetVarValPrint vvp=NULL);
/**
* \brief Branch over \a x with tie-breaking variable selection \a
* vars and value selection \a vals with symmetry breaking
*
* \ingroup TaskModelSetBranch
*/
GECODE_SET_EXPORT BrancherHandle
branch(Home home, const SetVarArgs& x,
TieBreak<SetVarBranch> vars, SetValBranch vals,
const Symmetries& syms,
SetBranchFilter bf=NULL,
SetVarValPrint vvp=NULL);
}
#endif
// IFDEF: GECODE_HAS_SET_VARS
// STATISTICS: set-post
|