Struct BfsBuilder 

pub struct BfsBuilder<Expander, Callback, Provider, const EXPANSION_NODES: usize> { /* private fields */ }

Used to define all the parameters of a BFS and run it.

Implementations

impl<Expander, Callback, Provider, const EXPANSION_NODES: usize> BfsBuilder<Expander, Callback, Provider, EXPANSION_NODES>

where Expander: BfsExpander<EXPANSION_NODES> + Clone + Sync, Callback: BfsCallback + Clone + Sync, Provider: BfsSettingsProvider + Sync,

pub fn new() -> Self

Creates a default builder with no parameters set.

pub fn threads(self, threads: usize) -> Self

The number of threads to use in the search.

pub fn chunk_size_bytes(self, chunk_size_bytes: usize) -> Self

The size of each bit array chunk in bytes. Must be at most 2^29.

pub fn update_memory(self, update_memory: usize) -> Self

The amount of memory to use for storing updates (adjacent nodes) in bytes.

pub fn num_update_blocks(self, num_update_blocks: usize) -> Self

The number of blocks in which to divide the update memory.

pub fn capacity_check_frequency(self, capacity_check_frequency: usize) -> Self

The frequency (one check per capacity_check_frequency new nodes) at which to check the capacity of an update block. When capacity is reached, the block will be stored and a new block taken.

pub fn initial_states(self, initial_states: &[u64]) -> Self

The nodes at depth 0, from which the search starts.

pub fn state_size(self, state_size: u64) -> Self

The number of nodes in the graph.

pub fn root_directories(self, root_directories: &[PathBuf]) -> Self

The working directories that will contain all of the intermediate data. Each directory should be on a different hard drive.

pub fn initial_memory_limit(self, initial_memory_limit: usize) -> Self

Approximate amount of memory in bytes to use for the initial in-memory breadth-first search, before switching to the disk-based search.

pub fn available_disk_space_limit(self, available_disk_space_limit: u64) -> Self

The minimum amount of available disk space (in bytes) that should be kept free on each drive.

pub fn update_array_threshold(self, update_array_threshold: u64) -> Self

The threshold at which to switch from writing an update file containing a list of node indices, to writing a bit array of updates.

pub fn use_locked_io(self, use_locked_io: bool) -> Self

Whether disk I/O should be locked using a mutex to prevent multiple threads from performing I/O on the same disk at the same time.

pub fn sync_filesystem(self, sync_filesystem: bool) -> Self

Whether to call sync on the filesystem before deleting files. If this is set to false and a system failure occurs, it’s possible that data could be lost and the search would need to be restarted from the beginning.

pub fn compute_checksums(self, compute_checksums: bool) -> Self

Whether to compute and verify checksums for all data written to disk.

pub fn use_compression(self, use_compression: bool) -> Self

Whether update files and bit arrays should be compressed.

pub fn expander(self, expander: Expander) -> Self

The implementor of the BfsExpander trait that defines the graph to traverse.

pub fn callback(self, callback: Callback) -> Self

The implementor of the BfsCallback trait that defines callbacks to run during the search.

pub fn settings_provider(self, settings_provider: Provider) -> Self

The implementor of the BfsSettingsProvider trait that provides various additional settings for the search.

pub fn run_no_defaults(self) -> Result<(), BfsBuilderError>

Runs the BFS with the given settings, requiring all fields of the BfsBuilder to be set explicitly, without using any default values.

pub fn run(self) -> Result<(), BfsBuilderError>

Runs the BFS with the given settings, using default values for any parameters that were not set, if possible.

Default values are:

• threads: 1
• update_memory: 1 GiB
• capacity_check_frequency: 256
• initial_memory_limit: 64 MiB
• use_locked_io: false
• sync_filesystem: true
• compute_checksums: true
• use_compression: true
• update_array_threshold: chunk_size_bytes
• num_update_blocks: 2 * threads * num_chunks, where num_chunks = state_size / (8 * chunk_size_bytes)

Trait Implementations

impl<Expander: Debug, Callback: Debug, Provider: Debug, const EXPANSION_NODES: usize> Debug for BfsBuilder<Expander, Callback, Provider, EXPANSION_NODES>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Expander, Callback, Provider, const EXPANSION_NODES: usize> Default for BfsBuilder<Expander, Callback, Provider, EXPANSION_NODES>

where Expander: BfsExpander<EXPANSION_NODES> + Clone + Sync, Callback: BfsCallback + Clone + Sync, Provider: BfsSettingsProvider + Sync,

fn default() -> Self

Returns the “default value” for a type.