always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

routing: improve doxygen

Browse Source
This commit is contained in:
Corentin Le Molgat
2025-11-07 18:25:21 +01:00
parent 64669dc08d
commit 678dedb5dc
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
ortools/constraint_solver/routing.h
View File

@@ -886,9 +886,8 @@ class OR_DLL RoutingModel {
/// when using @ref AddDisjunction. /// when using @ref AddDisjunction.
enum PenaltyCostBehavior { PENALIZE_ONCE, PENALIZE_PER_INACTIVE }; enum PenaltyCostBehavior { PENALIZE_ONCE, PENALIZE_PER_INACTIVE };
/// Adds a disjunction constraint on the indices: exactly 'max_cardinality' of /// @brief Adds a disjunction constraint on the indices.
/// the indices are active. Start and end indices of any vehicle cannot be /// @details exactly 'max_cardinality' of the indices are active.
/// part of a disjunction.
/// ///
/// If a penalty is given, at most 'max_cardinality' of the indices can be /// If a penalty is given, at most 'max_cardinality' of the indices can be
/// active, and if less are active, 'penalty' is payed per inactive index if /// active, and if less are active, 'penalty' is payed per inactive index if
@@ -902,11 +901,13 @@ class OR_DLL RoutingModel {
/// p == (Sum(i)active[i] != max_cardinality) /// p == (Sum(i)active[i] != max_cardinality)
/// where p is a boolean variable. /// where p is a boolean variable.
/// The following cost is added to the cost function: p * penalty. /// The following cost is added to the cost function: p * penalty.
/// 'penalty' must be positive to make the disjunction optional; a negative /// @param[in] penalty must be positive to make the disjunction optional; a
/// penalty will force 'max_cardinality' indices of the disjunction to be /// negative penalty will force 'max_cardinality' indices of the disjunction
/// performed, and therefore p == 0. /// to be performed, and therefore p == 0.
/// Note: passing a vector with a single index will model an optional index /// Note: passing a vector with a single index will model an optional index
/// with a penalty cost if it is not visited. /// with a penalty cost if it is not visited.
/// @warning Start and end indices of any vehicle cannot be part of a
/// disjunction.
DisjunctionIndex AddDisjunction(const std::vector<int64_t>& indices, DisjunctionIndex AddDisjunction(const std::vector<int64_t>& indices,
int64_t penalty = kNoPenalty, int64_t penalty = kNoPenalty,
int64_t max_cardinality = 1, int64_t max_cardinality = 1,