Stay organized with collections
Save and categorize content based on your preferences.
C++ Reference: class ArgumentHolder
Note: This documentation is automatically generated.
| Method |
FindIntegerArgumentOrDie | Return type: int64_t Arguments: const std::string& arg_name |
FindIntegerArgumentWithDefault | Return type: int64_t Arguments: const std::string& arg_name,
int64_t def Getters.
|
FindIntegerArrayArgumentOrDie | Return type: const std::vector<int64_t>& Arguments:
const std::string& arg_name |
FindIntegerExpressionArgumentOrDie | Return type: IntExpr* Arguments:
const std::string& arg_name |
FindIntegerMatrixArgumentOrDie | Return type: const IntTupleSet& Arguments:
const std::string& arg_name |
FindIntegerVariableArrayArgumentOrDie | Return type: const std::vector<IntVar*>& Arguments:
const std::string& arg_name |
HasIntegerExpressionArgument | Return type: bool Arguments: const std::string& arg_name Checks if arguments exist.
|
HasIntegerVariableArrayArgument | Return type: bool Arguments: const std::string& arg_name |
SetIntegerArgument | Return type: void Arguments: const std::string& arg_name, int64_t value Setters.
|
SetIntegerArrayArgument | Return type: void Arguments: const std::string& arg_name,
const std::vector<int64_t>& values |
SetIntegerExpressionArgument | Return type: void Arguments: const std::string& arg_name,
IntExpr* const expr |
SetIntegerMatrixArgument | Return type: void Arguments: const std::string& arg_name,
const IntTupleSet& values |
SetIntegerVariableArrayArgument | Return type: void Arguments: const std::string& arg_name,
const std::vector<IntVar*>& vars |
SetIntervalArgument | Return type: void Arguments: const std::string& arg_name, IntervalVar* const var |
SetIntervalArrayArgument | Return type: void Arguments: const std::string& arg_name,
const std::vector<IntervalVar*>& vars |
SetSequenceArgument | Return type: void Arguments: const std::string& arg_name, SequenceVar* const var |
SetSequenceArrayArgument | Return type: void Arguments: const std::string& arg_name,
const std::vector<SequenceVar*>& vars |
SetTypeName | Return type: void Arguments: const std::string& type_name |
TypeName | Return type: const std::string& Type of the argument.
|
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eArgumentHolder\u003c/code\u003e is a class within the OR-Tools constraint solver that manages arguments for constraints and search limits.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for setting and retrieving arguments of various types, including integers, integer arrays, integer expressions, and integer matrices.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eArgumentHolder\u003c/code\u003e supports retrieving arguments with default values or throwing exceptions if required arguments are missing.\u003c/p\u003e\n"],["\u003cp\u003eIt also offers functionality to check for the existence of specific arguments before accessing them.\u003c/p\u003e\n"],["\u003cp\u003eUsers can set the type name for the \u003ccode\u003eArgumentHolder\u003c/code\u003e instance using the \u003ccode\u003eSetTypeName\u003c/code\u003e method and retrieve it using the \u003ccode\u003eTypeName\u003c/code\u003e method.\u003c/p\u003e\n"]]],["The `ArgumentHolder` class in C++ manages various types of arguments. It supports setting and retrieving integer values, integer arrays, integer expressions, and integer matrices using `Set` and `Find` methods. It also handles arrays of variables like `IntVar`, `IntervalVar`, and `SequenceVar`. The class can check for the existence of specific integer expression or variable array arguments. Additionally, it manages type information with `SetTypeName` and `TypeName` methods.\n"],null,["# ArgumentHolder\n\nC++ Reference: class ArgumentHolder\n===================================\n\n\nNote: This documentation is automatically generated.\n\n| Method ||\n|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|\n| [`FindIntegerArgumentOrDie`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2356) | Return type: `int64_t ` Arguments: `const std::string& arg_name` \u003cbr /\u003e |\n| [`FindIntegerArgumentWithDefault`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2354) | Return type: `int64_t ` Arguments: `const std::string& arg_name, int64_t def` Getters. |\n| [`FindIntegerArrayArgumentOrDie`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2357) | Return type: `const std::vector\u003cint64_t\u003e& ` Arguments: ` const std::string& arg_name` \u003cbr /\u003e |\n| [`FindIntegerExpressionArgumentOrDie`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2362) | Return type: `IntExpr* ` Arguments: ` const std::string& arg_name` \u003cbr /\u003e |\n| [`FindIntegerMatrixArgumentOrDie`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2359) | Return type: `const IntTupleSet& ` Arguments: ` const std::string& arg_name` \u003cbr /\u003e |\n| [`FindIntegerVariableArrayArgumentOrDie`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2364) | Return type: `const std::vector\u003cIntVar*\u003e& ` Arguments: ` const std::string& arg_name` \u003cbr /\u003e |\n| [`HasIntegerExpressionArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2350) | Return type: `bool ` Arguments: `const std::string& arg_name` Checks if arguments exist. |\n| [`HasIntegerVariableArrayArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2351) | Return type: `bool ` Arguments: `const std::string& arg_name` \u003cbr /\u003e |\n| [`SetIntegerArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2333) | Return type: `void ` Arguments: `const std::string& arg_name, int64_t value` Setters. |\n| [`SetIntegerArrayArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2334) | Return type: `void ` Arguments: `const std::string& arg_name, const std::vector\u003cint64_t\u003e& values` \u003cbr /\u003e |\n| [`SetIntegerExpressionArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2338) | Return type: `void ` Arguments: `const std::string& arg_name, IntExpr* const expr` \u003cbr /\u003e |\n| [`SetIntegerMatrixArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2336) | Return type: `void ` Arguments: `const std::string& arg_name, const IntTupleSet& values` \u003cbr /\u003e |\n| [`SetIntegerVariableArrayArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2340) | Return type: `void ` Arguments: `const std::string& arg_name, const std::vector\u003cIntVar*\u003e& vars` \u003cbr /\u003e |\n| [`SetIntervalArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2342) | Return type: `void ` Arguments: `const std::string& arg_name, IntervalVar* const var` \u003cbr /\u003e |\n| [`SetIntervalArrayArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2343) | Return type: `void ` Arguments: `const std::string& arg_name, const std::vector\u003cIntervalVar*\u003e& vars` \u003cbr /\u003e |\n| [`SetSequenceArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2345) | Return type: `void ` Arguments: `const std::string& arg_name, SequenceVar* const var` \u003cbr /\u003e |\n| [`SetSequenceArrayArgument`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2346) | Return type: `void ` Arguments: `const std::string& arg_name, const std::vector\u003cSequenceVar*\u003e& vars` \u003cbr /\u003e |\n| [`SetTypeName`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2330) | Return type: `void ` Arguments: `const std::string& type_name` \u003cbr /\u003e |\n| [`TypeName`](https://github.com/google/or-tools/blob/v9.4/ortools/constraint_solver/constraint_solveri.h#L2329) | Return type: `const std::string& ` Type of the argument. |"]]
