Comparer.Compareとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Comparer.Compare メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

派生クラスでオーバーライドされると、同じ型の 2 つのオブジェクトに対する比較を実行し、一方のオブジェクトが他方よりも小さいか、等しいか、大きいかを示す値を返します。

名前空間: System.Collections.Generic
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Function
 Compare ( _
    x As T, _
    y As T _
) As Integer

Visual Basic (使用法)

Dim instance As Comparer(Of
 T)
Dim x As T
Dim y As T
Dim returnValue As Integer

returnValue = instance.Compare(x, y)

public abstract int Compare (
    T x,
    T y
)

C++

public:
virtual int Compare (
    T x, 
    T y
) abstract

public abstract int Compare (
    T x, 
    T y
)

JScript

public abstract function Compare (
    x : T, 
    y : T
) : int

パラメータ

x: 比較対象の第 1 オブジェクト。

y: 比較対象の第 2 オブジェクト。

戻り値

値	条件
0 より小さい値	x が y より小さい。
0	x と y は等しい。
0 より大きい値	x が y より大きい値です。

例外

例外の種類	条件
ArgumentException	T 型が、System.IComparable ジェネリックインターフェイスまたは System.IComparable インターフェイスのいずれも実装していません。

解説

T 型の並べ替え順序の比較方法をカスタマイズするには、このメソッドを実装します。

実装時の注意 null 参照 (Visual Basic では Nothing) を任意の参照型と比較できます。このような比較を行っても例外が生成されることはありません。null 参照は、null 以外のすべての参照より小さいと見なされます。カルチャ固有の比較の詳細については、System.Globalization 名前空間のトピックおよび「エンコーディングとローカリゼーション」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Comparer ジェネリッククラス
Comparer メンバ
System.Collections.Generic 名前空間
IComparable ジェネリックインターフェイス
IComparable インターフェイス
StringComparer クラス
Object クラス
System.Globalization.CultureInfo

Comparer.Compare メソッド

同じ型の 2 つのオブジェクトに対して大文字と小文字を区別する比較を実行し、一方が他方よりも小さいか、等しいか、大きいかを示す値を返します。

名前空間: System.Collections
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Function Compare ( _
    a As Object, _
    b As Object _
) As Integer

Visual Basic (使用法)

Dim instance As Comparer
Dim a As Object
Dim b As Object
Dim returnValue As Integer

returnValue = instance.Compare(a, b)

public int Compare (
    Object a,
    Object b
)

C++

public:
virtual int Compare (
    Object^ a, 
    Object^ b
) sealed

public final int Compare (
    Object a, 
    Object b
)

JScript

public final function Compare (
    a : Object, 
    b : Object
) : int

パラメータ

a: 比較対象の第 1 オブジェクト。

b: 比較対象の第 2 オブジェクト。

戻り値

値	説明
0 より小さい値	a が b より小さい。
0	a と b は等しい。
0 より大きい値	a が b より大きい値です。

例外

例外の種類	条件
ArgumentException	a と b が、いずれも IComparable インターフェイスを実装していません。または a と b の型が異なっていて、両者を比較できません。

例外の種類

条件

ArgumentException

a と b が、いずれも IComparable インターフェイスを実装していません。

または

a と b の型が異なっていて、両者を比較できません。

解説

a が IComparable を実装する場合は、a .CompareTo ( b ) が返されます。逆に、b が IComparable を実装する場合は、符号反転した b .CompareTo ( a ) が返されます。

null 参照 (Visual Basic では Nothing) を任意の型と比較できます。このような比較を行っても、IComparable を使用した場合に例外が生成されることはありません。並べ替え処理では、null 参照 (Visual Basic では Nothing) は、他のすべてのオブジェクトより小さいと見なされます。

文字列比較の結果は、カルチャに応じて異なる場合があります。カルチャ固有の比較の詳細については、System.Globalization 名前空間のトピックおよび「エンコーディングとローカリゼーション」を参照してください。

使用例

Comparer に関連付けられているカルチャに応じて、Compare が返す値が変わる方法については、次のコードの例を参照してください。

Visual Basic

Imports System
Imports System.Collections
Imports System.Globalization

Public Class SamplesComparer

   Public Shared Sub Main()

      ' Creates the strings to compare.
      Dim str1 As [String] = "llegar"
      Dim str2 As [String] = "lugar"
      Console.WriteLine("Comparing ""{0}""
 and ""{1}"" ...",
 str1, str2)

      ' Uses the DefaultInvariant Comparer.
      Console.WriteLine("   Invariant Comparer: {0}",
 Comparer.DefaultInvariant.Compare(str1, str2))

      ' Uses the Comparer based on the culture "es-ES" (Spanish
 - Spain, international sort).
      Dim myCompIntl As New
 Comparer(New CultureInfo("es-ES",
 False))
      Console.WriteLine("   International Sort: {0}",
 myCompIntl.Compare(str1, str2))

      ' Uses the Comparer based on the culture identifier 0x040A (Spanish
 - Spain, traditional sort).
      Dim myCompTrad As New
 Comparer(New CultureInfo(&H40A, False))
      Console.WriteLine("   Traditional Sort  : {0}",
 myCompTrad.Compare(str1, str2))

   End Sub 'Main 

End Class 'SamplesComparer


'This code produces the following output.
'
'Comparing "llegar" and "lugar" ...
'   Invariant Comparer: -1
'   International Sort: -1
'   Traditional Sort  : 1

using System;
using System.Collections;
using System.Globalization;


public class SamplesComparer  {

   public static void Main()
  {

      // Creates the strings to compare.
      String str1 = "llegar";
      String str2 = "lugar";
      Console.WriteLine( "Comparing \"{0}\" and \"{1}\"
 ...", str1, str2 );

      // Uses the DefaultInvariant Comparer.
      Console.WriteLine( "   Invariant Comparer: {0}", Comparer.DefaultInvariant.Compare(
 str1, str2 ) );

      // Uses the Comparer based on the culture "es-ES" (Spanish
 - Spain, international sort).
      Comparer myCompIntl = new Comparer( new
 CultureInfo( "es-ES", false ) );
      Console.WriteLine( "   International Sort: {0}", myCompIntl.Compare(
 str1, str2 ) );

      // Uses the Comparer based on the culture identifier 0x040A (Spanish
 - Spain, traditional sort).
      Comparer myCompTrad = new Comparer( new
 CultureInfo( 0x040A, false ) );
      Console.WriteLine( "   Traditional Sort  : {0}", myCompTrad.Compare(
 str1, str2 ) );

   }

}

/*
This code produces the following output.

Comparing "llegar" and "lugar" ...
   Invariant Comparer: -1
   International Sort: -1
   Traditional Sort  : 1

*/

C++

using namespace System;
using namespace System::Collections;
using namespace System::Globalization;
int main()
{
   
   // Creates the strings to compare.
   String^ str1 = "llegar";
   String^ str2 = "lugar";
   Console::WriteLine( "Comparing \"{0}\" and \"{1}\" ...",
 str1, str2 );
   
   // Uses the DefaultInvariant Comparer.
   Console::WriteLine( "   Invariant Comparer: {0}", Comparer::DefaultInvariant->Compare(
 str1, str2 ) );
   
   // Uses the Comparer based on the culture "es-ES" (Spanish
 - Spain, international sort).
   Comparer^ myCompIntl = gcnew Comparer( gcnew CultureInfo(  "es-ES",false
 ) );
   Console::WriteLine( "   International Sort: {0}", myCompIntl->Compare(
 str1, str2 ) );
   
   // Uses the Comparer based on the culture identifier 0x040A (Spanish
 - Spain, traditional sort).
   Comparer^ myCompTrad = gcnew Comparer( gcnew CultureInfo( 0x040A,false
 ) );
   Console::WriteLine( "   Traditional Sort  : {0}", myCompTrad->Compare(
 str1, str2 ) );
}

/*
This code produces the following output.

Comparing "llegar" and "lugar" ...
   Invariant Comparer: -1
   International Sort: -1
   Traditional Sort  : 1

*/

import System.* ;
import System.Collections.*;
import System.Globalization.*;

public class SamplesComparer
{
    public static void main(String[]
 args)
    {
        // Creates the strings to compare.
        String str1 = "llegar";
        String str2 = "lugar";
        Console.WriteLine("Comparing \"{0}\" and \"{1}\"
 ...", str1, str2);
      
        // Uses the DefaultInvariant Comparer.
        Console.WriteLine("   Invariant Comparer: {0}", 
            (Int32)Comparer.DefaultInvariant.Compare(str1, str2));

        // Uses the Comparer based on the culture "es-ES"
 (Spanish - Spain, 
        // international sort).
        Comparer myCompIntl = new Comparer(new
 CultureInfo("es-ES", false));
        Console.WriteLine("   International Sort: {0}", 
            (Int32)myCompIntl.Compare(str1, str2));

        // Uses the Comparer based on the culture identifier 0x040A
 
        // (Spanish - Spain, traditional sort).
        Comparer myCompTrad = new Comparer(new
 CultureInfo(0x40A, false));
        Console.WriteLine("   Traditional Sort  : {0}",
            (Int32)myCompTrad.Compare(str1, str2));
    } //main
} //SamplesComparer

/*
This code produces the following output.

Comparing "llegar" and "lugar" ...
   Invariant Comparer: -1
   International Sort: -1
   Traditional Sort  : 1

*/

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Comparer クラス
Comparer メンバ
System.Collections 名前空間
IComparable インターフェイス
System.Globalization.CompareInfo
Thread.CurrentCulture
System.Globalization.CultureInfo