 |
Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
|
|
Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
|
Static Public Attributes | |
| PICKUP_AND_DELIVERY_NO_ORDER = _pywrapcp.RoutingModel_PICKUP_AND_DELIVERY_NO_ORDER | |
| PICKUP_AND_DELIVERY_LIFO = _pywrapcp.RoutingModel_PICKUP_AND_DELIVERY_LIFO | |
| PICKUP_AND_DELIVERY_FIFO = _pywrapcp.RoutingModel_PICKUP_AND_DELIVERY_FIFO | |
| kTransitEvaluatorSignUnknown = _pywrapcp.RoutingModel_kTransitEvaluatorSignUnknown | |
| kTransitEvaluatorSignPositiveOrZero = _pywrapcp.RoutingModel_kTransitEvaluatorSignPositiveOrZero | |
| kTransitEvaluatorSignNegativeOrZero = _pywrapcp.RoutingModel_kTransitEvaluatorSignNegativeOrZero | |
| PENALIZE_ONCE = _pywrapcp.RoutingModel_PENALIZE_ONCE | |
| PENALIZE_PER_INACTIVE = _pywrapcp.RoutingModel_PENALIZE_PER_INACTIVE | |
| TYPE_ADDED_TO_VEHICLE = _pywrapcp.RoutingModel_TYPE_ADDED_TO_VEHICLE | |
| ADDED_TYPE_REMOVED_FROM_VEHICLE = _pywrapcp.RoutingModel_ADDED_TYPE_REMOVED_FROM_VEHICLE | |
| TYPE_ON_VEHICLE_UP_TO_VISIT = _pywrapcp.RoutingModel_TYPE_ON_VEHICLE_UP_TO_VISIT | |
| TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED = _pywrapcp.RoutingModel_TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
Definition at line 4858 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.__init__ | ( | self, | |
| * | args ) |
Constructor taking an index manager. The version which does not take
RoutingModelParameters is equivalent to passing
DefaultRoutingModelParameters().
Definition at line 4868 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ActiveVar | ( | self, | |
| index ) |
Returns the active variable of the node corresponding to index.
Definition at line 5946 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ActiveVehicleVar | ( | self, | |
| vehicle ) |
Returns the active variable of the vehicle. It will be equal to 1 iff the
route of the vehicle is not empty, 0 otherwise.
Definition at line 5950 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddAtSolutionCallback | ( | self, | |
| callback, | |||
| track_unchecked_neighbors = False ) |
Adds a callback called each time a solution is found during the search.
This is a shortcut to creating a monitor to call the callback on
AtSolution() and adding it with AddSearchMonitor.
If track_unchecked_neighbors is true, the callback will also be called on
AcceptUncheckedNeighbor() events, which is useful to grab solutions
obtained when solver_parameters.check_solution_period > 1 (aka fastLS).
Definition at line 5555 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddConstantDimension | ( | self, | |
| value, | |||
| capacity, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Definition at line 4969 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddConstantDimensionWithSlack | ( | self, | |
| value, | |||
| capacity, | |||
| slack_max, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Creates a dimension where the transit variable is constrained to be
equal to 'value'; 'capacity' is the upper bound of the cumul variables.
'name' is the name used to reference the dimension; this name is used to
get cumul and transit variables from the routing model.
Returns a pair consisting of an index to the registered unary transit
callback and a bool denoting whether the dimension has been created.
It is false if a dimension with the same name has already been created
(and doesn't create the new dimension but still register a new callback).
Definition at line 4956 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDimension | ( | self, | |
| evaluator_index, | |||
| slack_max, | |||
| capacity, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Model creation
Methods to add dimensions to routes; dimensions represent quantities
accumulated at nodes along the routes. They represent quantities such as
weights or volumes carried along the route, or distance or times.
Quantities at a node are represented by "cumul" variables and the increase
or decrease of quantities between nodes are represented by "transit"
variables. These variables are linked as follows:
if j == next(i), cumul(j) = cumul(i) + transit(i, j) + slack(i)
where slack is a positive slack variable (can represent waiting times for
a time dimension).
Setting the value of fix_start_cumul_to_zero to true will force the
"cumul" variable of the start node of all vehicles to be equal to 0.
Creates a dimension where the transit variable is constrained to be
equal to evaluator(i, next(i)); 'slack_max' is the upper bound of the
slack variable and 'capacity' is the upper bound of the cumul variables.
'name' is the name used to reference the dimension; this name is used to
get cumul and transit variables from the routing model.
Returns false if a dimension with the same name has already been created
(and doesn't create the new dimension).
Takes ownership of the callback 'evaluator'.
Definition at line 4911 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDimensionWithCumulDependentVehicleTransitAndCapacity | ( | self, | |
| fixed_evaluator_indices, | |||
| cumul_dependent_evaluator_indices, | |||
| slack_max, | |||
| vehicle_capacities, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Creates a dimension where the transit variable on arc i->j is the sum of:
- A "fixed" transit value, obtained from the fixed_evaluator_index for
this vehicle, referencing evaluators in transit_evaluators_, and
- A FloatSlopePiecewiseLinearFunction of the cumul of node i, obtained
from the cumul_dependent_evaluator_index of this vehicle, pointing to
an evaluator in cumul_dependent_transit_evaluators_.
Definition at line 4945 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDimensionWithVehicleCapacity | ( | self, | |
| evaluator_index, | |||
| slack_max, | |||
| vehicle_capacities, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Definition at line 4939 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDimensionWithVehicleTransitAndCapacity | ( | self, | |
| evaluator_indices, | |||
| slack_max, | |||
| vehicle_capacities, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Definition at line 4942 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDimensionWithVehicleTransits | ( | self, | |
| evaluator_indices, | |||
| slack_max, | |||
| capacity, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Definition at line 4936 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddDisjunction | ( | self, | |
| * | args ) |
Adds a disjunction constraint on the indices: exactly 'max_cardinality' of
the indices are active. Start and end indices of any vehicle cannot be
part of a disjunction.
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
the penalty cost is set to `PENALIZE_PER_INACTIVE`.
This is equivalent to adding the constraint:
p + Sum(i)active[i] == max_cardinality
where p is an integer variable.
If the penalty cost is set to `PENALIZE_ONCE`, then 'penalty' is payed
once if there are less than `max_cardinality` of the indices active.
This is equivalent to adding the constraint:
p == (Sum(i)active[i] != max_cardinality)
where p is a boolean variable.
The following cost is added to the cost function: p * penalty.
'penalty' must be positive to make the disjunction optional; a negative
penalty will force 'max_cardinality' indices of the disjunction to be
performed, and therefore p == 0.
Note: passing a vector with a single index will model an optional index
with a penalty cost if it is not visited.
Definition at line 5093 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddEnterSearchCallback | ( | self, | |
| callback ) |
Definition at line 5552 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddHardTypeIncompatibility | ( | self, | |
| type1, | |||
| type2 ) |
Incompatibilities:
Two nodes with "hard" incompatible types cannot share the same route at
all, while with a "temporal" incompatibility they can't be on the same
route at the same time.
NOTE: To avoid unnecessary memory reallocations, it is recommended to only
add incompatibilities once all the existing types have been set with
SetVisitType().
Definition at line 5302 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddIntervalToAssignment | ( | self, | |
| interval ) |
Definition at line 5857 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddLocalSearchFilter | ( | self, | |
| filter ) |
Adds a custom local search filter to the list of filters used to speed up
local search by pruning unfeasible variable assignments.
Calling this method after the routing model has been closed (CloseModel()
or Solve() has been called) has no effect.
The routing model does not take ownership of the filter.
Definition at line 5891 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddLocalSearchOperator | ( | self, | |
| ls_operator ) |
Adds a local search operator to the set of operators used to solve the
vehicle routing problem.
Definition at line 5541 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddMatrixDimension | ( | self, | |
| values, | |||
| capacity, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Creates a dimension where the transit variable is constrained to be
equal to 'values[i][next(i)]' for node i; 'capacity' is the upper bound of
the cumul variables. 'name' is the name used to reference the dimension;
this name is used to get cumul and transit variables from the routing
model.
Returns a pair consisting of an index to the registered transit callback
and a bool denoting whether the dimension has been created.
It is false if a dimension with the same name has already been created
(and doesn't create the new dimension but still register a new callback).
Definition at line 4986 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddPickupAndDelivery | ( | self, | |
| pickup, | |||
| delivery ) |
Notifies that index1 and index2 form a pair of nodes which should belong
to the same route. This methods helps the search find better solutions,
especially in the local search phase.
It should be called each time you have an equality constraint linking
the vehicle variables of two node (including for instance pickup and
delivery problems):
Solver* const solver = routing.solver();
int64_t index1 = manager.NodeToIndex(node1);
int64_t index2 = manager.NodeToIndex(node2);
solver->AddConstraint(solver->MakeEquality(
routing.VehicleVar(index1),
routing.VehicleVar(index2)));
routing.AddPickupAndDelivery(index1, index2);
Definition at line 5199 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddPickupAndDeliverySets | ( | self, | |
| pickup_disjunction, | |||
| delivery_disjunction ) |
Same as AddPickupAndDelivery but notifying that the performed node from
the disjunction of index 'pickup_disjunction' is on the same route as the
performed node from the disjunction of index 'delivery_disjunction'.
Definition at line 5217 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddRequiredTypeAlternativesWhenAddingType | ( | self, | |
| dependent_type, | |||
| required_type_alternatives ) |
If type_D depends on type_R when adding type_D, any node_D of type_D and
VisitTypePolicy TYPE_ADDED_TO_VEHICLE or
TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED requires at least one type_R on its
vehicle at the time node_D is visited.
Definition at line 5352 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddRequiredTypeAlternativesWhenRemovingType | ( | self, | |
| dependent_type, | |||
| required_type_alternatives ) |
The following requirements apply when visiting dependent nodes that remove
their type from the route, i.e. type_R must be on the vehicle when type_D
of VisitTypePolicy ADDED_TYPE_REMOVED_FROM_VEHICLE,
TYPE_ON_VEHICLE_UP_TO_VISIT or TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED is
visited.
Definition at line 5361 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddRestoreDimensionValuesResetCallback | ( | self, | |
| callback ) |
Definition at line 5566 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddRouteConstraint | ( | self, | |
| route_evaluator, | |||
| costs_are_homogeneous_across_vehicles = False ) |
Definition at line 5508 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddSameVehicleRequiredTypeAlternatives | ( | self, | |
| dependent_type, | |||
| required_type_alternatives ) |
Requirements:
NOTE: As of 2019-04, cycles in the requirement graph are not supported,
and lead to the dependent nodes being skipped if possible (otherwise
the model is considered infeasible).
The following functions specify that "dependent_type" requires at least
one of the types in "required_type_alternatives".
For same-vehicle requirements, a node of dependent type type_D requires at
least one node of type type_R among the required alternatives on the same
route.
NOTE: To avoid unnecessary memory reallocations, it is recommended to only
add requirements once all the existing types have been set with
SetVisitType().
Definition at line 5334 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddSearchMonitor | ( | self, | |
| monitor ) |
Adds a search monitor to the search used to solve the routing model.
Definition at line 5548 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddSoftSameVehicleConstraint | ( | self, | |
| indices, | |||
| cost ) |
Adds a soft constraint to force a set of variable indices to be on the
same vehicle. If all nodes are not on the same vehicle, each extra vehicle
used adds 'cost' to the cost function.
Definition at line 5178 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddTemporalTypeIncompatibility | ( | self, | |
| type1, | |||
| type2 ) |
Definition at line 5314 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddToAssignment | ( | self, | |
| var ) |
Adds an extra variable to the vehicle routing assignment.
Definition at line 5853 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddVariableMaximizedByFinalizer | ( | self, | |
| var ) |
Adds a variable to maximize in the solution finalizer (see above for
information on the solution finalizer).
Definition at line 5578 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddVariableMinimizedByFinalizer | ( | self, | |
| var ) |
Adds a variable to minimize in the solution finalizer. The solution
finalizer is called each time a solution is found during the search and
allows to instantiate secondary variables (such as dimension cumul
variables).
Definition at line 5569 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddVariableTargetToFinalizer | ( | self, | |
| var, | |||
| target ) |
Add a variable to set the closest possible to the target value in the
solution finalizer.
Definition at line 5599 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddVectorDimension | ( | self, | |
| values, | |||
| capacity, | |||
| fix_start_cumul_to_zero, | |||
| name ) |
Creates a dimension where the transit variable is constrained to be
equal to 'values[i]' for node i; 'capacity' is the upper bound of
the cumul variables. 'name' is the name used to reference the dimension;
this name is used to get cumul and transit variables from the routing
model.
Returns a pair consisting of an index to the registered unary transit
callback and a bool denoting whether the dimension has been created.
It is false if a dimension with the same name has already been created
(and doesn't create the new dimension but still register a new callback).
Definition at line 4972 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddWeightedVariableMaximizedByFinalizer | ( | self, | |
| var, | |||
| cost ) |
Adds a variable to maximize in the solution finalizer, with a weighted
priority: the higher the more priority it has.
Definition at line 5592 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddWeightedVariableMinimizedByFinalizer | ( | self, | |
| var, | |||
| cost ) |
Adds a variable to minimize in the solution finalizer, with a weighted
priority: the higher the more priority it has.
Definition at line 5585 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AddWeightedVariableTargetToFinalizer | ( | self, | |
| var, | |||
| target, | |||
| cost ) |
Same as above with a weighted priority: the higher the cost, the more
priority it has to be set close to the target value.
Definition at line 5606 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ApplyLocks | ( | self, | |
| locks ) |
Applies a lock chain to the next search. 'locks' represents an ordered
vector of nodes representing a partial route which will be fixed during
the next search; it will constrain next variables such that:
next[locks[i]] == locks[i+1].
Returns the next variable at the end of the locked chain; this variable is
not locked. An assignment containing the locks can be obtained by calling
PreAssignment().
Definition at line 5719 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ApplyLocksToAllVehicles | ( | self, | |
| locks, | |||
| close_routes ) |
Applies lock chains to all vehicles to the next search, such that locks[p]
is the lock chain for route p. Returns false if the locks do not contain
valid routes; expects that the routes do not contain the depots,
i.e. there are empty vectors in place of empty routes.
If close_routes is set to true, adds the end nodes to the route of each
vehicle and deactivates other nodes.
An assignment containing the locks can be obtained by calling
PreAssignment().
Definition at line 5732 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ArcIsMoreConstrainedThanArc | ( | self, | |
| _from, | |||
| to1, | |||
| to2 ) |
Returns whether the arc from->to1 is more constrained than from->to2,
taking into account, in order:
- whether the destination node isn't an end node
- whether the destination node is mandatory
- whether the destination node is bound to the same vehicle as the source
- the "primary constrained" dimension (see SetPrimaryConstrainedDimension)
It then breaks ties using, in order:
- the arc cost (taking unperformed penalties into account)
- the size of the vehicle vars of "to1" and "to2" (lowest size wins)
- the value: the lowest value of the indices to1 and to2 wins.
See the .cc for details.
The more constrained arc is typically preferable when building a
first solution. This method is intended to be used as a callback for the
BestValueByComparisonSelector value selector.
Args:
from: the variable index of the source node
to1: the variable index of the first candidate destination node.
to2: the variable index of the second candidate destination node.
Definition at line 6076 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AreRoutesInterdependent | ( | self, | |
| parameters ) |
Returns true if routes are interdependent. This means that any
modification to a route might impact another.
Definition at line 6190 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.AssignmentToRoutes | ( | self, | |
| assignment, | |||
| routes ) |
Converts the solution in the given assignment to routes for all vehicles.
Expects that assignment contains a valid solution (i.e. routes for all
vehicles end with an end index for that vehicle).
Definition at line 5811 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CancelSearch | ( | self | ) |
Cancels the current search.
Definition at line 6153 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CheckIfAssignmentIsFeasible | ( | self, | |
| assignment, | |||
| call_at_solution_monitors ) |
Returns a vector cumul_bounds, for which cumul_bounds[i][j] is a pair
containing the minimum and maximum of the CumulVar of the jth node on
route i.
- cumul_bounds[i][j].first is the minimum.
- cumul_bounds[i][j].second is the maximum.
Checks if an assignment is feasible.
Definition at line 6108 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CheckLimit | ( | self, | |
| * | args ) |
Returns true if the search limit has been crossed with the given time
offset.
Definition at line 6126 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CloseModel | ( | self | ) |
Closes the current routing model; after this method is called, no
modification to the model can be done, but RoutesToAssignment becomes
available. Note that CloseModel() is automatically called by Solve() and
other methods that produce solution.
This is equivalent to calling
CloseModelWithParameters(DefaultRoutingSearchParameters()).
Definition at line 5613 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CloseModelWithParameters | ( | self, | |
| search_parameters ) |
Same as above taking search parameters (as of 10/2015 some the parameters
have to be set when closing the model).
Definition at line 5624 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CompactAndCheckAssignment | ( | self, | |
| assignment ) |
Same as CompactAssignment() but also checks the validity of the final
compact solution; if it is not valid, no attempts to repair it are made
(instead, the method returns nullptr).
Definition at line 5845 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CompactAssignment | ( | self, | |
| assignment ) |
Converts the solution in the given assignment to routes for all vehicles.
If the returned vector is route_indices, route_indices[i][j] is the index
for jth location visited on route i. Note that contrary to
AssignmentToRoutes, the vectors do include start and end locations.
Returns a compacted version of the given assignment, in which all vehicles
with id lower or equal to some N have non-empty routes, and all vehicles
with id greater than N have empty routes. Does not take ownership of the
returned object.
If found, the cost of the compact assignment is the same as in the
original assignment and it preserves the values of 'active' variables.
Returns nullptr if a compact assignment was not found.
This method only works in homogenous mode, and it only swaps equivalent
vehicles (vehicles with the same start and end nodes). When creating the
compact assignment, the empty plan is replaced by the route assigned to
the compatible vehicle with the highest id. Note that with more complex
constraints on vehicle variables, this method might fail even if a compact
solution exists.
This method changes the vehicle and dimension variables as necessary.
While compacting the solution, only basic checks on vehicle variables are
performed; if one of these checks fails no attempts to repair it are made
(instead, the method returns nullptr).
Definition at line 5819 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ComputeLowerBound | ( | self | ) |
Computes a lower bound to the routing problem solving a linear assignment
problem. The routing model must be closed before calling this method.
Note that problems with node disjunction constraints (including optional
nodes) and non-homogenous costs are not supported (the method returns 0 in
these cases).
Definition at line 5694 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CostsAreHomogeneousAcrossVehicles | ( | self | ) |
Whether costs are homogeneous across all vehicles.
Definition at line 5991 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CostVar | ( | self | ) |
Returns the global cost variable which is being minimized.
Definition at line 5980 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.CumulDependentTransitCallback | ( | self, | |
| callback_index ) |
Definition at line 4908 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.DebugOutputAssignment | ( | self, | |
| solution_assignment, | |||
| dimension_to_print ) |
Print some debugging information about an assignment, including the
feasible intervals of the CumulVar for dimension "dimension_to_print"
at each step of the routes.
If "dimension_to_print" is omitted, all dimensions will be printed.
Definition at line 6099 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.enable_deep_serialization | ( | self | ) |
Returns the value of the internal enable_deep_serialization_ parameter.
Definition at line 5715 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.End | ( | self, | |
| vehicle ) |
Returns the variable index of the ending node of a vehicle route.
Definition at line 5908 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.FastSolveFromAssignmentWithParameters | ( | self, | |
| assignment, | |||
| search_parameters, | |||
| check_solution_in_cp, | |||
| touched = None ) |
Improves a given assignment using unchecked local search.
If check_solution_in_cp is true the final solution will be checked with
the CP solver.
As of 11/2023, only works with greedy descent.
Definition at line 5661 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetAllDimensionNames | ( | self | ) |
Outputs the names of all dimensions added to the routing engine.
Definition at line 5000 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetAmortizedLinearCostFactorOfVehicles | ( | self | ) |
Definition at line 5502 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetAmortizedQuadraticCostFactorOfVehicles | ( | self | ) |
Definition at line 5505 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetArcCostForClass | ( | self, | |
| from_index, | |||
| to_index, | |||
| cost_class_index ) |
Returns the cost of the segment between two nodes for a given cost
class. Input are variable indices of nodes and the cost class.
Unlike GetArcCostForVehicle(), if cost_class is kNoCost, then the
returned cost won't necessarily be zero: only some of the components
of the cost that depend on the cost class will be omited. See the code
for details.
Definition at line 6009 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetArcCostForFirstSolution | ( | self, | |
| from_index, | |||
| to_index ) |
Returns the cost of the arc in the context of the first solution strategy.
This is typically a simplification of the actual cost; see the .cc.
Definition at line 6002 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetArcCostForVehicle | ( | self, | |
| from_index, | |||
| to_index, | |||
| vehicle ) |
Returns the cost of the transit arc between two nodes for a given vehicle.
Input are variable indices of node. This returns 0 if vehicle < 0.
Definition at line 5984 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetAutomaticFirstSolutionStrategy | ( | self | ) |
Returns the automatic first solution strategy selected.
Definition at line 6182 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetCostClassesCount | ( | self | ) |
Returns the number of different cost classes in the model.
Definition at line 6031 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetCostClassIndexOfVehicle | ( | self, | |
| vehicle ) |
Get the cost class index of the given vehicle.
Definition at line 6020 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDeliveryPosition | ( | self, | |
| node_index ) |
Returns the pickup and delivery positions where the node is a delivery.
Definition at line 5229 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDepot | ( | self | ) |
Returns the variable index of the first starting or ending node of all
routes. If all routes start and end at the same node (single depot), this
is the node returned.
Definition at line 5420 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionOrDie | ( | self, | |
| dimension_name ) |
Returns a dimension from its name. Dies if the dimension does not exist.
Definition at line 5050 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionResourceGroupIndex | ( | self, | |
| dimension ) |
Returns the index of the resource group attached to the dimension.
DCHECKS that there's exactly one resource group for this dimension.
Definition at line 5084 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionResourceGroupIndices | ( | self, | |
| dimension ) |
Returns the indices of resource groups for this dimension. This method can
only be called after the model has been closed.
Definition at line 5077 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensions | ( | self | ) |
Returns all dimensions of the model.
Definition at line 5004 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionsWithGlobalCumulOptimizers | ( | self | ) |
Returns the dimensions which have [global|local]_dimension_optimizers_.
Definition at line 5016 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionsWithLocalCumulOptimizers | ( | self | ) |
Definition at line 5020 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDimensionsWithSoftOrSpanCosts | ( | self | ) |
Returns dimensions with soft or vehicle span costs.
Definition at line 5008 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDisjunctionIndices | ( | self, | |
| index ) |
Returns the indices of the disjunctions to which an index belongs.
Definition at line 5119 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDisjunctionMaxCardinality | ( | self, | |
| index ) |
Returns the maximum number of possible active nodes of the node
disjunction of index 'index'.
Definition at line 5127 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDisjunctionPenalty | ( | self, | |
| index ) |
Returns the penalty of the node disjunction of index 'index'.
Definition at line 5123 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetDisjunctionPenaltyCostBehavior | ( | self, | |
| index ) |
Returns the 'PenaltyCostBehavior' used by the disjunction of index
'index'.
Definition at line 5134 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetFirstMatchingPickupDeliverySibling | ( | self, | |
| node, | |||
| is_match ) |
Definition at line 5260 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetFirstSolutionHint | ( | self | ) |
Returns the current hint assignment.
Definition at line 5537 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetFixedCostOfVehicle | ( | self, | |
| vehicle ) |
Returns the route fixed cost taken into account if the route of the
vehicle is not empty, aka there's at least one node on the route other
than the first and last nodes.
Definition at line 5464 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetHardTypeIncompatibilitiesOfType | ( | self, | |
| type ) |
Returns visit types incompatible with a given type.
Definition at line 5317 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetHomogeneousCost | ( | self, | |
| from_index, | |||
| to_index ) |
Returns the cost of the segment between two nodes supposing all vehicle
costs are the same (returns the cost for the first vehicle otherwise).
Definition at line 5995 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMaximumNumberOfActiveVehicles | ( | self | ) |
Returns the maximum number of active vehicles.
Definition at line 5437 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableCPInterrupt | ( | self | ) |
Returns the atomic<bool> to stop the CP solver.
Definition at line 6149 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableCPSatInterrupt | ( | self | ) |
Returns the atomic<bool> to stop the CP-SAT solver.
Definition at line 6145 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableDimension | ( | self, | |
| dimension_name ) |
Returns a dimension from its name. Returns nullptr if the dimension does
not exist.
Definition at line 5054 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableGlobalCumulLPOptimizer | ( | self, | |
| dimension ) |
Returns the global/local dimension cumul optimizer for a given dimension,
or nullptr if there is none.
Definition at line 5030 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableGlobalCumulMPOptimizer | ( | self, | |
| dimension ) |
Definition at line 5037 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableLocalCumulLPOptimizer | ( | self, | |
| dimension ) |
Definition at line 5040 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetMutableLocalCumulMPOptimizer | ( | self, | |
| dimension ) |
Definition at line 5043 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNonZeroCostClassesCount | ( | self | ) |
Ditto, minus the 'always zero', built-in cost class.
Definition at line 6035 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNumberOfDecisionsInFirstSolution | ( | self, | |
| search_parameters ) |
Returns statistics on first solution search, number of decisions sent to
filters, number of decisions rejected by filters.
Definition at line 6172 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNumberOfDisjunctions | ( | self | ) |
Returns the number of node disjunctions in the model.
Definition at line 5141 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNumberOfRejectsInFirstSolution | ( | self, | |
| search_parameters ) |
Definition at line 6179 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNumberOfVisitTypes | ( | self | ) |
Definition at line 5299 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetNumOfSingletonNodes | ( | self | ) |
Returns the number of non-start/end nodes which do not appear in a
pickup/delivery pair.
Definition at line 5253 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetOrCreateNodeNeighborsByCostClass | ( | self, | |
| * | args ) |
*Overload 1:*
Returns neighbors of all nodes for every cost class. The result is cached
and is computed once. The number of neighbors considered is based on a
ratio of non-vehicle nodes, specified by neighbors_ratio, with a minimum
of min-neighbors node considered.
|
*Overload 2:*
Returns parameters.num_neighbors neighbors of all nodes for every cost
class. The result is cached and is computed once.
Definition at line 5875 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPairIndicesOfType | ( | self, | |
| type ) |
Definition at line 5293 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPathsMetadata | ( | self | ) |
Definition at line 6232 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPerfectBinaryDisjunctions | ( | self | ) |
Returns the list of all perfect binary disjunctions, as pairs of variable
indices: a disjunction is "perfect" when its variables do not appear in
any other disjunction. Each pair is sorted (lowest variable index first),
and the output vector is also sorted (lowest pairs first).
Definition at line 5159 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPickupAndDeliveryPolicyOfVehicle | ( | self, | |
| vehicle ) |
Definition at line 5250 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPickupPosition | ( | self, | |
| node_index ) |
Returns the pickup and delivery positions where the node is a pickup.
Definition at line 5225 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetPrimaryConstrainedDimension | ( | self | ) |
Get the primary constrained dimension, or an empty string if it is unset.
Definition at line 5070 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetRequiredTypeAlternativesWhenAddingType | ( | self, | |
| type ) |
Returns the set of requirement alternatives when adding the given type.
Definition at line 5378 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetRequiredTypeAlternativesWhenRemovingType | ( | self, | |
| type ) |
Returns the set of requirement alternatives when removing the given type.
Definition at line 5382 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetResourceGroup | ( | self, | |
| rg_index ) |
Definition at line 5074 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetRouteCost | ( | self, | |
| route ) |
Definition at line 5511 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameActivityGroupOfIndex | ( | self, | |
| node ) |
Returns the same activity group of the node.
Definition at line 6061 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameActivityGroupsCount | ( | self | ) |
Returns the number of same activity groups.
Definition at line 6065 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameActivityIndicesOfGroup | ( | self, | |
| group ) |
Returns variable indices of nodes in the same activity group.
Definition at line 6069 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameActivityIndicesOfIndex | ( | self, | |
| node ) |
Returns variable indices of nodes constrained to have the same activity.
Definition at line 6057 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameVehicleClassArcs | ( | self, | |
| from_index, | |||
| to_index ) |
Returns all arcs which are equivalent to the {from_index, to_index} arc
wrt vehicle classes. Arcs will be returned only if from_index is the
start of a vehicle or if to_index is the end of a vehicle. The returned
arcs will then be starting or ending at start or end nodes of vehicles in
the same vehicle class. The input arc is included in the returned vector.
Definition at line 6242 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameVehicleIndicesOfIndex | ( | self, | |
| node ) |
Returns variable indices of nodes constrained to be on the same route.
Definition at line 6053 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSameVehicleRequiredTypeAlternativesOfType | ( | self, | |
| type ) |
Returns the set of same-vehicle requirement alternatives for the given
type.
Definition at line 5371 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetSingleNodesOfType | ( | self, | |
| type ) |
Definition at line 5290 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetTemporalTypeIncompatibilitiesOfType | ( | self, | |
| type ) |
Definition at line 5321 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetUnaryDimensions | ( | self | ) |
Returns dimensions for which all transit evaluators are unary.
Definition at line 5012 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVehicleClassesCount | ( | self | ) |
Returns the number of different vehicle classes in the model.
Definition at line 6049 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVehicleClassIndexOfVehicle | ( | self, | |
| vehicle ) |
Definition at line 6039 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVehicleOfClass | ( | self, | |
| vehicle_class ) |
Returns a vehicle of the given vehicle class, and -1 if there are no
vehicles for this class.
Definition at line 6042 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVehiclesOfSameClass | ( | self, | |
| start_end_index ) |
Returns indices of the vehicles which are in the same vehicle class as the
vehicle starting or ending at start_end_index.
Definition at line 6235 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVehicleTypeContainer | ( | self | ) |
Definition at line 6073 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVisitType | ( | self, | |
| index ) |
Definition at line 5287 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.GetVisitTypePolicy | ( | self, | |
| index ) |
Definition at line 5296 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasDimension | ( | self, | |
| dimension_name ) |
Returns true if a dimension exists for a given dimension name.
Definition at line 5046 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasGlobalCumulOptimizer | ( | self, | |
| dimension ) |
Returns whether the given dimension has global/local cumul optimizers.
Definition at line 5023 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasHardTypeIncompatibilities | ( | self | ) |
Returns true iff any hard (resp. temporal) type incompatibilities have
been added to the model.
Definition at line 5324 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasLocalCumulOptimizer | ( | self, | |
| dimension ) |
Definition at line 5027 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasMandatoryDisjunctions | ( | self | ) |
Returns true if the model contains mandatory disjunctions (ones with
kNoPenalty as penalty).
Definition at line 5145 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasMaxCardinalityConstrainedDisjunctions | ( | self | ) |
Returns true if the model contains at least one disjunction which is
constrained by its max_cardinality.
Definition at line 5152 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasSameVehicleTypeRequirements | ( | self | ) |
Returns true iff any same-route (resp. temporal) type requirements have
been added to the model.
Definition at line 5386 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasTemporalTypeIncompatibilities | ( | self | ) |
Definition at line 5331 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasTemporalTypeRequirements | ( | self | ) |
Definition at line 5393 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasTypeRegulations | ( | self | ) |
Returns true iff the model has any incompatibilities or requirements set
on node types.
Definition at line 5396 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.HasVehicleWithCostClassIndex | ( | self, | |
| cost_class_index ) |
Returns true iff the model contains a vehicle with the given
cost_class_index.
Definition at line 6024 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IgnoreDisjunctionsAlreadyForcedToZero | ( | self | ) |
SPECIAL: Makes the solver ignore all the disjunctions whose active
variables are all trivially zero (i.e. Max() == 0), by setting their
max_cardinality to 0.
This can be useful when using the BaseBinaryDisjunctionNeighborhood
operators, in the context of arc-based routing.
Definition at line 5168 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsDelivery | ( | self, | |
| node_index ) |
Definition at line 5237 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsEnd | ( | self, | |
| index ) |
Returns true if 'index' represents the last node of a route.
Definition at line 5916 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsMatchingModel | ( | self | ) |
Returns true if a vehicle/node matching problem is detected.
Definition at line 6186 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsPickup | ( | self, | |
| node_index ) |
Returns whether the node is a pickup (resp. delivery).
Definition at line 5233 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsStart | ( | self, | |
| index ) |
Returns true if 'index' represents the first node of a route.
Definition at line 5912 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsVehicleAllowedForIndex | ( | self, | |
| vehicle, | |||
| index ) |
Returns true if a vehicle is allowed to visit a given node.
Definition at line 5195 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsVehicleUsed | ( | self, | |
| assignment, | |||
| vehicle ) |
Returns true if the route of 'vehicle' is non empty in 'assignment'.
Definition at line 5935 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.IsVehicleUsedWhenEmpty | ( | self, | |
| vehicle ) |
Definition at line 5517 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.MakeGuidedSlackFinalizer | ( | self, | |
| dimension, | |||
| initializer ) |
The next few members are in the public section only for testing purposes.
MakeGuidedSlackFinalizer creates a DecisionBuilder for the slacks of a
dimension using a callback to choose which values to start with.
The finalizer works only when all next variables in the model have
been fixed. It has the following two characteristics:
1. It follows the routes defined by the nexts variables when choosing a
variable to make a decision on.
2. When it comes to choose a value for the slack of node i, the decision
builder first calls the callback with argument i, and supposingly the
returned value is x it creates decisions slack[i] = x, slack[i] = x +
1, slack[i] = x - 1, slack[i] = x + 2, etc.
Definition at line 6197 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.MakeSelfDependentDimensionFinalizer | ( | self, | |
| dimension ) |
MakeSelfDependentDimensionFinalizer is a finalizer for the slacks of a
self-dependent dimension. It makes an extensive use of the caches of the
state dependent transits.
In detail, MakeSelfDependentDimensionFinalizer returns a composition of a
local search decision builder with a greedy descent operator for the cumul
of the start of each route and a guided slack finalizer. Provided there
are no time windows and the maximum slacks are large enough, once the
cumul of the start of route is fixed, the guided finalizer can find
optimal values of the slacks for the rest of the route in time
proportional to the length of the route. Therefore the composed finalizer
generally works in time O(log(t)*n*m), where t is the latest possible
departute time, n is the number of nodes in the network and m is the
number of vehicles.
Definition at line 6214 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.MutablePreAssignment | ( | self | ) |
Definition at line 5754 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.Next | ( | self, | |
| assignment, | |||
| index ) |
Assignment inspection
Returns the variable index of the node directly after the node
corresponding to 'index' in 'assignment'.
Definition at line 5927 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.NextVar | ( | self, | |
| index ) |
Returns the next variable of the node corresponding to index. Note that
NextVar(index) == index is equivalent to ActiveVar(index) == 0.
Definition at line 5939 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.nodes | ( | self | ) |
Sizes and indices
Returns the number of nodes in the model.
Definition at line 6157 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.objective_lower_bound | ( | self | ) |
Returns the current lower bound found by internal solvers during the
search.
Definition at line 5704 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.PackCumulsOfOptimizerDimensionsFromAssignment | ( | self, | |
| original_assignment, | |||
| duration_limit, | |||
| time_limit_was_reached = None ) |
For every dimension in the model with an optimizer in
local/global_dimension_optimizers_, this method tries to pack the cumul
values of the dimension, such that:
- The cumul costs (span costs, soft lower and upper bound costs, etc) are
minimized.
- The cumuls of the ends of the routes are minimized for this given
minimal cumul cost.
- Given these minimal end cumuls, the route start cumuls are maximized.
Returns the assignment resulting from allocating these packed cumuls with
the solver, and nullptr if these cumuls could not be set by the solver.
Definition at line 5860 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.PreAssignment | ( | self | ) |
Returns an assignment used to fix some of the variables of the problem.
In practice, this assignment locks partial routes of the problem. This
can be used in the context of locking the parts of the routes which have
already been driven in online routing problems.
Definition at line 5745 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ReadAssignment | ( | self, | |
| file_name ) |
Reads an assignment from a file and returns the current solution.
Returns nullptr if the file cannot be opened or if the assignment is not
valid.
Definition at line 5765 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ReadAssignmentFromRoutes | ( | self, | |
| routes, | |||
| ignore_inactive_indices ) |
Restores the routes as the current solution. Returns nullptr if the
solution cannot be restored (routes do not contain a valid solution). Note
that calling this method will run the solver to assign values to the
dimension variables; this may take considerable amount of time, especially
when using dimensions with slack.
Definition at line 5780 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RegisterCumulDependentTransitCallback | ( | self, | |
| callback ) |
Definition at line 4899 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RegisterTransitCallback | ( | self, | |
| * | args ) |
Definition at line 4896 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RegisterTransitMatrix | ( | self, | |
| values ) |
Definition at line 4893 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RegisterUnaryTransitCallback | ( | self, | |
| * | args ) |
Definition at line 4890 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RegisterUnaryTransitVector | ( | self, | |
| values ) |
Registers 'callback' and returns its index.
The sign parameter allows to notify the solver that the callback only
return values of the given sign. This can help the solver, but passing
an incorrect sign may crash in non-opt compilation mode, and yield
incorrect results in opt.
Definition at line 4880 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RemainingTime | ( | self | ) |
Returns the time left in the search limit.
Definition at line 6133 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.ResourceVar | ( | self, | |
| vehicle, | |||
| resource_group ) |
Returns the resource variable for the given vehicle index in the given
resource group. If a vehicle doesn't require a resource from the
corresponding resource group, then ResourceVar(v, r_g) == -1.
Definition at line 5972 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RestoreAssignment | ( | self, | |
| solution ) |
Restores an assignment as a solution in the routing model and returns the
new solution. Returns nullptr if the assignment is not valid.
Definition at line 5773 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.RoutesToAssignment | ( | self, | |
| routes, | |||
| ignore_inactive_indices, | |||
| close_routes, | |||
| assignment ) |
Fills an assignment from a specification of the routes of the
vehicles. The routes are specified as lists of variable indices that
appear on the routes of the vehicles. The indices of the outer vector in
'routes' correspond to vehicles IDs, the inner vector contains the
variable indices on the routes for the given vehicle. The inner vectors
must not contain the start and end indices, as these are determined by the
routing model. Sets the value of NextVars in the assignment, adding the
variables to the assignment if necessary. The method does not touch other
variables in the assignment. The method can only be called after the model
is closed. With ignore_inactive_indices set to false, this method will
fail (return nullptr) in case some of the route contain indices that are
deactivated in the model; when set to true, these indices will be
skipped. Returns true if routes were successfully
loaded. However, such assignment still might not be a valid
solution to the routing problem due to more complex constraints;
it is advisible to call solver()->CheckSolution() afterwards.
Definition at line 5790 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetAllowedVehiclesForIndex | ( | self, | |
| vehicles, | |||
| index ) |
Sets the vehicles which can visit a given node. If the node is in a
disjunction, this will not prevent it from being unperformed.
Specifying an empty vector of vehicles has no effect (all vehicles
will be allowed to visit the node).
Definition at line 5186 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetAmortizedCostFactorsOfAllVehicles | ( | self, | |
| linear_cost_factor, | |||
| quadratic_cost_factor ) |
The following methods set the linear and quadratic cost factors of
vehicles (must be positive values). The default value of these parameters
is zero for all vehicles.
When set, the cost_ of the model will contain terms aiming at reducing the
number of vehicles used in the model, by adding the following to the
objective for every vehicle v:
INDICATOR(v used in the model) *
[linear_cost_factor_of_vehicle_[v]
- quadratic_cost_factor_of_vehicle_[v]*(square of length of route v)]
i.e. for every used vehicle, we add the linear factor as fixed cost, and
subtract the square of the route length multiplied by the quadratic
factor. This second term aims at making the routes as dense as possible.
Sets the linear and quadratic cost factor of all vehicles.
Definition at line 5478 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetAmortizedCostFactorsOfVehicle | ( | self, | |
| linear_cost_factor, | |||
| quadratic_cost_factor, | |||
| vehicle ) |
Sets the linear and quadratic cost factor of the given vehicle.
Definition at line 5498 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetArcCostEvaluatorOfAllVehicles | ( | self, | |
| evaluator_index ) |
Sets the cost function of the model such that the cost of a segment of a
route between node 'from' and 'to' is evaluator(from, to), whatever the
route or vehicle performing the route.
Definition at line 5441 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetArcCostEvaluatorOfVehicle | ( | self, | |
| evaluator_index, | |||
| vehicle ) |
Sets the cost function for a given vehicle route.
Definition at line 5449 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetAssignmentFromOtherModelAssignment | ( | self, | |
| target_assignment, | |||
| source_model, | |||
| source_assignment ) |
Given a "source_model" and its "source_assignment", resets
"target_assignment" with the IntVar variables (nexts_, and vehicle_vars_
if costs aren't homogeneous across vehicles) of "this" model, with the
values set according to those in "other_assignment".
The objective_element of target_assignment is set to this->cost_.
Definition at line 5684 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetFirstSolutionEvaluator | ( | self, | |
| evaluator ) |
Gets/sets the evaluator used during the search. Only relevant when
RoutingSearchParameters.first_solution_strategy = EVALUATOR_STRATEGY.
Takes ownership of evaluator.
Definition at line 5520 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetFirstSolutionHint | ( | self, | |
| hint ) |
Adds a hint to be used by first solution strategies. The hint assignment
must outlive the search.
As of 2024-12, only used by LOCAL_CHEAPEST_INSERTION and
LOCAL_CHEAPEST_COST_INSERTION.
Definition at line 5528 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetFixedCostOfAllVehicles | ( | self, | |
| cost ) |
Sets the fixed cost of all vehicle routes. It is equivalent to calling
SetFixedCostOfVehicle on all vehicle routes.
Definition at line 5453 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetFixedCostOfVehicle | ( | self, | |
| cost, | |||
| vehicle ) |
Sets the fixed cost of one vehicle route.
Definition at line 5460 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetMaximumNumberOfActiveVehicles | ( | self, | |
| max_active_vehicles ) |
Constrains the maximum number of active vehicles, aka the number of
vehicles which do not have an empty route. For instance, this can be used
to limit the number of routes in the case where there are fewer drivers
than vehicles and that the fleet of vehicle is heterogeneous.
Definition at line 5428 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetPathEnergyCostOfVehicle | ( | self, | |
| force, | |||
| distance, | |||
| cost_per_unit, | |||
| vehicle ) |
Definition at line 5472 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetPathEnergyCostsOfVehicle | ( | self, | |
| force, | |||
| distance, | |||
| threshold, | |||
| cost_per_unit_below_threshold, | |||
| cost_per_unit_above_threshold, | |||
| vehicle ) |
Definition at line 5475 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetPickupAndDeliveryPolicyOfAllVehicles | ( | self, | |
| policy ) |
Sets the Pickup and delivery policy of all vehicles. It is equivalent to
calling SetPickupAndDeliveryPolicyOfVehicle on all vehicles.
Definition at line 5240 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetPickupAndDeliveryPolicyOfVehicle | ( | self, | |
| policy, | |||
| vehicle ) |
Definition at line 5247 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetPrimaryConstrainedDimension | ( | self, | |
| dimension_name ) |
Set the given dimension as "primary constrained". As of August 2013, this
is only used by ArcIsMoreConstrainedThanArc().
"dimension" must be the name of an existing dimension, or be empty, in
which case there will not be a primary dimension after this call.
Definition at line 5061 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetVehicleUsedWhenEmpty | ( | self, | |
| is_used, | |||
| vehicle ) |
Definition at line 5514 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SetVisitType | ( | self, | |
| index, | |||
| type, | |||
| type_policy ) |
Definition at line 5284 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.Size | ( | self | ) |
Returns the number of next variables in the model.
Definition at line 6168 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.Solve | ( | self, | |
| assignment = None ) |
Solves the current routing model; closes the current model.
This is equivalent to calling
SolveWithParameters(DefaultRoutingSearchParameters())
or
SolveFromAssignmentWithParameters(assignment,
DefaultRoutingSearchParameters()).
Definition at line 5631 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SolveFromAssignmentsWithParameters | ( | self, | |
| assignments, | |||
| search_parameters, | |||
| solutions = None ) |
Same as above but will try all assignments in order as first solutions
until one succeeds.
Definition at line 5670 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SolveFromAssignmentWithParameters | ( | self, | |
| assignment, | |||
| search_parameters, | |||
| solutions = None ) |
Same as above, except that if assignment is not null, it will be used as
the initial solution.
Definition at line 5654 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.solver | ( | self | ) |
Returns the underlying constraint solver. Can be used to add extra
constraints and/or modify search algorithms.
Definition at line 6119 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SolveWithIteratedLocalSearch | ( | self, | |
| search_parameters ) |
Solves the current routing model by using an Iterated Local Search
approach.
Definition at line 5677 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.SolveWithParameters | ( | self, | |
| search_parameters, | |||
| solutions = None ) |
Solves the current routing model with the given parameters. If 'solutions'
is specified, it will contain the k best solutions found during the search
(from worst to best, including the one returned by this method), where k
corresponds to the 'number_of_solutions_to_collect' in
'search_parameters'. Note that the Assignment returned by the method and
the ones in solutions are owned by the underlying solver and should not be
deleted.
Definition at line 5642 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.Start | ( | self, | |
| vehicle ) |
Model inspection.
Returns the variable index of the starting node of a vehicle route.
Definition at line 5901 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.status | ( | self | ) |
Returns the current status of the routing model.
Definition at line 5711 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.TimeBuffer | ( | self | ) |
Returns the time buffer to safely return a solution.
Definition at line 6141 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.TransitCallback | ( | self, | |
| callback_index ) |
Definition at line 4902 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.UnaryTransitCallbackOrNull | ( | self, | |
| callback_index ) |
Definition at line 4905 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.UnperformedPenalty | ( | self, | |
| var_index ) |
Get the "unperformed" penalty of a node. This is only well defined if the
node is only part of a single Disjunction, and that disjunction has a
penalty. For forced active nodes returns max int64_t. In all other cases,
this returns 0.
Definition at line 5403 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.UnperformedPenaltyOrValue | ( | self, | |
| default_value, | |||
| var_index ) |
Same as above except that it returns default_value instead of 0 when
penalty is not well defined (default value is passed as first argument to
simplify the usage of the method in a callback).
Definition at line 5412 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.UpdateTimeLimit | ( | self, | |
| time_limit ) |
Updates the time limit of the search limit.
Definition at line 6137 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.VehicleIndex | ( | self, | |
| index ) |
Returns the vehicle of the given start/end index, and -1 if the given
index is not a vehicle start/end.
Definition at line 5920 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.VehicleRouteConsideredVar | ( | self, | |
| vehicle ) |
Returns the variable specifying whether or not the given vehicle route is
considered for costs and constraints. It will be equal to 1 iff the route
of the vehicle is not empty OR vehicle_used_when_empty_[vehicle] is true.
Definition at line 5957 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.vehicles | ( | self | ) |
Returns the number of vehicle routes in the model.
Definition at line 6164 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.VehicleVar | ( | self, | |
| index ) |
Returns the vehicle variable of the node corresponding to index. Note that
VehicleVar(index) == -1 is equivalent to ActiveVar(index) == 0.
Definition at line 5965 of file pywrapcp.py.
| ortools.constraint_solver.pywrapcp.RoutingModel.WriteAssignment | ( | self, | |
| file_name ) |
Writes the current solution to a file containing an AssignmentProto.
Returns false if the file cannot be opened or if there is no current
solution.
Definition at line 5757 of file pywrapcp.py.
|
static |
Definition at line 5264 of file pywrapcp.py.
|
static |
Definition at line 4878 of file pywrapcp.py.
|
static |
Definition at line 4877 of file pywrapcp.py.
|
static |
Definition at line 4876 of file pywrapcp.py.
|
static |
Definition at line 5090 of file pywrapcp.py.
|
static |
Definition at line 5091 of file pywrapcp.py.
|
static |
Definition at line 4865 of file pywrapcp.py.
|
static |
Definition at line 4863 of file pywrapcp.py.
|
static |
Definition at line 4861 of file pywrapcp.py.
|
static |
Definition at line 5262 of file pywrapcp.py.
|
static |
Definition at line 5271 of file pywrapcp.py.
|
static |
Definition at line 5276 of file pywrapcp.py.
|
static |
Definition at line 4859 of file pywrapcp.py.
1.13.2