Skip to content

Optimize FlagCollection #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Optimize FlagCollection #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9311b4
Optimize `FlagCollection`
SergeiPavlov Jan 15, 2025
840f1a7
Simplify
SergeiPavlov Jan 15, 2025
70bdf36
Equals()
SergeiPavlov Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 52 additions & 122 deletions Orm/Xtensive.Orm/Collections/FlagCollection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
// Created by: Alexey Kochetov
// Created: 2007.10.01

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Diagnostics;
Expand All @@ -15,8 +13,6 @@
using Xtensive.Conversion;
using Xtensive.Core;



namespace Xtensive.Collections
{
/// <summary>
Expand All @@ -32,42 +28,29 @@ namespace Xtensive.Collections
[DebuggerDisplay("Count = {Count}")]
public class FlagCollection<TKey, TFlag>: LockableBase,
IList<KeyValuePair<TKey, TFlag>>,
IDictionary<TKey, TFlag>,
IReadOnlyDictionary<TKey, TFlag>,
IEquatable<FlagCollection<TKey, TFlag>>,
ISerializable
{
private const int MaxItemCount = 32;
private readonly Biconverter<TFlag, bool> converter;
private readonly List<TKey> keys;
private readonly ReadOnlyCollection<TKey> readOnlyKeys;
private readonly List<TKey> keys = new();
private BitVector32 flags;

/// <summary>
/// Gets <see cref="Biconverter{TFrom,TTo}"/> instance
/// used to convert flag value to <see cref="bool"/> and vice versa.
/// </summary>
public Biconverter<TFlag, bool> Converter
{
[DebuggerStepThrough]
get { return converter; }
}
public Biconverter<TFlag, bool> Converter { [DebuggerStepThrough] get; }

/// <summary>
/// Gets an <see cref="Collection{T}"/> containing the flags.
/// </summary>
public ICollection<TFlag> Flags
{
[DebuggerStepThrough]
get { return Values; }
}
public ICollection<TFlag> Flags => Values;

#region IDictionary<TKey,TFlag> Members
#region IReadOnlyDictionary<TKey,TFlag> Members

/// <inheritdoc/>
public bool ContainsKey(TKey key)
{
return keys.Contains(key);
}
public bool ContainsKey(TKey key) => keys.Contains(key);

/// <inheritdoc/>
public void Add(TKey key, TFlag flag)
Expand All @@ -78,13 +61,20 @@ public void Add(TKey key, TFlag flag)
if (keys.Count >= MaxItemCount)
throw new InvalidOperationException(string.Format(Strings.ExMaxItemCountIsN, MaxItemCount));
keys.Add(key);
flags[1 << (keys.Count - 1)] = converter.ConvertForward(flag);
flags[1 << (keys.Count - 1)] = Converter.ConvertForward(flag);
}

/// <inheritdoc/>
public virtual void Add(TKey key)
public virtual void Add(TKey key) => Add(key, default);

public bool TryAdd(TKey key, TFlag flag)
{
Add(key, default(TFlag));
if (!ContainsKey(key)) {
Add(key, flag);
return true;
}

return false;
}

/// <inheritdoc/>
Expand All @@ -107,11 +97,11 @@ public bool Remove(TKey key)
/// <inheritdoc/>
public bool TryGetValue(TKey key, out TFlag value)
{
value = converter.ConvertBackward(false);
value = Converter.ConvertBackward(false);
int index = keys.IndexOf(key);
if (index < 0)
return false;
value = converter.ConvertBackward(flags[1 << index]);
value = Converter.ConvertBackward(flags[1 << index]);
return true;
}

Expand All @@ -121,11 +111,7 @@ public TFlag this[TKey key]
get
{
ArgumentValidator.EnsureArgumentIsNotDefault(key, "key");
TFlag value;
bool result = TryGetValue(key, out value);
if (!result)
throw new KeyNotFoundException();
return value;
return TryGetValue(key, out var value) ? value : throw new KeyNotFoundException();
}
set
{
Expand All @@ -135,58 +121,42 @@ public TFlag this[TKey key]
if (index < 0)
Add(key, value);
else
flags[1 << index] = converter.ConvertForward(value);
flags[1 << index] = Converter.ConvertForward(value);
}
}

/// <summary>
/// Gets a list of keys.
/// </summary>
/// <returns>A list of keys.</returns>
public IReadOnlyList<TKey> Keys
{
get { return readOnlyKeys; }
}
public IReadOnlyList<TKey> Keys => keys;

/// <inheritdoc/>
ICollection<TKey> IDictionary<TKey, TFlag>.Keys
{
get { return readOnlyKeys; }
}
IEnumerable<TKey> IReadOnlyDictionary<TKey, TFlag>.Keys => Keys;

/// <summary>
/// Gets an array of values.
/// </summary>
/// <returns>An array of values.</returns>
public TFlag[] Values {
get {
var array = new TFlag[keys.Count];
for (int i = 0; i < keys.Count; i++)
array[i] = converter.ConvertBackward(flags[1 << i]);
var n = keys.Count;
var array = new TFlag[n];
for (int i = 0; i < n; i++)
array[i] = Converter.ConvertBackward(flags[1 << i]);
return array;
}
}

/// <inheritdoc/>
ICollection<TFlag> IDictionary<TKey, TFlag>.Values {
get {
var list = new List<TFlag>(keys.Count);
for (int i = 0; i < keys.Count; i++) {
list.Add(converter.ConvertBackward(flags[1 << i]));
}
return list;
}
}
IEnumerable<TFlag> IReadOnlyDictionary<TKey, TFlag>.Values => Values;

#endregion

#region IList<KeyValuePair<TKey,TFlag>> Members

/// <inheritdoc/>
public void Add(KeyValuePair<TKey, TFlag> item)
{
Add(item.Key, item.Value);
}
public void Add(KeyValuePair<TKey, TFlag> item) => Add(item.Key, item.Value);

/// <inheritdoc/>
public void Clear()
Expand All @@ -197,61 +167,35 @@ public void Clear()
}

/// <inheritdoc/>
public bool Contains(KeyValuePair<TKey, TFlag> item)
{
return ContainsKey(item.Key);
}
public bool Contains(KeyValuePair<TKey, TFlag> item) => ContainsKey(item.Key);

/// <inheritdoc/>
public void CopyTo(KeyValuePair<TKey, TFlag>[] array, int arrayIndex)
{
this.Copy(array, arrayIndex);
}
public void CopyTo(KeyValuePair<TKey, TFlag>[] array, int arrayIndex) => this.Copy(array, arrayIndex);

/// <inheritdoc/>
public bool Remove(KeyValuePair<TKey, TFlag> item)
{
return Remove(item.Key);
}
public bool Remove(KeyValuePair<TKey, TFlag> item) => Remove(item.Key);

/// <inheritdoc/>
public int Count
{
[DebuggerStepThrough]
get { return keys.Count; }
}
public int Count => keys.Count;

/// <inheritdoc/>
public bool IsReadOnly
{
[DebuggerStepThrough]
get { return IsLocked; }
}
public bool IsReadOnly => IsLocked;

/// <inheritdoc/>
int IList<KeyValuePair<TKey, TFlag>>.IndexOf(KeyValuePair<TKey, TFlag> item)
{
throw new NotSupportedException();
}
int IList<KeyValuePair<TKey, TFlag>>.IndexOf(KeyValuePair<TKey, TFlag> item) => throw new NotSupportedException();

/// <inheritdoc/>
void IList<KeyValuePair<TKey, TFlag>>.Insert(int index, KeyValuePair<TKey, TFlag> item)
{
throw new NotSupportedException();
}
void IList<KeyValuePair<TKey, TFlag>>.Insert(int index, KeyValuePair<TKey, TFlag> item) => throw new NotSupportedException();

/// <inheritdoc/>
void IList<KeyValuePair<TKey, TFlag>>.RemoveAt(int index)
{
throw new NotSupportedException();
}
void IList<KeyValuePair<TKey, TFlag>>.RemoveAt(int index) => throw new NotSupportedException();

/// <inheritdoc/>
public KeyValuePair<TKey, TFlag> this[int index] {
get {
if (keys.Count <= index)
throw new ArgumentOutOfRangeException("index");
return new KeyValuePair<TKey, TFlag>(keys[index], converter.ConvertBackward(flags[1<<index]));
return new KeyValuePair<TKey, TFlag>(keys[index], Converter.ConvertBackward(flags[1<<index]));
}
set {
// TODO: implement?
Expand All @@ -264,31 +208,22 @@ public KeyValuePair<TKey, TFlag> this[int index] {
#region ICollection<KeyValuePair<TKey, TFlag>> Members

/// <inheritdoc/>
void ICollection<KeyValuePair<TKey, TFlag>>.Add(KeyValuePair<TKey, TFlag> key)
{
Add(key.Key, key.Value);
}
void ICollection<KeyValuePair<TKey, TFlag>>.Add(KeyValuePair<TKey, TFlag> key) => Add(key.Key, key.Value);

/// <inheritdoc/>
bool ICollection<KeyValuePair<TKey, TFlag>>.Contains(KeyValuePair<TKey, TFlag> item)
{
int index = keys.IndexOf(item.Key);
if (index < 0)
return false;
return flags[1 << index] == converter.ConvertForward(item.Value);
return flags[1 << index] == Converter.ConvertForward(item.Value);
}

/// <inheritdoc/>
void ICollection<KeyValuePair<TKey, TFlag>>.CopyTo(KeyValuePair<TKey, TFlag>[] array, int arrayIndex)
{
this.Copy(array, arrayIndex);
}
void ICollection<KeyValuePair<TKey, TFlag>>.CopyTo(KeyValuePair<TKey, TFlag>[] array, int arrayIndex) => this.Copy(array, arrayIndex);

/// <inheritdoc/>
bool ICollection<KeyValuePair<TKey, TFlag>>.Remove(KeyValuePair<TKey, TFlag> item)
{
throw new NotSupportedException();
}
bool ICollection<KeyValuePair<TKey, TFlag>>.Remove(KeyValuePair<TKey, TFlag> item) => throw new NotSupportedException();

#endregion

Expand All @@ -298,7 +233,7 @@ bool ICollection<KeyValuePair<TKey, TFlag>>.Remove(KeyValuePair<TKey, TFlag> ite
public IEnumerator<KeyValuePair<TKey, TFlag>> GetEnumerator()
{
for (int i = 0; i < keys.Count; i++)
yield return new KeyValuePair<TKey, TFlag>(keys[i], converter.ConvertBackward(flags[1 << i]));
yield return new KeyValuePair<TKey, TFlag>(keys[i], Converter.ConvertBackward(flags[1 << i]));
}

/// <inheritdoc/>
Expand All @@ -314,23 +249,21 @@ IEnumerator IEnumerable.GetEnumerator()
/// <inheritdoc/>
public bool Equals(FlagCollection<TKey, TFlag> other)
{
if (ReferenceEquals(this, other))
return true;
if (other == null)
return false;
if (Count != other.Count)
var count = Count;
if (count != other.Count)
return false;
for (int i = 0; i < Count; i++)
for (int i = 0; i < count; i++)
if (!this[i].Equals(other[i]))
return false;
return true;
}

/// <inheritdoc/>
public override bool Equals(object obj)
{
if (ReferenceEquals(this, obj))
return true;
return Equals(obj as FlagCollection<TKey, TFlag>);
}
public override bool Equals(object obj) => obj is FlagCollection<TKey, TFlag> other && Equals(other);

/// <inheritdoc/>
public override int GetHashCode() => HashCode.Combine(keys, flags);
Expand All @@ -347,7 +280,7 @@ public override bool Equals(object obj)
public FlagCollection(Biconverter<TFlag, bool> converter)
: this()
{
this.converter = converter;
Converter = converter;
}

/// <summary>
Expand All @@ -358,15 +291,13 @@ public FlagCollection(Biconverter<TFlag, bool> converter)
public FlagCollection(Biconverter<TFlag, bool> converter, IEnumerable<KeyValuePair<TKey, TFlag>> enumerable)
: this()
{
this.converter = converter;
Converter = converter;
foreach (KeyValuePair<TKey, TFlag> pair in enumerable)
Add(pair.Key, pair.Value);
}

private FlagCollection()
{
keys = new List<TKey>();
readOnlyKeys = keys.AsReadOnly();
}

#region ISerializable members
Expand All @@ -379,10 +310,9 @@ private FlagCollection()
protected FlagCollection(SerializationInfo info, StreamingContext context)
: base(info.GetBoolean("IsLocked"))
{
converter = (Biconverter<TFlag, bool>)
Converter = (Biconverter<TFlag, bool>)
info.GetValue("AdvancedConverter", typeof(Biconverter<TFlag, bool>));
keys = (List<TKey>)info.GetValue("Keys", typeof(List<TKey>));
readOnlyKeys = keys.AsReadOnly();
flags = new BitVector32(info.GetInt32("Flags"));
}

Expand All @@ -395,7 +325,7 @@ protected FlagCollection(SerializationInfo info, StreamingContext context)
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
{
info.AddValue("IsLocked", IsLocked);
info.AddValue("AdvancedConverter", converter);
info.AddValue("AdvancedConverter", Converter);
info.AddValue("Keys", keys);
info.AddValue("Flags", flags.Data);
}
Expand Down
Loading
Loading