operations_research::PathOperator< ignore_path_vars >::IterationParameters Struct Reference

Set of parameters used to configure how the neighnorhood is traversed. More...

#include <constraint_solveri.h>

Public Attributes
int	number_of_base_nodes
	Number of nodes needed to define a neighbor.
bool	skip_locally_optimal_paths
bool	accept_path_end_base
	True if path ends should be considered when iterating over neighbors.
std::function< int(int64_t)>	start_empty_path_class
std::function< const std::vector< int > &(int, int)>	get_incoming_neighbors
std::function< const std::vector< int > &(int, int)>	get_outgoing_neighbors

Detailed Description

template<bool ignore_path_vars>
struct operations_research::PathOperator< ignore_path_vars >::IterationParameters

Set of parameters used to configure how the neighnorhood is traversed.

Definition at line 1533 of file constraint_solveri.h.

Member Data Documentation

accept_path_end_base

template<bool ignore_path_vars>

bool operations_research::PathOperator< ignore_path_vars >::IterationParameters::accept_path_end_base

True if path ends should be considered when iterating over neighbors.

Definition at line 1540 of file constraint_solveri.h.

get_incoming_neighbors

template<bool ignore_path_vars>

std::function<const std::vector<int>&( int, int)> operations_research::PathOperator< ignore_path_vars >::IterationParameters::get_incoming_neighbors

Callbacks returning incoming/outgoing neighbors of a node on a path starting at start_node.

Definition at line 1556 of file constraint_solveri.h.

get_outgoing_neighbors

template<bool ignore_path_vars>

std::function<const std::vector<int>&( int, int)> operations_research::PathOperator< ignore_path_vars >::IterationParameters::get_outgoing_neighbors

Definition at line 1559 of file constraint_solveri.h.

number_of_base_nodes

template<bool ignore_path_vars>

int operations_research::PathOperator< ignore_path_vars >::IterationParameters::number_of_base_nodes

Number of nodes needed to define a neighbor.

Definition at line 1535 of file constraint_solveri.h.

skip_locally_optimal_paths

template<bool ignore_path_vars>

bool operations_research::PathOperator< ignore_path_vars >::IterationParameters::skip_locally_optimal_paths

Skip paths which have been proven locally optimal. Note this might skip neighbors when paths are not independent.

Definition at line 1538 of file constraint_solveri.h.

start_empty_path_class

template<bool ignore_path_vars>

std::function<int(int64_t)> operations_research::PathOperator< ignore_path_vars >::IterationParameters::start_empty_path_class

Callback returning an index such that if c1 = start_empty_path_class(StartNode(p1)), c2 = start_empty_path_class(StartNode(p2)), p1 and p2 are path indices, then if c1 == c2, p1 and p2 are equivalent if they are empty. This is used to remove neighborhood symmetries on equivalent empty paths; for instance if a node cannot be moved to an empty path, then all moves moving the same node to equivalent empty paths will be skipped. 'start_empty_path_class' can be nullptr in which case no symmetries will be removed.

Definition at line 1551 of file constraint_solveri.h.

---

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

• ortools/constraint_solver/constraint_solveri.h