Skip to main content

ClikaRT::graph::WalkOptions

struct

Header: ClikaRT/graph/query.h

The bounds and filters of a walk. A walk is breadth-first from its start: each node is reached once, at its fewest edges from the start.

Data members​

direction​

WalkDirection direction = WalkDirection::Forward

Which way the walk crosses edges.

Declared in ClikaRT/graph/query.h, line 80

max_depth​

std::optional<std::size_t> max_depth

The most edges between the start and a node the walk reaches: 0 reaches the start alone. Empty: no limit.

Declared in ClikaRT/graph/query.h, line 83

max_nodes​

std::optional<std::size_t> max_nodes

The most nodes the walk may reach, the start included. A walk that would reach one more fails with Status::InvalidArgument naming this budget; it never returns a cut answer. Empty: no budget.

Declared in ClikaRT/graph/query.h, line 87

stop_at​

NodePredicate stop_at

A node this accepts is reached but not gone past (the start included), so a walk can end a region at each node of a kind. Empty: none.

Declared in ClikaRT/graph/query.h, line 90

edge_filter​

EdgePredicate edge_filter

The walk crosses only the edges this accepts. Empty: every edge.

Declared in ClikaRT/graph/query.h, line 92

skip_shape_lane​

bool skip_shape_lane = false

Cross no edge that carries shape or index arithmetic (the shape computations a graph optimization marks), so the nodes only such edges reach are left out. A graph that was not optimized carries no marks.

Declared in ClikaRT/graph/query.h, line 96