Struct Metrics 

#[non_exhaustive]
pub struct Metrics {
    pub aggregated_route_metrics: Option<AggregatedMetrics>,
    pub skipped_mandatory_shipment_count: i32,
    pub used_vehicle_count: i32,
    pub earliest_vehicle_start_time: Option<Timestamp>,
    pub latest_vehicle_end_time: Option<Timestamp>,
    pub costs: HashMap<String, f64>,
    pub total_cost: f64,
    /* private fields */
}

Overall metrics, aggregated over all routes.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aggregated_route_metrics: Option<AggregatedMetrics>

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

skipped_mandatory_shipment_count: i32

Number of mandatory shipments skipped.

used_vehicle_count: i32

Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.

earliest_vehicle_start_time: Option<Timestamp>

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

latest_vehicle_end_time: Option<Timestamp>

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

costs: HashMap<String, f64>

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. “model.shipments.pickups.cost”, and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs[“model.shipments.pickups.cost”] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

total_cost: f64

Total cost of the solution. The sum of all values in the costs map.

Implementations

impl Metrics

pub fn new() -> Self

pub fn set_aggregated_route_metrics<T>(self, v: T) -> Self

where T: Into<AggregatedMetrics>,

Sets the value of aggregated_route_metrics.

pub fn set_or_clear_aggregated_route_metrics<T>(self, v: Option<T>) -> Self

where T: Into<AggregatedMetrics>,

Sets or clears the value of aggregated_route_metrics.

pub fn set_skipped_mandatory_shipment_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of skipped_mandatory_shipment_count.

pub fn set_used_vehicle_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of used_vehicle_count.

pub fn set_earliest_vehicle_start_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of earliest_vehicle_start_time.

pub fn set_or_clear_earliest_vehicle_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of earliest_vehicle_start_time.

pub fn set_latest_vehicle_end_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of latest_vehicle_end_time.

pub fn set_or_clear_latest_vehicle_end_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of latest_vehicle_end_time.

pub fn set_costs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<f64>,

Sets the value of costs.

pub fn set_total_cost<T: Into<f64>>(self, v: T) -> Self

Sets the value of total_cost.

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Metrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metrics

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

Formats the value using the given formatter.

impl Default for Metrics

fn default() -> Metrics

Returns the “default value” for a type.

impl Message for Metrics

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Metrics

fn eq(&self, other: &Metrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Metrics