Skip to main content

MinimumCostCirculation

Struct MinimumCostCirculation 

Source
pub struct MinimumCostCirculation { /* private fields */ }
Expand description

Minimum-Cost Circulation problem.

§Variables

|A| variables: variable a ranges over {0, ..., c(a)} representing the integral circulation on arc a.

§Example

use problemreductions::models::graph::MinimumCostCirculation;
use problemreductions::topology::DirectedGraph;
use problemreductions::{Problem, Solver, BruteForce};

// Two competing cycles 0->1->0 and 0->2->0; the cheaper-per-unit
// cycle 0->2->0 has lower capacity, but pushing both to capacity is
// optimal.
let graph = DirectedGraph::new(3, vec![
    (0, 1), (1, 0), (0, 2), (2, 0),
]);
let problem = MinimumCostCirculation::new(
    graph,
    vec![2, 2, 1, 1],   // capacities
    vec![2, -3, 1, -4], // costs (signed)
);
let solver = BruteForce::new();
let witness = solver.find_witness(&problem).unwrap();
// Optimal cost = 2*2 + 2*(-3) + 1*1 + 1*(-4) = -5.
assert_eq!(problem.total_cost(&witness), -5);

Implementations§

Source§

impl MinimumCostCirculation

Source

pub fn new(graph: DirectedGraph, capacities: Vec<i64>, costs: Vec<i64>) -> Self

Create a new Minimum-Cost Circulation problem.

§Panics

Panics if any of the following holds:

  • capacities.len() != graph.num_arcs()
  • costs.len() != graph.num_arcs()
  • Any capacity is negative

Note: costs are signed and may be negative.

Source

pub fn graph(&self) -> &DirectedGraph

Get a reference to the underlying directed graph.

Source

pub fn capacities(&self) -> &[i64]

Get a reference to the arc capacities.

Source

pub fn costs(&self) -> &[i64]

Get a reference to the arc costs (signed).

Source

pub fn num_vertices(&self) -> usize

Get the number of vertices |V|.

Source

pub fn num_arcs(&self) -> usize

Get the number of arcs |A|.

Source

pub fn is_feasible(&self, config: &[usize]) -> bool

Check whether a circulation assignment is feasible.

A circulation is feasible iff

  1. config.len() == num_arcs,
  2. each 0 <= g(a) <= c(a), and
  3. inflow equals outflow at every vertex (no exempt terminals — this is what distinguishes a circulation from a flow).
Source

pub fn total_cost(&self, config: &[usize]) -> i64

Compute the total cost sum_a a(a) * g(a) of a circulation.

Trait Implementations§

Source§

impl Clone for MinimumCostCirculation

Source§

fn clone(&self) -> MinimumCostCirculation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MinimumCostCirculation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MinimumCostCirculation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Problem for MinimumCostCirculation

Source§

const NAME: &'static str = "MinimumCostCirculation"

Base name of this problem type (e.g., “MaximumIndependentSet”).
Source§

type Value = Min<i64>

The evaluation value type.
Source§

fn dims(&self) -> Vec<usize>

Configuration space dimensions. Each entry is the cardinality of that variable.
Source§

fn evaluate(&self, config: &[usize]) -> Min<i64>

Evaluate the problem on a configuration.
Source§

fn variant() -> Vec<(&'static str, &'static str)>

Returns variant attributes derived from type parameters. Read more
Source§

fn num_variables(&self) -> usize

Number of variables (derived from dims).
Source§

fn problem_type() -> ProblemType

Look up this problem’s catalog entry. Read more
Source§

impl ReduceTo<MinimumCostCirculation> for MinimumCostMaximumFlow

Source§

type Result = ReductionMCMFToMCC

The reduction result type.
Source§

fn reduce_to(&self) -> Self::Result

Reduce this problem to the target problem type.
Source§

impl Serialize for MinimumCostCirculation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl DeclaredVariant for MinimumCostCirculation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynProblem for T
where T: Problem + Serialize + 'static, <T as Problem>::Value: Display + Serialize,

Source§

fn evaluate_dyn(&self, config: &[usize]) -> String

Evaluate a configuration and return the CLI-facing metric string.
Source§

fn evaluate_json(&self, config: &[usize]) -> Value

Evaluate a configuration and return the result as a serializable JSON value.
Source§

fn serialize_json(&self) -> Value

Serialize the problem to a JSON value.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to &dyn Any for type recovery.
Source§

fn dims_dyn(&self) -> Vec<usize>

Return the configuration space dimensions.
Source§

fn problem_name(&self) -> &'static str

Return the problem name (Problem::NAME).
Source§

fn variant_map(&self) -> BTreeMap<String, String>

Return the variant key-value map.
Source§

fn num_variables_dyn(&self) -> usize

Return the number of variables.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,