Stay organized with collections
Save and categorize content based on your preferences.
C++ Reference: class Constraint
Note: This documentation is automatically generated.
| Method |
MutableProto | Return type: ConstraintProto* Returns the mutable underlying protobuf object (useful for model edition).
|
Name | Return type: const std::string& Returns the name of the constraint (or the empty string if not set).
|
OnlyEnforceIf | Return type: Constraint Arguments: absl::Span<const BoolVar> literals |
OnlyEnforceIf | Return type: Constraint Arguments: BoolVar literal See OnlyEnforceIf(absl::Span literals).
|
Proto | Return type: const ConstraintProto& Returns the underlying protobuf object (useful for testing).
|
WithName | Return type: Constraint Arguments: const std::string& name Sets the name of the constraint.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eConstraint\u003c/code\u003e class in C++ provides methods for interacting with constraints within the CP-SAT solver.\u003c/p\u003e\n"],["\u003cp\u003eIt allows accessing and modifying the underlying protobuf representation of the constraint for advanced usage.\u003c/p\u003e\n"],["\u003cp\u003eUsers can retrieve or set the name of the constraint for debugging and organizational purposes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eOnlyEnforceIf\u003c/code\u003e method enables conditional enforcement of the constraint based on Boolean literals or variables.\u003c/p\u003e\n"]]],["The `Constraint` class provides methods for managing constraints in a C++ model. Key actions include retrieving the underlying protobuf object via `MutableProto` or `Proto`, getting the constraint's name using `Name`, and setting it with `WithName`. `OnlyEnforceIf` allows conditional enforcement based on Boolean variables or a span of them. The methods primarily facilitate interaction with and modification of the constraint's internal representation and properties.\n"],null,["# Constraint\n\nC++ Reference: class Constraint\n===============================\n\n\nNote: This documentation is automatically generated.\n\n| Method ||\n|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|\n| [`MutableProto`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L551) | Return type: `ConstraintProto* ` Returns the mutable underlying protobuf object (useful for model edition). |\n| [`Name`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L545) | Return type: `const std::string& ` Returns the name of the constraint (or the empty string if not set). |\n| [`OnlyEnforceIf`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L536) | Return type: `Constraint ` Arguments: `absl::Span\u003cconst BoolVar\u003e literals` \u003cbr /\u003e |\n| [`OnlyEnforceIf`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L539) | Return type: `Constraint ` Arguments: `BoolVar literal` See OnlyEnforceIf(absl::Span literals). |\n| [`Proto`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L548) | Return type: `const ConstraintProto& ` Returns the underlying protobuf object (useful for testing). |\n| [`WithName`](https://github.com/google/or-tools/blob/v9.4/ortools/sat/cp_model.h#L542) | Return type: `Constraint ` Arguments: `const std::string& name` Sets the name of the constraint. |"]]
