fix: Optimizes FindItemsByType by removing allocations. (#1515)
### Summary Container enumeration is in dire need of optimization. Thanks to @stefanomerotta for initiating this work with PR #1443. This PR handles a small part of what Stefan started. Also included are some bug fixes. ### Method Signatures ```cs // Use with foreach without moving/deleting items FindItemsByTypeEnumerator<T> FindItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) // Use with foreach when moving/deleting items QueuedItemsEnumerator<T> EnumerateItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) // Use when iterating multiple times or queuing PooledRefQueue<T> QueueItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) // Use when iterating multiples times or manipulating elements without traversing PooledRefList<T> ListItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) ``` * `FindItemsByType<T>` has changed from returning `List<T>` to `FindItemsByTypeEnumerator<T>` - This method is not safe to use in situations where an item may get consumed, deleted, or moved. * `EnumerateItemsByType<T>` was added as a safe way to iterate and manipulate items. * **Note**: EnumerateItemsByType will _completely traverse the container_ before iteration starts because it uses `QueueItemsByType` under the hood. * `QueueItemsByType<T>` and `ListItemsByType<T>` was added to return a queue or list of items to iterate multiple times and manipulate the items. This isn't the most efficient since it uses a predicate and can result in 2 or 3 total iterations unnecessarily. ### Bug Fixes - [X] Fishing had an error in the random check that may have caused slight bias.
This commit is contained in:
Kamron Batman
GitHub
parent
146abad36e
commit
a4cabe2fa4
23 changed files with 655 additions and 390 deletions
243
Projects/Server/Items/Container.Enumerable.cs
Normal file
243
Projects/Server/Items/Container.Enumerable.cs
Normal file
|
|
@ -0,0 +1,243 @@
|
|||
/*************************************************************************
|
||||
* ModernUO *
|
||||
* Copyright 2019-2023 - ModernUO Development Team *
|
||||
* Email: hi@modernuo.com *
|
||||
* File: Container.Enumerable.cs *
|
||||
* *
|
||||
* This program is free software: you can redistribute it and/or modify *
|
||||
* it under the terms of the GNU General Public License as published by *
|
||||
* the Free Software Foundation, either version 3 of the License, or *
|
||||
* (at your option) any later version. *
|
||||
* *
|
||||
* You should have received a copy of the GNU General Public License *
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
||||
*************************************************************************/
|
||||
|
||||
using System;
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Runtime.InteropServices;
|
||||
using Server.Collections;
|
||||
|
||||
namespace Server.Items;
|
||||
|
||||
public partial class Container
|
||||
{
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public FindItemsByTypeEnumerator<Item> FindItemsByType(bool recurse = true, Predicate<Item> predicate = null)
|
||||
=> FindItemsByType<Item>(recurse, predicate);
|
||||
|
||||
/// <summary>
|
||||
/// Performs a breadth-first search through all the <see cref="Item" />s and
|
||||
/// nested <see cref="Container" />s within this <see cref="Container" />.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// DO NOT consume, delete, or move items while iterating
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// var total = 0;
|
||||
/// foreach (var gold in cont.FindItemsByType<Gold>())
|
||||
/// {
|
||||
/// total += gold.Amount;
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
/// <typeparam name="T">Type of objects being searched for</typeparam>
|
||||
/// <param name="recurse">
|
||||
/// Optional: If true, the search will recursively
|
||||
/// check any nested <see cref="Container" />s; otherwise, nested
|
||||
/// <see cref="Container" />s will not be searched.
|
||||
/// </param>
|
||||
/// <param name="predicate">
|
||||
/// Optional: A predicate to check if the <see cref="Item" />
|
||||
/// of type <typeparamref name="T" /> is one of the targets of the search.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An enumerator for iterating through <see cref="Item" />s of type <typeparamref name="T" /> that match the optional
|
||||
/// <paramref name="predicate" />.
|
||||
/// </returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public FindItemsByTypeEnumerator<T> FindItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)
|
||||
where T : Item => new(this, recurse, predicate);
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public QueuedItemsEnumerator<Item> EnumerateItemsByType(bool recurse = true, Predicate<Item> predicate = null)
|
||||
=> EnumerateItemsByType<Item>(recurse, predicate);
|
||||
|
||||
/// <summary>
|
||||
/// Safely enumerates items using a breadth-first search through all the <see cref="Item" />s and
|
||||
/// nested <see cref="Container" />s within this <see cref="Container" />.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Use EnumerateItemsByType for situations where the item might be manipulated, consumed, or moved.
|
||||
/// Note: This method scans through the container before returning the enumerator for iteration.
|
||||
/// </remarks>
|
||||
/// <example>
|
||||
/// <code>
|
||||
/// foreach (var item in cont.EnumerateItemsByType<Item>())
|
||||
/// {
|
||||
/// if (item.LootType is not LootType.Blessed)
|
||||
/// {
|
||||
/// item.Delete();
|
||||
/// }
|
||||
/// }
|
||||
/// </code>
|
||||
/// </example>
|
||||
/// <typeparam name="T">Type of objects being searched for</typeparam>
|
||||
/// <param name="recurse">
|
||||
/// Optional: If true, the search will recursively
|
||||
/// check any nested <see cref="Container" />s; otherwise, nested
|
||||
/// <see cref="Container" />s will not be searched.
|
||||
/// </param>
|
||||
/// <param name="predicate">
|
||||
/// Optional: A predicate to check if the <see cref="Item" />
|
||||
/// of type <typeparamref name="T" /> is one of the targets of the search.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// An enumerator for iterating through <see cref="Item" />s of type <typeparamref name="T" /> that match the optional
|
||||
/// <paramref name="predicate" />.
|
||||
/// </returns>
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public QueuedItemsEnumerator<T> EnumerateItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)
|
||||
where T : Item => new(QueueItemsByType(recurse, predicate));
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public PooledRefQueue<Item> QueueItemsByType(bool recurse = true, Predicate<Item> predicate = null) =>
|
||||
QueueItemsByType<Item>(recurse, predicate);
|
||||
|
||||
public PooledRefQueue<T> QueueItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) where T : Item
|
||||
{
|
||||
var queue = PooledRefQueue<T>.Create();
|
||||
foreach (var item in FindItemsByType(recurse, predicate))
|
||||
{
|
||||
queue.Enqueue(item);
|
||||
}
|
||||
|
||||
return queue;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public PooledRefList<Item> ListItemsByType(bool recurse = true, Predicate<Item> predicate = null) =>
|
||||
ListItemsByType<Item>(recurse, predicate);
|
||||
|
||||
public PooledRefList<T> ListItemsByType<T>(bool recurse = true, Predicate<T> predicate = null) where T : Item
|
||||
{
|
||||
var list = PooledRefList<T>.Create();
|
||||
foreach (var item in FindItemsByType(recurse, predicate))
|
||||
{
|
||||
list.Add(item);
|
||||
}
|
||||
|
||||
return list;
|
||||
}
|
||||
|
||||
public ref struct FindItemsByTypeEnumerator<T> where T : Item
|
||||
{
|
||||
private PooledRefQueue<Container> _containers;
|
||||
private Span<Item> _items;
|
||||
private int _index;
|
||||
private T _current;
|
||||
private bool _recurse;
|
||||
private Predicate<T> _predicate;
|
||||
|
||||
public FindItemsByTypeEnumerator(Container container, bool recurse, Predicate<T> predicate)
|
||||
{
|
||||
_containers = PooledRefQueue<Container>.Create();
|
||||
|
||||
if (container?.m_Items != null)
|
||||
{
|
||||
_items = CollectionsMarshal.AsSpan(container.m_Items);
|
||||
}
|
||||
|
||||
_current = default;
|
||||
_index = 0;
|
||||
_recurse = recurse;
|
||||
_predicate = predicate;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public bool MoveNext() => SetNextItem() || _recurse && SetNextContainer();
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private bool SetNextContainer()
|
||||
{
|
||||
if (!_containers.TryDequeue(out var c))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
_items = CollectionsMarshal.AsSpan(c.m_Items);
|
||||
_index = 0;
|
||||
return SetNextItem();
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
private bool SetNextItem()
|
||||
{
|
||||
while (_index < _items.Length)
|
||||
{
|
||||
Item item = _items[_index++];
|
||||
if (_recurse && item is Container { m_Items.Count: > 0 } c)
|
||||
{
|
||||
_containers.Enqueue(c);
|
||||
}
|
||||
|
||||
if (item is T t && _predicate?.Invoke(t) != false)
|
||||
{
|
||||
_current = t;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public T Current
|
||||
{
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
get => _current;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void Dispose() => _containers.Dispose();
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public FindItemsByTypeEnumerator<T> GetEnumerator() => this;
|
||||
}
|
||||
|
||||
public ref struct QueuedItemsEnumerator<T> where T : Item
|
||||
{
|
||||
private PooledRefQueue<T> _queue;
|
||||
private T _current;
|
||||
|
||||
public QueuedItemsEnumerator(PooledRefQueue<T> queue)
|
||||
{
|
||||
_queue = queue;
|
||||
_current = default;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public bool MoveNext()
|
||||
{
|
||||
if (_queue.TryDequeue(out var item))
|
||||
{
|
||||
_current = item;
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public T Current
|
||||
{
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
get => _current;
|
||||
}
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public void Dispose() => _queue.Dispose();
|
||||
|
||||
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
||||
public QueuedItemsEnumerator<T> GetEnumerator() => this;
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue