Struct SPProblem

pub struct SPProblem {
    pub instance: SPInstance,
    pub layout: Layout,
    /* private fields */
}

Strip Packing Problem

Fields

instance: SPInstance

layout: Layout

Implementations

impl SPProblem

pub fn new( instance: SPInstance, strip_width: fsize, cde_config: CDEConfig, ) -> Self

pub fn modify_strip_in_back(&mut self, new_width: fsize)

Adds or removes width in the back of the strip.

pub fn modify_strip_at_front(&mut self, new_width: fsize)

Adds or removes width at the front of the strip.

pub fn modify_strip_centered(&mut self, new_width: fsize)

Adds or removes width, dividing it equally at the front and back of the current items.

pub fn modify_strip(&mut self, rect: AARectangle)

Modifies the shape of the strip to a new rectangle. All items that fit in the new strip are kept, the rest are removed.

pub fn fit_strip(&mut self)

Shrinks the strip to the minimum width that fits all items.

pub fn occupied_range(&self) -> Option<(fsize, fsize)>

Returns the horizontal range occupied by the placed items. If no items are placed, returns None.

pub fn occupied_width(&self) -> fsize

Returns the width occupied by the placed items.

pub fn strip_width(&self) -> fsize

pub fn strip_height(&self) -> fsize

Trait Implementations

impl Clone for SPProblem

fn clone(&self) -> SPProblem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<SPProblem> for Problem

fn from(sp: SPProblem) -> Self

Converts to this type from the input type.

impl ProblemGeneric for SPProblem

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 template_layout_indices_with_stock( &self, ) -> impl Iterator<Item = LayoutIndex>

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

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 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.