1 //===- Simplex.cpp - MLIR Simplex Class -----------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "mlir/Analysis/Presburger/Simplex.h" 10 #include "mlir/Analysis/Presburger/Matrix.h" 11 #include "mlir/Support/MathExtras.h" 12 #include "llvm/ADT/Optional.h" 13 14 namespace mlir { 15 using Direction = Simplex::Direction; 16 17 const int nullIndex = std::numeric_limits<int>::max(); 18 19 /// Construct a Simplex object with `nVar` variables. 20 SimplexBase::SimplexBase(unsigned nVar) 21 : nRow(0), nCol(2), nRedundant(0), tableau(0, 2 + nVar), empty(false) { 22 colUnknown.push_back(nullIndex); 23 colUnknown.push_back(nullIndex); 24 for (unsigned i = 0; i < nVar; ++i) { 25 var.emplace_back(Orientation::Column, /*restricted=*/false, /*pos=*/nCol); 26 colUnknown.push_back(i); 27 nCol++; 28 } 29 } 30 31 SimplexBase::SimplexBase(const FlatAffineConstraints &constraints) 32 : SimplexBase(constraints.getNumIds()) { 33 for (unsigned i = 0, numIneqs = constraints.getNumInequalities(); 34 i < numIneqs; ++i) 35 addInequality(constraints.getInequality(i)); 36 for (unsigned i = 0, numEqs = constraints.getNumEqualities(); i < numEqs; ++i) 37 addEquality(constraints.getEquality(i)); 38 } 39 40 const Simplex::Unknown &SimplexBase::unknownFromIndex(int index) const { 41 assert(index != nullIndex && "nullIndex passed to unknownFromIndex"); 42 return index >= 0 ? var[index] : con[~index]; 43 } 44 45 const Simplex::Unknown &SimplexBase::unknownFromColumn(unsigned col) const { 46 assert(col < nCol && "Invalid column"); 47 return unknownFromIndex(colUnknown[col]); 48 } 49 50 const Simplex::Unknown &SimplexBase::unknownFromRow(unsigned row) const { 51 assert(row < nRow && "Invalid row"); 52 return unknownFromIndex(rowUnknown[row]); 53 } 54 55 Simplex::Unknown &SimplexBase::unknownFromIndex(int index) { 56 assert(index != nullIndex && "nullIndex passed to unknownFromIndex"); 57 return index >= 0 ? var[index] : con[~index]; 58 } 59 60 Simplex::Unknown &SimplexBase::unknownFromColumn(unsigned col) { 61 assert(col < nCol && "Invalid column"); 62 return unknownFromIndex(colUnknown[col]); 63 } 64 65 Simplex::Unknown &SimplexBase::unknownFromRow(unsigned row) { 66 assert(row < nRow && "Invalid row"); 67 return unknownFromIndex(rowUnknown[row]); 68 } 69 70 /// Add a new row to the tableau corresponding to the given constant term and 71 /// list of coefficients. The coefficients are specified as a vector of 72 /// (variable index, coefficient) pairs. 73 unsigned SimplexBase::addRow(ArrayRef<int64_t> coeffs) { 74 assert(coeffs.size() == 1 + var.size() && 75 "Incorrect number of coefficients!"); 76 77 ++nRow; 78 // If the tableau is not big enough to accomodate the extra row, we extend it. 79 if (nRow >= tableau.getNumRows()) 80 tableau.resizeVertically(nRow); 81 rowUnknown.push_back(~con.size()); 82 con.emplace_back(Orientation::Row, false, nRow - 1); 83 84 tableau(nRow - 1, 0) = 1; 85 tableau(nRow - 1, 1) = coeffs.back(); 86 for (unsigned col = 2; col < nCol; ++col) 87 tableau(nRow - 1, col) = 0; 88 89 // Process each given variable coefficient. 90 for (unsigned i = 0; i < var.size(); ++i) { 91 unsigned pos = var[i].pos; 92 if (coeffs[i] == 0) 93 continue; 94 95 if (var[i].orientation == Orientation::Column) { 96 // If a variable is in column position at column col, then we just add the 97 // coefficient for that variable (scaled by the common row denominator) to 98 // the corresponding entry in the new row. 99 tableau(nRow - 1, pos) += coeffs[i] * tableau(nRow - 1, 0); 100 continue; 101 } 102 103 // If the variable is in row position, we need to add that row to the new 104 // row, scaled by the coefficient for the variable, accounting for the two 105 // rows potentially having different denominators. The new denominator is 106 // the lcm of the two. 107 int64_t lcm = mlir::lcm(tableau(nRow - 1, 0), tableau(pos, 0)); 108 int64_t nRowCoeff = lcm / tableau(nRow - 1, 0); 109 int64_t idxRowCoeff = coeffs[i] * (lcm / tableau(pos, 0)); 110 tableau(nRow - 1, 0) = lcm; 111 for (unsigned col = 1; col < nCol; ++col) 112 tableau(nRow - 1, col) = 113 nRowCoeff * tableau(nRow - 1, col) + idxRowCoeff * tableau(pos, col); 114 } 115 116 normalizeRow(nRow - 1); 117 // Push to undo log along with the index of the new constraint. 118 undoLog.push_back(UndoLogEntry::RemoveLastConstraint); 119 return con.size() - 1; 120 } 121 122 /// Normalize the row by removing factors that are common between the 123 /// denominator and all the numerator coefficients. 124 void SimplexBase::normalizeRow(unsigned row) { 125 int64_t gcd = 0; 126 for (unsigned col = 0; col < nCol; ++col) { 127 if (gcd == 1) 128 break; 129 gcd = llvm::greatestCommonDivisor(gcd, std::abs(tableau(row, col))); 130 } 131 for (unsigned col = 0; col < nCol; ++col) 132 tableau(row, col) /= gcd; 133 } 134 135 namespace { 136 bool signMatchesDirection(int64_t elem, Direction direction) { 137 assert(elem != 0 && "elem should not be 0"); 138 return direction == Direction::Up ? elem > 0 : elem < 0; 139 } 140 141 Direction flippedDirection(Direction direction) { 142 return direction == Direction::Up ? Direction::Down : Simplex::Direction::Up; 143 } 144 } // namespace 145 146 /// Find a pivot to change the sample value of the row in the specified 147 /// direction. The returned pivot row will involve `row` if and only if the 148 /// unknown is unbounded in the specified direction. 149 /// 150 /// To increase (resp. decrease) the value of a row, we need to find a live 151 /// column with a non-zero coefficient. If the coefficient is positive, we need 152 /// to increase (decrease) the value of the column, and if the coefficient is 153 /// negative, we need to decrease (increase) the value of the column. Also, 154 /// we cannot decrease the sample value of restricted columns. 155 /// 156 /// If multiple columns are valid, we break ties by considering a lexicographic 157 /// ordering where we prefer unknowns with lower index. 158 Optional<SimplexBase::Pivot> SimplexBase::findPivot(int row, 159 Direction direction) const { 160 Optional<unsigned> col; 161 for (unsigned j = 2; j < nCol; ++j) { 162 int64_t elem = tableau(row, j); 163 if (elem == 0) 164 continue; 165 166 if (unknownFromColumn(j).restricted && 167 !signMatchesDirection(elem, direction)) 168 continue; 169 if (!col || colUnknown[j] < colUnknown[*col]) 170 col = j; 171 } 172 173 if (!col) 174 return {}; 175 176 Direction newDirection = 177 tableau(row, *col) < 0 ? flippedDirection(direction) : direction; 178 Optional<unsigned> maybePivotRow = findPivotRow(row, newDirection, *col); 179 return Pivot{maybePivotRow.getValueOr(row), *col}; 180 } 181 182 /// Swap the associated unknowns for the row and the column. 183 /// 184 /// First we swap the index associated with the row and column. Then we update 185 /// the unknowns to reflect their new position and orientation. 186 void SimplexBase::swapRowWithCol(unsigned row, unsigned col) { 187 std::swap(rowUnknown[row], colUnknown[col]); 188 Unknown &uCol = unknownFromColumn(col); 189 Unknown &uRow = unknownFromRow(row); 190 uCol.orientation = Orientation::Column; 191 uRow.orientation = Orientation::Row; 192 uCol.pos = col; 193 uRow.pos = row; 194 } 195 196 void SimplexBase::pivot(Pivot pair) { pivot(pair.row, pair.column); } 197 198 /// Pivot pivotRow and pivotCol. 199 /// 200 /// Let R be the pivot row unknown and let C be the pivot col unknown. 201 /// Since initially R = a*C + sum b_i * X_i 202 /// (where the sum is over the other column's unknowns, x_i) 203 /// C = (R - (sum b_i * X_i))/a 204 /// 205 /// Let u be some other row unknown. 206 /// u = c*C + sum d_i * X_i 207 /// So u = c*(R - sum b_i * X_i)/a + sum d_i * X_i 208 /// 209 /// This results in the following transform: 210 /// pivot col other col pivot col other col 211 /// pivot row a b -> pivot row 1/a -b/a 212 /// other row c d other row c/a d - bc/a 213 /// 214 /// Taking into account the common denominators p and q: 215 /// 216 /// pivot col other col pivot col other col 217 /// pivot row a/p b/p -> pivot row p/a -b/a 218 /// other row c/q d/q other row cp/aq (da - bc)/aq 219 /// 220 /// The pivot row transform is accomplished be swapping a with the pivot row's 221 /// common denominator and negating the pivot row except for the pivot column 222 /// element. 223 void SimplexBase::pivot(unsigned pivotRow, unsigned pivotCol) { 224 assert(pivotCol >= 2 && "Refusing to pivot invalid column"); 225 226 swapRowWithCol(pivotRow, pivotCol); 227 std::swap(tableau(pivotRow, 0), tableau(pivotRow, pivotCol)); 228 // We need to negate the whole pivot row except for the pivot column. 229 if (tableau(pivotRow, 0) < 0) { 230 // If the denominator is negative, we negate the row by simply negating the 231 // denominator. 232 tableau(pivotRow, 0) = -tableau(pivotRow, 0); 233 tableau(pivotRow, pivotCol) = -tableau(pivotRow, pivotCol); 234 } else { 235 for (unsigned col = 1; col < nCol; ++col) { 236 if (col == pivotCol) 237 continue; 238 tableau(pivotRow, col) = -tableau(pivotRow, col); 239 } 240 } 241 normalizeRow(pivotRow); 242 243 for (unsigned row = 0; row < nRow; ++row) { 244 if (row == pivotRow) 245 continue; 246 if (tableau(row, pivotCol) == 0) // Nothing to do. 247 continue; 248 tableau(row, 0) *= tableau(pivotRow, 0); 249 for (unsigned j = 1; j < nCol; ++j) { 250 if (j == pivotCol) 251 continue; 252 // Add rather than subtract because the pivot row has been negated. 253 tableau(row, j) = tableau(row, j) * tableau(pivotRow, 0) + 254 tableau(row, pivotCol) * tableau(pivotRow, j); 255 } 256 tableau(row, pivotCol) *= tableau(pivotRow, pivotCol); 257 normalizeRow(row); 258 } 259 } 260 261 /// Perform pivots until the unknown has a non-negative sample value or until 262 /// no more upward pivots can be performed. Return success if we were able to 263 /// bring the row to a non-negative sample value, and failure otherwise. 264 LogicalResult SimplexBase::restoreRow(Unknown &u) { 265 assert(u.orientation == Orientation::Row && 266 "unknown should be in row position"); 267 268 while (tableau(u.pos, 1) < 0) { 269 Optional<Pivot> maybePivot = findPivot(u.pos, Direction::Up); 270 if (!maybePivot) 271 break; 272 273 pivot(*maybePivot); 274 if (u.orientation == Orientation::Column) 275 return success(); // the unknown is unbounded above. 276 } 277 return success(tableau(u.pos, 1) >= 0); 278 } 279 280 /// Find a row that can be used to pivot the column in the specified direction. 281 /// This returns an empty optional if and only if the column is unbounded in the 282 /// specified direction (ignoring skipRow, if skipRow is set). 283 /// 284 /// If skipRow is set, this row is not considered, and (if it is restricted) its 285 /// restriction may be violated by the returned pivot. Usually, skipRow is set 286 /// because we don't want to move it to column position unless it is unbounded, 287 /// and we are either trying to increase the value of skipRow or explicitly 288 /// trying to make skipRow negative, so we are not concerned about this. 289 /// 290 /// If the direction is up (resp. down) and a restricted row has a negative 291 /// (positive) coefficient for the column, then this row imposes a bound on how 292 /// much the sample value of the column can change. Such a row with constant 293 /// term c and coefficient f for the column imposes a bound of c/|f| on the 294 /// change in sample value (in the specified direction). (note that c is 295 /// non-negative here since the row is restricted and the tableau is consistent) 296 /// 297 /// We iterate through the rows and pick the row which imposes the most 298 /// stringent bound, since pivoting with a row changes the row's sample value to 299 /// 0 and hence saturates the bound it imposes. We break ties between rows that 300 /// impose the same bound by considering a lexicographic ordering where we 301 /// prefer unknowns with lower index value. 302 Optional<unsigned> SimplexBase::findPivotRow(Optional<unsigned> skipRow, 303 Direction direction, 304 unsigned col) const { 305 Optional<unsigned> retRow; 306 int64_t retElem, retConst; 307 for (unsigned row = nRedundant; row < nRow; ++row) { 308 if (skipRow && row == *skipRow) 309 continue; 310 int64_t elem = tableau(row, col); 311 if (elem == 0) 312 continue; 313 if (!unknownFromRow(row).restricted) 314 continue; 315 if (signMatchesDirection(elem, direction)) 316 continue; 317 int64_t constTerm = tableau(row, 1); 318 319 if (!retRow) { 320 retRow = row; 321 retElem = elem; 322 retConst = constTerm; 323 continue; 324 } 325 326 int64_t diff = retConst * elem - constTerm * retElem; 327 if ((diff == 0 && rowUnknown[row] < rowUnknown[*retRow]) || 328 (diff != 0 && !signMatchesDirection(diff, direction))) { 329 retRow = row; 330 retElem = elem; 331 retConst = constTerm; 332 } 333 } 334 return retRow; 335 } 336 337 bool SimplexBase::isEmpty() const { return empty; } 338 339 void SimplexBase::swapRows(unsigned i, unsigned j) { 340 if (i == j) 341 return; 342 tableau.swapRows(i, j); 343 std::swap(rowUnknown[i], rowUnknown[j]); 344 unknownFromRow(i).pos = i; 345 unknownFromRow(j).pos = j; 346 } 347 348 void SimplexBase::swapColumns(unsigned i, unsigned j) { 349 assert(i < nCol && j < nCol && "Invalid columns provided!"); 350 if (i == j) 351 return; 352 tableau.swapColumns(i, j); 353 std::swap(colUnknown[i], colUnknown[j]); 354 unknownFromColumn(i).pos = i; 355 unknownFromColumn(j).pos = j; 356 } 357 358 /// Mark this tableau empty and push an entry to the undo stack. 359 void SimplexBase::markEmpty() { 360 // If the set is already empty, then we shouldn't add another UnmarkEmpty log 361 // entry, since in that case the Simplex will be erroneously marked as 362 // non-empty when rolling back past this point. 363 if (empty) 364 return; 365 undoLog.push_back(UndoLogEntry::UnmarkEmpty); 366 empty = true; 367 } 368 369 /// Add an inequality to the tableau. If coeffs is c_0, c_1, ... c_n, where n 370 /// is the current number of variables, then the corresponding inequality is 371 /// c_n + c_0*x_0 + c_1*x_1 + ... + c_{n-1}*x_{n-1} >= 0. 372 /// 373 /// We add the inequality and mark it as restricted. We then try to make its 374 /// sample value non-negative. If this is not possible, the tableau has become 375 /// empty and we mark it as such. 376 void SimplexBase::addInequality(ArrayRef<int64_t> coeffs) { 377 unsigned conIndex = addRow(coeffs); 378 Unknown &u = con[conIndex]; 379 u.restricted = true; 380 LogicalResult result = restoreRow(u); 381 if (failed(result)) 382 markEmpty(); 383 } 384 385 /// Add an equality to the tableau. If coeffs is c_0, c_1, ... c_n, where n 386 /// is the current number of variables, then the corresponding equality is 387 /// c_n + c_0*x_0 + c_1*x_1 + ... + c_{n-1}*x_{n-1} == 0. 388 /// 389 /// We simply add two opposing inequalities, which force the expression to 390 /// be zero. 391 void SimplexBase::addEquality(ArrayRef<int64_t> coeffs) { 392 addInequality(coeffs); 393 SmallVector<int64_t, 8> negatedCoeffs; 394 for (int64_t coeff : coeffs) 395 negatedCoeffs.emplace_back(-coeff); 396 addInequality(negatedCoeffs); 397 } 398 399 unsigned SimplexBase::getNumVariables() const { return var.size(); } 400 unsigned SimplexBase::getNumConstraints() const { return con.size(); } 401 402 /// Return a snapshot of the current state. This is just the current size of the 403 /// undo log. 404 unsigned SimplexBase::getSnapshot() const { return undoLog.size(); } 405 406 void SimplexBase::undo(UndoLogEntry entry) { 407 if (entry == UndoLogEntry::RemoveLastConstraint) { 408 Unknown &constraint = con.back(); 409 if (constraint.orientation == Orientation::Column) { 410 unsigned column = constraint.pos; 411 Optional<unsigned> row; 412 413 // Try to find any pivot row for this column that preserves tableau 414 // consistency (except possibly the column itself, which is going to be 415 // deallocated anyway). 416 // 417 // If no pivot row is found in either direction, then the unknown is 418 // unbounded in both directions and we are free to 419 // perform any pivot at all. To do this, we just need to find any row with 420 // a non-zero coefficient for the column. 421 if (Optional<unsigned> maybeRow = 422 findPivotRow({}, Direction::Up, column)) { 423 row = *maybeRow; 424 } else if (Optional<unsigned> maybeRow = 425 findPivotRow({}, Direction::Down, column)) { 426 row = *maybeRow; 427 } else { 428 // The loop doesn't find a pivot row only if the column has zero 429 // coefficients for every row. But the unknown is a constraint, 430 // so it was added initially as a row. Such a row could never have been 431 // pivoted to a column. So a pivot row will always be found. 432 for (unsigned i = nRedundant; i < nRow; ++i) { 433 if (tableau(i, column) != 0) { 434 row = i; 435 break; 436 } 437 } 438 } 439 assert(row.hasValue() && "No pivot row found!"); 440 pivot(*row, column); 441 } 442 443 // Move this unknown to the last row and remove the last row from the 444 // tableau. 445 swapRows(constraint.pos, nRow - 1); 446 // It is not strictly necessary to shrink the tableau, but for now we 447 // maintain the invariant that the tableau has exactly nRow rows. 448 tableau.resizeVertically(nRow - 1); 449 nRow--; 450 rowUnknown.pop_back(); 451 con.pop_back(); 452 } else if (entry == UndoLogEntry::RemoveLastVariable) { 453 // Whenever we are rolling back the addition of a variable, it is guaranteed 454 // that the variable will be in column position. 455 // 456 // We can see this as follows: any constraint that depends on this variable 457 // was added after this variable was added, so the addition of such 458 // constraints should already have been rolled back by the time we get to 459 // rolling back the addition of the variable. Therefore, no constraint 460 // currently has a component along the variable, so the variable itself must 461 // be part of the basis. 462 assert(var.back().orientation == Orientation::Column && 463 "Variable to be removed must be in column orientation!"); 464 465 // Move this variable to the last column and remove the column from the 466 // tableau. 467 swapColumns(var.back().pos, nCol - 1); 468 tableau.resizeHorizontally(nCol - 1); 469 var.pop_back(); 470 colUnknown.pop_back(); 471 nCol--; 472 } else if (entry == UndoLogEntry::UnmarkEmpty) { 473 empty = false; 474 } else if (entry == UndoLogEntry::UnmarkLastRedundant) { 475 nRedundant--; 476 } 477 } 478 479 /// Rollback to the specified snapshot. 480 /// 481 /// We undo all the log entries until the log size when the snapshot was taken 482 /// is reached. 483 void SimplexBase::rollback(unsigned snapshot) { 484 while (undoLog.size() > snapshot) { 485 undo(undoLog.back()); 486 undoLog.pop_back(); 487 } 488 } 489 490 void SimplexBase::appendVariable(unsigned count) { 491 if (count == 0) 492 return; 493 var.reserve(var.size() + count); 494 colUnknown.reserve(colUnknown.size() + count); 495 for (unsigned i = 0; i < count; ++i) { 496 nCol++; 497 var.emplace_back(Orientation::Column, /*restricted=*/false, 498 /*pos=*/nCol - 1); 499 colUnknown.push_back(var.size() - 1); 500 } 501 tableau.resizeHorizontally(nCol); 502 undoLog.insert(undoLog.end(), count, UndoLogEntry::RemoveLastVariable); 503 } 504 505 /// Add all the constraints from the given FlatAffineConstraints. 506 void SimplexBase::intersectFlatAffineConstraints( 507 const FlatAffineConstraints &fac) { 508 assert(fac.getNumIds() == getNumVariables() && 509 "FlatAffineConstraints must have same dimensionality as simplex"); 510 for (unsigned i = 0, e = fac.getNumInequalities(); i < e; ++i) 511 addInequality(fac.getInequality(i)); 512 for (unsigned i = 0, e = fac.getNumEqualities(); i < e; ++i) 513 addEquality(fac.getEquality(i)); 514 } 515 516 Optional<Fraction> Simplex::computeRowOptimum(Direction direction, 517 unsigned row) { 518 // Keep trying to find a pivot for the row in the specified direction. 519 while (Optional<Pivot> maybePivot = findPivot(row, direction)) { 520 // If findPivot returns a pivot involving the row itself, then the optimum 521 // is unbounded, so we return None. 522 if (maybePivot->row == row) 523 return {}; 524 pivot(*maybePivot); 525 } 526 527 // The row has reached its optimal sample value, which we return. 528 // The sample value is the entry in the constant column divided by the common 529 // denominator for this row. 530 return Fraction(tableau(row, 1), tableau(row, 0)); 531 } 532 533 /// Compute the optimum of the specified expression in the specified direction, 534 /// or None if it is unbounded. 535 Optional<Fraction> Simplex::computeOptimum(Direction direction, 536 ArrayRef<int64_t> coeffs) { 537 assert(!empty && "Simplex should not be empty"); 538 539 unsigned snapshot = getSnapshot(); 540 unsigned conIndex = addRow(coeffs); 541 unsigned row = con[conIndex].pos; 542 Optional<Fraction> optimum = computeRowOptimum(direction, row); 543 rollback(snapshot); 544 return optimum; 545 } 546 547 Optional<Fraction> Simplex::computeOptimum(Direction direction, Unknown &u) { 548 assert(!empty && "Simplex should not be empty!"); 549 if (u.orientation == Orientation::Column) { 550 unsigned column = u.pos; 551 Optional<unsigned> pivotRow = findPivotRow({}, direction, column); 552 // If no pivot is returned, the constraint is unbounded in the specified 553 // direction. 554 if (!pivotRow) 555 return {}; 556 pivot(*pivotRow, column); 557 } 558 559 unsigned row = u.pos; 560 Optional<Fraction> optimum = computeRowOptimum(direction, row); 561 if (u.restricted && direction == Direction::Down && 562 (!optimum || *optimum < Fraction(0, 1))) { 563 if (failed(restoreRow(u))) 564 llvm_unreachable("Could not restore row!"); 565 } 566 return optimum; 567 } 568 569 bool Simplex::isBoundedAlongConstraint(unsigned constraintIndex) { 570 assert(!empty && "It is not meaningful to ask whether a direction is bounded " 571 "in an empty set."); 572 // The constraint's perpendicular is already bounded below, since it is a 573 // constraint. If it is also bounded above, we can return true. 574 return computeOptimum(Direction::Up, con[constraintIndex]).hasValue(); 575 } 576 577 /// Redundant constraints are those that are in row orientation and lie in 578 /// rows 0 to nRedundant - 1. 579 bool Simplex::isMarkedRedundant(unsigned constraintIndex) const { 580 const Unknown &u = con[constraintIndex]; 581 return u.orientation == Orientation::Row && u.pos < nRedundant; 582 } 583 584 /// Mark the specified row redundant. 585 /// 586 /// This is done by moving the unknown to the end of the block of redundant 587 /// rows (namely, to row nRedundant) and incrementing nRedundant to 588 /// accomodate the new redundant row. 589 void Simplex::markRowRedundant(Unknown &u) { 590 assert(u.orientation == Orientation::Row && 591 "Unknown should be in row position!"); 592 assert(u.pos >= nRedundant && "Unknown is already marked redundant!"); 593 swapRows(u.pos, nRedundant); 594 ++nRedundant; 595 undoLog.emplace_back(UndoLogEntry::UnmarkLastRedundant); 596 } 597 598 /// Find a subset of constraints that is redundant and mark them redundant. 599 void Simplex::detectRedundant() { 600 // It is not meaningful to talk about redundancy for empty sets. 601 if (empty) 602 return; 603 604 // Iterate through the constraints and check for each one if it can attain 605 // negative sample values. If it can, it's not redundant. Otherwise, it is. 606 // We mark redundant constraints redundant. 607 // 608 // Constraints that get marked redundant in one iteration are not respected 609 // when checking constraints in later iterations. This prevents, for example, 610 // two identical constraints both being marked redundant since each is 611 // redundant given the other one. In this example, only the first of the 612 // constraints that is processed will get marked redundant, as it should be. 613 for (Unknown &u : con) { 614 if (u.orientation == Orientation::Column) { 615 unsigned column = u.pos; 616 Optional<unsigned> pivotRow = findPivotRow({}, Direction::Down, column); 617 // If no downward pivot is returned, the constraint is unbounded below 618 // and hence not redundant. 619 if (!pivotRow) 620 continue; 621 pivot(*pivotRow, column); 622 } 623 624 unsigned row = u.pos; 625 Optional<Fraction> minimum = computeRowOptimum(Direction::Down, row); 626 if (!minimum || *minimum < Fraction(0, 1)) { 627 // Constraint is unbounded below or can attain negative sample values and 628 // hence is not redundant. 629 if (failed(restoreRow(u))) 630 llvm_unreachable("Could not restore non-redundant row!"); 631 continue; 632 } 633 634 markRowRedundant(u); 635 } 636 } 637 638 bool Simplex::isUnbounded() { 639 if (empty) 640 return false; 641 642 SmallVector<int64_t, 8> dir(var.size() + 1); 643 for (unsigned i = 0; i < var.size(); ++i) { 644 dir[i] = 1; 645 646 Optional<Fraction> maybeMax = computeOptimum(Direction::Up, dir); 647 if (!maybeMax) 648 return true; 649 650 Optional<Fraction> maybeMin = computeOptimum(Direction::Down, dir); 651 if (!maybeMin) 652 return true; 653 654 dir[i] = 0; 655 } 656 return false; 657 } 658 659 /// Make a tableau to represent a pair of points in the original tableau. 660 /// 661 /// The product constraints and variables are stored as: first A's, then B's. 662 /// 663 /// The product tableau has row layout: 664 /// A's redundant rows, B's redundant rows, A's other rows, B's other rows. 665 /// 666 /// It has column layout: 667 /// denominator, constant, A's columns, B's columns. 668 Simplex Simplex::makeProduct(const Simplex &a, const Simplex &b) { 669 unsigned numVar = a.getNumVariables() + b.getNumVariables(); 670 unsigned numCon = a.getNumConstraints() + b.getNumConstraints(); 671 Simplex result(numVar); 672 673 result.tableau.resizeVertically(numCon); 674 result.empty = a.empty || b.empty; 675 676 auto concat = [](ArrayRef<Unknown> v, ArrayRef<Unknown> w) { 677 SmallVector<Unknown, 8> result; 678 result.reserve(v.size() + w.size()); 679 result.insert(result.end(), v.begin(), v.end()); 680 result.insert(result.end(), w.begin(), w.end()); 681 return result; 682 }; 683 result.con = concat(a.con, b.con); 684 result.var = concat(a.var, b.var); 685 686 auto indexFromBIndex = [&](int index) { 687 return index >= 0 ? a.getNumVariables() + index 688 : ~(a.getNumConstraints() + ~index); 689 }; 690 691 result.colUnknown.assign(2, nullIndex); 692 for (unsigned i = 2; i < a.nCol; ++i) { 693 result.colUnknown.push_back(a.colUnknown[i]); 694 result.unknownFromIndex(result.colUnknown.back()).pos = 695 result.colUnknown.size() - 1; 696 } 697 for (unsigned i = 2; i < b.nCol; ++i) { 698 result.colUnknown.push_back(indexFromBIndex(b.colUnknown[i])); 699 result.unknownFromIndex(result.colUnknown.back()).pos = 700 result.colUnknown.size() - 1; 701 } 702 703 auto appendRowFromA = [&](unsigned row) { 704 for (unsigned col = 0; col < a.nCol; ++col) 705 result.tableau(result.nRow, col) = a.tableau(row, col); 706 result.rowUnknown.push_back(a.rowUnknown[row]); 707 result.unknownFromIndex(result.rowUnknown.back()).pos = 708 result.rowUnknown.size() - 1; 709 result.nRow++; 710 }; 711 712 // Also fixes the corresponding entry in rowUnknown and var/con (as the case 713 // may be). 714 auto appendRowFromB = [&](unsigned row) { 715 result.tableau(result.nRow, 0) = b.tableau(row, 0); 716 result.tableau(result.nRow, 1) = b.tableau(row, 1); 717 718 unsigned offset = a.nCol - 2; 719 for (unsigned col = 2; col < b.nCol; ++col) 720 result.tableau(result.nRow, offset + col) = b.tableau(row, col); 721 result.rowUnknown.push_back(indexFromBIndex(b.rowUnknown[row])); 722 result.unknownFromIndex(result.rowUnknown.back()).pos = 723 result.rowUnknown.size() - 1; 724 result.nRow++; 725 }; 726 727 result.nRedundant = a.nRedundant + b.nRedundant; 728 for (unsigned row = 0; row < a.nRedundant; ++row) 729 appendRowFromA(row); 730 for (unsigned row = 0; row < b.nRedundant; ++row) 731 appendRowFromB(row); 732 for (unsigned row = a.nRedundant; row < a.nRow; ++row) 733 appendRowFromA(row); 734 for (unsigned row = b.nRedundant; row < b.nRow; ++row) 735 appendRowFromB(row); 736 737 return result; 738 } 739 740 SmallVector<Fraction, 8> SimplexBase::getRationalSample() const { 741 assert(!empty && "This should not be called when Simplex is empty."); 742 743 SmallVector<Fraction, 8> sample; 744 sample.reserve(var.size()); 745 // Push the sample value for each variable into the vector. 746 for (const Unknown &u : var) { 747 if (u.orientation == Orientation::Column) { 748 // If the variable is in column position, its sample value is zero. 749 sample.emplace_back(0, 1); 750 } else { 751 // If the variable is in row position, its sample value is the entry in 752 // the constant column divided by the entry in the common denominator 753 // column. 754 sample.emplace_back(tableau(u.pos, 1), tableau(u.pos, 0)); 755 } 756 } 757 return sample; 758 } 759 760 Optional<SmallVector<int64_t, 8>> 761 SimplexBase::getSamplePointIfIntegral() const { 762 // If the tableau is empty, no sample point exists. 763 if (empty) 764 return {}; 765 SmallVector<Fraction, 8> rationalSample = getRationalSample(); 766 SmallVector<int64_t, 8> integerSample; 767 integerSample.reserve(var.size()); 768 for (const Fraction &coord : rationalSample) { 769 // If the sample is non-integral, return None. 770 if (coord.num % coord.den != 0) 771 return {}; 772 integerSample.push_back(coord.num / coord.den); 773 } 774 return integerSample; 775 } 776 777 /// Given a simplex for a polytope, construct a new simplex whose variables are 778 /// identified with a pair of points (x, y) in the original polytope. Supports 779 /// some operations needed for generalized basis reduction. In what follows, 780 /// dotProduct(x, y) = x_1 * y_1 + x_2 * y_2 + ... x_n * y_n where n is the 781 /// dimension of the original polytope. 782 /// 783 /// This supports adding equality constraints dotProduct(dir, x - y) == 0. It 784 /// also supports rolling back this addition, by maintaining a snapshot stack 785 /// that contains a snapshot of the Simplex's state for each equality, just 786 /// before that equality was added. 787 class GBRSimplex { 788 using Orientation = Simplex::Orientation; 789 790 public: 791 GBRSimplex(const Simplex &originalSimplex) 792 : simplex(Simplex::makeProduct(originalSimplex, originalSimplex)), 793 simplexConstraintOffset(simplex.getNumConstraints()) {} 794 795 /// Add an equality dotProduct(dir, x - y) == 0. 796 /// First pushes a snapshot for the current simplex state to the stack so 797 /// that this can be rolled back later. 798 void addEqualityForDirection(ArrayRef<int64_t> dir) { 799 assert( 800 std::any_of(dir.begin(), dir.end(), [](int64_t x) { return x != 0; }) && 801 "Direction passed is the zero vector!"); 802 snapshotStack.push_back(simplex.getSnapshot()); 803 simplex.addEquality(getCoeffsForDirection(dir)); 804 } 805 /// Compute max(dotProduct(dir, x - y)). 806 Fraction computeWidth(ArrayRef<int64_t> dir) { 807 Optional<Fraction> maybeWidth = 808 simplex.computeOptimum(Direction::Up, getCoeffsForDirection(dir)); 809 assert(maybeWidth.hasValue() && "Width should not be unbounded!"); 810 return *maybeWidth; 811 } 812 813 /// Compute max(dotProduct(dir, x - y)) and save the dual variables for only 814 /// the direction equalities to `dual`. 815 Fraction computeWidthAndDuals(ArrayRef<int64_t> dir, 816 SmallVectorImpl<int64_t> &dual, 817 int64_t &dualDenom) { 818 // We can't just call into computeWidth or computeOptimum since we need to 819 // access the state of the tableau after computing the optimum, and these 820 // functions rollback the insertion of the objective function into the 821 // tableau before returning. We instead add a row for the objective function 822 // ourselves, call into computeOptimum, compute the duals from the tableau 823 // state, and finally rollback the addition of the row before returning. 824 unsigned snap = simplex.getSnapshot(); 825 unsigned conIndex = simplex.addRow(getCoeffsForDirection(dir)); 826 unsigned row = simplex.con[conIndex].pos; 827 Optional<Fraction> maybeWidth = 828 simplex.computeRowOptimum(Simplex::Direction::Up, row); 829 assert(maybeWidth.hasValue() && "Width should not be unbounded!"); 830 dualDenom = simplex.tableau(row, 0); 831 dual.clear(); 832 833 // The increment is i += 2 because equalities are added as two inequalities, 834 // one positive and one negative. Each iteration processes one equality. 835 for (unsigned i = simplexConstraintOffset; i < conIndex; i += 2) { 836 // The dual variable for an inequality in column orientation is the 837 // negative of its coefficient at the objective row. If the inequality is 838 // in row orientation, the corresponding dual variable is zero. 839 // 840 // We want the dual for the original equality, which corresponds to two 841 // inequalities: a positive inequality, which has the same coefficients as 842 // the equality, and a negative equality, which has negated coefficients. 843 // 844 // Note that at most one of these inequalities can be in column 845 // orientation because the column unknowns should form a basis and hence 846 // must be linearly independent. If the positive inequality is in column 847 // position, its dual is the dual corresponding to the equality. If the 848 // negative inequality is in column position, the negation of its dual is 849 // the dual corresponding to the equality. If neither is in column 850 // position, then that means that this equality is redundant, and its dual 851 // is zero. 852 // 853 // Note that it is NOT valid to perform pivots during the computation of 854 // the duals. This entire dual computation must be performed on the same 855 // tableau configuration. 856 assert(!(simplex.con[i].orientation == Orientation::Column && 857 simplex.con[i + 1].orientation == Orientation::Column) && 858 "Both inequalities for the equality cannot be in column " 859 "orientation!"); 860 if (simplex.con[i].orientation == Orientation::Column) 861 dual.push_back(-simplex.tableau(row, simplex.con[i].pos)); 862 else if (simplex.con[i + 1].orientation == Orientation::Column) 863 dual.push_back(simplex.tableau(row, simplex.con[i + 1].pos)); 864 else 865 dual.push_back(0); 866 } 867 simplex.rollback(snap); 868 return *maybeWidth; 869 } 870 871 /// Remove the last equality that was added through addEqualityForDirection. 872 /// 873 /// We do this by rolling back to the snapshot at the top of the stack, which 874 /// should be a snapshot taken just before the last equality was added. 875 void removeLastEquality() { 876 assert(!snapshotStack.empty() && "Snapshot stack is empty!"); 877 simplex.rollback(snapshotStack.back()); 878 snapshotStack.pop_back(); 879 } 880 881 private: 882 /// Returns coefficients of the expression 'dot_product(dir, x - y)', 883 /// i.e., dir_1 * x_1 + dir_2 * x_2 + ... + dir_n * x_n 884 /// - dir_1 * y_1 - dir_2 * y_2 - ... - dir_n * y_n, 885 /// where n is the dimension of the original polytope. 886 SmallVector<int64_t, 8> getCoeffsForDirection(ArrayRef<int64_t> dir) { 887 assert(2 * dir.size() == simplex.getNumVariables() && 888 "Direction vector has wrong dimensionality"); 889 SmallVector<int64_t, 8> coeffs(dir.begin(), dir.end()); 890 coeffs.reserve(2 * dir.size()); 891 for (int64_t coeff : dir) 892 coeffs.push_back(-coeff); 893 coeffs.push_back(0); // constant term 894 return coeffs; 895 } 896 897 Simplex simplex; 898 /// The first index of the equality constraints, the index immediately after 899 /// the last constraint in the initial product simplex. 900 unsigned simplexConstraintOffset; 901 /// A stack of snapshots, used for rolling back. 902 SmallVector<unsigned, 8> snapshotStack; 903 }; 904 905 // Return a + scale*b; 906 static SmallVector<int64_t, 8> scaleAndAdd(ArrayRef<int64_t> a, int64_t scale, 907 ArrayRef<int64_t> b) { 908 assert(a.size() == b.size()); 909 SmallVector<int64_t, 8> res; 910 res.reserve(a.size()); 911 for (unsigned i = 0, e = a.size(); i < e; ++i) 912 res.push_back(a[i] + scale * b[i]); 913 return res; 914 } 915 916 /// Reduce the basis to try and find a direction in which the polytope is 917 /// "thin". This only works for bounded polytopes. 918 /// 919 /// This is an implementation of the algorithm described in the paper 920 /// "An Implementation of Generalized Basis Reduction for Integer Programming" 921 /// by W. Cook, T. Rutherford, H. E. Scarf, D. Shallcross. 922 /// 923 /// Let b_{level}, b_{level + 1}, ... b_n be the current basis. 924 /// Let width_i(v) = max <v, x - y> where x and y are points in the original 925 /// polytope such that <b_j, x - y> = 0 is satisfied for all level <= j < i. 926 /// 927 /// In every iteration, we first replace b_{i+1} with b_{i+1} + u*b_i, where u 928 /// is the integer such that width_i(b_{i+1} + u*b_i) is minimized. Let dual_i 929 /// be the dual variable associated with the constraint <b_i, x - y> = 0 when 930 /// computing width_{i+1}(b_{i+1}). It can be shown that dual_i is the 931 /// minimizing value of u, if it were allowed to be fractional. Due to 932 /// convexity, the minimizing integer value is either floor(dual_i) or 933 /// ceil(dual_i), so we just need to check which of these gives a lower 934 /// width_{i+1} value. If dual_i turned out to be an integer, then u = dual_i. 935 /// 936 /// Now if width_i(b_{i+1}) < 0.75 * width_i(b_i), we swap b_i and (the new) 937 /// b_{i + 1} and decrement i (unless i = level, in which case we stay at the 938 /// same i). Otherwise, we increment i. 939 /// 940 /// We keep f values and duals cached and invalidate them when necessary. 941 /// Whenever possible, we use them instead of recomputing them. We implement the 942 /// algorithm as follows. 943 /// 944 /// In an iteration at i we need to compute: 945 /// a) width_i(b_{i + 1}) 946 /// b) width_i(b_i) 947 /// c) the integer u that minimizes width_i(b_{i + 1} + u*b_i) 948 /// 949 /// If width_i(b_i) is not already cached, we compute it. 950 /// 951 /// If the duals are not already cached, we compute width_{i+1}(b_{i+1}) and 952 /// store the duals from this computation. 953 /// 954 /// We call updateBasisWithUAndGetFCandidate, which finds the minimizing value 955 /// of u as explained before, caches the duals from this computation, sets 956 /// b_{i+1} to b_{i+1} + u*b_i, and returns the new value of width_i(b_{i+1}). 957 /// 958 /// Now if width_i(b_{i+1}) < 0.75 * width_i(b_i), we swap b_i and b_{i+1} and 959 /// decrement i, resulting in the basis 960 /// ... b_{i - 1}, b_{i + 1} + u*b_i, b_i, b_{i+2}, ... 961 /// with corresponding f values 962 /// ... width_{i-1}(b_{i-1}), width_i(b_{i+1} + u*b_i), width_{i+1}(b_i), ... 963 /// The values up to i - 1 remain unchanged. We have just gotten the middle 964 /// value from updateBasisWithUAndGetFCandidate, so we can update that in the 965 /// cache. The value at width_{i+1}(b_i) is unknown, so we evict this value from 966 /// the cache. The iteration after decrementing needs exactly the duals from the 967 /// computation of width_i(b_{i + 1} + u*b_i), so we keep these in the cache. 968 /// 969 /// When incrementing i, no cached f values get invalidated. However, the cached 970 /// duals do get invalidated as the duals for the higher levels are different. 971 void Simplex::reduceBasis(Matrix &basis, unsigned level) { 972 const Fraction epsilon(3, 4); 973 974 if (level == basis.getNumRows() - 1) 975 return; 976 977 GBRSimplex gbrSimplex(*this); 978 SmallVector<Fraction, 8> width; 979 SmallVector<int64_t, 8> dual; 980 int64_t dualDenom; 981 982 // Finds the value of u that minimizes width_i(b_{i+1} + u*b_i), caches the 983 // duals from this computation, sets b_{i+1} to b_{i+1} + u*b_i, and returns 984 // the new value of width_i(b_{i+1}). 985 // 986 // If dual_i is not an integer, the minimizing value must be either 987 // floor(dual_i) or ceil(dual_i). We compute the expression for both and 988 // choose the minimizing value. 989 // 990 // If dual_i is an integer, we don't need to perform these computations. We 991 // know that in this case, 992 // a) u = dual_i. 993 // b) one can show that dual_j for j < i are the same duals we would have 994 // gotten from computing width_i(b_{i + 1} + u*b_i), so the correct duals 995 // are the ones already in the cache. 996 // c) width_i(b_{i+1} + u*b_i) = min_{alpha} width_i(b_{i+1} + alpha * b_i), 997 // which 998 // one can show is equal to width_{i+1}(b_{i+1}). The latter value must 999 // be in the cache, so we get it from there and return it. 1000 auto updateBasisWithUAndGetFCandidate = [&](unsigned i) -> Fraction { 1001 assert(i < level + dual.size() && "dual_i is not known!"); 1002 1003 int64_t u = floorDiv(dual[i - level], dualDenom); 1004 basis.addToRow(i, i + 1, u); 1005 if (dual[i - level] % dualDenom != 0) { 1006 SmallVector<int64_t, 8> candidateDual[2]; 1007 int64_t candidateDualDenom[2]; 1008 Fraction widthI[2]; 1009 1010 // Initially u is floor(dual) and basis reflects this. 1011 widthI[0] = gbrSimplex.computeWidthAndDuals( 1012 basis.getRow(i + 1), candidateDual[0], candidateDualDenom[0]); 1013 1014 // Now try ceil(dual), i.e. floor(dual) + 1. 1015 ++u; 1016 basis.addToRow(i, i + 1, 1); 1017 widthI[1] = gbrSimplex.computeWidthAndDuals( 1018 basis.getRow(i + 1), candidateDual[1], candidateDualDenom[1]); 1019 1020 unsigned j = widthI[0] < widthI[1] ? 0 : 1; 1021 if (j == 0) 1022 // Subtract 1 to go from u = ceil(dual) back to floor(dual). 1023 basis.addToRow(i, i + 1, -1); 1024 1025 // width_i(b{i+1} + u*b_i) should be minimized at our value of u. 1026 // We assert that this holds by checking that the values of width_i at 1027 // u - 1 and u + 1 are greater than or equal to the value at u. If the 1028 // width is lesser at either of the adjacent values, then our computed 1029 // value of u is clearly not the minimizer. Otherwise by convexity the 1030 // computed value of u is really the minimizer. 1031 1032 // Check the value at u - 1. 1033 assert(gbrSimplex.computeWidth(scaleAndAdd( 1034 basis.getRow(i + 1), -1, basis.getRow(i))) >= widthI[j] && 1035 "Computed u value does not minimize the width!"); 1036 // Check the value at u + 1. 1037 assert(gbrSimplex.computeWidth(scaleAndAdd( 1038 basis.getRow(i + 1), +1, basis.getRow(i))) >= widthI[j] && 1039 "Computed u value does not minimize the width!"); 1040 1041 dual = std::move(candidateDual[j]); 1042 dualDenom = candidateDualDenom[j]; 1043 return widthI[j]; 1044 } 1045 1046 assert(i + 1 - level < width.size() && "width_{i+1} wasn't saved"); 1047 // f_i(b_{i+1} + dual*b_i) == width_{i+1}(b_{i+1}) when `dual` minimizes the 1048 // LHS. (note: the basis has already been updated, so b_{i+1} + dual*b_i in 1049 // the above expression is equal to basis.getRow(i+1) below.) 1050 assert(gbrSimplex.computeWidth(basis.getRow(i + 1)) == 1051 width[i + 1 - level]); 1052 return width[i + 1 - level]; 1053 }; 1054 1055 // In the ith iteration of the loop, gbrSimplex has constraints for directions 1056 // from `level` to i - 1. 1057 unsigned i = level; 1058 while (i < basis.getNumRows() - 1) { 1059 if (i >= level + width.size()) { 1060 // We don't even know the value of f_i(b_i), so let's find that first. 1061 // We have to do this first since later we assume that width already 1062 // contains values up to and including i. 1063 1064 assert((i == 0 || i - 1 < level + width.size()) && 1065 "We are at level i but we don't know the value of width_{i-1}"); 1066 1067 // We don't actually use these duals at all, but it doesn't matter 1068 // because this case should only occur when i is level, and there are no 1069 // duals in that case anyway. 1070 assert(i == level && "This case should only occur when i == level"); 1071 width.push_back( 1072 gbrSimplex.computeWidthAndDuals(basis.getRow(i), dual, dualDenom)); 1073 } 1074 1075 if (i >= level + dual.size()) { 1076 assert(i + 1 >= level + width.size() && 1077 "We don't know dual_i but we know width_{i+1}"); 1078 // We don't know dual for our level, so let's find it. 1079 gbrSimplex.addEqualityForDirection(basis.getRow(i)); 1080 width.push_back(gbrSimplex.computeWidthAndDuals(basis.getRow(i + 1), dual, 1081 dualDenom)); 1082 gbrSimplex.removeLastEquality(); 1083 } 1084 1085 // This variable stores width_i(b_{i+1} + u*b_i). 1086 Fraction widthICandidate = updateBasisWithUAndGetFCandidate(i); 1087 if (widthICandidate < epsilon * width[i - level]) { 1088 basis.swapRows(i, i + 1); 1089 width[i - level] = widthICandidate; 1090 // The values of width_{i+1}(b_{i+1}) and higher may change after the 1091 // swap, so we remove the cached values here. 1092 width.resize(i - level + 1); 1093 if (i == level) { 1094 dual.clear(); 1095 continue; 1096 } 1097 1098 gbrSimplex.removeLastEquality(); 1099 i--; 1100 continue; 1101 } 1102 1103 // Invalidate duals since the higher level needs to recompute its own duals. 1104 dual.clear(); 1105 gbrSimplex.addEqualityForDirection(basis.getRow(i)); 1106 i++; 1107 } 1108 } 1109 1110 /// Search for an integer sample point using a branch and bound algorithm. 1111 /// 1112 /// Each row in the basis matrix is a vector, and the set of basis vectors 1113 /// should span the space. Initially this is the identity matrix, 1114 /// i.e., the basis vectors are just the variables. 1115 /// 1116 /// In every level, a value is assigned to the level-th basis vector, as 1117 /// follows. Compute the minimum and maximum rational values of this direction. 1118 /// If only one integer point lies in this range, constrain the variable to 1119 /// have this value and recurse to the next variable. 1120 /// 1121 /// If the range has multiple values, perform generalized basis reduction via 1122 /// reduceBasis and then compute the bounds again. Now we try constraining 1123 /// this direction in the first value in this range and "recurse" to the next 1124 /// level. If we fail to find a sample, we try assigning the direction the next 1125 /// value in this range, and so on. 1126 /// 1127 /// If no integer sample is found from any of the assignments, or if the range 1128 /// contains no integer value, then of course the polytope is empty for the 1129 /// current assignment of the values in previous levels, so we return to 1130 /// the previous level. 1131 /// 1132 /// If we reach the last level where all the variables have been assigned values 1133 /// already, then we simply return the current sample point if it is integral, 1134 /// and go back to the previous level otherwise. 1135 /// 1136 /// To avoid potentially arbitrarily large recursion depths leading to stack 1137 /// overflows, this algorithm is implemented iteratively. 1138 Optional<SmallVector<int64_t, 8>> Simplex::findIntegerSample() { 1139 if (empty) 1140 return {}; 1141 1142 unsigned nDims = var.size(); 1143 Matrix basis = Matrix::identity(nDims); 1144 1145 unsigned level = 0; 1146 // The snapshot just before constraining a direction to a value at each level. 1147 SmallVector<unsigned, 8> snapshotStack; 1148 // The maximum value in the range of the direction for each level. 1149 SmallVector<int64_t, 8> upperBoundStack; 1150 // The next value to try constraining the basis vector to at each level. 1151 SmallVector<int64_t, 8> nextValueStack; 1152 1153 snapshotStack.reserve(basis.getNumRows()); 1154 upperBoundStack.reserve(basis.getNumRows()); 1155 nextValueStack.reserve(basis.getNumRows()); 1156 while (level != -1u) { 1157 if (level == basis.getNumRows()) { 1158 // We've assigned values to all variables. Return if we have a sample, 1159 // or go back up to the previous level otherwise. 1160 if (auto maybeSample = getSamplePointIfIntegral()) 1161 return maybeSample; 1162 level--; 1163 continue; 1164 } 1165 1166 if (level >= upperBoundStack.size()) { 1167 // We haven't populated the stack values for this level yet, so we have 1168 // just come down a level ("recursed"). Find the lower and upper bounds. 1169 // If there is more than one integer point in the range, perform 1170 // generalized basis reduction. 1171 SmallVector<int64_t, 8> basisCoeffs = 1172 llvm::to_vector<8>(basis.getRow(level)); 1173 basisCoeffs.push_back(0); 1174 1175 int64_t minRoundedUp, maxRoundedDown; 1176 std::tie(minRoundedUp, maxRoundedDown) = 1177 computeIntegerBounds(basisCoeffs); 1178 1179 // Heuristic: if the sample point is integral at this point, just return 1180 // it. 1181 if (auto maybeSample = getSamplePointIfIntegral()) 1182 return *maybeSample; 1183 1184 if (minRoundedUp < maxRoundedDown) { 1185 reduceBasis(basis, level); 1186 basisCoeffs = llvm::to_vector<8>(basis.getRow(level)); 1187 basisCoeffs.push_back(0); 1188 std::tie(minRoundedUp, maxRoundedDown) = 1189 computeIntegerBounds(basisCoeffs); 1190 } 1191 1192 snapshotStack.push_back(getSnapshot()); 1193 // The smallest value in the range is the next value to try. 1194 nextValueStack.push_back(minRoundedUp); 1195 upperBoundStack.push_back(maxRoundedDown); 1196 } 1197 1198 assert((snapshotStack.size() - 1 == level && 1199 nextValueStack.size() - 1 == level && 1200 upperBoundStack.size() - 1 == level) && 1201 "Mismatched variable stack sizes!"); 1202 1203 // Whether we "recursed" or "returned" from a lower level, we rollback 1204 // to the snapshot of the starting state at this level. (in the "recursed" 1205 // case this has no effect) 1206 rollback(snapshotStack.back()); 1207 int64_t nextValue = nextValueStack.back(); 1208 nextValueStack.back()++; 1209 if (nextValue > upperBoundStack.back()) { 1210 // We have exhausted the range and found no solution. Pop the stack and 1211 // return up a level. 1212 snapshotStack.pop_back(); 1213 nextValueStack.pop_back(); 1214 upperBoundStack.pop_back(); 1215 level--; 1216 continue; 1217 } 1218 1219 // Try the next value in the range and "recurse" into the next level. 1220 SmallVector<int64_t, 8> basisCoeffs(basis.getRow(level).begin(), 1221 basis.getRow(level).end()); 1222 basisCoeffs.push_back(-nextValue); 1223 addEquality(basisCoeffs); 1224 level++; 1225 } 1226 1227 return {}; 1228 } 1229 1230 /// Compute the minimum and maximum integer values the expression can take. We 1231 /// compute each separately. 1232 std::pair<int64_t, int64_t> 1233 Simplex::computeIntegerBounds(ArrayRef<int64_t> coeffs) { 1234 int64_t minRoundedUp; 1235 if (Optional<Fraction> maybeMin = 1236 computeOptimum(Simplex::Direction::Down, coeffs)) 1237 minRoundedUp = ceil(*maybeMin); 1238 else 1239 llvm_unreachable("Tableau should not be unbounded"); 1240 1241 int64_t maxRoundedDown; 1242 if (Optional<Fraction> maybeMax = 1243 computeOptimum(Simplex::Direction::Up, coeffs)) 1244 maxRoundedDown = floor(*maybeMax); 1245 else 1246 llvm_unreachable("Tableau should not be unbounded"); 1247 1248 return {minRoundedUp, maxRoundedDown}; 1249 } 1250 1251 void SimplexBase::print(raw_ostream &os) const { 1252 os << "rows = " << nRow << ", columns = " << nCol << "\n"; 1253 if (empty) 1254 os << "Simplex marked empty!\n"; 1255 os << "var: "; 1256 for (unsigned i = 0; i < var.size(); ++i) { 1257 if (i > 0) 1258 os << ", "; 1259 var[i].print(os); 1260 } 1261 os << "\ncon: "; 1262 for (unsigned i = 0; i < con.size(); ++i) { 1263 if (i > 0) 1264 os << ", "; 1265 con[i].print(os); 1266 } 1267 os << '\n'; 1268 for (unsigned row = 0; row < nRow; ++row) { 1269 if (row > 0) 1270 os << ", "; 1271 os << "r" << row << ": " << rowUnknown[row]; 1272 } 1273 os << '\n'; 1274 os << "c0: denom, c1: const"; 1275 for (unsigned col = 2; col < nCol; ++col) 1276 os << ", c" << col << ": " << colUnknown[col]; 1277 os << '\n'; 1278 for (unsigned row = 0; row < nRow; ++row) { 1279 for (unsigned col = 0; col < nCol; ++col) 1280 os << tableau(row, col) << '\t'; 1281 os << '\n'; 1282 } 1283 os << '\n'; 1284 } 1285 1286 void SimplexBase::dump() const { print(llvm::errs()); } 1287 1288 bool Simplex::isRationalSubsetOf(const FlatAffineConstraints &fac) { 1289 if (isEmpty()) 1290 return true; 1291 1292 for (unsigned i = 0, e = fac.getNumInequalities(); i < e; ++i) 1293 if (!isRedundantInequality(fac.getInequality(i))) 1294 return false; 1295 1296 for (unsigned i = 0, e = fac.getNumEqualities(); i < e; ++i) 1297 if (!isRedundantEquality(fac.getEquality(i))) 1298 return false; 1299 1300 return true; 1301 } 1302 1303 /// Computes the minimum value `coeffs` can take. If the value is greater than 1304 /// or equal to zero, the polytope entirely lies in the half-space defined by 1305 /// `coeffs >= 0`. 1306 bool Simplex::isRedundantInequality(ArrayRef<int64_t> coeffs) { 1307 Optional<Fraction> minimum = computeOptimum(Direction::Down, coeffs); 1308 return minimum && *minimum >= Fraction(0, 1); 1309 } 1310 1311 /// Check whether the equality given by `coeffs == 0` is redundant given 1312 /// the existing constraints. This is redundant when `coeffs` is already 1313 /// always zero under the existing constraints. `coeffs` is always zero 1314 /// when the minimum and maximum value that `coeffs` can take are both zero. 1315 bool Simplex::isRedundantEquality(ArrayRef<int64_t> coeffs) { 1316 Optional<Fraction> minimum = computeOptimum(Direction::Down, coeffs); 1317 Optional<Fraction> maximum = computeOptimum(Direction::Up, coeffs); 1318 return minimum && maximum && *maximum == Fraction(0, 1) && 1319 *minimum == Fraction(0, 1); 1320 } 1321 1322 } // namespace mlir 1323