Struct BPProblem

pub struct BPProblem {
    pub instance: BPInstance,
    pub layouts: Vec<Layout>,
    /* private fields */
}

Bin Packing Problem

Fields

instance: BPInstance

layouts: Vec<Layout>

Implementations

impl BPProblem

pub fn new(instance: BPInstance) -> Self

pub fn remove_layout(&mut self, layout_index: LayoutIndex)

pub fn register_layout(&mut self, layout: Layout) -> LayoutIndex

pub fn deregister_layout(&mut self, layout_index: LayoutIndex)

Trait Implementations

impl Clone for BPProblem

fn clone(&self) -> BPProblem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<BPProblem> for Problem

fn from(bp: BPProblem) -> Self

Converts to this type from the input type.

impl ProblemGeneric for BPProblem

fn place_item(&mut self, p_opt: PlacingOption) -> (LayoutIndex, PItemKey)

Places an item into the problem instance according to the given PlacingOption. Returns the index of the layout where the item was placed.

fn remove_item( &mut self, layout_index: LayoutIndex, pik: PItemKey, commit_instantly: bool, ) -> PlacingOption

Removes a placed item (with its unique key) from a specific Layout. Returns a PlacingOption that can be used to place the item back in the same configuration. For more information about commit_instantly, see crate::collision_detection::cd_engine::CDEngine::deregister_hazard.

fn create_solution(&mut self, old_solution: Option<&Solution>) -> Solution

Saves the current state of the problem as a Solution.

fn restore_to_solution(&mut self, solution: &Solution)

Restores the state of the problem to a previous Solution.

fn layouts(&self) -> &[Layout]

fn layouts_mut(&mut self) -> &mut [Layout]

fn template_layouts(&self) -> &[Layout]

Template layouts are empty and immutable. For every unique bin in the problem instance, there is a template layout. When an item is placed in a template layout, it is cloned into a real layout.

fn missing_item_qtys(&self) -> &[isize]

The quantity of each item that is requested but currently missing in the problem instance, indexed by item id.

fn bin_qtys(&self) -> &[usize]

fn instance(&self) -> &dyn InstanceGeneric

fn placed_item_qtys(&self) -> impl Iterator<Item = usize>

The quantity of each item that is currently placed in the problem instance, indexed by item id.

fn usage(&mut self) -> fsize

fn used_bin_cost(&self) -> u64

fn layout_indices(&self) -> impl Iterator<Item = LayoutIndex>

Returns the LayoutIndex of all layouts.

fn template_layout_indices_with_stock( &self, ) -> impl Iterator<Item = LayoutIndex>

Returns the LayoutIndex of all template layouts that have remaining stock.

fn get_layout(&self, index: impl Borrow<LayoutIndex>) -> &Layout

fn flush_changes(&mut self)

Makes sure that the all collision detection engines are completely updated with the changes made to the layouts.