 |
OR-Tools
9.3
|
|
OR-Tools
9.3
|
Classes | |
| struct | CostClass |
| class | ResourceGroup |
| A ResourceGroup defines a set of available Resources with attributes on one or multiple dimensions. More... | |
| struct | StateDependentTransit |
| What follows is relevant for models with time/state dependent transits. More... | |
| struct | VehicleClass |
| struct | VehicleTypeContainer |
| Struct used to sort and store vehicles by their type. More... | |
Public Member Functions | |
| RoutingModel (const RoutingIndexManager &index_manager) | |
| Constructor taking an index manager. More... | |
| RoutingModel (const RoutingIndexManager &index_manager, const RoutingModelParameters ¶meters) | |
| ~RoutingModel () | |
| int | RegisterUnaryTransitVector (std::vector< int64_t > values) |
| Registers 'callback' and returns its index. More... | |
| int | RegisterUnaryTransitCallback (TransitCallback1 callback) |
| int | RegisterPositiveUnaryTransitCallback (TransitCallback1 callback) |
| int | RegisterTransitMatrix (std::vector< std::vector< int64_t > > values) |
| int | RegisterTransitCallback (TransitCallback2 callback) |
| int | RegisterPositiveTransitCallback (TransitCallback2 callback) |
| int | RegisterStateDependentTransitCallback (VariableIndexEvaluator2 callback) |
| const TransitCallback2 & | TransitCallback (int callback_index) const |
| const TransitCallback1 & | UnaryTransitCallbackOrNull (int callback_index) const |
| const VariableIndexEvaluator2 & | StateDependentTransitCallback (int callback_index) const |
| bool | AddDimension (int evaluator_index, int64_t slack_max, int64_t capacity, bool fix_start_cumul_to_zero, const std::string &name) |
| Model creation. More... | |
| bool | AddDimensionWithVehicleTransits (const std::vector< int > &evaluator_indices, int64_t slack_max, int64_t capacity, bool fix_start_cumul_to_zero, const std::string &name) |
| bool | AddDimensionWithVehicleCapacity (int evaluator_index, int64_t slack_max, std::vector< int64_t > vehicle_capacities, bool fix_start_cumul_to_zero, const std::string &name) |
| bool | AddDimensionWithVehicleTransitAndCapacity (const std::vector< int > &evaluator_indices, int64_t slack_max, std::vector< int64_t > vehicle_capacities, bool fix_start_cumul_to_zero, const std::string &name) |
| std::pair< int, bool > | AddConstantDimensionWithSlack (int64_t value, int64_t capacity, int64_t slack_max, bool fix_start_cumul_to_zero, const std::string &name) |
| Creates a dimension where the transit variable is constrained to be equal to 'value'; 'capacity' is the upper bound of the cumul variables. More... | |
| std::pair< int, bool > | AddConstantDimension (int64_t value, int64_t capacity, bool fix_start_cumul_to_zero, const std::string &name) |
| std::pair< int, bool > | AddVectorDimension (std::vector< int64_t > values, int64_t capacity, bool fix_start_cumul_to_zero, const std::string &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. More... | |
| std::pair< int, bool > | AddMatrixDimension (std::vector< std::vector< int64_t > > values, int64_t capacity, bool fix_start_cumul_to_zero, const std::string &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. More... | |
| bool | AddDimensionDependentDimensionWithVehicleCapacity (const std::vector< int > &pure_transits, const std::vector< int > &dependent_transits, const RoutingDimension *base_dimension, int64_t slack_max, std::vector< int64_t > vehicle_capacities, bool fix_start_cumul_to_zero, const std::string &name) |
| Creates a dimension with transits depending on the cumuls of another dimension. More... | |
| bool | AddDimensionDependentDimensionWithVehicleCapacity (const std::vector< int > &transits, const RoutingDimension *base_dimension, int64_t slack_max, std::vector< int64_t > vehicle_capacities, bool fix_start_cumul_to_zero, const std::string &name) |
| As above, but pure_transits are taken to be zero evaluators. More... | |
| bool | AddDimensionDependentDimensionWithVehicleCapacity (int transit, const RoutingDimension *base_dimension, int64_t slack_max, int64_t vehicle_capacity, bool fix_start_cumul_to_zero, const std::string &name) |
| Homogeneous versions of the functions above. More... | |
| bool | AddDimensionDependentDimensionWithVehicleCapacity (int pure_transit, int dependent_transit, const RoutingDimension *base_dimension, int64_t slack_max, int64_t vehicle_capacity, bool fix_start_cumul_to_zero, const std::string &name) |
| Constraint * | MakePathSpansAndTotalSlacks (const RoutingDimension *dimension, std::vector< IntVar * > spans, std::vector< IntVar * > total_slacks) |
| For every vehicle of the routing model: More... | |
| std::vector< std::string > | GetAllDimensionNames () const |
| Outputs the names of all dimensions added to the routing engine. More... | |
| const std::vector< RoutingDimension * > & | GetDimensions () const |
| Returns all dimensions of the model. More... | |
| std::vector< RoutingDimension * > | GetDimensionsWithSoftOrSpanCosts () const |
| Returns dimensions with soft or vehicle span costs. More... | |
| const std::vector< std::unique_ptr< GlobalDimensionCumulOptimizer > > & | GetGlobalDimensionCumulOptimizers () const |
| Returns [global|local]_dimension_optimizers_, which are empty if the model has not been closed. More... | |
| const std::vector< std::unique_ptr< GlobalDimensionCumulOptimizer > > & | GetGlobalDimensionCumulMPOptimizers () const |
| const std::vector< std::unique_ptr< LocalDimensionCumulOptimizer > > & | GetLocalDimensionCumulOptimizers () const |
| const std::vector< std::unique_ptr< LocalDimensionCumulOptimizer > > & | GetLocalDimensionCumulMPOptimizers () const |
| GlobalDimensionCumulOptimizer * | GetMutableGlobalCumulOptimizer (const RoutingDimension &dimension) const |
| Returns the global/local dimension cumul optimizer for a given dimension, or nullptr if there is none. More... | |
| GlobalDimensionCumulOptimizer * | GetMutableGlobalCumulMPOptimizer (const RoutingDimension &dimension) const |
| LocalDimensionCumulOptimizer * | GetMutableLocalCumulOptimizer (const RoutingDimension &dimension) const |
| LocalDimensionCumulOptimizer * | GetMutableLocalCumulMPOptimizer (const RoutingDimension &dimension) const |
| bool | HasDimension (const std::string &dimension_name) const |
| Returns true if a dimension exists for a given dimension name. More... | |
| const RoutingDimension & | GetDimensionOrDie (const std::string &dimension_name) const |
| Returns a dimension from its name. Dies if the dimension does not exist. More... | |
| RoutingDimension * | GetMutableDimension (const std::string &dimension_name) const |
| Returns a dimension from its name. More... | |
| void | SetPrimaryConstrainedDimension (const std::string &dimension_name) |
| Set the given dimension as "primary constrained". More... | |
| const std::string & | GetPrimaryConstrainedDimension () const |
| Get the primary constrained dimension, or an empty string if it is unset. More... | |
| int | AddResourceGroup () |
| Adds a resource group to the routing model. More... | |
| const std::vector< std::unique_ptr< ResourceGroup > > & | GetResourceGroups () const |
| ResourceGroup * | GetResourceGroup (int rg_index) const |
| const std::vector< int > & | GetDimensionResourceGroupIndices (const RoutingDimension *dimension) const |
| Returns the indices of resource groups for this dimension. More... | |
| int | GetDimensionResourceGroupIndex (const RoutingDimension *dimension) const |
| Returns the index of the resource group attached to the dimension. More... | |
| DisjunctionIndex | AddDisjunction (const std::vector< int64_t > &indices, int64_t penalty=kNoPenalty, int64_t max_cardinality=1) |
| Adds a disjunction constraint on the indices: exactly 'max_cardinality' of the indices are active. More... | |
| const std::vector< DisjunctionIndex > & | GetDisjunctionIndices (int64_t index) const |
| Returns the indices of the disjunctions to which an index belongs. More... | |
| template<typename F > | |
| void | ForEachNodeInDisjunctionWithMaxCardinalityFromIndex (int64_t index, int64_t max_cardinality, F f) const |
| Calls f for each variable index of indices in the same disjunctions as the node corresponding to the variable index 'index'; only disjunctions of cardinality 'cardinality' are considered. More... | |
| const std::vector< int64_t > & | GetDisjunctionNodeIndices (DisjunctionIndex index) const |
| Returns the variable indices of the nodes in the disjunction of index 'index'. More... | |
| int64_t | GetDisjunctionPenalty (DisjunctionIndex index) const |
| Returns the penalty of the node disjunction of index 'index'. More... | |
| int64_t | GetDisjunctionMaxCardinality (DisjunctionIndex index) const |
| Returns the maximum number of possible active nodes of the node disjunction of index 'index'. More... | |
| int | GetNumberOfDisjunctions () const |
| Returns the number of node disjunctions in the model. More... | |
| bool | HasMandatoryDisjunctions () const |
| Returns true if the model contains mandatory disjunctions (ones with kNoPenalty as penalty). More... | |
| bool | HasMaxCardinalityConstrainedDisjunctions () const |
| Returns true if the model contains at least one disjunction which is constrained by its max_cardinality. More... | |
| std::vector< std::pair< int64_t, int64_t > > | GetPerfectBinaryDisjunctions () const |
| 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. More... | |
| void | IgnoreDisjunctionsAlreadyForcedToZero () |
| SPECIAL: Makes the solver ignore all the disjunctions whose active variables are all trivially zero (i.e. More... | |
| void | AddSoftSameVehicleConstraint (const std::vector< int64_t > &indices, int64_t cost) |
| Adds a soft constraint to force a set of variable indices to be on the same vehicle. More... | |
| void | SetAllowedVehiclesForIndex (const std::vector< int > &vehicles, int64_t index) |
| Sets the vehicles which can visit a given node. More... | |
| bool | IsVehicleAllowedForIndex (int vehicle, int64_t index) |
| Returns true if a vehicle is allowed to visit a given node. More... | |
| void | AddPickupAndDelivery (int64_t pickup, int64_t delivery) |
| Notifies that index1 and index2 form a pair of nodes which should belong to the same route. More... | |
| void | AddPickupAndDeliverySets (DisjunctionIndex pickup_disjunction, DisjunctionIndex 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'. More... | |
| const std::vector< std::pair< int, int > > & | GetPickupIndexPairs (int64_t node_index) const |
| Returns pairs for which the node is a pickup; the first element of each pair is the index in the pickup and delivery pairs list in which the pickup appears, the second element is its index in the pickups list. More... | |
| const std::vector< std::pair< int, int > > & | GetDeliveryIndexPairs (int64_t node_index) const |
| Same as above for deliveries. More... | |
| void | SetPickupAndDeliveryPolicyOfAllVehicles (PickupAndDeliveryPolicy policy) |
| Sets the Pickup and delivery policy of all vehicles. More... | |
| void | SetPickupAndDeliveryPolicyOfVehicle (PickupAndDeliveryPolicy policy, int vehicle) |
| PickupAndDeliveryPolicy | GetPickupAndDeliveryPolicyOfVehicle (int vehicle) const |
| int | GetNumOfSingletonNodes () const |
| Returns the number of non-start/end nodes which do not appear in a pickup/delivery pair. More... | |
| const IndexPairs & | GetPickupAndDeliveryPairs () const |
| Returns pickup and delivery pairs currently in the model. More... | |
| const std::vector< std::pair< DisjunctionIndex, DisjunctionIndex > > & | GetPickupAndDeliveryDisjunctions () const |
| const IndexPairs & | GetImplicitUniquePickupAndDeliveryPairs () const |
| Returns implicit pickup and delivery pairs currently in the model. More... | |
| void | SetVisitType (int64_t index, int type, VisitTypePolicy type_policy) |
| int | GetVisitType (int64_t index) const |
| const std::vector< int > & | GetSingleNodesOfType (int type) const |
| const std::vector< int > & | GetPairIndicesOfType (int type) const |
| VisitTypePolicy | GetVisitTypePolicy (int64_t index) const |
| void | CloseVisitTypes () |
| This function should be called once all node visit types have been set and prior to adding any incompatibilities/requirements. More... | |
| int | GetNumberOfVisitTypes () const |
| const std::vector< std::vector< int > > & | GetTopologicallySortedVisitTypes () const |
| void | AddHardTypeIncompatibility (int type1, int 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. More... | |
| void | AddTemporalTypeIncompatibility (int type1, int type2) |
| const absl::flat_hash_set< int > & | GetHardTypeIncompatibilitiesOfType (int type) const |
| Returns visit types incompatible with a given type. More... | |
| const absl::flat_hash_set< int > & | GetTemporalTypeIncompatibilitiesOfType (int type) const |
| bool | HasHardTypeIncompatibilities () const |
| Returns true iff any hard (resp. More... | |
| bool | HasTemporalTypeIncompatibilities () const |
| void | AddSameVehicleRequiredTypeAlternatives (int dependent_type, absl::flat_hash_set< int > 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). More... | |
| void | AddRequiredTypeAlternativesWhenAddingType (int dependent_type, absl::flat_hash_set< int > 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. More... | |
| void | AddRequiredTypeAlternativesWhenRemovingType (int dependent_type, absl::flat_hash_set< int > required_type_alternatives) |
| The following requirements apply when visiting dependent nodes that remove their type from the route, i.e. More... | |
| const std::vector< absl::flat_hash_set< int > > & | GetSameVehicleRequiredTypeAlternativesOfType (int type) const |
| Returns the set of same-vehicle requirement alternatives for the given type. More... | |
| const std::vector< absl::flat_hash_set< int > > & | GetRequiredTypeAlternativesWhenAddingType (int type) const |
| Returns the set of requirement alternatives when adding the given type. More... | |
| const std::vector< absl::flat_hash_set< int > > & | GetRequiredTypeAlternativesWhenRemovingType (int type) const |
| Returns the set of requirement alternatives when removing the given type. More... | |
| bool | HasSameVehicleTypeRequirements () const |
| Returns true iff any same-route (resp. More... | |
| bool | HasTemporalTypeRequirements () const |
| bool | HasTypeRegulations () const |
| Returns true iff the model has any incompatibilities or requirements set on node types. More... | |
| int64_t | UnperformedPenalty (int64_t var_index) const |
| Get the "unperformed" penalty of a node. More... | |
| int64_t | UnperformedPenaltyOrValue (int64_t default_value, int64_t var_index) const |
| 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). More... | |
| int64_t | GetDepot () const |
| Returns the variable index of the first starting or ending node of all routes. More... | |
| void | SetMaximumNumberOfActiveVehicles (int max_active_vehicles) |
| Constrains the maximum number of active vehicles, aka the number of vehicles which do not have an empty route. More... | |
| int | GetMaximumNumberOfActiveVehicles () const |
| Returns the maximum number of active vehicles. More... | |
| void | SetArcCostEvaluatorOfAllVehicles (int 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. More... | |
| void | SetArcCostEvaluatorOfVehicle (int evaluator_index, int vehicle) |
| Sets the cost function for a given vehicle route. More... | |
| void | SetFixedCostOfAllVehicles (int64_t cost) |
| Sets the fixed cost of all vehicle routes. More... | |
| void | SetFixedCostOfVehicle (int64_t cost, int vehicle) |
| Sets the fixed cost of one vehicle route. More... | |
| int64_t | GetFixedCostOfVehicle (int vehicle) const |
| 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. More... | |
| void | SetAmortizedCostFactorsOfAllVehicles (int64_t linear_cost_factor, int64_t quadratic_cost_factor) |
| The following methods set the linear and quadratic cost factors of vehicles (must be positive values). More... | |
| void | SetAmortizedCostFactorsOfVehicle (int64_t linear_cost_factor, int64_t quadratic_cost_factor, int vehicle) |
| Sets the linear and quadratic cost factor of the given vehicle. More... | |
| const std::vector< int64_t > & | GetAmortizedLinearCostFactorOfVehicles () const |
| const std::vector< int64_t > & | GetAmortizedQuadraticCostFactorOfVehicles () const |
| void | SetVehicleUsedWhenEmpty (bool is_used, int vehicle) |
| bool | IsVehicleUsedWhenEmpty (int vehicle) const |
| const Solver::IndexEvaluator2 & | first_solution_evaluator () const |
| Gets/sets the evaluator used during the search. More... | |
| void | SetFirstSolutionEvaluator (Solver::IndexEvaluator2 evaluator) |
| Takes ownership of evaluator. More... | |
| void | AddLocalSearchOperator (LocalSearchOperator *ls_operator) |
| Adds a local search operator to the set of operators used to solve the vehicle routing problem. More... | |
| void | AddSearchMonitor (SearchMonitor *const monitor) |
| Adds a search monitor to the search used to solve the routing model. More... | |
| void | AddAtSolutionCallback (std::function< void()> callback) |
| Adds a callback called each time a solution is found during the search. More... | |
| void | AddVariableMinimizedByFinalizer (IntVar *var) |
| Adds a variable to minimize in the solution finalizer. More... | |
| void | AddVariableMaximizedByFinalizer (IntVar *var) |
| Adds a variable to maximize in the solution finalizer (see above for information on the solution finalizer). More... | |
| void | AddWeightedVariableMinimizedByFinalizer (IntVar *var, int64_t cost) |
| Adds a variable to minimize in the solution finalizer, with a weighted priority: the higher the more priority it has. More... | |
| void | AddWeightedVariableMaximizedByFinalizer (IntVar *var, int64_t cost) |
| Adds a variable to maximize in the solution finalizer, with a weighted priority: the higher the more priority it has. More... | |
| void | AddVariableTargetToFinalizer (IntVar *var, int64_t target) |
| Add a variable to set the closest possible to the target value in the solution finalizer. More... | |
| void | AddWeightedVariableTargetToFinalizer (IntVar *var, int64_t target, int64_t 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. More... | |
| void | CloseModel () |
| Closes the current routing model; after this method is called, no modification to the model can be done, but RoutesToAssignment becomes available. More... | |
| void | CloseModelWithParameters (const RoutingSearchParameters &search_parameters) |
| Same as above taking search parameters (as of 10/2015 some the parameters have to be set when closing the model). More... | |
| const Assignment * | Solve (const Assignment *assignment=nullptr) |
| Solves the current routing model; closes the current model. More... | |
| const Assignment * | SolveWithParameters (const RoutingSearchParameters &search_parameters, std::vector< const Assignment * > *solutions=nullptr) |
| Solves the current routing model with the given parameters. More... | |
| const Assignment * | SolveFromAssignmentWithParameters (const Assignment *assignment, const RoutingSearchParameters &search_parameters, std::vector< const Assignment * > *solutions=nullptr) |
| Same as above, except that if assignment is not null, it will be used as the initial solution. More... | |
| const Assignment * | SolveFromAssignmentsWithParameters (const std::vector< const Assignment * > &assignments, const RoutingSearchParameters &search_parameters, std::vector< const Assignment * > *solutions=nullptr) |
| Same as above but will try all assignments in order as first solutions until one succeeds. More... | |
| void | SetAssignmentFromOtherModelAssignment (Assignment *target_assignment, const RoutingModel *source_model, const Assignment *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". More... | |
| int64_t | ComputeLowerBound () |
| Computes a lower bound to the routing problem solving a linear assignment problem. More... | |
| Status | status () const |
| Returns the current status of the routing model. More... | |
| IntVar * | ApplyLocks (const std::vector< int64_t > &locks) |
| Applies a lock chain to the next search. More... | |
| bool | ApplyLocksToAllVehicles (const std::vector< std::vector< int64_t > > &locks, bool close_routes) |
| Applies lock chains to all vehicles to the next search, such that locks[p] is the lock chain for route p. More... | |
| const Assignment *const | PreAssignment () const |
| Returns an assignment used to fix some of the variables of the problem. More... | |
| Assignment * | MutablePreAssignment () |
| bool | WriteAssignment (const std::string &file_name) const |
| Writes the current solution to a file containing an AssignmentProto. More... | |
| Assignment * | ReadAssignment (const std::string &file_name) |
| Reads an assignment from a file and returns the current solution. More... | |
| Assignment * | RestoreAssignment (const Assignment &solution) |
| Restores an assignment as a solution in the routing model and returns the new solution. More... | |
| Assignment * | ReadAssignmentFromRoutes (const std::vector< std::vector< int64_t > > &routes, bool ignore_inactive_indices) |
| Restores the routes as the current solution. More... | |
| bool | RoutesToAssignment (const std::vector< std::vector< int64_t > > &routes, bool ignore_inactive_indices, bool close_routes, Assignment *const assignment) const |
| Fills an assignment from a specification of the routes of the vehicles. More... | |
| void | AssignmentToRoutes (const Assignment &assignment, std::vector< std::vector< int64_t > > *const routes) const |
| Converts the solution in the given assignment to routes for all vehicles. More... | |
| std::vector< std::vector< int64_t > > | GetRoutesFromAssignment (const Assignment &assignment) |
| Converts the solution in the given assignment to routes for all vehicles. More... | |
| Assignment * | CompactAssignment (const Assignment &assignment) const |
| 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. More... | |
| Assignment * | CompactAndCheckAssignment (const Assignment &assignment) const |
| 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). More... | |
| void | AddToAssignment (IntVar *const var) |
| Adds an extra variable to the vehicle routing assignment. More... | |
| void | AddIntervalToAssignment (IntervalVar *const interval) |
| const Assignment * | PackCumulsOfOptimizerDimensionsFromAssignment (const Assignment *original_assignment, absl::Duration duration_limit) |
| 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: More... | |
| void | SetSweepArranger (SweepArranger *sweep_arranger) |
| SweepArranger * | sweep_arranger () const |
| Returns the sweep arranger to be used by routing heuristics. More... | |
| void | AddLocalSearchFilter (LocalSearchFilter *filter) |
| Adds a custom local search filter to the list of filters used to speed up local search by pruning unfeasible variable assignments. More... | |
| int64_t | Start (int vehicle) const |
| Model inspection. More... | |
| int64_t | End (int vehicle) const |
| Returns the variable index of the ending node of a vehicle route. More... | |
| bool | IsStart (int64_t index) const |
| Returns true if 'index' represents the first node of a route. More... | |
| bool | IsEnd (int64_t index) const |
| Returns true if 'index' represents the last node of a route. More... | |
| int | VehicleIndex (int64_t index) const |
| Returns the vehicle of the given start/end index, and -1 if the given index is not a vehicle start/end. More... | |
| int64_t | Next (const Assignment &assignment, int64_t index) const |
| Assignment inspection Returns the variable index of the node directly after the node corresponding to 'index' in 'assignment'. More... | |
| bool | IsVehicleUsed (const Assignment &assignment, int vehicle) const |
| Returns true if the route of 'vehicle' is non empty in 'assignment'. More... | |
| const std::vector< IntVar * > & | Nexts () const |
| Returns all next variables of the model, such that Nexts(i) is the next variable of the node corresponding to i. More... | |
| const std::vector< IntVar * > & | VehicleVars () const |
| Returns all vehicle variables of the model, such that VehicleVars(i) is the vehicle variable of the node corresponding to i. More... | |
| const std::vector< IntVar * > & | ResourceVars (int resource_group) const |
| Returns vehicle resource variables for a given resource group, such that ResourceVars(r_g)[v] is the resource variable for vehicle 'v' in resource group 'r_g'. More... | |
| IntVar * | NextVar (int64_t index) const |
| !defined(SWIGPYTHON) More... | |
| IntVar * | ActiveVar (int64_t index) const |
| Returns the active variable of the node corresponding to index. More... | |
| IntVar * | ActiveVehicleVar (int vehicle) const |
| Returns the active variable of the vehicle. More... | |
| IntVar * | VehicleRouteConsideredVar (int vehicle) const |
| Returns the variable specifying whether or not the given vehicle route is considered for costs and constraints. More... | |
| IntVar * | VehicleVar (int64_t index) const |
| Returns the vehicle variable of the node corresponding to index. More... | |
| IntVar * | ResourceVar (int vehicle, int resource_group) const |
| Returns the resource variable for the given vehicle index in the given resource group. More... | |
| IntVar * | CostVar () const |
| Returns the global cost variable which is being minimized. More... | |
| int64_t | GetArcCostForVehicle (int64_t from_index, int64_t to_index, int64_t vehicle) const |
| Returns the cost of the transit arc between two nodes for a given vehicle. More... | |
| bool | CostsAreHomogeneousAcrossVehicles () const |
| Whether costs are homogeneous across all vehicles. More... | |
| int64_t | GetHomogeneousCost (int64_t from_index, int64_t to_index) const |
| Returns the cost of the segment between two nodes supposing all vehicle costs are the same (returns the cost for the first vehicle otherwise). More... | |
| int64_t | GetArcCostForFirstSolution (int64_t from_index, int64_t to_index) const |
| Returns the cost of the arc in the context of the first solution strategy. More... | |
| int64_t | GetArcCostForClass (int64_t from_index, int64_t to_index, int64_t cost_class_index) const |
| Returns the cost of the segment between two nodes for a given cost class. More... | |
| CostClassIndex | GetCostClassIndexOfVehicle (int64_t vehicle) const |
| Get the cost class index of the given vehicle. More... | |
| bool | HasVehicleWithCostClassIndex (CostClassIndex cost_class_index) const |
| Returns true iff the model contains a vehicle with the given cost_class_index. More... | |
| int | GetCostClassesCount () const |
| Returns the number of different cost classes in the model. More... | |
| int | GetNonZeroCostClassesCount () const |
| Ditto, minus the 'always zero', built-in cost class. More... | |
| VehicleClassIndex | GetVehicleClassIndexOfVehicle (int64_t vehicle) const |
| int | GetVehicleOfClass (VehicleClassIndex vehicle_class) const |
| Returns a vehicle of the given vehicle class, and -1 if there are no vehicles for this class. More... | |
| int | GetVehicleClassesCount () const |
| Returns the number of different vehicle classes in the model. More... | |
| const std::vector< int > & | GetSameVehicleIndicesOfIndex (int node) const |
| Returns variable indices of nodes constrained to be on the same route. More... | |
| const VehicleTypeContainer & | GetVehicleTypeContainer () const |
| bool | ArcIsMoreConstrainedThanArc (int64_t from, int64_t to1, int64_t to2) |
| Returns whether the arc from->to1 is more constrained than from->to2, taking into account, in order: More... | |
| std::string | DebugOutputAssignment (const Assignment &solution_assignment, const std::string &dimension_to_print) const |
| 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. More... | |
| std::vector< std::vector< std::pair< int64_t, int64_t > > > | GetCumulBounds (const Assignment &solution_assignment, const RoutingDimension &dimension) |
| 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. More... | |
| Solver * | solver () const |
| Returns the underlying constraint solver. More... | |
| bool | CheckLimit () |
| Returns true if the search limit has been crossed. More... | |
| absl::Duration | RemainingTime () const |
| Returns the time left in the search limit. More... | |
| int | nodes () const |
| Sizes and indices Returns the number of nodes in the model. More... | |
| int | vehicles () const |
| Returns the number of vehicle routes in the model. More... | |
| int64_t | Size () const |
| Returns the number of next variables in the model. More... | |
| int64_t | GetNumberOfDecisionsInFirstSolution (const RoutingSearchParameters &search_parameters) const |
| Returns statistics on first solution search, number of decisions sent to filters, number of decisions rejected by filters. More... | |
| int64_t | GetNumberOfRejectsInFirstSolution (const RoutingSearchParameters &search_parameters) const |
| operations_research::FirstSolutionStrategy::Value | GetAutomaticFirstSolutionStrategy () const |
| Returns the automatic first solution strategy selected. More... | |
| bool | IsMatchingModel () const |
| Returns true if a vehicle/node matching problem is detected. More... | |
| void | SetTabuVarsCallback (GetTabuVarsCallback tabu_var_callback) |
| DecisionBuilder * | MakeGuidedSlackFinalizer (const RoutingDimension *dimension, std::function< int64_t(int64_t)> initializer) |
| The next few members are in the public section only for testing purposes. More... | |
| const std::vector< SearchMonitor * > & | GetSearchMonitors () const |
| DecisionBuilder * | MakeSelfDependentDimensionFinalizer (const RoutingDimension *dimension) |
| SWIG More... | |
Static Public Member Functions | |
| static RoutingModel::StateDependentTransit | MakeStateDependentTransit (const std::function< int64_t(int64_t)> &f, int64_t domain_start, int64_t domain_end) |
| Creates a cached StateDependentTransit from an std::function. More... | |
| static std::unique_ptr< LocalSearchOperator > | MakeGreedyDescentLSOperator (std::vector< IntVar * > variables) |
| Perhaps move it to constraint_solver.h. More... | |
Static Public Attributes | |
| static const int64_t | kNoPenalty = -1 |
| Constant used to express a hard constraint instead of a soft penalty. More... | |
| static const DisjunctionIndex | kNoDisjunction |
| Constant used to express the "no disjunction" index, returned when a node does not appear in any disjunction. More... | |
| static const DimensionIndex | kNoDimension |
| Constant used to express the "no dimension" index, returned when a dimension name does not correspond to an actual dimension. More... | |
| typedef RoutingCostClassIndex CostClassIndex |
| typedef RoutingDimensionIndex DimensionIndex |
| typedef RoutingDisjunctionIndex DisjunctionIndex |
| using GetTabuVarsCallback = std::function<std::vector<operations_research::IntVar*>(RoutingModel*)> |
| typedef RoutingIndexPair IndexPair |
| typedef RoutingIndexPairs IndexPairs |
| typedef std::function<StateDependentTransit(int64_t, int64_t)> VariableIndexEvaluator2 |
| typedef RoutingVehicleClassIndex VehicleClassIndex |
| enum Status |
Status of the search.
| Enumerator | |
|---|---|
| ROUTING_NOT_SOLVED | Problem not solved yet (before calling RoutingModel::Solve()). |
| ROUTING_SUCCESS | Problem solved successfully after calling RoutingModel::Solve(). |
| ROUTING_FAIL | No solution found to the problem after calling RoutingModel::Solve(). |
| ROUTING_FAIL_TIMEOUT | Time limit reached before finding a solution with RoutingModel::Solve(). |
| ROUTING_INVALID | Model, model parameters or flags are not valid. |
| ROUTING_INFEASIBLE | Problem proven to be infeasible. |
| enum VisitTypePolicy |
Set the node visit types and incompatibilities/requirements between the types (see below).
NOTE: Before adding any incompatibilities and/or requirements on types: 1) All corresponding node types must have been set. 2) CloseVisitTypes() must be called so all containers are resized accordingly.
The following enum is used to describe how a node with a given type 'T' impacts the number of types 'T' on the route when visited, and thus determines how temporal incompatibilities and requirements take effect.
|
explicit |
Constructor taking an index manager.
The version which does not take RoutingModelParameters is equivalent to passing DefaultRoutingModelParameters().
Definition at line 885 of file routing.cc.
| RoutingModel | ( | const RoutingIndexManager & | index_manager, |
| const RoutingModelParameters & | parameters | ||
| ) |
Definition at line 888 of file routing.cc.
| ~RoutingModel | ( | ) |
Definition at line 978 of file routing.cc.
|
inline |
|
inline |
| void AddAtSolutionCallback | ( | std::function< void()> | callback | ) |
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.
Definition at line 3130 of file routing.cc.
|
inline |
| std::pair< int, bool > AddConstantDimensionWithSlack | ( | int64_t | value, |
| int64_t | capacity, | ||
| int64_t | slack_max, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | 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 1194 of file routing.cc.
| bool AddDimension | ( | int | evaluator_index, |
| int64_t | slack_max, | ||
| int64_t | capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | 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) + 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 1115 of file routing.cc.
|
inline |
Creates a dimension with transits depending on the cumuls of another dimension.
'pure_transits' are the per-vehicle fixed transits as above. 'dependent_transits' is a vector containing for each vehicle an index to a registered state dependent transit callback. 'base_dimension' indicates the dimension from which the cumul variable is taken. If 'base_dimension' is nullptr, then the newly created dimension is self-based.
| bool AddDimensionDependentDimensionWithVehicleCapacity | ( | const std::vector< int > & | transits, |
| const RoutingDimension * | base_dimension, | ||
| int64_t | slack_max, | ||
| std::vector< int64_t > | vehicle_capacities, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
As above, but pure_transits are taken to be zero evaluators.
Definition at line 1300 of file routing.cc.
| bool AddDimensionDependentDimensionWithVehicleCapacity | ( | int | pure_transit, |
| int | dependent_transit, | ||
| const RoutingDimension * | base_dimension, | ||
| int64_t | slack_max, | ||
| int64_t | vehicle_capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
Definition at line 1340 of file routing.cc.
| bool AddDimensionDependentDimensionWithVehicleCapacity | ( | int | transit, |
| const RoutingDimension * | base_dimension, | ||
| int64_t | slack_max, | ||
| int64_t | vehicle_capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
Homogeneous versions of the functions above.
Definition at line 1311 of file routing.cc.
| bool AddDimensionWithVehicleCapacity | ( | int | evaluator_index, |
| int64_t | slack_max, | ||
| std::vector< int64_t > | vehicle_capacities, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
Definition at line 1134 of file routing.cc.
| bool AddDimensionWithVehicleTransitAndCapacity | ( | const std::vector< int > & | evaluator_indices, |
| int64_t | slack_max, | ||
| std::vector< int64_t > | vehicle_capacities, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
Definition at line 1144 of file routing.cc.
| bool AddDimensionWithVehicleTransits | ( | const std::vector< int > & | evaluator_indices, |
| int64_t | slack_max, | ||
| int64_t | capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | name | ||
| ) |
Definition at line 1125 of file routing.cc.
| RoutingModel::DisjunctionIndex AddDisjunction | ( | const std::vector< int64_t > & | indices, |
| int64_t | penalty = kNoPenalty, |
||
| int64_t | max_cardinality = 1 |
||
| ) |
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. This is equivalent to adding the constraint: p + Sum(i)active[i] == max_cardinality where p is an integer variable, and the following cost 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 1917 of file routing.cc.
| void AddHardTypeIncompatibility | ( | int | type1, |
| int | 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.
Definition at line 4150 of file routing.cc.
| void AddIntervalToAssignment | ( | IntervalVar *const | interval | ) |
Definition at line 5802 of file routing.cc.
|
inline |
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.
| void AddLocalSearchOperator | ( | LocalSearchOperator * | ls_operator | ) |
Adds a local search operator to the set of operators used to solve the vehicle routing problem.
Definition at line 2140 of file routing.cc.
| std::pair< int, bool > AddMatrixDimension | ( | std::vector< std::vector< int64_t > > | values, |
| int64_t | capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | 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 1214 of file routing.cc.
| void AddPickupAndDelivery | ( | int64_t | pickup, |
| int64_t | 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 2028 of file routing.cc.
| void AddPickupAndDeliverySets | ( | DisjunctionIndex | pickup_disjunction, |
| DisjunctionIndex | 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 2033 of file routing.cc.
| void AddRequiredTypeAlternativesWhenAddingType | ( | int | dependent_type, |
| absl::flat_hash_set< int > | 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 4206 of file routing.cc.
| void AddRequiredTypeAlternativesWhenRemovingType | ( | int | dependent_type, |
| absl::flat_hash_set< int > | 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 4227 of file routing.cc.
| int AddResourceGroup | ( | ) |
Adds a resource group to the routing model.
Returns its index in resource_groups_.
Definition at line 1484 of file routing.cc.
| void AddSameVehicleRequiredTypeAlternatives | ( | int | dependent_type, |
| absl::flat_hash_set< int > | 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.
Definition at line 4184 of file routing.cc.
| void AddSearchMonitor | ( | SearchMonitor *const | monitor | ) |
Adds a search monitor to the search used to solve the routing model.
Definition at line 3111 of file routing.cc.
| void AddSoftSameVehicleConstraint | ( | const std::vector< int64_t > & | indices, |
| int64_t | 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 2007 of file routing.cc.
| void AddTemporalTypeIncompatibility | ( | int | type1, |
| int | type2 | ||
| ) |
Definition at line 4159 of file routing.cc.
| void AddToAssignment | ( | IntVar *const | var | ) |
Adds an extra variable to the vehicle routing assignment.
Definition at line 5798 of file routing.cc.
| void AddVariableMaximizedByFinalizer | ( | IntVar * | var | ) |
Adds a variable to maximize in the solution finalizer (see above for information on the solution finalizer).
Definition at line 5784 of file routing.cc.
| void AddVariableMinimizedByFinalizer | ( | IntVar * | 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 5788 of file routing.cc.
| void AddVariableTargetToFinalizer | ( | IntVar * | var, |
| int64_t | target | ||
| ) |
Add a variable to set the closest possible to the target value in the solution finalizer.
Definition at line 5777 of file routing.cc.
| std::pair< int, bool > AddVectorDimension | ( | std::vector< int64_t > | values, |
| int64_t | capacity, | ||
| bool | fix_start_cumul_to_zero, | ||
| const std::string & | 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 1205 of file routing.cc.
| void AddWeightedVariableMaximizedByFinalizer | ( | IntVar * | var, |
| int64_t | cost | ||
| ) |
Adds a variable to maximize in the solution finalizer, with a weighted priority: the higher the more priority it has.
Definition at line 5771 of file routing.cc.
| void AddWeightedVariableMinimizedByFinalizer | ( | IntVar * | var, |
| int64_t | cost | ||
| ) |
Adds a variable to minimize in the solution finalizer, with a weighted priority: the higher the more priority it has.
Definition at line 5765 of file routing.cc.
| void AddWeightedVariableTargetToFinalizer | ( | IntVar * | var, |
| int64_t | target, | ||
| int64_t | 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 5745 of file routing.cc.
| IntVar * ApplyLocks | ( | const std::vector< int64_t > & | 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 3635 of file routing.cc.
| bool ApplyLocksToAllVehicles | ( | const std::vector< std::vector< int64_t > > & | locks, |
| bool | 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 3656 of file routing.cc.
| bool ArcIsMoreConstrainedThanArc | ( | int64_t | from, |
| int64_t | to1, | ||
| int64_t | to2 | ||
| ) |
Returns whether the arc from->to1 is more constrained than from->to2, taking into account, in order:
Definition at line 4016 of file routing.cc.
| void AssignmentToRoutes | ( | const Assignment & | assignment, |
| std::vector< std::vector< int64_t > > *const | routes | ||
| ) | const |
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 3844 of file routing.cc.
|
inline |
| void CloseModel | ( | ) |
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 2247 of file routing.cc.
| void CloseModelWithParameters | ( | const RoutingSearchParameters & | 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 2425 of file routing.cc.
| void CloseVisitTypes | ( | ) |
This function should be called once all node visit types have been set and prior to adding any incompatibilities/requirements.
"close" types.
Definition at line 4141 of file routing.cc.
| Assignment * CompactAndCheckAssignment | ( | const Assignment & | assignment | ) | const |
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 3549 of file routing.cc.
| Assignment * CompactAssignment | ( | const Assignment & | assignment | ) | const |
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 3544 of file routing.cc.
| int64_t ComputeLowerBound | ( | ) |
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 3400 of file routing.cc.
|
inline |
|
inline |
| std::string DebugOutputAssignment | ( | const Assignment & | solution_assignment, |
| const std::string & | dimension_to_print | ||
| ) | const |
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 4289 of file routing.cc.
|
inline |
|
inline |
|
inline |
| std::vector< std::string > GetAllDimensionNames | ( | ) | const |
Outputs the names of all dimensions added to the routing engine.
Definition at line 1365 of file routing.cc.
|
inline |
|
inline |
| int64_t GetArcCostForClass | ( | int64_t | from_index, |
| int64_t | to_index, | ||
| int64_t | cost_class_index | ||
| ) | const |
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 3971 of file routing.cc.
| int64_t GetArcCostForFirstSolution | ( | int64_t | from_index, |
| int64_t | to_index | ||
| ) | const |
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 3982 of file routing.cc.
| int64_t GetArcCostForVehicle | ( | int64_t | from_index, |
| int64_t | to_index, | ||
| int64_t | vehicle | ||
| ) | const |
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 3961 of file routing.cc.
|
inline |
|
inline |
|
inline |
| std::vector< std::vector< std::pair< int64_t, int64_t > > > GetCumulBounds | ( | const Assignment & | solution_assignment, |
| const RoutingDimension & | dimension | ||
| ) |
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.
Definition at line 4363 of file routing.cc.
| const std::vector< std::pair< int, int > > & GetDeliveryIndexPairs | ( | int64_t | node_index | ) | const |
Same as above for deliveries.
Definition at line 2072 of file routing.cc.
| int64_t GetDepot | ( | ) | const |
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 2144 of file routing.cc.
| const RoutingDimension & GetDimensionOrDie | ( | const std::string & | dimension_name | ) | const |
Returns a dimension from its name. Dies if the dimension does not exist.
Definition at line 1432 of file routing.cc.
|
inline |
| const std::vector< int > & GetDimensionResourceGroupIndices | ( | const RoutingDimension * | dimension | ) | const |
Returns the indices of resource groups for this dimension.
This method can only be called after the model has been closed.
Definition at line 1513 of file routing.cc.
|
inline |
| std::vector< RoutingDimension * > GetDimensionsWithSoftOrSpanCosts | ( | ) | const |
Returns dimensions with soft or vehicle span costs.
Definition at line 5047 of file routing.cc.
|
inline |
|
inline |
|
inline |
|
inline |
| int64_t GetFixedCostOfVehicle | ( | int | vehicle | ) | const |
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 1541 of file routing.cc.
|
inline |
|
inline |
| const absl::flat_hash_set< int > & GetHardTypeIncompatibilitiesOfType | ( | int | type | ) | const |
Returns visit types incompatible with a given type.
Definition at line 4169 of file routing.cc.
|
inline |
|
inline |
Returns implicit pickup and delivery pairs currently in the model.
Pairs are implicit if they are not linked by a pickup and delivery constraint but that for a given unary dimension, the first element of the pair has a positive demand d, and the second element has a demand of -d.
|
inline |
|
inline |
|
inline |
| RoutingDimension * GetMutableDimension | ( | const std::string & | dimension_name | ) | const |
Returns a dimension from its name.
Returns nullptr if the dimension does not exist.
Definition at line 1437 of file routing.cc.
| GlobalDimensionCumulOptimizer * GetMutableGlobalCumulMPOptimizer | ( | const RoutingDimension & | dimension | ) | const |
Definition at line 1386 of file routing.cc.
| GlobalDimensionCumulOptimizer * GetMutableGlobalCumulOptimizer | ( | const RoutingDimension & | dimension | ) | const |
Returns the global/local dimension cumul optimizer for a given dimension, or nullptr if there is none.
Definition at line 1374 of file routing.cc.
| LocalDimensionCumulOptimizer * GetMutableLocalCumulMPOptimizer | ( | const RoutingDimension & | dimension | ) | const |
Definition at line 1410 of file routing.cc.
| LocalDimensionCumulOptimizer * GetMutableLocalCumulOptimizer | ( | const RoutingDimension & | dimension | ) | const |
Definition at line 1398 of file routing.cc.
|
inline |
| int64_t GetNumberOfDecisionsInFirstSolution | ( | const RoutingSearchParameters & | search_parameters | ) | const |
Returns statistics on first solution search, number of decisions sent to filters, number of decisions rejected by filters.
Definition at line 3662 of file routing.cc.
|
inline |
| int64_t GetNumberOfRejectsInFirstSolution | ( | const RoutingSearchParameters & | search_parameters | ) | const |
Definition at line 3670 of file routing.cc.
| int GetNumOfSingletonNodes | ( | ) | const |
Returns the number of non-start/end nodes which do not appear in a pickup/delivery pair.
Definition at line 2098 of file routing.cc.
| const std::vector< int > & GetPairIndicesOfType | ( | int | type | ) | const |
Definition at line 4130 of file routing.cc.
| std::vector< std::pair< int64_t, int64_t > > GetPerfectBinaryDisjunctions | ( | ) | const |
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 1948 of file routing.cc.
|
inline |
|
inline |
| RoutingModel::PickupAndDeliveryPolicy GetPickupAndDeliveryPolicyOfVehicle | ( | int | vehicle | ) | const |
Definition at line 2093 of file routing.cc.
| const std::vector< std::pair< int, int > > & GetPickupIndexPairs | ( | int64_t | node_index | ) | const |
Returns pairs for which the node is a pickup; the first element of each pair is the index in the pickup and delivery pairs list in which the pickup appears, the second element is its index in the pickups list.
Definition at line 2066 of file routing.cc.
|
inline |
| const std::vector< absl::flat_hash_set< int > > & GetRequiredTypeAlternativesWhenAddingType | ( | int | type | ) | const |
Returns the set of requirement alternatives when adding the given type.
Definition at line 4258 of file routing.cc.
| const std::vector< absl::flat_hash_set< int > > & GetRequiredTypeAlternativesWhenRemovingType | ( | int | type | ) | const |
Returns the set of requirement alternatives when removing the given type.
Definition at line 4265 of file routing.cc.
|
inline |
|
inline |
| std::vector< std::vector< int64_t > > GetRoutesFromAssignment | ( | const Assignment & | 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.
Definition at line 3878 of file routing.cc.
|
inline |
| const std::vector< absl::flat_hash_set< int > > & GetSameVehicleRequiredTypeAlternativesOfType | ( | int | type | ) | const |
Returns the set of same-vehicle requirement alternatives for the given type.
Definition at line 4250 of file routing.cc.
|
inline |
| const std::vector< int > & GetSingleNodesOfType | ( | int | type | ) | const |
Definition at line 4125 of file routing.cc.
| const absl::flat_hash_set< int > & GetTemporalTypeIncompatibilitiesOfType | ( | int | type | ) | const |
Definition at line 4176 of file routing.cc.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| int GetVisitType | ( | int64_t | index | ) | const |
Definition at line 4120 of file routing.cc.
| RoutingModel::VisitTypePolicy GetVisitTypePolicy | ( | int64_t | index | ) | const |
Definition at line 4135 of file routing.cc.
| bool HasDimension | ( | const std::string & | dimension_name | ) | const |
Returns true if a dimension exists for a given dimension name.
Definition at line 1422 of file routing.cc.
|
inline |
| bool HasMandatoryDisjunctions | ( | ) | const |
Returns true if the model contains mandatory disjunctions (ones with kNoPenalty as penalty).
Definition at line 1933 of file routing.cc.
| bool HasMaxCardinalityConstrainedDisjunctions | ( | ) | const |
Returns true if the model contains at least one disjunction which is constrained by its max_cardinality.
Definition at line 1940 of file routing.cc.
|
inline |
|
inline |
|
inline |
| void IgnoreDisjunctionsAlreadyForcedToZero | ( | ) |
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 1965 of file routing.cc.
|
inline |
| bool IsMatchingModel | ( | ) | const |
Returns true if a vehicle/node matching problem is detected.
Definition at line 55 of file routing_flow.cc.
| bool IsStart | ( | int64_t | index | ) | const |
Returns true if 'index' represents the first node of a route.
Definition at line 3939 of file routing.cc.
|
inline |
| bool IsVehicleUsed | ( | const Assignment & | assignment, |
| int | vehicle | ||
| ) | const |
Returns true if the route of 'vehicle' is non empty in 'assignment'.
Definition at line 3943 of file routing.cc.
|
static |
Perhaps move it to constraint_solver.h.
MakeGreedyDescentLSOperator creates a local search operator that tries to improve the initial assignment by moving a logarithmically decreasing step away in each possible dimension.
Definition at line 4617 of file routing_search.cc.
| DecisionBuilder * MakeGuidedSlackFinalizer | ( | const RoutingDimension * | dimension, |
| std::function< int64_t(int64_t)> | 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:
Definition at line 4490 of file routing_search.cc.
| Constraint * MakePathSpansAndTotalSlacks | ( | const RoutingDimension * | dimension, |
| std::vector< IntVar * > | spans, | ||
| std::vector< IntVar * > | total_slacks | ||
| ) |
For every vehicle of the routing model:
Definition at line 6153 of file routing.cc.
| DecisionBuilder * MakeSelfDependentDimensionFinalizer | ( | const RoutingDimension * | dimension | ) |
SWIG
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 4623 of file routing_search.cc.
|
static |
Creates a cached StateDependentTransit from an std::function.
Definition at line 1353 of file routing.cc.
|
inline |
| int64_t Next | ( | const Assignment & | assignment, |
| int64_t | index | ||
| ) | const |
Assignment inspection Returns the variable index of the node directly after the node corresponding to 'index' in 'assignment'.
Definition at line 3953 of file routing.cc.
|
inline |
|
inline |
|
inline |
| const Assignment * PackCumulsOfOptimizerDimensionsFromAssignment | ( | const Assignment * | original_assignment, |
| absl::Duration | duration_limit | ||
| ) |
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:
Definition at line 607 of file routing.cc.
|
inline |
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.
| Assignment * ReadAssignment | ( | const std::string & | 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 3687 of file routing.cc.
| Assignment * ReadAssignmentFromRoutes | ( | const std::vector< std::vector< int64_t > > & | routes, |
| bool | 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 3831 of file routing.cc.
| int RegisterPositiveTransitCallback | ( | TransitCallback2 | callback | ) |
Definition at line 1084 of file routing.cc.
| int RegisterPositiveUnaryTransitCallback | ( | TransitCallback1 | callback | ) |
Definition at line 1050 of file routing.cc.
| int RegisterStateDependentTransitCallback | ( | VariableIndexEvaluator2 | callback | ) |
Definition at line 1091 of file routing.cc.
| int RegisterTransitCallback | ( | TransitCallback2 | callback | ) |
Definition at line 1058 of file routing.cc.
| int RegisterTransitMatrix | ( | std::vector< std::vector< int64_t > > | values | ) |
Definition at line 1031 of file routing.cc.
| int RegisterUnaryTransitCallback | ( | TransitCallback1 | callback | ) |
Definition at line 1023 of file routing.cc.
| int RegisterUnaryTransitVector | ( | std::vector< int64_t > | values | ) |
Registers 'callback' and returns its index.
Definition at line 1012 of file routing.cc.
|
inline |
|
inline |
|
inline |
| Assignment * RestoreAssignment | ( | const Assignment & | 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 3696 of file routing.cc.
| bool RoutesToAssignment | ( | const std::vector< std::vector< int64_t > > & | routes, |
| bool | ignore_inactive_indices, | ||
| bool | close_routes, | ||
| Assignment *const | assignment | ||
| ) | const |
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 3718 of file routing.cc.
| void SetAllowedVehiclesForIndex | ( | const std::vector< int > & | vehicles, |
| int64_t | 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 2019 of file routing.cc.
| void SetAmortizedCostFactorsOfAllVehicles | ( | int64_t | linear_cost_factor, |
| int64_t | 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]
Sets the linear and quadratic cost factor of all vehicles.
Definition at line 1552 of file routing.cc.
| void SetAmortizedCostFactorsOfVehicle | ( | int64_t | linear_cost_factor, |
| int64_t | quadratic_cost_factor, | ||
| int | vehicle | ||
| ) |
Sets the linear and quadratic cost factor of the given vehicle.
Definition at line 1560 of file routing.cc.
| void SetArcCostEvaluatorOfAllVehicles | ( | int | 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 1521 of file routing.cc.
| void SetArcCostEvaluatorOfVehicle | ( | int | evaluator_index, |
| int | vehicle | ||
| ) |
Sets the cost function for a given vehicle route.
Definition at line 1528 of file routing.cc.
| void SetAssignmentFromOtherModelAssignment | ( | Assignment * | target_assignment, |
| const RoutingModel * | source_model, | ||
| const Assignment * | 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 3362 of file routing.cc.
|
inline |
| void SetFixedCostOfAllVehicles | ( | int64_t | cost | ) |
Sets the fixed cost of all vehicle routes.
It is equivalent to calling SetFixedCostOfVehicle on all vehicle routes.
Definition at line 1535 of file routing.cc.
| void SetFixedCostOfVehicle | ( | int64_t | cost, |
| int | vehicle | ||
| ) |
Sets the fixed cost of one vehicle route.
Definition at line 1546 of file routing.cc.
|
inline |
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.
| void SetPickupAndDeliveryPolicyOfAllVehicles | ( | PickupAndDeliveryPolicy | policy | ) |
Sets the Pickup and delivery policy of all vehicles.
It is equivalent to calling SetPickupAndDeliveryPolicyOfVehicle on all vehicles.
Definition at line 2084 of file routing.cc.
| void SetPickupAndDeliveryPolicyOfVehicle | ( | PickupAndDeliveryPolicy | policy, |
| int | vehicle | ||
| ) |
Definition at line 2078 of file routing.cc.
|
inline |
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.
| void SetSweepArranger | ( | SweepArranger * | sweep_arranger | ) |
Definition at line 676 of file routing.cc.
| void SetTabuVarsCallback | ( | GetTabuVarsCallback | tabu_var_callback | ) |
Definition at line 5665 of file routing.cc.
|
inline |
| void SetVisitType | ( | int64_t | index, |
| int | type, | ||
| VisitTypePolicy | type_policy | ||
| ) |
Definition at line 4111 of file routing.cc.
|
inline |
| const Assignment * Solve | ( | const Assignment * | assignment = nullptr | ) |
Solves the current routing model; closes the current model.
This is equivalent to calling SolveWithParameters(DefaultRoutingSearchParameters()) or SolveFromAssignmentWithParameters(assignment, DefaultRoutingSearchParameters()).
Definition at line 3135 of file routing.cc.
| const Assignment * SolveFromAssignmentsWithParameters | ( | const std::vector< const Assignment * > & | assignments, |
| const RoutingSearchParameters & | search_parameters, | ||
| std::vector< const Assignment * > * | solutions = nullptr |
||
| ) |
Same as above but will try all assignments in order as first solutions until one succeeds.
Definition at line 3213 of file routing.cc.
| const Assignment * SolveFromAssignmentWithParameters | ( | const Assignment * | assignment, |
| const RoutingSearchParameters & | search_parameters, | ||
| std::vector< const Assignment * > * | solutions = nullptr |
||
| ) |
Same as above, except that if assignment is not null, it will be used as the initial solution.
Definition at line 3206 of file routing.cc.
|
inline |
| const Assignment * SolveWithParameters | ( | const RoutingSearchParameters & | search_parameters, |
| std::vector< const Assignment * > * | solutions = nullptr |
||
| ) |
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 3140 of file routing.cc.
|
inline |
|
inline |
|
inline |
| SweepArranger * sweep_arranger | ( | ) | const |
Returns the sweep arranger to be used by routing heuristics.
Definition at line 680 of file routing.cc.
|
inline |
|
inline |
| int64_t UnperformedPenalty | ( | int64_t | var_index | ) | const |
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 4271 of file routing.cc.
| int64_t UnperformedPenaltyOrValue | ( | int64_t | default_value, |
| int64_t | var_index | ||
| ) | const |
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 4275 of file routing.cc.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| bool WriteAssignment | ( | const std::string & | file_name | ) | const |
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 3678 of file routing.cc.
|
static |
|
static |
|
static |
1.9.3