or-tools 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6d267706d117ea1b3e1e76b0c74f49d28fedb300e39243ccf9d5160bcc5c76
-  data.tar.gz: 401e862ce8f7ae97608c746df879d7b43b39738bb45293097ef0dd61363b6491
+  metadata.gz: 976e5d3e7d64ac20e1d445baa12720acd4e91469d1fddbaf8c71cf32e1bb7be6
+  data.tar.gz: 38d1b76452dc3df179cc7536e466846bf6030dfcd1da283393cbfa3c9c68b4b6
 SHA512:
-  metadata.gz: 34775f80be4bcf4fb0b039189365d66241821f9805ffa0e83f794a8c1fa00e5c3857ac90b2c98b2050004e92eb4b522155f11475b8335ac1f9f18666bd775503
-  data.tar.gz: fb904b96d10d5e88e9cbdc2326b031f46a565589546786899797432a66487464afaf31ff86f2f3f751d24cdf1993f09a366b7f0e411f28004292de4a12272bf6
+  metadata.gz: 2612839346ab70b75cb4f307ae2116816a4638580a1e943e3c09247af4ff0e27177549ae2c170aa1b67d6453922883265c7c7c93d8dfbf573ec1bce650864bc6
+  data.tar.gz: 256087097f368c7c34d4affc531ef744184c897e99b0727f1c00a620644399de77b9c874e5cfc0f5a519552e965c55647146ad3b29346ebfd4ecc595a8d35068

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.3 (2022-07-23)
+
+- Added more methods to `RoutingModel` and  `RoutingDimension`
+
 ## 0.7.2 (2022-05-28)
 
 - Fixed library not loaded error on Mac

data/ext/or-tools/routing.cpp

@@ -9,6 +9,7 @@ using operations_research::DefaultRoutingSearchParameters;
 using operations_research::FirstSolutionStrategy;
 using operations_research::LocalSearchMetaheuristic;
 using operations_research::RoutingDimension;
+using operations_research::RoutingDisjunctionIndex;
 using operations_research::RoutingIndexManager;
 using operations_research::RoutingModel;
 using operations_research::RoutingModelParameters;
@@ -55,6 +56,19 @@ namespace Rice::detail
   };
 }
 
+namespace Rice::detail
+{
+  template<class T, class U>
+  class To_Ruby<std::pair<T, U>>
+  {
+  public:
+    VALUE convert(std::pair<T, U> const & x)
+    {
+      return rb_ary_new3(2, To_Ruby<T>().convert(x.first), To_Ruby<U>().convert(x.second));
+    }
+  };
+}
+
 void init_routing(Rice::Module& m) {
   auto rb_cRoutingSearchParameters = Rice::define_class_under<RoutingSearchParameters>(m, "RoutingSearchParameters");
   auto rb_cIntVar = Rice::define_class_under<operations_research::IntVar>(m, "IntVar");
@@ -198,8 +212,28 @@ void init_routing(Rice::Module& m) {
     .define_method("old_end_max", &operations_research::IntervalVar::OldEndMax);
 
   Rice::define_class_under<RoutingDimension>(m, "RoutingDimension")
+    .define_method("transit_value", &RoutingDimension::GetTransitValue)
+    // TODO GetTransitValueFromClass
+    .define_method("cumul_var", &RoutingDimension::CumulVar)
+    .define_method("transit_var", &RoutingDimension::TransitVar)
+    .define_method("fixed_transit_var", &RoutingDimension::FixedTransitVar)
+    .define_method("slack_var", &RoutingDimension::SlackVar)
+    .define_method("set_span_upper_bound_for_vehicle", &RoutingDimension::SetSpanUpperBoundForVehicle)
+    .define_method("set_span_cost_coefficient_for_vehicle", &RoutingDimension::SetSpanCostCoefficientForVehicle)
+    .define_method("set_span_cost_coefficient_for_all_vehicles", &RoutingDimension::SetSpanCostCoefficientForAllVehicles)
+    .define_method("set_global_span_cost_coefficient", &RoutingDimension::SetGlobalSpanCostCoefficient)
+    // alias
     .define_method("global_span_cost_coefficient=", &RoutingDimension::SetGlobalSpanCostCoefficient)
-    .define_method("cumul_var", &RoutingDimension::CumulVar);
+    .define_method("set_cumul_var_soft_upper_bound", &RoutingDimension::SetCumulVarSoftUpperBound)
+    .define_method("cumul_var_soft_upper_bound?", &RoutingDimension::HasCumulVarSoftUpperBound)
+    .define_method("cumul_var_soft_upper_bound", &RoutingDimension::GetCumulVarSoftUpperBound)
+    .define_method("cumul_var_soft_upper_bound_coefficient", &RoutingDimension::GetCumulVarSoftUpperBoundCoefficient)
+    .define_method("set_cumul_var_soft_lower_bound", &RoutingDimension::SetCumulVarSoftLowerBound)
+    .define_method("cumul_var_soft_lower_bound?", &RoutingDimension::HasCumulVarSoftLowerBound)
+    .define_method("cumul_var_soft_lower_bound", &RoutingDimension::GetCumulVarSoftLowerBound)
+    .define_method("cumul_var_soft_lower_bound_coefficient", &RoutingDimension::GetCumulVarSoftLowerBoundCoefficient);
+
+  Rice::define_class_under<RoutingDisjunctionIndex>(m, "RoutingDisjunctionIndex");
 
   Rice::define_class_under<operations_research::Constraint>(m, "Constraint")
     .define_method("post", &operations_research::Constraint::Post)
@@ -264,27 +298,103 @@ void init_routing(Rice::Module& m) {
 
   Rice::define_class_under<RoutingModel>(m, "RoutingModel")
     .define_constructor(Rice::Constructor<RoutingModel, RoutingIndexManager, RoutingModelParameters>(), Rice::Arg("index_manager"), Rice::Arg("parameters") = operations_research::DefaultRoutingModelParameters())
+    .define_method("register_unary_transit_vector", &RoutingModel::RegisterUnaryTransitVector)
     .define_method(
-      "register_transit_callback",
+      "register_unary_transit_callback",
       [](RoutingModel& self, Object callback) {
-        return self.RegisterTransitCallback(
-          [callback](int64_t from_index, int64_t to_index) -> int64_t {
-            return Rice::detail::From_Ruby<int64_t>().convert(callback.call("call", from_index, to_index));
+        return self.RegisterUnaryTransitCallback(
+          [callback](int64_t from_index) -> int64_t {
+            return Rice::detail::From_Ruby<int64_t>().convert(callback.call("call", from_index));
           }
         );
       })
+    .define_method("register_transit_matrix", &RoutingModel::RegisterTransitMatrix)
     .define_method(
-      "register_unary_transit_callback",
+      "register_transit_callback",
       [](RoutingModel& self, Object callback) {
-        return self.RegisterUnaryTransitCallback(
-          [callback](int64_t from_index) -> int64_t {
-            return Rice::detail::From_Ruby<int64_t>().convert(callback.call("call", from_index));
+        return self.RegisterTransitCallback(
+          [callback](int64_t from_index, int64_t to_index) -> int64_t {
+            return Rice::detail::From_Ruby<int64_t>().convert(callback.call("call", from_index, to_index));
           }
         );
       })
+    .define_method("add_dimension", &RoutingModel::AddDimension)
+    .define_method("add_dimension_with_vehicle_transits", &RoutingModel::AddDimensionWithVehicleTransits)
+    .define_method("add_dimension_with_vehicle_capacity", &RoutingModel::AddDimensionWithVehicleCapacity)
+    .define_method("add_dimension_with_vehicle_transit_and_capacity", &RoutingModel::AddDimensionWithVehicleTransitAndCapacity)
+    .define_method("add_constant_dimension_with_slack", &RoutingModel::AddConstantDimensionWithSlack)
+    .define_method("add_constant_dimension", &RoutingModel::AddConstantDimension)
+    .define_method("add_vector_dimension", &RoutingModel::AddVectorDimension)
+    .define_method("add_matrix_dimension", &RoutingModel::AddMatrixDimension)
+    // TODO AddDimensionDependentDimensionWithVehicleCapacity
+    // .define_method("make_path_spans_and_total_slacks", &RoutingModel::MakePathSpansAndTotalSlacks)
+    .define_method("all_dimension_names", &RoutingModel::GetAllDimensionNames)
+    // .define_method("dimensions", &RoutingModel::GetDimensions)
+    // .define_method("dimensions_with_soft_or_span_costs", &RoutingModel::GetDimensionsWithSoftOrSpanCosts)
+    .define_method("dimension?", &RoutingModel::HasDimension)
+    // .define_method("dimension_or_die", &RoutingModel::GetDimensionOrDie)
+    .define_method("mutable_dimension", &RoutingModel::GetMutableDimension)
+    .define_method("set_primary_constrained_dimension", &RoutingModel::SetPrimaryConstrainedDimension)
+    .define_method("primary_constrained_dimension", &RoutingModel::GetPrimaryConstrainedDimension)
+    .define_method("add_resource_group", &RoutingModel::AddResourceGroup)
+    .define_method("dimension_resource_group_indices", &RoutingModel::GetDimensionResourceGroupIndices)
+    .define_method("dimension_resource_group_index", &RoutingModel::GetDimensionResourceGroupIndex)
+    .define_method("add_disjunction", &RoutingModel::AddDisjunction, Rice::Arg("indices"), Rice::Arg("penalty"), Rice::Arg("max_cardinality") = (int64_t)1)
+    .define_method("disjunction_indices", &RoutingModel::GetDisjunctionIndices)
+    .define_method("disjunction_penalty", &RoutingModel::GetDisjunctionPenalty)
+    .define_method("disjunction_max_cardinality", &RoutingModel::GetDisjunctionMaxCardinality)
+    .define_method("number_of_disjunctions", &RoutingModel::GetNumberOfDisjunctions)
+    .define_method("mandatory_disjunctions?", &RoutingModel::HasMandatoryDisjunctions)
+    .define_method("max_cardinality_constrained_disjunctions?", &RoutingModel::HasMaxCardinalityConstrainedDisjunctions)
+    .define_method("perfect_binary_disjunctions", &RoutingModel::GetPerfectBinaryDisjunctions)
+    .define_method("ignore_disjunctions_already_forced_to_zero", &RoutingModel::IgnoreDisjunctionsAlreadyForcedToZero)
+    .define_method("add_soft_same_vehicle_constraint", &RoutingModel::AddSoftSameVehicleConstraint)
+    .define_method("set_allowed_vehicles_for_index", &RoutingModel::SetAllowedVehiclesForIndex)
+    .define_method("vehicle_allowed_for_index?", &RoutingModel::IsVehicleAllowedForIndex)
+    .define_method("add_pickup_and_delivery", &RoutingModel::AddPickupAndDelivery)
+    .define_method("add_pickup_and_delivery_sets", &RoutingModel::AddPickupAndDeliverySets)
+    .define_method("pickup_index_pairs", &RoutingModel::GetPickupIndexPairs)
+    .define_method("delivery_index_pairs", &RoutingModel::GetDeliveryIndexPairs)
+    // TODO SetPickupAndDeliveryPolicyOfAllVehicles
+    // TODO SetPickupAndDeliveryPolicyOfVehicle
+    // TODO GetPickupAndDeliveryPolicyOfVehicle
+    .define_method("num_of_singleton_nodes", &RoutingModel::GetNumOfSingletonNodes)
+    .define_method("unperformed_penalty", &RoutingModel::UnperformedPenalty)
+    .define_method("unperformed_penalty_or_value", &RoutingModel::UnperformedPenaltyOrValue)
     .define_method("depot", &RoutingModel::GetDepot)
-    .define_method("size", &RoutingModel::Size)
-    .define_method("status", [](RoutingModel& self) {
+    .define_method("set_maximum_number_of_active_vehicles", &RoutingModel::SetMaximumNumberOfActiveVehicles)
+    .define_method("maximum_number_of_active_vehicles", &RoutingModel::GetMaximumNumberOfActiveVehicles)
+    .define_method("set_arc_cost_evaluator_of_all_vehicles", &RoutingModel::SetArcCostEvaluatorOfAllVehicles)
+    .define_method("set_arc_cost_evaluator_of_vehicle", &RoutingModel::SetArcCostEvaluatorOfVehicle)
+    .define_method("set_fixed_cost_of_all_vehicles", &RoutingModel::SetFixedCostOfAllVehicles)
+    .define_method("set_fixed_cost_of_vehicle", &RoutingModel::SetFixedCostOfVehicle)
+    .define_method("fixed_cost_of_vehicle", &RoutingModel::GetFixedCostOfVehicle)
+    .define_method("set_amortized_cost_factors_of_all_vehicles", &RoutingModel::SetAmortizedCostFactorsOfAllVehicles)
+    .define_method("set_amortized_cost_factors_of_vehicle", &RoutingModel::SetAmortizedCostFactorsOfVehicle)
+    .define_method("amortized_linear_cost_factor_of_vehicles", &RoutingModel::GetAmortizedLinearCostFactorOfVehicles)
+    .define_method("amortized_quadratic_cost_factor_of_vehicles", &RoutingModel::GetAmortizedQuadraticCostFactorOfVehicles)
+    .define_method("set_vehicle_used_when_empty", &RoutingModel::SetVehicleUsedWhenEmpty)
+    .define_method("vehicle_used_when_empty?", &RoutingModel::IsVehicleUsedWhenEmpty)
+    .define_method("add_variable_minimized_by_finalizer", &RoutingModel::AddVariableMinimizedByFinalizer)
+    .define_method("add_variable_maximized_by_finalizer", &RoutingModel::AddVariableMaximizedByFinalizer)
+    .define_method("add_weighted_variable_minimized_by_finalizer", &RoutingModel::AddWeightedVariableMinimizedByFinalizer)
+    .define_method("add_weighted_variable_maximized_by_finalizer", &RoutingModel::AddWeightedVariableMaximizedByFinalizer)
+    .define_method("add_variable_target_to_finalizer", &RoutingModel::AddVariableTargetToFinalizer)
+    .define_method("add_weighted_variable_target_to_finalizer", &RoutingModel::AddWeightedVariableTargetToFinalizer)
+    .define_method("close_model", &RoutingModel::CloseModel)
+    .define_method(
+      "solve",
+      [](RoutingModel& self) {
+        return self.Solve();
+      })
+    .define_method(
+      "solve_with_parameters",
+      [](RoutingModel& self, const RoutingSearchParameters& search_parameters) {
+        return self.SolveWithParameters(search_parameters);
+      })
+    .define_method("compute_lower_bound", &RoutingModel::ComputeLowerBound)
+    .define_method("status",
+      [](RoutingModel& self) {
         auto status = self.status();
 
         if (status == RoutingModel::ROUTING_NOT_SOLVED) {
@@ -301,30 +411,22 @@ void init_routing(Rice::Module& m) {
           throw std::runtime_error("Unknown solver status");
         }
       })
-    .define_method("vehicle_var", &RoutingModel::VehicleVar)
-    .define_method("set_arc_cost_evaluator_of_all_vehicles", &RoutingModel::SetArcCostEvaluatorOfAllVehicles)
-    .define_method("set_arc_cost_evaluator_of_vehicle", &RoutingModel::SetArcCostEvaluatorOfVehicle)
-    .define_method("set_fixed_cost_of_all_vehicles", &RoutingModel::SetFixedCostOfAllVehicles)
-    .define_method("set_fixed_cost_of_vehicle", &RoutingModel::SetFixedCostOfVehicle)
-    .define_method("fixed_cost_of_vehicle", &RoutingModel::GetFixedCostOfVehicle)
-    .define_method("add_dimension", &RoutingModel::AddDimension)
-    .define_method(
-      "add_dimension_with_vehicle_capacity",
-      [](RoutingModel& self, int evaluator_index, int64_t slack_max, std::vector<int64_t> vehicle_capacities, bool fix_start_cumul_to_zero, const std::string& name) {
-        self.AddDimensionWithVehicleCapacity(evaluator_index, slack_max, vehicle_capacities, fix_start_cumul_to_zero, name);
-      })
-    .define_method(
-      "add_dimension_with_vehicle_transits",
-      [](RoutingModel& self, std::vector<int> evaluator_indices, int64_t slack_max, int64_t capacity, bool fix_start_cumul_to_zero, const std::string& name) {
-        self.AddDimensionWithVehicleTransits(evaluator_indices, slack_max, capacity, fix_start_cumul_to_zero, name);
-      })
-    .define_method(
-      "add_disjunction",
-      [](RoutingModel& self, std::vector<int64_t> indices, int64_t penalty) {
-        self.AddDisjunction(indices, penalty);
-      })
-    .define_method("add_pickup_and_delivery", &RoutingModel::AddPickupAndDelivery)
-    .define_method("solver", &RoutingModel::solver)
+    .define_method("apply_locks", &RoutingModel::ApplyLocks)
+    .define_method("apply_locks_to_all_vehicles", &RoutingModel::ApplyLocksToAllVehicles)
+    .define_method("pre_assignment", &RoutingModel::PreAssignment)
+    .define_method("mutable_pre_assignment", &RoutingModel::MutablePreAssignment)
+    .define_method("write_assignment", &RoutingModel::WriteAssignment)
+    .define_method("read_assignment", &RoutingModel::ReadAssignment)
+    .define_method("restore_assignment", &RoutingModel::RestoreAssignment)
+    .define_method("read_assignment_from_routes", &RoutingModel::ReadAssignmentFromRoutes)
+    .define_method("routes_to_assignment", &RoutingModel::RoutesToAssignment)
+    .define_method("assignment_to_routes", &RoutingModel::AssignmentToRoutes)
+    .define_method("compact_assignment", &RoutingModel::CompactAssignment)
+    .define_method("compact_and_check_assignment", &RoutingModel::CompactAndCheckAssignment)
+    .define_method("add_to_assignment", &RoutingModel::AddToAssignment)
+    .define_method("add_interval_to_assignment", &RoutingModel::AddIntervalToAssignment)
+    // TODO PackCumulsOfOptimizerDimensionsFromAssignment
+    // TODO AddLocalSearchFilter
     .define_method("start", &RoutingModel::Start)
     .define_method("end", &RoutingModel::End)
     .define_method("start?", &RoutingModel::IsStart)
@@ -333,12 +435,23 @@ void init_routing(Rice::Module& m) {
     .define_method("next", &RoutingModel::Next)
     .define_method("vehicle_used?", &RoutingModel::IsVehicleUsed)
     .define_method("next_var", &RoutingModel::NextVar)
+    .define_method("active_var", &RoutingModel::ActiveVar)
+    .define_method("active_vehicle_var", &RoutingModel::ActiveVehicleVar)
+    .define_method("vehicle_route_considered_var", &RoutingModel::VehicleRouteConsideredVar)
+    .define_method("vehicle_var", &RoutingModel::VehicleVar)
+    .define_method("resource_var", &RoutingModel::ResourceVar)
+    .define_method("cost_var", &RoutingModel::CostVar)
     .define_method("arc_cost_for_vehicle", &RoutingModel::GetArcCostForVehicle)
-    .define_method("mutable_dimension", &RoutingModel::GetMutableDimension)
-    .define_method("add_variable_minimized_by_finalizer", &RoutingModel::AddVariableMinimizedByFinalizer)
-    .define_method(
-      "solve_with_parameters",
-      [](RoutingModel& self, const RoutingSearchParameters& search_parameters) {
-        return self.SolveWithParameters(search_parameters);
-      });
+    .define_method("costs_are_homogeneous_across_vehicles?", &RoutingModel::CostsAreHomogeneousAcrossVehicles)
+    .define_method("homogeneous_cost", &RoutingModel::GetHomogeneousCost)
+    .define_method("arc_cost_for_first_solution", &RoutingModel::GetArcCostForFirstSolution)
+    .define_method("cost_classes_count", &RoutingModel::GetCostClassesCount)
+    .define_method("non_zero_cost_classes_count", &RoutingModel::GetNonZeroCostClassesCount)
+    .define_method("vehicle_classes_count", &RoutingModel::GetVehicleClassesCount)
+    .define_method("arc_is_more_constrained_than_arc?", &RoutingModel::ArcIsMoreConstrainedThanArc)
+    .define_method("solver", &RoutingModel::solver)
+    .define_method("nodes", &RoutingModel::nodes)
+    .define_method("vehicles", &RoutingModel::vehicles)
+    .define_method("size", &RoutingModel::Size)
+    .define_method("matching_model?", &RoutingModel::IsMatchingModel);
 }

data/lib/or_tools/tsp.rb

@@ -22,13 +22,7 @@ module ORTools
       manager = ORTools::RoutingIndexManager.new(locations.size, 1, 0)
       routing = ORTools::RoutingModel.new(manager)
 
-      distance_callback = lambda do |from_index, to_index|
-        from_node = manager.index_to_node(from_index)
-        to_node = manager.index_to_node(to_index)
-        distance_matrix[from_node][to_node]
-      end
-
-      transit_callback_index = routing.register_transit_callback(distance_callback)
+      transit_callback_index = routing.register_transit_matrix(distance_matrix)
       routing.set_arc_cost_evaluator_of_all_vehicles(transit_callback_index)
       assignment = routing.solve(first_solution_strategy: :path_cheapest_arc)
 

data/lib/or_tools/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-28 00:00:00.000000000 Z
+date: 2022-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice