com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-or-tools Show documentation
A project to publish Google OR-Tools as a dependable dependency in Maven.
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: ortools/constraint_solver/routing_parameters.proto

package com.google.ortools.constraintsolver;

public interface RoutingSearchParametersOrBuilder extends
    // @@protoc_insertion_point(interface_extends:operations_research.RoutingSearchParameters)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * First solution strategies, used as starting point of local search.
   * 
   *
   * .operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;
   */
  int getFirstSolutionStrategyValue();
  /**
   *    * First solution strategies, used as starting point of local search.
   * 
   *
   * .operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;
   */
  com.google.ortools.constraintsolver.FirstSolutionStrategy.Value getFirstSolutionStrategy();

  /**
   *    * These are advanced first solutions strategy settings which should not be
   * modified unless you know what you are doing.
   * Use filtered version of first solution strategy if available.
   * 
   *
   * bool use_filtered_first_solution_strategy = 2;
   */
  boolean getUseFilteredFirstSolutionStrategy();

  /**
   *    * Parameters specific to the Savings first solution heuristic.
   * Ratio (between 0 and 1) of neighbors to consider for each node when
   * constructing the savings. If <= 0 or greater than 1, its value is
   * considered to be 1.0.
   * 
   *
   * double savings_neighbors_ratio = 14;
   */
  double getSavingsNeighborsRatio();

  /**
   *    * Add savings related to reverse arcs when finding the nearest neighbors
   * of the nodes.
   * 
   *
   * bool savings_add_reverse_arcs = 15;
   */
  boolean getSavingsAddReverseArcs();

  /**
   * .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
   */
  boolean hasLocalSearchOperators();
  /**
   * .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
   */
  com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators getLocalSearchOperators();
  /**
   * .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
   */
  com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder getLocalSearchOperatorsOrBuilder();

  /**
   *    * Local search metaheuristics used to guide the search.
   * 
   *
   * .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;
   */
  int getLocalSearchMetaheuristicValue();
  /**
   *    * Local search metaheuristics used to guide the search.
   * 
   *
   * .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;
   */
  com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value getLocalSearchMetaheuristic();

  /**
   *    * These are advanced settings which should not be modified unless you know
   * what you are doing.
   * Lambda coefficient used to penalize arc costs when GUIDED_LOCAL_SEARCH is
   * used.
   * 
   *
   * double guided_local_search_lambda_coefficient = 5;
   */
  double getGuidedLocalSearchLambdaCoefficient();

  /**
   *    * --- Search control ---
   * If true, the solver should use depth-first search rather than local search
   * to solve the problem.
   * 
   *
   * bool use_depth_first_search = 6;
   */
  boolean getUseDepthFirstSearch();

  /**
   *    * Minimum step by which the solution must be improved in local search.
   * 
   *
   * int64 optimization_step = 7;
   */
  long getOptimizationStep();

  /**
   *    * -- Search limits --
   * Limit to the number of solutions generated during the search.
   * 
   *
   * int64 solution_limit = 8;
   */
  long getSolutionLimit();

  /**
   *    * Limit in milliseconds to the time spent in the search.
   * 
   *
   * int64 time_limit_ms = 9;
   */
  long getTimeLimitMs();

  /**
   *    * Limit in milliseconds to the time spent in the completion search for each
   * local search neighbor.
   * 
   *
   * int64 lns_time_limit_ms = 10;
   */
  long getLnsTimeLimitMs();

  /**
   *    * --- Propagation control ---
   * These are advanced settings which should not be modified unless you know
   * what you are doing.
   * Use constraints with light propagation in routing model. Extra propagation
   * is only necessary when using depth-first search or for models which
   * require strong propagation to finalize the value of secondary variables.
   * Changing this setting to true will slow down the search in most cases and
   * increase memory consumption in all cases.
   * 
   *
   * bool use_light_propagation = 11;
   */
  boolean getUseLightPropagation();

  /**
   *    * --- Miscellaneous ---
   * Some of these are advanced settings which should not be modified unless you
   * know what you are doing.
   * If true, arc cost evaluators will be fingerprinted. The fingerprint will
   * be used when computing vehicle cost equivalent classes, otherwise the
   * address of the evaluator will be used.
   * 
   *
   * bool fingerprint_arc_cost_evaluators = 12;
   */
  boolean getFingerprintArcCostEvaluators();

  /**
   *    * Activates search logging. For each solution found during the search, the
   * following will be displayed: its objective value, the maximum objective
   * value since the beginning of the search, the elapsed time since the
   * beginning of the search, the number of branches explored in the search
   * tree, the number of failures in the search tree, the depth of the search
   * tree, the number of local search neighbors explored, the number of local
   * search neighbors filtered by local search filters, the number of local
   * search neighbors accepted, the total memory used and the percentage of the
   * search done.
   * 
   *
   * bool log_search = 13;
   */
  boolean getLogSearch();
}