chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,169 @@
|
||||
/*
|
||||
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
|
||||
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
using System;
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace QuantConnect.Util
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines an enumerable that can be enumerated many times while
|
||||
/// only performing a single enumeration of the root enumerable
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class MemoizingEnumerable<T> : IEnumerable<T>
|
||||
{
|
||||
private List<T> _buffer;
|
||||
private IEnumerator<T> _enumerator;
|
||||
|
||||
/// <summary>
|
||||
/// Allow disableing the buffering
|
||||
/// </summary>
|
||||
/// <remarks>Should be called before the enumeration starts</remarks>
|
||||
public bool Enabled { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the count of items in the enumerable. This will force enumeration of the entire collection if it has not already been enumerated.
|
||||
/// </summary>
|
||||
public int Count
|
||||
{
|
||||
get
|
||||
{
|
||||
if (!Enabled)
|
||||
{
|
||||
throw new InvalidOperationException("Count is not supported when memoization is disabled");
|
||||
}
|
||||
if (_buffer == null)
|
||||
{
|
||||
foreach (var item in this) {}
|
||||
}
|
||||
return _buffer.Count;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets whether the enumerable is empty. This will force enumeration of the first item if it has not already been enumerated.
|
||||
/// </summary>
|
||||
public bool Empty
|
||||
{
|
||||
get
|
||||
{
|
||||
if (!Enabled)
|
||||
{
|
||||
throw new InvalidOperationException("Empty is not supported when memoization is disabled");
|
||||
}
|
||||
if (_buffer == null || _buffer.Count == 0)
|
||||
{
|
||||
using var enumerator = GetEnumerator();
|
||||
return !enumerator.MoveNext();
|
||||
}
|
||||
return _buffer.Count == 0;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="MemoizingEnumerable{T}"/> class
|
||||
/// </summary>
|
||||
/// <param name="enumerable">The source enumerable to be memoized</param>
|
||||
public MemoizingEnumerable(IEnumerable<T> enumerable)
|
||||
{
|
||||
Enabled = true;
|
||||
_enumerator = enumerable.GetEnumerator();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns an enumerator that iterates through the collection.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
|
||||
/// </returns>
|
||||
/// <filterpriority>1</filterpriority>
|
||||
public IEnumerator<T> GetEnumerator()
|
||||
{
|
||||
if (!Enabled)
|
||||
{
|
||||
if (_enumerator != null)
|
||||
{
|
||||
while (_enumerator.MoveNext())
|
||||
{
|
||||
yield return _enumerator.Current;
|
||||
}
|
||||
|
||||
// important to avoid leak!
|
||||
_enumerator.Dispose();
|
||||
_enumerator = null;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (_buffer == null)
|
||||
{
|
||||
// lazy create our buffer
|
||||
_buffer = new List<T>();
|
||||
}
|
||||
|
||||
int i = 0;
|
||||
while (i <= _buffer.Count)
|
||||
{
|
||||
// sync for multiple threads access to _enumerator and _buffer
|
||||
lock (_buffer)
|
||||
{
|
||||
// check to see if we need to move next
|
||||
if (_enumerator != null && i >= _buffer.Count)
|
||||
{
|
||||
if (_enumerator.MoveNext())
|
||||
{
|
||||
var value = _enumerator.Current;
|
||||
_buffer.Add(value);
|
||||
yield return value;
|
||||
}
|
||||
else
|
||||
{
|
||||
// important to avoid leak!
|
||||
_enumerator.Dispose();
|
||||
_enumerator = null;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// we have a value if it's in the buffer
|
||||
if (_buffer.Count > i)
|
||||
{
|
||||
yield return _buffer[i];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// increment for next time
|
||||
i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns an enumerator that iterates through a collection.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
|
||||
/// </returns>
|
||||
/// <filterpriority>2</filterpriority>
|
||||
IEnumerator IEnumerable.GetEnumerator()
|
||||
{
|
||||
return GetEnumerator();
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user