Struct vrp_core::models::GoalContextBuilder

pub struct GoalContextBuilder { /* private fields */ }

Provides a customizable way to build goal context.

Implementations

impl GoalContextBuilder

pub fn with_features(features: &[Feature]) -> GenericResult<Self>

Creates a GoalContextBuilder with the given list of features.

Examples found in repository

examples/pdptw.rs (line 86)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    // configure features needed to model PDPTW
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        // enable time constraint (not necessary, default behavior, here for demonstration purpose only)
        .set_time_constrained(true)
        .build_minimize_distance()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature])?.build()
}

examples/custom_constraint.rs (line 116)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        .set_time_constrained(false)
        .build_minimize_distance()?;
    // create our custom feature
    let hardware_feature = FeatureBuilder::default()
        .with_name("hardware")
        .with_constraint(HardwareConstraint { code: ViolationCode::default() })
        .build()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature, hardware_feature])?
        .build()
}

examples/cvrp.rs (line 75)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    // configure features needed to model CVRP
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        // explicitly opt-out from time constraint on vehicles/jobs
        .set_time_constrained(false)
        .build_minimize_distance()?;

    // configure goal of optimization: features with objectives are read from ordered feature list. Here we have:
    //   1. minimum of unassigned jobs as the main objective
    //   2. minimum distance traveled
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature])?.build()
}

examples/custom_objective.rs (line 133)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        .set_time_constrained(false)
        .build_minimize_distance()?;

    // create our custom feature that consists of an objective and a state
    let priority_feature = FeatureBuilder::default()
        .with_name("maximize-priority")
        .with_objective(PriorityObjective)
        .with_state(PriorityState)
        .build()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[priority_feature, minimize_unassigned, transport_feature, capacity_feature])?
        .build()
}

pub fn set_main_goal(self, goal: Goal) -> Self

Sets a main goal of optimization.

pub fn add_alternative_goal(self, goal: Goal, weight: f64) -> Self

Sets an alternative goal of optimization.

pub fn build(self) -> GenericResult<GoalContext>

Builds goal context.

Examples found in repository

examples/pdptw.rs (line 86)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    // configure features needed to model PDPTW
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        // enable time constraint (not necessary, default behavior, here for demonstration purpose only)
        .set_time_constrained(true)
        .build_minimize_distance()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature])?.build()
}

examples/custom_constraint.rs (line 117)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        .set_time_constrained(false)
        .build_minimize_distance()?;
    // create our custom feature
    let hardware_feature = FeatureBuilder::default()
        .with_name("hardware")
        .with_constraint(HardwareConstraint { code: ViolationCode::default() })
        .build()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature, hardware_feature])?
        .build()
}

examples/cvrp.rs (line 75)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    // configure features needed to model CVRP
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        // explicitly opt-out from time constraint on vehicles/jobs
        .set_time_constrained(false)
        .build_minimize_distance()?;

    // configure goal of optimization: features with objectives are read from ordered feature list. Here we have:
    //   1. minimum of unassigned jobs as the main objective
    //   2. minimum distance traveled
    GoalContextBuilder::with_features(&[minimize_unassigned, transport_feature, capacity_feature])?.build()
}

examples/custom_objective.rs (line 134)

fn define_goal(transport: Arc<dyn TransportCost + Send + Sync>) -> GenericResult<GoalContext> {
    let minimize_unassigned = MinimizeUnassignedBuilder::new("min-unassigned").build()?;
    let capacity_feature = CapacityFeatureBuilder::<SingleDimLoad>::new("capacity").build()?;
    let transport_feature = TransportFeatureBuilder::new("min-distance")
        .set_transport_cost(transport)
        .set_time_constrained(false)
        .build_minimize_distance()?;

    // create our custom feature that consists of an objective and a state
    let priority_feature = FeatureBuilder::default()
        .with_name("maximize-priority")
        .with_objective(PriorityObjective)
        .with_state(PriorityState)
        .build()?;

    // configure goal of optimization
    GoalContextBuilder::with_features(&[priority_feature, minimize_unassigned, transport_feature, capacity_feature])?
        .build()
}