ExBoxPacker.Result.PackedBox (ExBoxPacker v0.2.0)

A box together with the items packed into it, plus computed weight, space and utilisation accessors. Port of BoxPacker's PackedBox.

Summary

t()

new(box, items)

Verify the packing is physically valid: every item is within the box bounds and no two items overlap. Returns :ok or {:error, reason}.

weight(pb)

@type t() :: %ExBoxPacker.Result.PackedBox{
  box: ExBoxPacker.Box.t(),
  items: ExBoxPacker.Result.PackedItemList.t()
}

@spec inner_volume(t()) :: integer()

@spec item_weight(t()) :: integer()

@spec new(ExBoxPacker.Box.t(), ExBoxPacker.Result.PackedItemList.t()) :: t()

@spec remaining_depth(t()) :: integer()

@spec remaining_length(t()) :: integer()

@spec remaining_weight(t()) :: integer()

@spec remaining_width(t()) :: integer()

@spec unused_volume(t()) :: integer()

@spec used_depth(t()) :: integer()

@spec used_length(t()) :: integer()

@spec used_volume(t()) :: integer()

@spec used_width(t()) :: integer()

@spec validate(t()) :: :ok | {:error, term()}

Verify the packing is physically valid: every item is within the box bounds and no two items overlap. Returns :ok or {:error, reason}.

@spec volume_utilisation(t()) :: float()

@spec weight(t()) :: integer()