wrapした変数を格納するHashSetをつくりたい

Question

前提

タイトルの通りですが、C#でwrapした変数を重複無しで格納するコレクションを作りたいです。

当然ですが、既存のHashSetにオブジェクトを入れると、valueが同じでも、異なるオブジェクトであれば格納されてしまいます。

そこで、「コレクションにaddするときに、既に格納されているオブジェクトのvalueを参照して、重複するようであれば追加しない」というコレクションを作りたいです。

速度は必要ないので、二分木などのデータ構造は必要なく、単にforeachで全て確認するだけでいいので、Listを継承するなどの方法が分かれば解決しそうなのですが、そのようなことはできるのでしょうか。

どうぞよろしくお願いいたします。

実現したいこと

wrapした変数をvalueを基準として格納する、HashSetのようなコレクションを作りたい。

該当のソースコード

public class IDList
{
    // MyHashSet<ID> list; の様にしたい
    List<ID> list;
    public IDList()
    {
        list = new List<ID>();
    }
    public bool Add(ID id)
    {
        // このforeachをList内部で処理したい
        foreach (var item in list)
        {
            if (item.value == id.value)
            {
                return false;
            }
        }
        list.Add(id);
        return true;
    }
}
public class ID
{
    public int value { get; }
    public ID(int v)
    {
        value = v;
    }
}

Comments

[退会済みユーザー]

「該当のソースコード」では何が期待と違うのか具体的に書いてください。

Answer 1

当然ですが、既存のHashSetにオブジェクトを入れると、valueが同じでも、異なるオブジェクトであれば格納されてしまいます。

はい。しかしそれの手当ても当然用意されています。

IDクラスをいじれる場合

IEquatable<T>を実装してください。

IEquatable<T> インターフェイス (System) | Microsoft Learn
クラスまたは構造体の値の等価性を定義する方法 - C# プログラミング ガイド | Microsoft Learn

C#9 以降ならrecordを使うのが手っ取り早いです。
レコード - C# リファレンス | Microsoft Learn

IDクラスをいじれない場合

HashSet<T>にIEqualityComparer<T>を与えます。

HashSet<T> コンストラクター (System.Collections.Generic) | Microsoft Learn
IEqualityComparer<T> インターフェイス (System.Collections.Generic) | Microsoft Learn
EqualityComparer<T> クラス (System.Collections.Generic) | Microsoft Learn

.NET6です^^

using System.Diagnostics.CodeAnalysis;

var idRecords = new HashSet<IdRecord>();
Console.WriteLine(idRecords.Add(new IdRecord(1))); // True
Console.WriteLine(idRecords.Add(new IdRecord(2))); // True
Console.WriteLine(idRecords.Add(new IdRecord(1))); // False
Console.WriteLine(string.Join(", ", idRecords)); // IdRecord { Value = 1 }, IdRecord { Value = 2 }
Console.WriteLine(new IdRecord(1) == new IdRecord(1)); // True

Console.WriteLine();


var ids = new HashSet<ID>(new IDEqualityComparer());
Console.WriteLine(ids.Add(new ID(1))); // True
Console.WriteLine(ids.Add(new ID(2))); // True
Console.WriteLine(ids.Add(new ID(1))); // False
Console.WriteLine(string.Join(", ", ids.Select(x => x.Value))); // 1, 2
Console.WriteLine(new ID(1) == new ID(1)); // False



record IdRecord(int Value);

class ID
{
    public int Value { get; }
    public ID(int v) => Value = v;
}

class IDEqualityComparer : EqualityComparer<ID>
{
    public override bool Equals(ID? x, ID? y) => x?.Value == y?.Value;
    public override int GetHashCode([DisallowNull] ID obj) => obj.Value.GetHashCode();
}

Comments

[kdt.nmk]

ご返信ありがとうございます！
IDクラスのEqualsをオーバーライドする方法をとって、完結なコードにすることができました！
複数の対応策を示していただき、コードまで書いてくださったおかげで、とても勉強になりました。

Answer 2

TN8001 さんの回答とダブるところがありますが・・・

HashSet<T> コンストラクターに以下の通り IEqualityComparer<T> を引数に取るオーバーロードがあります。

https://learn.microsoft.com/ja-jp/dotnet/api/system.collections.generic.hashset-1.-ctor?view=netframework-4.8#system-collections-generic-hashset-1-ctor(system-collections-generic-iequalitycomparer((-0)))

それを使って以下のようにしてはいかがですか？　TN8001 さんの回答と違うところは .NET Framework 4.8 ベースであることと、EqualityComparer<T> 継承した比較用クラスの実装だけです。

EqualityComparer<T> を使う理由は以下の記事の Remarks を見てください。

EqualityComparer<T> Class
https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.equalitycomparer-1?view=netframework-4.8

using System;
using System.Collections.Generic;

namespace ConsoleAppHashSet
{
    internal class Program
    {
        static void Main(string[] args)
        {
            var hashSet = new HashSet<ID>(new IdComparer());

            var id1 = new ID(1);
            var id2 = new ID(1);

            bool result = hashSet.Add(id1);
            Console.WriteLine(result);

            result = hashSet.Add(id1);
            Console.WriteLine(result);

            result = hashSet.Add(id2);
            Console.WriteLine(result);
        }
    }

    public class ID
    {
        public ID(int value)
        {
            this.Value = value;
        }

        public int Value { get; set; }
    }

    // Derive from this class to provide a custom implementation of the
    // IEqualityComparer<T> generic interface for use with collection
    // classes such as the Dictionary<TKey,TValue> generic class, or
    // with methods such as List<T>.Sort.
    class IdComparer : EqualityComparer<ID>
    {
        public override bool Equals(ID x, ID y)
        {
            if (Object.ReferenceEquals(x, y)) return true;

            if (x is null || y is null) return false;

            return x.Value == y.Value;
        }

        // Equals() が true を返した場合 GetHashCode() は比較した
        // 両オブジェクトで同じ値を返さなければならない
        public override int GetHashCode(ID id)
        {            
            return id.Value.GetHashCode();
        }
    }
}

結果は:

上記は .NET Framework 4.8 の例です。.NET 6.0 でも同じですが、デフォルトで null 許容参照型が有効になっていますので、その対応は必要です。

Comments

[kdt.nmk]

ご返信ありがとうございます。
今回は、IDクラスのEqualsをオーバーライドする方法を取ることにしました。

質問の仕方に対するご指摘もありがとうございます。
キーワードを知ることができればなんとかできそうだったため、シンプルな質問にしてしまいましたが、今後はわかりやすい質問を心がけたいと思います。

Answer 3

ある劣悪なハッシュ関数は同じ入力に対して異なるハッシュ値を返すことがある。
インターネットの誤情報に騙されないように注意せよ。

Answer 4

Dictionary<int,ID>とかつかえばいいと思うけど、、、
IDのEqualsとGetHashCodeをオーバーライドしてHashSet<ID>使う手もあるけど、好みが分かれるところ。