1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*!
<!-- "short sentence explaining what it is"] -->
This crate solves the problem of "fitting smaller boxes inside of a larger box" using a three
dimensional fitting algorithm.
<!-- [more detailed explanation] -->
The algorithm orthogonally packs the all the items into a minimum number of bins by leveraging a [First Fit
Decreasing](https://en.wikipedia.org/wiki/Bin_packing_problem#First_Fit_Decreasing_(FFD)) greedy
strategy, along with rotational optimizations.
<!-- [at least one code example that users can copy/paste to try it] -->
# Usage:
```rust
use bin_packer_3d::bin::Bin;
use bin_packer_3d::item::Item;
use bin_packer_3d::packing_algorithm::packing_algorithm;
let deck = Item::new("deck", [2, 8, 12]);
let die = Item::new("die", [8, 8, 8]);
let items = vec![deck, deck, die, deck, deck];
let packed_items = packing_algorithm(Bin::new([8, 8, 12]), &items);
assert_eq!(packed_items, Ok(vec![vec!["deck", "deck", "deck", "deck"], vec!["die"]]));
```
<!-- # /// [more detailed explanation] -->
# Limitations:
This algorithm solves a constrained version of the 3D bin packing problem. As such, we have the
following limitations:
* The items we are packing, and the bins that we are packing them into, are limited to cuboid
shapes.
* The items we are packing can be rotated in any direction, with the limitation that each edge must
be parallel to the corresponding bin edge.
* As an NP-Hard problem, this algorithm does not attempt to find the optimal solution, but instead
uses an approximation that runs with a time complexity of *O(n^2)*
# Acknowledgements:
The algorithm leverages a rotational optimization when packing items which are less than half the
length of a bin's side, as proposed in the paper titled "The Three-Dimensional Bin Packing Problem"
(Martello, 1997), page 257:
[https://www.jstor.org/stable/pdf/223143.pdf](https://www.jstor.org/stable/pdf/223143.pdf)
*/
/// Defines the function that will be used for our packing algorithm.
/// A struct representing the dimensions of the bin, which will be used for packing.
/// A struct representing the items we'll be packing into the bin.
/// Defines an Error type and a Result type, which can be raised from the packing algorithm.