Classes
class	NodeNeighborsByCostClass

class	PickupDeliveryPosition

class	ResourceGroup

class	RouteDimensionTravelInfo

class	SecondaryOptimizer

class	VariableValuePair

class	VehicleTypeContainer

Public Member Functions
	RoutingModel (long cPtr, boolean cMemoryOwn)

synchronized void	delete ()

	RoutingModel (RoutingIndexManager index_manager)

	RoutingModel (RoutingIndexManager index_manager, com.google.ortools.constraintsolver.RoutingModelParameters parameters)

int	registerUnaryTransitVector (long[] values)

int	registerUnaryTransitCallback (LongUnaryOperator callback, int sign)

int	registerUnaryTransitCallback (LongUnaryOperator callback)

int	registerTransitMatrix (long[][] values)

int	registerTransitCallback (LongBinaryOperator callback, int sign)

int	registerTransitCallback (LongBinaryOperator callback)

boolean	addDimension (int evaluator_index, long slack_max, long capacity, boolean fix_start_cumul_to_zero, String name)

boolean	addDimensionWithVehicleTransits (int[] evaluator_indices, long slack_max, long capacity, boolean fix_start_cumul_to_zero, String name)

boolean	addDimensionWithVehicleCapacity (int evaluator_index, long slack_max, long[] vehicle_capacities, boolean fix_start_cumul_to_zero, String name)

boolean	addDimensionWithVehicleTransitAndCapacity (int[] evaluator_indices, long slack_max, long[] vehicle_capacities, boolean fix_start_cumul_to_zero, String name)

IntBoolPair	addConstantDimensionWithSlack (long value, long capacity, long slack_max, boolean fix_start_cumul_to_zero, String name)

IntBoolPair	addConstantDimension (long value, long capacity, boolean fix_start_cumul_to_zero, String name)

IntBoolPair	addVectorDimension (long[] values, long capacity, boolean fix_start_cumul_to_zero, String name)

IntBoolPair	addMatrixDimension (long[][] values, long capacity, boolean fix_start_cumul_to_zero, String name)

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_p_t	GetUnaryDimensions ()

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_const_p_t	GetDimensionsWithGlobalCumulOptimizers ()

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_const_p_t	GetDimensionsWithLocalCumulOptimizers ()

boolean	HasGlobalCumulOptimizer (RoutingDimension dimension)

boolean	HasLocalCumulOptimizer (RoutingDimension dimension)

SWIGTYPE_p_operations_research__GlobalDimensionCumulOptimizer	GetMutableGlobalCumulLPOptimizer (RoutingDimension dimension)

SWIGTYPE_p_operations_research__GlobalDimensionCumulOptimizer	GetMutableGlobalCumulMPOptimizer (RoutingDimension dimension)

SWIGTYPE_p_operations_research__LocalDimensionCumulOptimizer	GetMutableLocalCumulLPOptimizer (RoutingDimension dimension)

boolean	hasDimension (String dimension_name)

RoutingDimension	getDimensionOrDie (String dimension_name)

RoutingDimension	getMutableDimension (String dimension_name)

void	setPrimaryConstrainedDimension (String dimension_name)

String	getPrimaryConstrainedDimension ()

RoutingModel.ResourceGroup	AddResourceGroup ()

SWIGTYPE_p_std__vectorT_std__unique_ptrT_operations_research__RoutingModel__ResourceGroup_t_t	GetResourceGroups ()

RoutingModel.ResourceGroup	GetResourceGroup (int rg_index)

int[]	GetDimensionResourceGroupIndices (RoutingDimension dimension)

int	GetDimensionResourceGroupIndex (RoutingDimension dimension)

int	addDisjunction (long[] indices, long penalty, long max_cardinality)

int	addDisjunction (long[] indices, long penalty)

int	addDisjunction (long[] indices)

int[]	getDisjunctionIndices (long index)

long[]	GetDisjunctionNodeIndices (int index)

long	getDisjunctionPenalty (int index)

long	getDisjunctionMaxCardinality (int index)

int	getNumberOfDisjunctions ()

boolean	HasMandatoryDisjunctions ()

boolean	HasMaxCardinalityConstrainedDisjunctions ()

void	ignoreDisjunctionsAlreadyForcedToZero ()

void	addSoftSameVehicleConstraint (long[] indices, long cost)

void	setAllowedVehiclesForIndex (int[] vehicles, long index)

boolean	isVehicleAllowedForIndex (int vehicle, long index)

void	addPickupAndDelivery (long pickup, long delivery)

void	addPickupAndDeliverySets (int pickup_disjunction, int delivery_disjunction)

SWIGTYPE_p_std__vectorT_operations_research__RoutingModel__PickupDeliveryPosition_t	GetPickupPositions (long node_index)

SWIGTYPE_p_std__vectorT_operations_research__RoutingModel__PickupDeliveryPosition_t	GetDeliveryPositions (long node_index)

boolean	IsPickup (long node_index)

boolean	IsDelivery (long node_index)

void	setPickupAndDeliveryPolicyOfAllVehicles (int policy)

void	setPickupAndDeliveryPolicyOfVehicle (int policy, int vehicle)

int	getPickupAndDeliveryPolicyOfVehicle (int vehicle)

int	getNumOfSingletonNodes ()

void	setVisitType (long index, int type, int type_policy)

int	getVisitType (long index)

int[]	GetSingleNodesOfType (int type)

int[]	GetPairIndicesOfType (int type)

int	GetVisitTypePolicy (long index)

void	closeVisitTypes ()

int	getNumberOfVisitTypes ()

void	addHardTypeIncompatibility (int type1, int type2)

void	addTemporalTypeIncompatibility (int type1, int type2)

SWIGTYPE_p_absl__flat_hash_setT_int_t	getTemporalTypeIncompatibilitiesOfType (int type)

boolean	hasHardTypeIncompatibilities ()

boolean	hasTemporalTypeIncompatibilities ()

void	addRequiredTypeAlternativesWhenAddingType (int dependent_type, SWIGTYPE_p_absl__flat_hash_setT_int_t required_type_alternatives)

void	addRequiredTypeAlternativesWhenRemovingType (int dependent_type, SWIGTYPE_p_absl__flat_hash_setT_int_t required_type_alternatives)

SWIGTYPE_p_std__vectorT_absl__flat_hash_setT_int_t_t	GetRequiredTypeAlternativesWhenAddingType (int type)

SWIGTYPE_p_std__vectorT_absl__flat_hash_setT_int_t_t	GetRequiredTypeAlternativesWhenRemovingType (int type)

boolean	hasSameVehicleTypeRequirements ()

boolean	hasTemporalTypeRequirements ()

long	unperformedPenalty (long var_index)

long	unperformedPenaltyOrValue (long default_value, long var_index)

long	getDepot ()

void	SetMaximumNumberOfActiveVehicles (int max_active_vehicles)

int	GetMaximumNumberOfActiveVehicles ()

void	setArcCostEvaluatorOfAllVehicles (int evaluator_index)

void	setArcCostEvaluatorOfVehicle (int evaluator_index, int vehicle)

void	setFixedCostOfAllVehicles (long cost)

void	setFixedCostOfVehicle (long cost, int vehicle)

long	getFixedCostOfVehicle (int vehicle)

void	SetPathEnergyCostOfVehicle (String force, String distance, long unit_cost, int vehicle)

void	setAmortizedCostFactorsOfAllVehicles (long linear_cost_factor, long quadratic_cost_factor)

void	setAmortizedCostFactorsOfVehicle (long linear_cost_factor, long quadratic_cost_factor, int vehicle)

long[]	getAmortizedLinearCostFactorOfVehicles ()

long[]	getAmortizedQuadraticCostFactorOfVehicles ()

void	SetVehicleUsedWhenEmpty (boolean is_used, int vehicle)

boolean	IsVehicleUsedWhenEmpty (int vehicle)

void	setFirstSolutionEvaluator (LongBinaryOperator evaluator)

void	addLocalSearchOperator (LocalSearchOperator ls_operator)

void	addSearchMonitor (SearchMonitor monitor)

void	addAtSolutionCallback (Runnable callback, boolean track_unchecked_neighbors)

void	addAtSolutionCallback (Runnable callback)

void	addVariableMinimizedByFinalizer (IntVar var)

void	addVariableMaximizedByFinalizer (IntVar var)

void	AddWeightedVariableMinimizedByFinalizer (IntVar var, long cost)

void	AddWeightedVariableMaximizedByFinalizer (IntVar var, long cost)

void	addVariableTargetToFinalizer (IntVar var, long target)

void	AddWeightedVariableTargetToFinalizer (IntVar var, long target, long cost)

void	closeModel ()

void	closeModelWithParameters (com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

Assignment	solve (Assignment assignment)

Assignment	solve ()

Assignment	solveWithParameters (com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

Assignment	solveFromAssignmentWithParameters (Assignment assignment, com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

Assignment	FastSolveFromAssignmentWithParameters (Assignment assignment, com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters, boolean check_solution_in_cp, SWIGTYPE_p_absl__flat_hash_setT_operations_research__IntVar_p_t touched)

Assignment	FastSolveFromAssignmentWithParameters (Assignment assignment, com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters, boolean check_solution_in_cp)

Assignment	SolveFromAssignmentsWithParameters (SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t assignments, com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters, SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t solutions)

Assignment	SolveFromAssignmentsWithParameters (SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t assignments, com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

Assignment	SolveWithIteratedLocalSearch (com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

void	setAssignmentFromOtherModelAssignment (Assignment target_assignment, RoutingModel source_model, Assignment source_assignment)

long	computeLowerBound ()

long	objective_lower_bound ()

int	status ()

boolean	enable_deep_serialization ()

IntVar	applyLocks (long[] locks)

boolean	applyLocksToAllVehicles (long[][] locks, boolean close_routes)

Assignment	preAssignment ()

Assignment	mutablePreAssignment ()

boolean	writeAssignment (String file_name)

Assignment	readAssignment (String file_name)

Assignment	restoreAssignment (Assignment solution)

Assignment	readAssignmentFromRoutes (long[][] routes, boolean ignore_inactive_indices)

boolean	routesToAssignment (long[][] routes, boolean ignore_inactive_indices, boolean close_routes, Assignment assignment)

void	assignmentToRoutes (Assignment assignment, long[][] routes)

Assignment	compactAssignment (Assignment assignment)

Assignment	compactAndCheckAssignment (Assignment assignment)

void	addToAssignment (IntVar var)

void	addIntervalToAssignment (IntervalVar interval)

RoutingModel.NodeNeighborsByCostClass	GetOrCreateNodeNeighborsByCostClass (double neighbors_ratio, long min_neighbors, SWIGTYPE_p_double neighbors_ratio_used, boolean add_vehicle_starts_to_neighbors)

RoutingModel.NodeNeighborsByCostClass	GetOrCreateNodeNeighborsByCostClass (double neighbors_ratio, long min_neighbors, SWIGTYPE_p_double neighbors_ratio_used)

RoutingModel.NodeNeighborsByCostClass	GetOrCreateNodeNeighborsByCostClass (int num_neighbors, boolean add_vehicle_starts_to_neighbors)

RoutingModel.NodeNeighborsByCostClass	GetOrCreateNodeNeighborsByCostClass (int num_neighbors)

void	addLocalSearchFilter (LocalSearchFilter filter)

long	start (int vehicle)

long	end (int vehicle)

boolean	isStart (long index)

boolean	isEnd (long index)

int	VehicleIndex (long index)

long	next (Assignment assignment, long index)

boolean	isVehicleUsed (Assignment assignment, int vehicle)

IntVar[]	nexts ()

IntVar[]	vehicleVars ()

IntVar[]	ResourceVars (int resource_group)

IntVar	nextVar (long index)

IntVar	activeVar (long index)

IntVar	activeVehicleVar (int vehicle)

IntVar	VehicleRouteConsideredVar (int vehicle)

IntVar	vehicleVar (long index)

IntVar	ResourceVar (int vehicle, int resource_group)

IntVar	costVar ()

long	getArcCostForVehicle (long from_index, long to_index, long vehicle)

boolean	costsAreHomogeneousAcrossVehicles ()

long	getHomogeneousCost (long from_index, long to_index)

long	getArcCostForFirstSolution (long from_index, long to_index)

long	getArcCostForClass (long from_index, long to_index, long cost_class_index)

int	getCostClassIndexOfVehicle (long vehicle)

boolean	hasVehicleWithCostClassIndex (int cost_class_index)

int	getCostClassesCount ()

int	getNonZeroCostClassesCount ()

int	getVehicleClassIndexOfVehicle (long vehicle)

int	GetVehicleOfClass (int vehicle_class)

int	getVehicleClassesCount ()

int[]	getSameVehicleIndicesOfIndex (int node)

RoutingModel.VehicleTypeContainer	GetVehicleTypeContainer ()

boolean	arcIsMoreConstrainedThanArc (long from, long to1, long to2)

String	debugOutputAssignment (Assignment solution_assignment, String dimension_to_print)

boolean	CheckIfAssignmentIsFeasible (Assignment assignment, boolean call_at_solution_monitors)

Solver	solver ()

boolean	checkLimit (SWIGTYPE_p_absl__Duration offset)

boolean	checkLimit ()

void	UpdateTimeLimit (SWIGTYPE_p_absl__Duration time_limit)

SWIGTYPE_p_absl__Duration	TimeBuffer ()

SWIGTYPE_p_std__atomicT_bool_t	GetMutableCPSatInterrupt ()

SWIGTYPE_p_std__atomicT_bool_t	GetMutableCPInterrupt ()

void	CancelSearch ()

int	nodes ()

int	vehicles ()

long	size ()

long	getNumberOfDecisionsInFirstSolution (com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

long	getNumberOfRejectsInFirstSolution (com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters)

boolean	isMatchingModel ()

boolean	AreRoutesInterdependent (SWIGTYPE_p_operations_research__RoutingSearchParameters parameters)

DecisionBuilder	makeGuidedSlackFinalizer (RoutingDimension dimension, LongUnaryOperator initializer)

DecisionBuilder	makeSelfDependentDimensionFinalizer (RoutingDimension dimension)

PathsMetadata	GetPathsMetadata ()

Static Public Member Functions
static long	getCPtr (RoutingModel obj)

static long	swigRelease (RoutingModel obj)

static long	getKNoPenalty ()

static int	getKNoDisjunction ()

static int	getKNoDimension ()

Static Public Attributes
static final int	ROUTING_NOT_SOLVED = mainJNI.RoutingModel_ROUTING_NOT_SOLVED_get()
	Status.

static final int	ROUTING_SUCCESS = mainJNI.RoutingModel_ROUTING_SUCCESS_get()

static final int	ROUTING_PARTIAL_SUCCESS_LOCAL_OPTIMUM_NOT_REACHED = mainJNI.RoutingModel_ROUTING_PARTIAL_SUCCESS_LOCAL_OPTIMUM_NOT_REACHED_get()

static final int	ROUTING_FAIL = mainJNI.RoutingModel_ROUTING_FAIL_get()

static final int	ROUTING_FAIL_TIMEOUT = mainJNI.RoutingModel_ROUTING_FAIL_TIMEOUT_get()

static final int	ROUTING_INVALID = mainJNI.RoutingModel_ROUTING_INVALID_get()

static final int	ROUTING_INFEASIBLE = mainJNI.RoutingModel_ROUTING_INFEASIBLE_get()

static final int	ROUTING_OPTIMAL = mainJNI.RoutingModel_ROUTING_OPTIMAL_get()

static final int	PICKUP_AND_DELIVERY_NO_ORDER = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_NO_ORDER_get()
	PickupAndDeliveryPolicy.

static final int	PICKUP_AND_DELIVERY_LIFO = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_LIFO_get()

static final int	PICKUP_AND_DELIVERY_FIFO = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_FIFO_get()

static final int	kTransitEvaluatorSignUnknown = mainJNI.RoutingModel_kTransitEvaluatorSignUnknown_get()
	TransitEvaluatorSign.

static final int	kTransitEvaluatorSignPositiveOrZero = mainJNI.RoutingModel_kTransitEvaluatorSignPositiveOrZero_get()

static final int	kTransitEvaluatorSignNegativeOrZero = mainJNI.RoutingModel_kTransitEvaluatorSignNegativeOrZero_get()

static final int	TYPE_ADDED_TO_VEHICLE = mainJNI.RoutingModel_TYPE_ADDED_TO_VEHICLE_get()
	VisitTypePolicy.

static final int	ADDED_TYPE_REMOVED_FROM_VEHICLE = mainJNI.RoutingModel_ADDED_TYPE_REMOVED_FROM_VEHICLE_get()

static final int	TYPE_ON_VEHICLE_UP_TO_VISIT = mainJNI.RoutingModel_TYPE_ON_VEHICLE_UP_TO_VISIT_get()

static final int	TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED = mainJNI.RoutingModel_TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED_get()

Protected Member Functions
void	finalize ()

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Definition at line 20 of file RoutingModel.java.

Constructor & Destructor Documentation

◆ RoutingModel() [1/3]

com.google.ortools.constraintsolver.RoutingModel.RoutingModel	(	long	cPtr,
		boolean	cMemoryOwn )

Definition at line 24 of file RoutingModel.java.

◆ RoutingModel() [2/3]

com.google.ortools.constraintsolver.RoutingModel.RoutingModel ( RoutingIndexManager index_manager )

Constructor taking an index manager. The version which does not take
RoutingModelParameters is equivalent to passing
DefaultRoutingModelParameters().

Definition at line 594 of file RoutingModel.java.

◆ RoutingModel() [3/3]

com.google.ortools.constraintsolver.RoutingModel.RoutingModel	(	RoutingIndexManager	index_manager,
		com.google.ortools.constraintsolver.RoutingModelParameters	parameters )

Definition at line 598 of file RoutingModel.java.

Member Function Documentation

◆ activeVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.activeVar ( long index )

Returns the active variable of the node corresponding to index.

Definition at line 2361 of file RoutingModel.java.

◆ activeVehicleVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.activeVehicleVar ( int vehicle )

Returns the active variable of the vehicle. It will be equal to 1 iff the
route of the vehicle is not empty, 0 otherwise.

Definition at line 2370 of file RoutingModel.java.

◆ addAtSolutionCallback() [1/2]

void com.google.ortools.constraintsolver.RoutingModel.addAtSolutionCallback ( Runnable 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.
If track_unchecked_neighbors is true, the callback will also be called on
AcceptUncheckedNeighbor() events, which is useful to grab solutions
obtained when solver_parameters.check_solution_period > 1 (aka fastLS).

Definition at line 1439 of file RoutingModel.java.

◆ addAtSolutionCallback() [2/2]

void com.google.ortools.constraintsolver.RoutingModel.addAtSolutionCallback	(	Runnable	callback,
		boolean	track_unchecked_neighbors )

Adds a callback called each time a solution is found during the search.
This is a shortcut to creating a monitor to call the callback on
AtSolution() and adding it with AddSearchMonitor.
If track_unchecked_neighbors is true, the callback will also be called on
AcceptUncheckedNeighbor() events, which is useful to grab solutions
obtained when solver_parameters.check_solution_period > 1 (aka fastLS).

Definition at line 1427 of file RoutingModel.java.

◆ addConstantDimension()

IntBoolPair com.google.ortools.constraintsolver.RoutingModel.addConstantDimension	(	long	value,
		long	capacity,
		boolean	fix_start_cumul_to_zero,
		String	name )

Definition at line 685 of file RoutingModel.java.

◆ addConstantDimensionWithSlack()

IntBoolPair com.google.ortools.constraintsolver.RoutingModel.addConstantDimensionWithSlack	(	long	value,
		long	capacity,
		long	slack_max,
		boolean	fix_start_cumul_to_zero,
		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 681 of file RoutingModel.java.

◆ addDimension()

boolean com.google.ortools.constraintsolver.RoutingModel.addDimension	(	int	evaluator_index,
		long	slack_max,
		long	capacity,
		boolean	fix_start_cumul_to_zero,
		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, j) + slack(i)
where slack is a positive slack variable (can represent waiting times for
a time dimension).
Setting the value of fix_start_cumul_to_zero to true will force the
"cumul" variable of the start node of all vehicles to be equal to 0.
Creates a dimension where the transit variable is constrained to be
equal to evaluator(i, next(i)); 'slack_max' is the upper bound of the
slack variable and 'capacity' is the upper bound of the cumul variables.
'name' is the name used to reference the dimension; this name is used to
get cumul and transit variables from the routing model.
Returns false if a dimension with the same name has already been created
(and doesn't create the new dimension).
Takes ownership of the callback 'evaluator'.

Definition at line 655 of file RoutingModel.java.

◆ addDimensionWithVehicleCapacity()

boolean com.google.ortools.constraintsolver.RoutingModel.addDimensionWithVehicleCapacity	(	int	evaluator_index,
		long	slack_max,
		long[]	vehicle_capacities,
		boolean	fix_start_cumul_to_zero,
		String	name )

Definition at line 663 of file RoutingModel.java.

◆ addDimensionWithVehicleTransitAndCapacity()

boolean com.google.ortools.constraintsolver.RoutingModel.addDimensionWithVehicleTransitAndCapacity	(	int[]	evaluator_indices,
		long	slack_max,
		long[]	vehicle_capacities,
		boolean	fix_start_cumul_to_zero,
		String	name )

Definition at line 667 of file RoutingModel.java.

◆ addDimensionWithVehicleTransits()

boolean com.google.ortools.constraintsolver.RoutingModel.addDimensionWithVehicleTransits	(	int[]	evaluator_indices,
		long	slack_max,
		long	capacity,
		boolean	fix_start_cumul_to_zero,
		String	name )

Definition at line 659 of file RoutingModel.java.

◆ addDisjunction() [1/3]

int com.google.ortools.constraintsolver.RoutingModel.addDisjunction ( long[] indices )

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 902 of file RoutingModel.java.

◆ addDisjunction() [2/3]

int com.google.ortools.constraintsolver.RoutingModel.addDisjunction	(	long[]	indices,
		long	penalty )

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 880 of file RoutingModel.java.

◆ addDisjunction() [3/3]

int com.google.ortools.constraintsolver.RoutingModel.addDisjunction	(	long[]	indices,
		long	penalty,
		long	max_cardinality )

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 858 of file RoutingModel.java.

◆ addHardTypeIncompatibility()

void com.google.ortools.constraintsolver.RoutingModel.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 1191 of file RoutingModel.java.

◆ addIntervalToAssignment()

void com.google.ortools.constraintsolver.RoutingModel.addIntervalToAssignment ( IntervalVar interval )

Definition at line 1816 of file RoutingModel.java.

◆ addLocalSearchFilter()

void com.google.ortools.constraintsolver.RoutingModel.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.
Calling this method after the routing model has been closed (CloseModel()
or Solve() has been called) has no effect.
The routing model does not take ownership of the filter.

Definition at line 2267 of file RoutingModel.java.

◆ addLocalSearchOperator()

void com.google.ortools.constraintsolver.RoutingModel.addLocalSearchOperator ( LocalSearchOperator ls_operator )

Adds a local search operator to the set of operators used to solve the
vehicle routing problem.

Definition at line 1408 of file RoutingModel.java.

◆ addMatrixDimension()

IntBoolPair com.google.ortools.constraintsolver.RoutingModel.addMatrixDimension	(	long	values[][],
		long	capacity,
		boolean	fix_start_cumul_to_zero,
		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 715 of file RoutingModel.java.

◆ addPickupAndDelivery()

void com.google.ortools.constraintsolver.RoutingModel.addPickupAndDelivery	(	long	pickup,
		long	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 1011 of file RoutingModel.java.

◆ addPickupAndDeliverySets()

void com.google.ortools.constraintsolver.RoutingModel.addPickupAndDeliverySets	(	int	pickup_disjunction,
		int	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 1020 of file RoutingModel.java.

◆ addRequiredTypeAlternativesWhenAddingType()

void com.google.ortools.constraintsolver.RoutingModel.addRequiredTypeAlternativesWhenAddingType	(	int	dependent_type,
		SWIGTYPE_p_absl__flat_hash_setT_int_t	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 1221 of file RoutingModel.java.

◆ addRequiredTypeAlternativesWhenRemovingType()

void com.google.ortools.constraintsolver.RoutingModel.addRequiredTypeAlternativesWhenRemovingType	(	int	dependent_type,
		SWIGTYPE_p_absl__flat_hash_setT_int_t	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 1232 of file RoutingModel.java.

◆ AddResourceGroup()

RoutingModel.ResourceGroup com.google.ortools.constraintsolver.RoutingModel.AddResourceGroup ( )

Adds a resource group to the routing model and returns a pointer to it.

Definition at line 810 of file RoutingModel.java.

◆ addSearchMonitor()

void com.google.ortools.constraintsolver.RoutingModel.addSearchMonitor ( SearchMonitor monitor )

Adds a search monitor to the search used to solve the routing model.

Definition at line 1415 of file RoutingModel.java.

◆ addSoftSameVehicleConstraint()

void com.google.ortools.constraintsolver.RoutingModel.addSoftSameVehicleConstraint	(	long[]	indices,
		long	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 975 of file RoutingModel.java.

◆ addTemporalTypeIncompatibility()

void com.google.ortools.constraintsolver.RoutingModel.addTemporalTypeIncompatibility	(	int	type1,
		int	type2 )

Definition at line 1195 of file RoutingModel.java.

◆ addToAssignment()

void com.google.ortools.constraintsolver.RoutingModel.addToAssignment ( IntVar var )

Adds an extra variable to the vehicle routing assignment.

Definition at line 1812 of file RoutingModel.java.

◆ addVariableMaximizedByFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.addVariableMaximizedByFinalizer ( IntVar var )

Adds a variable to maximize in the solution finalizer (see above for
information on the solution finalizer).

Definition at line 1457 of file RoutingModel.java.

◆ addVariableMinimizedByFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.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 1449 of file RoutingModel.java.

◆ addVariableTargetToFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.addVariableTargetToFinalizer	(	IntVar	var,
		long	target )

Add a variable to set the closest possible to the target value in the
solution finalizer.

Definition at line 1481 of file RoutingModel.java.

◆ addVectorDimension()

IntBoolPair com.google.ortools.constraintsolver.RoutingModel.addVectorDimension	(	long[]	values,
		long	capacity,
		boolean	fix_start_cumul_to_zero,
		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 700 of file RoutingModel.java.

◆ AddWeightedVariableMaximizedByFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.AddWeightedVariableMaximizedByFinalizer	(	IntVar	var,
		long	cost )

Adds a variable to maximize in the solution finalizer, with a weighted
priority: the higher the more priority it has.

Definition at line 1473 of file RoutingModel.java.

◆ AddWeightedVariableMinimizedByFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.AddWeightedVariableMinimizedByFinalizer	(	IntVar	var,
		long	cost )

Adds a variable to minimize in the solution finalizer, with a weighted
priority: the higher the more priority it has.

Definition at line 1465 of file RoutingModel.java.

◆ AddWeightedVariableTargetToFinalizer()

void com.google.ortools.constraintsolver.RoutingModel.AddWeightedVariableTargetToFinalizer	(	IntVar	var,
		long	target,
		long	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 1489 of file RoutingModel.java.

◆ applyLocks()

IntVar com.google.ortools.constraintsolver.RoutingModel.applyLocks ( long[] 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 1665 of file RoutingModel.java.

◆ applyLocksToAllVehicles()

boolean com.google.ortools.constraintsolver.RoutingModel.applyLocksToAllVehicles	(	long	locks[][],
		boolean	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 1680 of file RoutingModel.java.

◆ arcIsMoreConstrainedThanArc()

boolean com.google.ortools.constraintsolver.RoutingModel.arcIsMoreConstrainedThanArc	(	long	from,
		long	to1,
		long	to2 )

Returns whether the arc from->to1 is more constrained than from->to2,
taking into account, in order:

whether the destination node isn't an end node
whether the destination node is mandatory
whether the destination node is bound to the same vehicle as the source
the "primary constrained" dimension (see SetPrimaryConstrainedDimension)
It then breaks ties using, in order:
the arc cost (taking unperformed penalties into account)
the size of the vehicle vars of "to1" and "to2" (lowest size wins)
the value: the lowest value of the indices to1 and to2 wins.
See the .cc for details.
The more constrained arc is typically preferable when building a
first solution. This method is intended to be used as a callback for the
BestValueByComparisonSelector value selector.
Args:
from: the variable index of the source node
to1: the variable index of the first candidate destination node.
to2: the variable index of the second candidate destination node.

Definition at line 2534 of file RoutingModel.java.

◆ AreRoutesInterdependent()

boolean com.google.ortools.constraintsolver.RoutingModel.AreRoutesInterdependent ( SWIGTYPE_p_operations_research__RoutingSearchParameters parameters )

Returns true if routes are interdependent. This means that any
modification to a route might impact another.

Definition at line 2667 of file RoutingModel.java.

◆ assignmentToRoutes()

void com.google.ortools.constraintsolver.RoutingModel.assignmentToRoutes	(	Assignment	assignment,
		long	routes[][] )

Converts the solution in the given assignment to routes for all vehicles.
Expects that assignment contains a valid solution (i.e. routes for all
vehicles end with an end index for that vehicle).

Definition at line 1767 of file RoutingModel.java.

◆ CancelSearch()

void com.google.ortools.constraintsolver.RoutingModel.CancelSearch ( )

Cancels the current search.

Definition at line 2618 of file RoutingModel.java.

◆ CheckIfAssignmentIsFeasible()

boolean com.google.ortools.constraintsolver.RoutingModel.CheckIfAssignmentIsFeasible	(	Assignment	assignment,
		boolean	call_at_solution_monitors )

Returns a vector cumul_bounds, for which cumul_bounds[i][j] is a pair
containing the minimum and maximum of the CumulVar of the jth node on
route i.

cumul_bounds[i][j].first is the minimum.
cumul_bounds[i][j].second is the maximum.
Checks if an assignment is feasible.

Definition at line 2556 of file RoutingModel.java.

◆ checkLimit() [1/2]

boolean com.google.ortools.constraintsolver.RoutingModel.checkLimit ( )

Returns true if the search limit has been crossed with the given time
offset.

Definition at line 2581 of file RoutingModel.java.

◆ checkLimit() [2/2]

boolean com.google.ortools.constraintsolver.RoutingModel.checkLimit ( SWIGTYPE_p_absl__Duration offset )

Returns true if the search limit has been crossed with the given time
offset.

Definition at line 2573 of file RoutingModel.java.

◆ closeModel()

void com.google.ortools.constraintsolver.RoutingModel.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 1501 of file RoutingModel.java.

◆ closeModelWithParameters()

void com.google.ortools.constraintsolver.RoutingModel.closeModelWithParameters ( com.google.ortools.constraintsolver.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 1509 of file RoutingModel.java.

◆ closeVisitTypes()

void com.google.ortools.constraintsolver.RoutingModel.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 1177 of file RoutingModel.java.

◆ compactAndCheckAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.compactAndCheckAssignment ( Assignment assignment )

Same as CompactAssignment() but also checks the validity of the final
compact solution; if it is not valid, no attempts to repair it are made
(instead, the method returns nullptr).

Definition at line 1804 of file RoutingModel.java.

◆ compactAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.compactAssignment ( 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.
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 1794 of file RoutingModel.java.

◆ computeLowerBound()

long com.google.ortools.constraintsolver.RoutingModel.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 1629 of file RoutingModel.java.

◆ costsAreHomogeneousAcrossVehicles()

boolean com.google.ortools.constraintsolver.RoutingModel.costsAreHomogeneousAcrossVehicles ( )

Whether costs are homogeneous across all vehicles.

Definition at line 2423 of file RoutingModel.java.

◆ costVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.costVar ( )

Returns the global cost variable which is being minimized.

Definition at line 2407 of file RoutingModel.java.

◆ debugOutputAssignment()

String com.google.ortools.constraintsolver.RoutingModel.debugOutputAssignment	(	Assignment	solution_assignment,
		String	dimension_to_print )

Print some debugging information about an assignment, including the
feasible intervals of the CumulVar for dimension "dimension_to_print"
at each step of the routes.
If "dimension_to_print" is omitted, all dimensions will be printed.

Definition at line 2544 of file RoutingModel.java.

◆ delete()

synchronized void com.google.ortools.constraintsolver.RoutingModel.delete ( )

Definition at line 50 of file RoutingModel.java.

◆ enable_deep_serialization()

boolean com.google.ortools.constraintsolver.RoutingModel.enable_deep_serialization ( )

Returns the value of the internal enable_deep_serialization_ parameter.

Definition at line 1651 of file RoutingModel.java.

◆ end()

long com.google.ortools.constraintsolver.RoutingModel.end ( int vehicle )

Returns the variable index of the ending node of a vehicle route.

Definition at line 2282 of file RoutingModel.java.

◆ FastSolveFromAssignmentWithParameters() [1/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.FastSolveFromAssignmentWithParameters	(	Assignment	assignment,
		com.google.ortools.constraintsolver.RoutingSearchParameters	search_parameters,
		boolean	check_solution_in_cp )

Improves a given assignment using unchecked local search.
If check_solution_in_cp is true the final solution will be checked with
the CP solver.
As of 11/2023, only works with greedy descent.

Definition at line 1579 of file RoutingModel.java.

◆ FastSolveFromAssignmentWithParameters() [2/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.FastSolveFromAssignmentWithParameters	(	Assignment	assignment,
		com.google.ortools.constraintsolver.RoutingSearchParameters	search_parameters,
		boolean	check_solution_in_cp,
		SWIGTYPE_p_absl__flat_hash_setT_operations_research__IntVar_p_t	touched )

Improves a given assignment using unchecked local search.
If check_solution_in_cp is true the final solution will be checked with
the CP solver.
As of 11/2023, only works with greedy descent.

Definition at line 1568 of file RoutingModel.java.

◆ finalize()

void com.google.ortools.constraintsolver.RoutingModel.finalize ( )

protected

Definition at line 46 of file RoutingModel.java.

◆ getAmortizedLinearCostFactorOfVehicles()

long[] com.google.ortools.constraintsolver.RoutingModel.getAmortizedLinearCostFactorOfVehicles ( )

Definition at line 1379 of file RoutingModel.java.

◆ getAmortizedQuadraticCostFactorOfVehicles()

long[] com.google.ortools.constraintsolver.RoutingModel.getAmortizedQuadraticCostFactorOfVehicles ( )

Definition at line 1383 of file RoutingModel.java.

◆ getArcCostForClass()

long com.google.ortools.constraintsolver.RoutingModel.getArcCostForClass	(	long	from_index,
		long	to_index,
		long	cost_class_index )

Returns the cost of the segment between two nodes for a given cost
class. Input are variable indices of nodes and the cost class.
Unlike GetArcCostForVehicle(), if cost_class is kNoCost, then the
returned cost won't necessarily be zero: only some of the components
of the cost that depend on the cost class will be omited. See the code
for details.

Definition at line 2451 of file RoutingModel.java.

◆ getArcCostForFirstSolution()

long com.google.ortools.constraintsolver.RoutingModel.getArcCostForFirstSolution	(	long	from_index,
		long	to_index )

Returns the cost of the arc in the context of the first solution strategy.
This is typically a simplification of the actual cost; see the .cc.

Definition at line 2439 of file RoutingModel.java.

◆ getArcCostForVehicle()

long com.google.ortools.constraintsolver.RoutingModel.getArcCostForVehicle	(	long	from_index,
		long	to_index,
		long	vehicle )

Returns the cost of the transit arc between two nodes for a given vehicle.
Input are variable indices of node. This returns 0 if vehicle < 0.

Definition at line 2416 of file RoutingModel.java.

◆ getCostClassesCount()

int com.google.ortools.constraintsolver.RoutingModel.getCostClassesCount ( )

Returns the number of different cost classes in the model.

Definition at line 2473 of file RoutingModel.java.

◆ getCostClassIndexOfVehicle()

int com.google.ortools.constraintsolver.RoutingModel.getCostClassIndexOfVehicle ( long vehicle )

Get the cost class index of the given vehicle.

Definition at line 2458 of file RoutingModel.java.

◆ getCPtr()

static long com.google.ortools.constraintsolver.RoutingModel.getCPtr ( RoutingModel obj )

static

Definition at line 29 of file RoutingModel.java.

◆ GetDeliveryPositions()

SWIGTYPE_p_std__vectorT_operations_research__RoutingModel__PickupDeliveryPosition_t com.google.ortools.constraintsolver.RoutingModel.GetDeliveryPositions ( long node_index )

Returns the pickup and delivery positions where the node is a delivery.

Definition at line 1113 of file RoutingModel.java.

◆ getDepot()

long com.google.ortools.constraintsolver.RoutingModel.getDepot ( )

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 1286 of file RoutingModel.java.

◆ getDimensionOrDie()

RoutingDimension com.google.ortools.constraintsolver.RoutingModel.getDimensionOrDie ( String dimension_name )

Returns a dimension from its name. Dies if the dimension does not exist.

Definition at line 777 of file RoutingModel.java.

◆ GetDimensionResourceGroupIndex()

int com.google.ortools.constraintsolver.RoutingModel.GetDimensionResourceGroupIndex ( RoutingDimension dimension )

Returns the index of the resource group attached to the dimension.
DCHECKS that there's exactly one resource group for this dimension.

Definition at line 836 of file RoutingModel.java.

◆ GetDimensionResourceGroupIndices()

int[] com.google.ortools.constraintsolver.RoutingModel.GetDimensionResourceGroupIndices ( RoutingDimension dimension )

Returns the indices of resource groups for this dimension. This method can
only be called after the model has been closed.

Definition at line 828 of file RoutingModel.java.

◆ GetDimensionsWithGlobalCumulOptimizers()

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_const_p_t com.google.ortools.constraintsolver.RoutingModel.GetDimensionsWithGlobalCumulOptimizers ( )

Returns the dimensions which have [global|local]_dimension_optimizers_.

Definition at line 729 of file RoutingModel.java.

◆ GetDimensionsWithLocalCumulOptimizers()

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_const_p_t com.google.ortools.constraintsolver.RoutingModel.GetDimensionsWithLocalCumulOptimizers ( )

Definition at line 733 of file RoutingModel.java.

◆ getDisjunctionIndices()

int[] com.google.ortools.constraintsolver.RoutingModel.getDisjunctionIndices ( long index )

Returns the indices of the disjunctions to which an index belongs.

Definition at line 909 of file RoutingModel.java.

◆ getDisjunctionMaxCardinality()

long com.google.ortools.constraintsolver.RoutingModel.getDisjunctionMaxCardinality ( int index )

Returns the maximum number of possible active nodes of the node
disjunction of index 'index'.

Definition at line 932 of file RoutingModel.java.

◆ GetDisjunctionNodeIndices()

long[] com.google.ortools.constraintsolver.RoutingModel.GetDisjunctionNodeIndices ( int index )

Returns the variable indices of the nodes in the disjunction of index
'index'.

Definition at line 917 of file RoutingModel.java.

◆ getDisjunctionPenalty()

long com.google.ortools.constraintsolver.RoutingModel.getDisjunctionPenalty ( int index )

Returns the penalty of the node disjunction of index 'index'.

Definition at line 924 of file RoutingModel.java.

◆ getFixedCostOfVehicle()

long com.google.ortools.constraintsolver.RoutingModel.getFixedCostOfVehicle ( int vehicle )

Returns the route fixed cost taken into account if the route of the
vehicle is not empty, aka there's at least one node on the route other
than the first and last nodes.

Definition at line 1343 of file RoutingModel.java.

◆ getHomogeneousCost()

long com.google.ortools.constraintsolver.RoutingModel.getHomogeneousCost	(	long	from_index,
		long	to_index )

Returns the cost of the segment between two nodes supposing all vehicle
costs are the same (returns the cost for the first vehicle otherwise).

Definition at line 2431 of file RoutingModel.java.

◆ getKNoDimension()

static int com.google.ortools.constraintsolver.RoutingModel.getKNoDimension ( )

static

Constant used to express the "no dimension" index, returned when a
dimension name does not correspond to an actual dimension.

Definition at line 585 of file RoutingModel.java.

◆ getKNoDisjunction()

static int com.google.ortools.constraintsolver.RoutingModel.getKNoDisjunction ( )

static

Constant used to express the "no disjunction" index, returned when a node
does not appear in any disjunction.

Definition at line 577 of file RoutingModel.java.

◆ getKNoPenalty()

static long com.google.ortools.constraintsolver.RoutingModel.getKNoPenalty ( )

static

Constant used to express a hard constraint instead of a soft penalty.

Definition at line 569 of file RoutingModel.java.

◆ GetMaximumNumberOfActiveVehicles()

int com.google.ortools.constraintsolver.RoutingModel.GetMaximumNumberOfActiveVehicles ( )

Returns the maximum number of active vehicles.

Definition at line 1303 of file RoutingModel.java.

◆ GetMutableCPInterrupt()

SWIGTYPE_p_std__atomicT_bool_t com.google.ortools.constraintsolver.RoutingModel.GetMutableCPInterrupt ( )

Returns the atomic<bool> to stop the CP solver.

Definition at line 2610 of file RoutingModel.java.

◆ GetMutableCPSatInterrupt()

SWIGTYPE_p_std__atomicT_bool_t com.google.ortools.constraintsolver.RoutingModel.GetMutableCPSatInterrupt ( )

Returns the atomic<bool> to stop the CP-SAT solver.

Definition at line 2602 of file RoutingModel.java.

◆ getMutableDimension()

RoutingDimension com.google.ortools.constraintsolver.RoutingModel.getMutableDimension ( String dimension_name )

Returns a dimension from its name. Returns nullptr if the dimension does
not exist.

Definition at line 785 of file RoutingModel.java.

◆ GetMutableGlobalCumulLPOptimizer()

SWIGTYPE_p_operations_research__GlobalDimensionCumulOptimizer com.google.ortools.constraintsolver.RoutingModel.GetMutableGlobalCumulLPOptimizer ( RoutingDimension dimension )

Returns the global/local dimension cumul optimizer for a given dimension,
or nullptr if there is none.

Definition at line 752 of file RoutingModel.java.

◆ GetMutableGlobalCumulMPOptimizer()

SWIGTYPE_p_operations_research__GlobalDimensionCumulOptimizer com.google.ortools.constraintsolver.RoutingModel.GetMutableGlobalCumulMPOptimizer ( RoutingDimension dimension )

Definition at line 757 of file RoutingModel.java.

◆ GetMutableLocalCumulLPOptimizer()

SWIGTYPE_p_operations_research__LocalDimensionCumulOptimizer com.google.ortools.constraintsolver.RoutingModel.GetMutableLocalCumulLPOptimizer ( RoutingDimension dimension )

Definition at line 762 of file RoutingModel.java.

◆ getNonZeroCostClassesCount()

int com.google.ortools.constraintsolver.RoutingModel.getNonZeroCostClassesCount ( )

Ditto, minus the 'always zero', built-in cost class.

Definition at line 2480 of file RoutingModel.java.

◆ getNumberOfDecisionsInFirstSolution()

long com.google.ortools.constraintsolver.RoutingModel.getNumberOfDecisionsInFirstSolution ( com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters )

Returns statistics on first solution search, number of decisions sent to
filters, number of decisions rejected by filters.

Definition at line 2648 of file RoutingModel.java.

◆ getNumberOfDisjunctions()

int com.google.ortools.constraintsolver.RoutingModel.getNumberOfDisjunctions ( )

Returns the number of node disjunctions in the model.

Definition at line 939 of file RoutingModel.java.

◆ getNumberOfRejectsInFirstSolution()

long com.google.ortools.constraintsolver.RoutingModel.getNumberOfRejectsInFirstSolution ( com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters )

Definition at line 2652 of file RoutingModel.java.

◆ getNumberOfVisitTypes()

int com.google.ortools.constraintsolver.RoutingModel.getNumberOfVisitTypes ( )

Definition at line 1181 of file RoutingModel.java.

◆ getNumOfSingletonNodes()

int com.google.ortools.constraintsolver.RoutingModel.getNumOfSingletonNodes ( )

Returns the number of non-start/end nodes which do not appear in a
pickup/delivery pair.

Definition at line 1148 of file RoutingModel.java.

◆ GetOrCreateNodeNeighborsByCostClass() [1/4]

RoutingModel.NodeNeighborsByCostClass com.google.ortools.constraintsolver.RoutingModel.GetOrCreateNodeNeighborsByCostClass	(	double	neighbors_ratio,
		long	min_neighbors,
		SWIGTYPE_p_double	neighbors_ratio_used )

Returns neighbors of all nodes for every cost class. The result is cached
and is computed once. The number of neighbors considered is based on a
ratio of non-vehicle nodes, specified by neighbors_ratio, with a minimum
of min-neighbors node considered.

Definition at line 2237 of file RoutingModel.java.

◆ GetOrCreateNodeNeighborsByCostClass() [2/4]

RoutingModel.NodeNeighborsByCostClass com.google.ortools.constraintsolver.RoutingModel.GetOrCreateNodeNeighborsByCostClass	(	double	neighbors_ratio,
		long	min_neighbors,
		SWIGTYPE_p_double	neighbors_ratio_used,
		boolean	add_vehicle_starts_to_neighbors )

Returns neighbors of all nodes for every cost class. The result is cached
and is computed once. The number of neighbors considered is based on a
ratio of non-vehicle nodes, specified by neighbors_ratio, with a minimum
of min-neighbors node considered.

Definition at line 2226 of file RoutingModel.java.

◆ GetOrCreateNodeNeighborsByCostClass() [3/4]

RoutingModel.NodeNeighborsByCostClass com.google.ortools.constraintsolver.RoutingModel.GetOrCreateNodeNeighborsByCostClass ( int num_neighbors )

Returns parameters.num_neighbors neighbors of all nodes for every cost
class. The result is cached and is computed once.

Definition at line 2255 of file RoutingModel.java.

◆ GetOrCreateNodeNeighborsByCostClass() [4/4]

RoutingModel.NodeNeighborsByCostClass com.google.ortools.constraintsolver.RoutingModel.GetOrCreateNodeNeighborsByCostClass	(	int	num_neighbors,
		boolean	add_vehicle_starts_to_neighbors )

Returns parameters.num_neighbors neighbors of all nodes for every cost
class. The result is cached and is computed once.

Definition at line 2246 of file RoutingModel.java.

◆ GetPairIndicesOfType()

int[] com.google.ortools.constraintsolver.RoutingModel.GetPairIndicesOfType ( int type )

Definition at line 1164 of file RoutingModel.java.

◆ GetPathsMetadata()

PathsMetadata com.google.ortools.constraintsolver.RoutingModel.GetPathsMetadata ( )

Definition at line 2710 of file RoutingModel.java.

◆ getPickupAndDeliveryPolicyOfVehicle()

int com.google.ortools.constraintsolver.RoutingModel.getPickupAndDeliveryPolicyOfVehicle ( int vehicle )

Definition at line 1140 of file RoutingModel.java.

◆ GetPickupPositions()

SWIGTYPE_p_std__vectorT_operations_research__RoutingModel__PickupDeliveryPosition_t com.google.ortools.constraintsolver.RoutingModel.GetPickupPositions ( long node_index )

Returns the pickup and delivery positions where the node is a pickup.

Definition at line 1106 of file RoutingModel.java.

◆ getPrimaryConstrainedDimension()

String com.google.ortools.constraintsolver.RoutingModel.getPrimaryConstrainedDimension ( )

Get the primary constrained dimension, or an empty string if it is unset.

Definition at line 803 of file RoutingModel.java.

◆ GetRequiredTypeAlternativesWhenAddingType()

SWIGTYPE_p_std__vectorT_absl__flat_hash_setT_int_t_t com.google.ortools.constraintsolver.RoutingModel.GetRequiredTypeAlternativesWhenAddingType ( int type )

Returns the set of requirement alternatives when adding the given type.

Definition at line 1239 of file RoutingModel.java.

◆ GetRequiredTypeAlternativesWhenRemovingType()

SWIGTYPE_p_std__vectorT_absl__flat_hash_setT_int_t_t com.google.ortools.constraintsolver.RoutingModel.GetRequiredTypeAlternativesWhenRemovingType ( int type )

Returns the set of requirement alternatives when removing the given type.

Definition at line 1246 of file RoutingModel.java.

◆ GetResourceGroup()

RoutingModel.ResourceGroup com.google.ortools.constraintsolver.RoutingModel.GetResourceGroup ( int rg_index )

Definition at line 819 of file RoutingModel.java.

◆ GetResourceGroups()

SWIGTYPE_p_std__vectorT_std__unique_ptrT_operations_research__RoutingModel__ResourceGroup_t_t com.google.ortools.constraintsolver.RoutingModel.GetResourceGroups ( )

Definition at line 815 of file RoutingModel.java.

◆ getSameVehicleIndicesOfIndex()

int[] com.google.ortools.constraintsolver.RoutingModel.getSameVehicleIndicesOfIndex ( int node )

Returns variable indices of nodes constrained to be on the same route.

Definition at line 2506 of file RoutingModel.java.

◆ GetSingleNodesOfType()

int[] com.google.ortools.constraintsolver.RoutingModel.GetSingleNodesOfType ( int type )

Definition at line 1160 of file RoutingModel.java.

◆ getTemporalTypeIncompatibilitiesOfType()

SWIGTYPE_p_absl__flat_hash_setT_int_t com.google.ortools.constraintsolver.RoutingModel.getTemporalTypeIncompatibilitiesOfType ( int type )

Definition at line 1199 of file RoutingModel.java.

◆ GetUnaryDimensions()

SWIGTYPE_p_std__vectorT_operations_research__RoutingDimension_p_t com.google.ortools.constraintsolver.RoutingModel.GetUnaryDimensions ( )

Returns dimensions for which all transit evaluators are unary.

Definition at line 722 of file RoutingModel.java.

◆ getVehicleClassesCount()

int com.google.ortools.constraintsolver.RoutingModel.getVehicleClassesCount ( )

Returns the number of different vehicle classes in the model.

Definition at line 2499 of file RoutingModel.java.

◆ getVehicleClassIndexOfVehicle()

int com.google.ortools.constraintsolver.RoutingModel.getVehicleClassIndexOfVehicle ( long vehicle )

Definition at line 2484 of file RoutingModel.java.

◆ GetVehicleOfClass()

int com.google.ortools.constraintsolver.RoutingModel.GetVehicleOfClass ( int vehicle_class )

Returns a vehicle of the given vehicle class, and -1 if there are no
vehicles for this class.

Definition at line 2492 of file RoutingModel.java.

◆ GetVehicleTypeContainer()

RoutingModel.VehicleTypeContainer com.google.ortools.constraintsolver.RoutingModel.GetVehicleTypeContainer ( )

Definition at line 2510 of file RoutingModel.java.

◆ getVisitType()

int com.google.ortools.constraintsolver.RoutingModel.getVisitType ( long index )

Definition at line 1156 of file RoutingModel.java.

◆ GetVisitTypePolicy()

int com.google.ortools.constraintsolver.RoutingModel.GetVisitTypePolicy ( long index )

Definition at line 1168 of file RoutingModel.java.

◆ hasDimension()

boolean com.google.ortools.constraintsolver.RoutingModel.hasDimension ( String dimension_name )

Returns true if a dimension exists for a given dimension name.

Definition at line 770 of file RoutingModel.java.

◆ HasGlobalCumulOptimizer()

boolean com.google.ortools.constraintsolver.RoutingModel.HasGlobalCumulOptimizer ( RoutingDimension dimension )

Returns whether the given dimension has global/local cumul optimizers.

Definition at line 740 of file RoutingModel.java.

◆ hasHardTypeIncompatibilities()

boolean com.google.ortools.constraintsolver.RoutingModel.hasHardTypeIncompatibilities ( )

Returns true iff any hard (resp. temporal) type incompatibilities have
been added to the model.

Definition at line 1207 of file RoutingModel.java.

◆ HasLocalCumulOptimizer()

boolean com.google.ortools.constraintsolver.RoutingModel.HasLocalCumulOptimizer ( RoutingDimension dimension )

Definition at line 744 of file RoutingModel.java.

◆ HasMandatoryDisjunctions()

boolean com.google.ortools.constraintsolver.RoutingModel.HasMandatoryDisjunctions ( )

Returns true if the model contains mandatory disjunctions (ones with
kNoPenalty as penalty).

Definition at line 947 of file RoutingModel.java.

◆ HasMaxCardinalityConstrainedDisjunctions()

boolean com.google.ortools.constraintsolver.RoutingModel.HasMaxCardinalityConstrainedDisjunctions ( )

Returns true if the model contains at least one disjunction which is
constrained by its max_cardinality.

Definition at line 955 of file RoutingModel.java.

◆ hasSameVehicleTypeRequirements()

boolean com.google.ortools.constraintsolver.RoutingModel.hasSameVehicleTypeRequirements ( )

Returns true iff any same-route (resp. temporal) type requirements have
been added to the model.

Definition at line 1254 of file RoutingModel.java.

◆ hasTemporalTypeIncompatibilities()

boolean com.google.ortools.constraintsolver.RoutingModel.hasTemporalTypeIncompatibilities ( )

Definition at line 1211 of file RoutingModel.java.

◆ hasTemporalTypeRequirements()

boolean com.google.ortools.constraintsolver.RoutingModel.hasTemporalTypeRequirements ( )

Definition at line 1258 of file RoutingModel.java.

◆ hasVehicleWithCostClassIndex()

boolean com.google.ortools.constraintsolver.RoutingModel.hasVehicleWithCostClassIndex ( int cost_class_index )

Returns true iff the model contains a vehicle with the given
cost_class_index.

Definition at line 2466 of file RoutingModel.java.

◆ ignoreDisjunctionsAlreadyForcedToZero()

void com.google.ortools.constraintsolver.RoutingModel.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 966 of file RoutingModel.java.

◆ IsDelivery()

boolean com.google.ortools.constraintsolver.RoutingModel.IsDelivery ( long node_index )

Definition at line 1124 of file RoutingModel.java.

◆ isEnd()

boolean com.google.ortools.constraintsolver.RoutingModel.isEnd ( long index )

Returns true if 'index' represents the last node of a route.

Definition at line 2296 of file RoutingModel.java.

◆ isMatchingModel()

boolean com.google.ortools.constraintsolver.RoutingModel.isMatchingModel ( )

Returns true if a vehicle/node matching problem is detected.

Definition at line 2659 of file RoutingModel.java.

◆ IsPickup()

boolean com.google.ortools.constraintsolver.RoutingModel.IsPickup ( long node_index )

Returns whether the node is a pickup (resp. delivery).

Definition at line 1120 of file RoutingModel.java.

◆ isStart()

boolean com.google.ortools.constraintsolver.RoutingModel.isStart ( long index )

Returns true if 'index' represents the first node of a route.

Definition at line 2289 of file RoutingModel.java.

◆ isVehicleAllowedForIndex()

boolean com.google.ortools.constraintsolver.RoutingModel.isVehicleAllowedForIndex	(	int	vehicle,
		long	index )

Returns true if a vehicle is allowed to visit a given node.

Definition at line 992 of file RoutingModel.java.

◆ isVehicleUsed()

boolean com.google.ortools.constraintsolver.RoutingModel.isVehicleUsed	(	Assignment	assignment,
		int	vehicle )

Returns true if the route of 'vehicle' is non empty in 'assignment'.

Definition at line 2320 of file RoutingModel.java.

◆ IsVehicleUsedWhenEmpty()

boolean com.google.ortools.constraintsolver.RoutingModel.IsVehicleUsedWhenEmpty ( int vehicle )

Definition at line 1391 of file RoutingModel.java.

◆ makeGuidedSlackFinalizer()

DecisionBuilder com.google.ortools.constraintsolver.RoutingModel.makeGuidedSlackFinalizer	(	RoutingDimension	dimension,
		LongUnaryOperator	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:

It follows the routes defined by the nexts variables when choosing a
variable to make a decision on.
When it comes to choose a value for the slack of node i, the decision
builder first calls the callback with argument i, and supposingly the
returned value is x it creates decisions slack[i] = x, slack[i] = x +
1, slack[i] = x - 1, slack[i] = x + 2, etc.

Definition at line 2685 of file RoutingModel.java.

◆ makeSelfDependentDimensionFinalizer()

DecisionBuilder com.google.ortools.constraintsolver.RoutingModel.makeSelfDependentDimensionFinalizer ( RoutingDimension dimension )

MakeSelfDependentDimensionFinalizer is a finalizer for the slacks of a
self-dependent dimension. It makes an extensive use of the caches of the
state dependent transits.
In detail, MakeSelfDependentDimensionFinalizer returns a composition of a
local search decision builder with a greedy descent operator for the cumul
of the start of each route and a guided slack finalizer. Provided there
are no time windows and the maximum slacks are large enough, once the
cumul of the start of route is fixed, the guided finalizer can find
optimal values of the slacks for the rest of the route in time
proportional to the length of the route. Therefore the composed finalizer
generally works in time O(log(t)*n*m), where t is the latest possible
departute time, n is the number of nodes in the network and m is the
number of vehicles.

Definition at line 2705 of file RoutingModel.java.

◆ mutablePreAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.mutablePreAssignment ( )

Definition at line 1695 of file RoutingModel.java.

◆ next()

long com.google.ortools.constraintsolver.RoutingModel.next	(	Assignment	assignment,
		long	index )

Assignment inspection
Returns the variable index of the node directly after the node
corresponding to 'index' in 'assignment'.

Definition at line 2313 of file RoutingModel.java.

◆ nexts()

IntVar[] com.google.ortools.constraintsolver.RoutingModel.nexts ( )

Returns all next variables of the model, such that Nexts(i) is the next
variable of the node corresponding to i.

Definition at line 2328 of file RoutingModel.java.

◆ nextVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.nextVar ( long index )

Returns the next variable of the node corresponding to index. Note that
NextVar(index) == index is equivalent to ActiveVar(index) == 0.

Definition at line 2353 of file RoutingModel.java.

◆ nodes()

int com.google.ortools.constraintsolver.RoutingModel.nodes ( )

Sizes and indices
Returns the number of nodes in the model.

Definition at line 2626 of file RoutingModel.java.

◆ objective_lower_bound()

long com.google.ortools.constraintsolver.RoutingModel.objective_lower_bound ( )

Returns the current lower bound found by internal solvers during the
search.

Definition at line 1637 of file RoutingModel.java.

◆ preAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.preAssignment ( )

Returns an assignment used to fix some of the variables of the problem.
In practice, this assignment locks partial routes of the problem. This
can be used in the context of locking the parts of the routes which have
already been driven in online routing problems.

Definition at line 1690 of file RoutingModel.java.

◆ readAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.readAssignment ( 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 1714 of file RoutingModel.java.

◆ readAssignmentFromRoutes()

Assignment com.google.ortools.constraintsolver.RoutingModel.readAssignmentFromRoutes	(	long	routes[][],
		boolean	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 1735 of file RoutingModel.java.

◆ registerTransitCallback() [1/2]

int com.google.ortools.constraintsolver.RoutingModel.registerTransitCallback ( LongBinaryOperator callback )

Definition at line 629 of file RoutingModel.java.

◆ registerTransitCallback() [2/2]

int com.google.ortools.constraintsolver.RoutingModel.registerTransitCallback	(	LongBinaryOperator	callback,
		int	sign )

Definition at line 625 of file RoutingModel.java.

◆ registerTransitMatrix()

int com.google.ortools.constraintsolver.RoutingModel.registerTransitMatrix ( long values[][] )

Definition at line 621 of file RoutingModel.java.

◆ registerUnaryTransitCallback() [1/2]

int com.google.ortools.constraintsolver.RoutingModel.registerUnaryTransitCallback ( LongUnaryOperator callback )

Definition at line 617 of file RoutingModel.java.

◆ registerUnaryTransitCallback() [2/2]

int com.google.ortools.constraintsolver.RoutingModel.registerUnaryTransitCallback	(	LongUnaryOperator	callback,
		int	sign )

Definition at line 613 of file RoutingModel.java.

◆ registerUnaryTransitVector()

int com.google.ortools.constraintsolver.RoutingModel.registerUnaryTransitVector ( long[] values )

Registers 'callback' and returns its index.
The sign parameter allows to notify the solver that the callback only
return values of the given sign. This can help the solver, but passing
an incorrect sign may crash in non-opt compilation mode, and yield
incorrect results in opt.

Definition at line 609 of file RoutingModel.java.

◆ ResourceVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.ResourceVar	(	int	vehicle,
		int	resource_group )

Returns the resource variable for the given vehicle index in the given
resource group. If a vehicle doesn't require a resource from the
corresponding resource group, then ResourceVar(v, r_g) == -1.

Definition at line 2399 of file RoutingModel.java.

◆ ResourceVars()

IntVar[] com.google.ortools.constraintsolver.RoutingModel.ResourceVars ( int resource_group )

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'.

Definition at line 2345 of file RoutingModel.java.

◆ restoreAssignment()

Assignment com.google.ortools.constraintsolver.RoutingModel.restoreAssignment ( 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 1723 of file RoutingModel.java.

◆ routesToAssignment()

boolean com.google.ortools.constraintsolver.RoutingModel.routesToAssignment	(	long	routes[][],
		boolean	ignore_inactive_indices,
		boolean	close_routes,
		Assignment	assignment )

Fills an assignment from a specification of the routes of the
vehicles. The routes are specified as lists of variable indices that
appear on the routes of the vehicles. The indices of the outer vector in
'routes' correspond to vehicles IDs, the inner vector contains the
variable indices on the routes for the given vehicle. The inner vectors
must not contain the start and end indices, as these are determined by the
routing model. Sets the value of NextVars in the assignment, adding the
variables to the assignment if necessary. The method does not touch other
variables in the assignment. The method can only be called after the model
is closed. With ignore_inactive_indices set to false, this method will
fail (return nullptr) in case some of the route contain indices that are
deactivated in the model; when set to true, these indices will be
skipped. Returns true if routes were successfully
loaded. However, such assignment still might not be a valid
solution to the routing problem due to more complex constraints;
it is advisible to call solver()->CheckSolution() afterwards.

Definition at line 1758 of file RoutingModel.java.

◆ setAllowedVehiclesForIndex()

void com.google.ortools.constraintsolver.RoutingModel.setAllowedVehiclesForIndex	(	int[]	vehicles,
		long	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 985 of file RoutingModel.java.

◆ setAmortizedCostFactorsOfAllVehicles()

void com.google.ortools.constraintsolver.RoutingModel.setAmortizedCostFactorsOfAllVehicles	(	long	linear_cost_factor,
		long	quadratic_cost_factor )

The following methods set the linear and quadratic cost factors of
vehicles (must be positive values). The default value of these parameters
is zero for all vehicles.

When set, the cost_ of the model will contain terms aiming at reducing the
number of vehicles used in the model, by adding the following to the
objective for every vehicle v:
INDICATOR(v used in the model) *
[linear_cost_factor_of_vehicle_[v]

quadratic_cost_factor_of_vehicle_[v]*(square of length of route v)]
i.e. for every used vehicle, we add the linear factor as fixed cost, and
subtract the square of the route length multiplied by the quadratic
factor. This second term aims at making the routes as dense as possible.

Sets the linear and quadratic cost factor of all vehicles.

Definition at line 1368 of file RoutingModel.java.

◆ setAmortizedCostFactorsOfVehicle()

void com.google.ortools.constraintsolver.RoutingModel.setAmortizedCostFactorsOfVehicle	(	long	linear_cost_factor,
		long	quadratic_cost_factor,
		int	vehicle )

Sets the linear and quadratic cost factor of the given vehicle.

Definition at line 1375 of file RoutingModel.java.

◆ setArcCostEvaluatorOfAllVehicles()

void com.google.ortools.constraintsolver.RoutingModel.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 1312 of file RoutingModel.java.

◆ setArcCostEvaluatorOfVehicle()

void com.google.ortools.constraintsolver.RoutingModel.setArcCostEvaluatorOfVehicle	(	int	evaluator_index,
		int	vehicle )

Sets the cost function for a given vehicle route.

Definition at line 1319 of file RoutingModel.java.

◆ setAssignmentFromOtherModelAssignment()

void com.google.ortools.constraintsolver.RoutingModel.setAssignmentFromOtherModelAssignment	(	Assignment	target_assignment,
		RoutingModel	source_model,
		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 1618 of file RoutingModel.java.

◆ setFirstSolutionEvaluator()

void com.google.ortools.constraintsolver.RoutingModel.setFirstSolutionEvaluator ( LongBinaryOperator evaluator )

Gets/sets the evaluator used during the search. Only relevant when
RoutingSearchParameters.first_solution_strategy = EVALUATOR_STRATEGY.
Takes ownership of evaluator.

Definition at line 1400 of file RoutingModel.java.

◆ setFixedCostOfAllVehicles()

void com.google.ortools.constraintsolver.RoutingModel.setFixedCostOfAllVehicles ( long cost )

Sets the fixed cost of all vehicle routes. It is equivalent to calling
SetFixedCostOfVehicle on all vehicle routes.

Definition at line 1327 of file RoutingModel.java.

◆ setFixedCostOfVehicle()

void com.google.ortools.constraintsolver.RoutingModel.setFixedCostOfVehicle	(	long	cost,
		int	vehicle )

Sets the fixed cost of one vehicle route.

Definition at line 1334 of file RoutingModel.java.

◆ SetMaximumNumberOfActiveVehicles()

void com.google.ortools.constraintsolver.RoutingModel.SetMaximumNumberOfActiveVehicles ( int max_active_vehicles )

Constrains the maximum number of active vehicles, aka the number of
vehicles which do not have an empty route. For instance, this can be used
to limit the number of routes in the case where there are fewer drivers
than vehicles and that the fleet of vehicle is heterogeneous.

Definition at line 1296 of file RoutingModel.java.

◆ SetPathEnergyCostOfVehicle()

void com.google.ortools.constraintsolver.RoutingModel.SetPathEnergyCostOfVehicle	(	String	force,
		String	distance,
		long	unit_cost,
		int	vehicle )

Definition at line 1347 of file RoutingModel.java.

◆ setPickupAndDeliveryPolicyOfAllVehicles()

void com.google.ortools.constraintsolver.RoutingModel.setPickupAndDeliveryPolicyOfAllVehicles ( int policy )

Sets the Pickup and delivery policy of all vehicles. It is equivalent to
calling SetPickupAndDeliveryPolicyOfVehicle on all vehicles.

Definition at line 1132 of file RoutingModel.java.

◆ setPickupAndDeliveryPolicyOfVehicle()

void com.google.ortools.constraintsolver.RoutingModel.setPickupAndDeliveryPolicyOfVehicle	(	int	policy,
		int	vehicle )

Definition at line 1136 of file RoutingModel.java.

◆ setPrimaryConstrainedDimension()

void com.google.ortools.constraintsolver.RoutingModel.setPrimaryConstrainedDimension ( String dimension_name )

Set the given dimension as "primary constrained". As of August 2013, this
is only used by ArcIsMoreConstrainedThanArc().
"dimension" must be the name of an existing dimension, or be empty, in
which case there will not be a primary dimension after this call.

Definition at line 796 of file RoutingModel.java.

◆ SetVehicleUsedWhenEmpty()

void com.google.ortools.constraintsolver.RoutingModel.SetVehicleUsedWhenEmpty	(	boolean	is_used,
		int	vehicle )

Definition at line 1387 of file RoutingModel.java.

◆ setVisitType()

void com.google.ortools.constraintsolver.RoutingModel.setVisitType	(	long	index,
		int	type,
		int	type_policy )

Definition at line 1152 of file RoutingModel.java.

◆ size()

long com.google.ortools.constraintsolver.RoutingModel.size ( )

Returns the number of next variables in the model.

Definition at line 2640 of file RoutingModel.java.

◆ solve() [1/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.solve ( )

Solves the current routing model; closes the current model.
This is equivalent to calling
SolveWithParameters(DefaultRoutingSearchParameters())
or
SolveFromAssignmentWithParameters(assignment,<br> DefaultRoutingSearchParameters()).

Definition at line 1534 of file RoutingModel.java.

◆ solve() [2/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.solve ( Assignment assignment )

Solves the current routing model; closes the current model.
This is equivalent to calling
SolveWithParameters(DefaultRoutingSearchParameters())
or
SolveFromAssignmentWithParameters(assignment,<br> DefaultRoutingSearchParameters()).

Definition at line 1521 of file RoutingModel.java.

◆ SolveFromAssignmentsWithParameters() [1/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.SolveFromAssignmentsWithParameters	(	SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t	assignments,
		com.google.ortools.constraintsolver.RoutingSearchParameters	search_parameters )

Same as above but will try all assignments in order as first solutions
until one succeeds.

Definition at line 1597 of file RoutingModel.java.

◆ SolveFromAssignmentsWithParameters() [2/2]

Assignment com.google.ortools.constraintsolver.RoutingModel.SolveFromAssignmentsWithParameters	(	SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t	assignments,
		com.google.ortools.constraintsolver.RoutingSearchParameters	search_parameters,
		SWIGTYPE_p_std__vectorT_operations_research__Assignment_const_p_t	solutions )

Same as above but will try all assignments in order as first solutions
until one succeeds.

Definition at line 1588 of file RoutingModel.java.

◆ solveFromAssignmentWithParameters()

Assignment com.google.ortools.constraintsolver.RoutingModel.solveFromAssignmentWithParameters	(	Assignment	assignment,
		com.google.ortools.constraintsolver.RoutingSearchParameters	search_parameters )

Same as above, except that if assignment is not null, it will be used as
the initial solution.

Definition at line 1557 of file RoutingModel.java.

◆ solver()

Solver com.google.ortools.constraintsolver.RoutingModel.solver ( )

Returns the underlying constraint solver. Can be used to add extra
constraints and/or modify search algorithms.

Definition at line 2564 of file RoutingModel.java.

◆ SolveWithIteratedLocalSearch()

Assignment com.google.ortools.constraintsolver.RoutingModel.SolveWithIteratedLocalSearch ( com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters )

Solves the current routing model by using an Iterated Local Search
approach.

Definition at line 1606 of file RoutingModel.java.

◆ solveWithParameters()

Assignment com.google.ortools.constraintsolver.RoutingModel.solveWithParameters ( com.google.ortools.constraintsolver.RoutingSearchParameters search_parameters )

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 1548 of file RoutingModel.java.

◆ start()

long com.google.ortools.constraintsolver.RoutingModel.start ( int vehicle )

Model inspection.
Returns the variable index of the starting node of a vehicle route.

Definition at line 2275 of file RoutingModel.java.

◆ status()

int com.google.ortools.constraintsolver.RoutingModel.status ( )

Returns the current status of the routing model.

Definition at line 1644 of file RoutingModel.java.

◆ swigRelease()

static long com.google.ortools.constraintsolver.RoutingModel.swigRelease ( RoutingModel obj )

static

Definition at line 33 of file RoutingModel.java.

◆ TimeBuffer()

SWIGTYPE_p_absl__Duration com.google.ortools.constraintsolver.RoutingModel.TimeBuffer ( )

Returns the time buffer to safely return a solution.

Definition at line 2595 of file RoutingModel.java.

◆ unperformedPenalty()

long com.google.ortools.constraintsolver.RoutingModel.unperformedPenalty ( long var_index )

Get the "unperformed" penalty of a node. This is only well defined if the
node is only part of a single Disjunction, and that disjunction has a
penalty. For forced active nodes returns max int64_t. In all other cases,
this returns 0.

Definition at line 1268 of file RoutingModel.java.

◆ unperformedPenaltyOrValue()

long com.google.ortools.constraintsolver.RoutingModel.unperformedPenaltyOrValue	(	long	default_value,
		long	var_index )

Same as above except that it returns default_value instead of 0 when
penalty is not well defined (default value is passed as first argument to
simplify the usage of the method in a callback).

Definition at line 1277 of file RoutingModel.java.

◆ UpdateTimeLimit()

void com.google.ortools.constraintsolver.RoutingModel.UpdateTimeLimit ( SWIGTYPE_p_absl__Duration time_limit )

Updates the time limit of the search limit.

Definition at line 2588 of file RoutingModel.java.

◆ VehicleIndex()

int com.google.ortools.constraintsolver.RoutingModel.VehicleIndex ( long index )

Returns the vehicle of the given start/end index, and -1 if the given
index is not a vehicle start/end.

Definition at line 2304 of file RoutingModel.java.

◆ VehicleRouteConsideredVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.VehicleRouteConsideredVar ( int vehicle )

Returns the variable specifying whether or not the given vehicle route is
considered for costs and constraints. It will be equal to 1 iff the route
of the vehicle is not empty OR vehicle_used_when_empty_[vehicle] is true.

Definition at line 2380 of file RoutingModel.java.

◆ vehicles()

int com.google.ortools.constraintsolver.RoutingModel.vehicles ( )

Returns the number of vehicle routes in the model.

Definition at line 2633 of file RoutingModel.java.

◆ vehicleVar()

IntVar com.google.ortools.constraintsolver.RoutingModel.vehicleVar ( long index )

Returns the vehicle variable of the node corresponding to index. Note that
VehicleVar(index) == -1 is equivalent to ActiveVar(index) == 0.

Definition at line 2389 of file RoutingModel.java.

◆ vehicleVars()

IntVar[] com.google.ortools.constraintsolver.RoutingModel.vehicleVars ( )

Returns all vehicle variables of the model, such that VehicleVars(i) is
the vehicle variable of the node corresponding to i.

Definition at line 2336 of file RoutingModel.java.

◆ writeAssignment()

boolean com.google.ortools.constraintsolver.RoutingModel.writeAssignment ( String file_name )

Writes the current solution to a file containing an AssignmentProto.
Returns false if the file cannot be opened or if there is no current
solution.

Definition at line 1705 of file RoutingModel.java.

Member Data Documentation

◆ ADDED_TYPE_REMOVED_FROM_VEHICLE

final int com.google.ortools.constraintsolver.RoutingModel.ADDED_TYPE_REMOVED_FROM_VEHICLE = mainJNI.RoutingModel_ADDED_TYPE_REMOVED_FROM_VEHICLE_get()

static

When visited, one instance of type 'T' previously added to the route
(TYPE_ADDED_TO_VEHICLE), if any, is removed from the vehicle.
If the type was not previously added to the route or all added instances
have already been removed, this visit has no effect on the types.

Definition at line 2806 of file RoutingModel.java.

◆ kTransitEvaluatorSignNegativeOrZero

final int com.google.ortools.constraintsolver.RoutingModel.kTransitEvaluatorSignNegativeOrZero = mainJNI.RoutingModel_kTransitEvaluatorSignNegativeOrZero_get()

static

Definition at line 2779 of file RoutingModel.java.

◆ kTransitEvaluatorSignPositiveOrZero

final int com.google.ortools.constraintsolver.RoutingModel.kTransitEvaluatorSignPositiveOrZero = mainJNI.RoutingModel_kTransitEvaluatorSignPositiveOrZero_get()

static

Definition at line 2778 of file RoutingModel.java.

◆ kTransitEvaluatorSignUnknown

final int com.google.ortools.constraintsolver.RoutingModel.kTransitEvaluatorSignUnknown = mainJNI.RoutingModel_kTransitEvaluatorSignUnknown_get()

static

TransitEvaluatorSign.

Represents the sign of values returned by a transit evaluator.

Definition at line 2777 of file RoutingModel.java.

◆ PICKUP_AND_DELIVERY_FIFO

final int com.google.ortools.constraintsolver.RoutingModel.PICKUP_AND_DELIVERY_FIFO = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_FIFO_get()

static

Deliveries must be performed in the same order as pickups.

Definition at line 2770 of file RoutingModel.java.

◆ PICKUP_AND_DELIVERY_LIFO

final int com.google.ortools.constraintsolver.RoutingModel.PICKUP_AND_DELIVERY_LIFO = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_LIFO_get()

static

Deliveries must be performed in reverse order of pickups.

Definition at line 2766 of file RoutingModel.java.

◆ PICKUP_AND_DELIVERY_NO_ORDER

final int com.google.ortools.constraintsolver.RoutingModel.PICKUP_AND_DELIVERY_NO_ORDER = mainJNI.RoutingModel_PICKUP_AND_DELIVERY_NO_ORDER_get()

static

PickupAndDeliveryPolicy.

Types of precedence policy applied to pickup and delivery pairs. Any precedence is accepted.

Definition at line 2762 of file RoutingModel.java.

◆ ROUTING_FAIL

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_FAIL = mainJNI.RoutingModel_ROUTING_FAIL_get()

static

No solution found to the problem after calling RoutingModel::Solve().

Definition at line 2736 of file RoutingModel.java.

◆ ROUTING_FAIL_TIMEOUT

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_FAIL_TIMEOUT = mainJNI.RoutingModel_ROUTING_FAIL_TIMEOUT_get()

static

Time limit reached before finding a solution with RoutingModel::Solve().

Definition at line 2740 of file RoutingModel.java.

◆ ROUTING_INFEASIBLE

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_INFEASIBLE = mainJNI.RoutingModel_ROUTING_INFEASIBLE_get()

static

Problem proven to be infeasible.

Definition at line 2748 of file RoutingModel.java.

◆ ROUTING_INVALID

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_INVALID = mainJNI.RoutingModel_ROUTING_INVALID_get()

static

Model, model parameters or flags are not valid.

Definition at line 2744 of file RoutingModel.java.

◆ ROUTING_NOT_SOLVED

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_NOT_SOLVED = mainJNI.RoutingModel_ROUTING_NOT_SOLVED_get()

static

Status.

Status of the search. Problem not solved yet (before calling RoutingModel::Solve()).

Definition at line 2722 of file RoutingModel.java.

◆ ROUTING_OPTIMAL

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_OPTIMAL = mainJNI.RoutingModel_ROUTING_OPTIMAL_get()

static

Problem has been solved to optimality.

Definition at line 2752 of file RoutingModel.java.

◆ ROUTING_PARTIAL_SUCCESS_LOCAL_OPTIMUM_NOT_REACHED

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_PARTIAL_SUCCESS_LOCAL_OPTIMUM_NOT_REACHED = mainJNI.RoutingModel_ROUTING_PARTIAL_SUCCESS_LOCAL_OPTIMUM_NOT_REACHED_get()

static

Problem solved successfully after calling RoutingModel::Solve(), except
that a local optimum has not been reached. Leaving more time would allow
improving the solution.

Definition at line 2732 of file RoutingModel.java.

◆ ROUTING_SUCCESS

final int com.google.ortools.constraintsolver.RoutingModel.ROUTING_SUCCESS = mainJNI.RoutingModel_ROUTING_SUCCESS_get()

static

Problem solved successfully after calling RoutingModel::Solve().

Definition at line 2726 of file RoutingModel.java.

◆ swigCMemOwn

transient boolean com.google.ortools.constraintsolver.RoutingModel.swigCMemOwn

protected

Definition at line 22 of file RoutingModel.java.

◆ TYPE_ADDED_TO_VEHICLE

final int com.google.ortools.constraintsolver.RoutingModel.TYPE_ADDED_TO_VEHICLE = mainJNI.RoutingModel_TYPE_ADDED_TO_VEHICLE_get()

static

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. When visited, the number of types 'T' on the vehicle increases by one.

Definition at line 2799 of file RoutingModel.java.

◆ TYPE_ON_VEHICLE_UP_TO_VISIT

final int com.google.ortools.constraintsolver.RoutingModel.TYPE_ON_VEHICLE_UP_TO_VISIT = mainJNI.RoutingModel_TYPE_ON_VEHICLE_UP_TO_VISIT_get()

static

With the following policy, the visit enforces that type 'T' is
considered on the route from its start until this node is visited.

Definition at line 2811 of file RoutingModel.java.

◆ TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED

final int com.google.ortools.constraintsolver.RoutingModel.TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED = mainJNI.RoutingModel_TYPE_SIMULTANEOUSLY_ADDED_AND_REMOVED_get()

static

The visit doesn't have an impact on the number of types 'T' on the
route, as it's (virtually) added and removed directly.
This policy can be used for visits which are part of an incompatibility
or requirement set without affecting the type count on the route.

Definition at line 2818 of file RoutingModel.java.

The documentation for this class was generated from the following file:

build/java/ortools-java/src/main/java/com/google/ortools/constraintsolver/RoutingModel.java

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RoutingModel() [1/3]

◆ RoutingModel() [2/3]

◆ RoutingModel() [3/3]

Member Function Documentation

◆ activeVar()

◆ activeVehicleVar()

◆ addAtSolutionCallback() [1/2]

◆ addAtSolutionCallback() [2/2]

◆ addConstantDimension()

◆ addConstantDimensionWithSlack()

◆ addDimension()

◆ addDimensionWithVehicleCapacity()

◆ addDimensionWithVehicleTransitAndCapacity()

◆ addDimensionWithVehicleTransits()

◆ addDisjunction() [1/3]

◆ addDisjunction() [2/3]

◆ addDisjunction() [3/3]

◆ addHardTypeIncompatibility()

◆ addIntervalToAssignment()

◆ addLocalSearchFilter()

◆ addLocalSearchOperator()

◆ addMatrixDimension()

◆ addPickupAndDelivery()

◆ addPickupAndDeliverySets()

◆ addRequiredTypeAlternativesWhenAddingType()

◆ addRequiredTypeAlternativesWhenRemovingType()

◆ AddResourceGroup()

◆ addSearchMonitor()

◆ addSoftSameVehicleConstraint()

◆ addTemporalTypeIncompatibility()

◆ addToAssignment()

◆ addVariableMaximizedByFinalizer()

◆ addVariableMinimizedByFinalizer()

◆ addVariableTargetToFinalizer()

◆ addVectorDimension()

◆ AddWeightedVariableMaximizedByFinalizer()

◆ AddWeightedVariableMinimizedByFinalizer()

◆ AddWeightedVariableTargetToFinalizer()

◆ applyLocks()

◆ applyLocksToAllVehicles()

◆ arcIsMoreConstrainedThanArc()

◆ AreRoutesInterdependent()

◆ assignmentToRoutes()

◆ CancelSearch()

◆ CheckIfAssignmentIsFeasible()

◆ checkLimit() [1/2]

◆ checkLimit() [2/2]

◆ closeModel()

◆ closeModelWithParameters()

◆ closeVisitTypes()

◆ compactAndCheckAssignment()

◆ compactAssignment()

◆ computeLowerBound()

◆ costsAreHomogeneousAcrossVehicles()

◆ costVar()

◆ debugOutputAssignment()

◆ delete()

◆ enable_deep_serialization()

◆ end()

◆ FastSolveFromAssignmentWithParameters() [1/2]

◆ FastSolveFromAssignmentWithParameters() [2/2]

◆ finalize()

◆ getAmortizedLinearCostFactorOfVehicles()

◆ getAmortizedQuadraticCostFactorOfVehicles()

◆ getArcCostForClass()

◆ getArcCostForFirstSolution()

◆ getArcCostForVehicle()

◆ getCostClassesCount()

◆ getCostClassIndexOfVehicle()

◆ getCPtr()

◆ GetDeliveryPositions()

◆ getDepot()