Struct MotionPlanner 

pub struct MotionPlanner<'a, T = usize>
where
    T: Eq + Hash,
{ /* private fields */ }

The MotionPlanner is a pathfinding algorithm implementation for finding the chain of transformations between two triads along the surface of the hyper-tonnetz.

Implementations

impl<'a, T> MotionPlanner<'a, T>

where T: Eq + Hash,

pub fn new(tonnetz: &'a HyperTonnetz<[T; 3], Triads, T>) -> MotionPlanner<'a, T>

Create a new motion planner for the given tonnetz

pub const fn cache(&self) -> &PathCache<T>

returns an immutable reference to the cache

pub const fn cache_mut(&mut self) -> &mut PathCache<T>

returns a mutable reference to the cache

pub const fn config(&self) -> &MotionPlannerConfig

returns an immutable reference to the configuration of the planner

pub const fn config_mut(&mut self) -> &mut MotionPlannerConfig

returns a mutable reference to the configuration of the planner

pub const fn max_depth(&self) -> usize

returns the maximum depth for pathfinding

pub const fn max_paths(&self) -> usize

returns the maximum number of paths to find

pub const fn tonnetz(&self) -> &HyperTonnetz<[T; 3], Triads, T>

returns an immutable reference to the tonnetz

pub fn set_config( &mut self, config: MotionPlannerConfig, ) -> &mut MotionPlanner<'a, T>

updates the current configuration and returns a mutable reference to the instance.

pub fn set_max_depth(&mut self, depth: usize) -> &mut MotionPlanner<'a, T>

set the maximum depth for pathfinding

pub fn set_max_paths(&mut self, paths: usize) -> &mut MotionPlanner<'a, T>

set the maximum number of paths to find

pub fn with_max_depth(self, depth: usize) -> MotionPlanner<'a, T>

consumes the current instance to create another with the given maximum depth

pub fn with_max_paths(self, paths: usize) -> MotionPlanner<'a, T>

consumes the current instance to create another with the given maximum number of paths

impl<'a, T> MotionPlanner<'a, T>

where T: Hash + Ord + FromPrimitive + ToPrimitive + One + Zero<Output = T> + PitchMod<Output = T> + Add + Copy + Sub<Output = T> + Eq + AddAssign,

pub fn find_paths_to_pitch( &mut self, start_edge: IndexBase<usize, EdgeIndex>, target_pitch: T, ) -> Vec<Path<T>>

find a set of paths from one triad to one that contains the target pitch

pub fn find_paths_between_edges( &mut self, start_edge: IndexBase<usize, EdgeIndex>, goal_edge: IndexBase<usize, EdgeIndex>, ) -> Vec<Path<T>>

Search for paths between two specific edges in the tonnetz

pub fn search_from( &self, start_triad: TriadBase<[T; 3], Triads, T>, target_pitch: T, transforms: Vec<LPR>, triads: Vec<TriadBase<[T; 3], Triads, T>>, edge_ids: Vec<Option<IndexBase<usize, EdgeIndex>>>, max_paths: usize, remaining_depth: usize, ) -> Vec<Path<T>>

Find paths from a specified edge by continuing search from a given state Used for parallel search implementations