Encapsulate mutable collections in Bin and Result

Replace public mutable collection fields/properties with private
backing fields and expose them as IReadOnlyList. Add proper methods
for mutation (AddItem, AddItems, RemoveItem, SortItems).

Changes:
- Bin.Items: Now private with AddItem/AddItems/RemoveItem/SortItems
- Result.ItemsNotUsed: Now readonly with Add methods
- Result.Bins: Now readonly with Add methods
- Updated all engine classes to use new encapsulated APIs

This improves encapsulation and prevents external code from
bypassing business logic by directly manipulating collections.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
AJ
2025-11-18 16:02:48 -05:00
parent 2c6fe924e5
commit 703efd528a
5 changed files with 80 additions and 33 deletions

View File

@@ -7,14 +7,36 @@ namespace SawCut
{ {
public class Bin public class Bin
{ {
public List<BinItem> Items; private readonly List<BinItem> _items;
public Bin(double length) public Bin(double length)
{ {
Items = new List<BinItem>(); _items = new List<BinItem>();
Length = length; Length = length;
} }
public IReadOnlyList<BinItem> Items => _items;
public void AddItem(BinItem item)
{
_items.Add(item);
}
public void AddItems(IEnumerable<BinItem> items)
{
_items.AddRange(items);
}
public void RemoveItem(BinItem item)
{
_items.Remove(item);
}
public void SortItems(Comparison<BinItem> comparison)
{
_items.Sort(comparison);
}
public double Spacing { get; set; } public double Spacing { get; set; }
public double Length { get; set; } public double Length { get; set; }

View File

@@ -31,17 +31,17 @@ namespace SawCut.Nesting
Items = items.OrderByDescending(i => i.Length).ToList(); Items = items.OrderByDescending(i => i.Length).ToList();
var result = new Result var result = new Result();
{ var itemsTooLarge = Items.Where(i => i.Length > StockLength).ToList();
ItemsNotUsed = Items.Where(i => i.Length > StockLength).ToList() result.AddItemsNotUsed(itemsTooLarge);
};
Items.RemoveAll(item => result.ItemsNotUsed.Contains(item)); Items.RemoveAll(item => itemsTooLarge.Contains(item));
CreateBins(); CreateBins();
result.ItemsNotUsed = Items.Where(i => i.Length > StockLength).ToList(); var finalItemsTooLarge = Items.Where(i => i.Length > StockLength).ToList();
result.Bins = Bins; result.AddItemsNotUsed(finalItemsTooLarge);
result.AddBins(Bins);
foreach (var bin in result.Bins) foreach (var bin in result.Bins)
{ {
@@ -51,7 +51,7 @@ namespace SawCut.Nesting
} }
} }
result.ItemsNotUsed.AddRange(Items); result.AddItemsNotUsed(Items);
return result; return result;
} }
@@ -70,8 +70,8 @@ namespace SawCut.Nesting
while (TryImprovePacking(bin)) while (TryImprovePacking(bin))
{ {
} }
bin.Items.Sort((a, b) => bin.SortItems((a, b) =>
{ {
int comparison = b.Length.CompareTo(a.Length); int comparison = b.Length.CompareTo(a.Length);
return comparison != 0 ? comparison : a.Length.CompareTo(b.Length); return comparison != 0 ? comparison : a.Length.CompareTo(b.Length);
@@ -105,7 +105,7 @@ namespace SawCut.Nesting
{ {
if (bin.RemainingLength >= Items[i].Length) if (bin.RemainingLength >= Items[i].Length)
{ {
bin.Items.Add(Items[i]); bin.AddItem(Items[i]);
Items.RemoveAt(i); Items.RemoveAt(i);
i--; i--;
} }
@@ -130,7 +130,7 @@ namespace SawCut.Nesting
foreach (var item in originalBin.Items) foreach (var item in originalBin.Items)
{ {
var newItem = Items.FirstOrDefault(a => a.Length == item.Length); var newItem = Items.FirstOrDefault(a => a.Length == item.Length);
newBin.Items.Add(newItem); newBin.AddItem(newItem);
Items.Remove(newItem); Items.Remove(newItem);
} }
@@ -167,7 +167,7 @@ namespace SawCut.Nesting
{ {
var minRemainingLength = bin.RemainingLength; var minRemainingLength = bin.RemainingLength;
var firstItem = group.Items.FirstOrDefault(); var firstItem = group.Items.FirstOrDefault();
bin.Items.Remove(firstItem); bin.RemoveItem(firstItem);
for (int i = 0; i < Items.Count; i++) for (int i = 0; i < Items.Count; i++)
{ {
@@ -178,7 +178,7 @@ namespace SawCut.Nesting
var bin2 = new Bin(bin.RemainingLength); var bin2 = new Bin(bin.RemainingLength);
bin2.Spacing = bin.Spacing; bin2.Spacing = bin.Spacing;
bin2.Items.Add(item1); bin2.AddItem(item1);
for (int j = i + 1; j < Items.Count; j++) for (int j = i + 1; j < Items.Count; j++)
{ {
@@ -190,13 +190,13 @@ namespace SawCut.Nesting
if (item2.Length > bin2.RemainingLength) if (item2.Length > bin2.RemainingLength)
continue; continue;
bin2.Items.Add(item2); bin2.AddItem(item2);
} }
if (bin2.RemainingLength < minRemainingLength) if (bin2.RemainingLength < minRemainingLength)
{ {
Items.Add(firstItem); Items.Add(firstItem);
bin.Items.AddRange(bin2.Items); bin.AddItems(bin2.Items);
foreach (var item in bin2.Items) foreach (var item in bin2.Items)
{ {
@@ -208,13 +208,13 @@ namespace SawCut.Nesting
} }
} }
bin.Items.Add(firstItem); bin.AddItem(firstItem);
} }
return false; return false;
} }
private List<LengthGroup> GroupItemsByLength(List<BinItem> items) private List<LengthGroup> GroupItemsByLength(IEnumerable<BinItem> items)
{ {
var groups = new List<LengthGroup>(); var groups = new List<LengthGroup>();
var groupMap = new Dictionary<double, LengthGroup>(); var groupMap = new Dictionary<double, LengthGroup>();

View File

@@ -23,16 +23,18 @@ namespace SawCut.Nesting
Items = items.OrderByDescending(i => i.Length).ToList(); Items = items.OrderByDescending(i => i.Length).ToList();
var result = new Result(); var result = new Result();
result.ItemsNotUsed = Items.Where(i => i.Length > StockLength).ToList(); var itemsTooLarge = Items.Where(i => i.Length > StockLength).ToList();
result.AddItemsNotUsed(itemsTooLarge);
foreach (var item in result.ItemsNotUsed) foreach (var item in itemsTooLarge)
{ {
Items.Remove(item); Items.Remove(item);
} }
result.Bins = GetBins(); var bins = GetBins();
result.AddBins(bins);
foreach (var bin in result.Bins) foreach (var bin in bins)
{ {
foreach (var item in bin.Items) foreach (var item in bin.Items)
{ {
@@ -40,7 +42,7 @@ namespace SawCut.Nesting
} }
} }
result.ItemsNotUsed.AddRange(Items); result.AddItemsNotUsed(Items);
return result; return result;
} }
@@ -66,7 +68,7 @@ namespace SawCut.Nesting
} }
if (best_bin != null) if (best_bin != null)
best_bin.Items.Add(item); best_bin.AddItem(item);
} }

View File

@@ -29,11 +29,11 @@ namespace SawCut.Nesting
e.Spacing = Spacing; e.Spacing = Spacing;
var r = e.Pack(remainingItems); var r = e.Pack(remainingItems);
result.Bins.AddRange(r.Bins); result.AddBins(r.Bins);
remainingItems = r.ItemsNotUsed; remainingItems = r.ItemsNotUsed.ToList();
} }
result.ItemsNotUsed = remainingItems; result.AddItemsNotUsed(remainingItems);
return result; return result;
} }

View File

@@ -4,14 +4,37 @@ namespace SawCut.Nesting
{ {
public class Result public class Result
{ {
private readonly List<BinItem> _itemsNotUsed;
private readonly List<Bin> _bins;
public Result() public Result()
{ {
ItemsNotUsed = new List<BinItem>(); _itemsNotUsed = new List<BinItem>();
Bins = new List<Bin>(); _bins = new List<Bin>();
} }
public List<BinItem> ItemsNotUsed { get; set; } public IReadOnlyList<BinItem> ItemsNotUsed => _itemsNotUsed;
public List<Bin> Bins { get; set; } public IReadOnlyList<Bin> Bins => _bins;
public void AddItemNotUsed(BinItem item)
{
_itemsNotUsed.Add(item);
}
public void AddItemsNotUsed(IEnumerable<BinItem> items)
{
_itemsNotUsed.AddRange(items);
}
public void AddBin(Bin bin)
{
_bins.Add(bin);
}
public void AddBins(IEnumerable<Bin> bins)
{
_bins.AddRange(bins);
}
} }
} }