Struct Tour

pub struct Tour { /* private fields */ }

Represents a tour, a smart container for jobs with their associated activities.

Implementations

impl Tour

pub fn new(actor: &Actor) -> Self

Creates a new tour with start and optional end using actor properties.

pub fn set_start(&mut self, activity: Activity) -> &mut Tour

Sets tour start.

pub fn set_end(&mut self, activity: Activity) -> &mut Tour

Sets tour end.

pub fn insert_last(&mut self, activity: Activity) -> &mut Tour

Inserts activity within its job to the end of tour.

pub fn insert_at(&mut self, activity: Activity, index: usize) -> &mut Tour

Inserts activity within its job at specified index.

pub fn remove(&mut self, job: &Job) -> bool

Removes job within its activities from the tour.

pub fn remove_activity_at(&mut self, idx: usize) -> Job

Removes activity and its job from the tour.

pub fn all_activities(&self) -> Iter<'_, Activity>

Returns all activities in tour.

pub fn activities_slice(&self, start: usize, end: usize) -> &[Activity]

Returns activities slice in specific range (all inclusive).

pub fn all_activities_mut(&mut self) -> IterMut<'_, Activity>

Returns all activities in tour as mutable.

pub fn job_activities<'a>( &'a self, job: &'a Job, ) -> impl Iterator<Item = &Activity> + 'a

Returns all activities in tour for specific job.

pub fn legs(&self) -> impl Iterator<Item = Leg<'_>> + '_ + Clone

Returns counted tour legs.

pub fn jobs(&self) -> impl Iterator<Item = &Job> + '_

Returns all jobs.

Examples found in repository

examples/custom_objective.rs (line 79)

fn calculate_solution_fitness(solution_ctx: &SolutionContext) -> Cost {
    solution_ctx.routes.iter().flat_map(|route_ctx| route_ctx.route().tour.jobs()).map(estimate_job_cost).sum::<Cost>()
}

pub fn get(&self, index: usize) -> Option<&Activity>

Returns activity by its index in tour.

pub fn get_mut(&mut self, index: usize) -> Option<&mut Activity>

Returns mutable activity by its index in tour.

pub fn start(&self) -> Option<&Activity>

Returns start activity in tour.

pub fn end(&self) -> Option<&Activity>

Returns end activity in tour.

pub fn end_idx(&self) -> Option<usize>

Returns end activity in tour.

pub fn contains(&self, job: &Job) -> bool

Checks whether job is present in tour

pub fn index(&self, job: &Job) -> Option<usize>

Returns index of first job occurrence in the tour.

pub fn index_last(&self, job: &Job) -> Option<usize>

Returns index of last job occurrence in the tour.

pub fn has_job(&self, job: &Job) -> bool

Checks whether job is present in tour.

pub fn has_jobs(&self) -> bool

Checks whether tour has jobs.

pub fn job_activity_count(&self) -> usize

Returns total amount of job activities.

pub fn total(&self) -> usize

Returns amount of all activities in tour.

pub fn job_count(&self) -> usize

Returns amount of jobs.

pub fn deep_copy(&self) -> Tour

Creates a copy of existing tour deeply copying all activities and jobs.

Trait Implementations

impl Debug for Tour

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

Formats the value using the given formatter.

impl Default for Tour

fn default() -> Tour

Returns the “default value” for a type.

impl Index<usize> for Tour

type Output = Activity

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.