SortKey SortKey SortKey SortKey Class

Определение

Представляет результат сопоставления строки ее ключу сортировки.Represents the result of mapping a string to its sort key.

public ref class SortKey
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class SortKey
type SortKey = class
Public Class SortKey
Наследование
SortKeySortKeySortKeySortKey
Атрибуты

Примеры

В следующем примере сравнивается строка «llama», с помощью «en US» и языков и региональных параметров «es-ES» и «en US» и «es-ES» традиционных языков и региональных параметров.The following example compares the string "llama" using the "en-US" and "es-ES" cultures, and the "en-US" and "es-ES" traditional cultures.

using namespace System;
using namespace System::Globalization;
int main()
{
   
   // Creates a SortKey using the en-US culture.
   CultureInfo^ MyCI = gcnew CultureInfo( "en-US",false );
   CompareInfo^ myComp_enUS = MyCI->CompareInfo;
   SortKey^ mySK1 = myComp_enUS->GetSortKey( "llama" );
   
   // Creates a SortKey using the es-ES culture with international sort.
   MyCI = gcnew CultureInfo( "es-ES",false );
   CompareInfo^ myComp_esES = MyCI->CompareInfo;
   SortKey^ mySK2 = myComp_esES->GetSortKey( "llama" );
   
   // Creates a SortKey using the es-ES culture with traditional sort.
   MyCI = gcnew CultureInfo( 0x040A,false );
   CompareInfo^ myComp_es = MyCI->CompareInfo;
   SortKey^ mySK3 = myComp_es->GetSortKey( "llama" );
   
   // Compares the en-US SortKey with each of the es-ES SortKey objects.
   Console::WriteLine( "Comparing \"llama\" in en-US and in es-ES with international sort : {0}", SortKey::Compare( mySK1, mySK2 ) );
   Console::WriteLine( "Comparing \"llama\" in en-US and in es-ES with traditional sort   : {0}", SortKey::Compare( mySK1, mySK3 ) );
}

/*
This code produces the following output.

Comparing S"llama" in en-US and in es-ES with international sort : 0
Comparing S"llama" in en-US and in es-ES with traditional sort   : -1
*/
using System;
using System.Globalization;

public class SamplesSortKey  {

   public static void Main()  {

      // Creates a SortKey using the en-US culture.
      CompareInfo myComp_enUS = new CultureInfo("en-US",false).CompareInfo;
      SortKey mySK1 = myComp_enUS.GetSortKey( "llama" );

      // Creates a SortKey using the es-ES culture with international sort.
      CompareInfo myComp_esES = new CultureInfo("es-ES",false).CompareInfo;
      SortKey mySK2 = myComp_esES.GetSortKey( "llama" );

      // Creates a SortKey using the es-ES culture with traditional sort.
      CompareInfo myComp_es   = new CultureInfo(0x040A,false).CompareInfo;
      SortKey mySK3 = myComp_es.GetSortKey( "llama" );

      // Compares the en-US SortKey with each of the es-ES SortKey objects.
      Console.WriteLine( "Comparing \"llama\" in en-US and in es-ES with international sort : {0}", SortKey.Compare( mySK1, mySK2 ) );
      Console.WriteLine( "Comparing \"llama\" in en-US and in es-ES with traditional sort   : {0}", SortKey.Compare( mySK1, mySK3 ) );

   }

}

/*
This code produces the following output.

Comparing "llama" in en-US and in es-ES with international sort : 0
Comparing "llama" in en-US and in es-ES with traditional sort   : -1
*/

Imports System
Imports System.Globalization

Public Class SamplesSortKey

   Public Shared Sub Main()

      ' Creates a SortKey using the en-US culture.
      Dim myComp_enUS As CompareInfo = New CultureInfo("en-US", False).CompareInfo
      Dim mySK1 As SortKey = myComp_enUS.GetSortKey("llama")

      ' Creates a SortKey using the es-ES culture with international sort.
      Dim myComp_esES As CompareInfo = New CultureInfo("es-ES", False).CompareInfo
      Dim mySK2 As SortKey = myComp_esES.GetSortKey("llama")

      ' Creates a SortKey using the es-ES culture with traditional sort.
      Dim myComp_es As CompareInfo = New CultureInfo(&H40A, False).CompareInfo
      Dim mySK3 As SortKey = myComp_es.GetSortKey("llama")

      ' Compares the en-US SortKey with each of the es-ES SortKey objects.
      Console.WriteLine("Comparing ""llama"" in en-US and in es-ES with international sort : {0}", SortKey.Compare(mySK1, mySK2))
      Console.WriteLine("Comparing ""llama"" in en-US and in es-ES with traditional sort   : {0}", SortKey.Compare(mySK1, mySK3))

   End Sub 'Main 

End Class 'SamplesSortKey


'This code produces the following output.
'
'Comparing "llama" in en-US and in es-ES with international sort : 0
'Comparing "llama" in en-US and in es-ES with traditional sort   : -1

В следующем примере показано, как можно использовать SortKey класса для повышения производительности в приложении, которое сильно зависит от Сортировка и поиск большого массива.The following example shows how you can use the SortKey class to improve performance in an application that relies extensively on sorting and searching a large array. В примере создается неупорядоченный массив имен, в этом случае с 13 элементов.The example creates an unordered array of names, which in this case has 13 elements. Она сохраняет ключ сортировки каждое имя в параллельных массив, который передается Array.Sort(Array, Array) метод.It then stores the sort key of each name in a parallel array, which it passes to the Array.Sort(Array, Array) method. Результатом является отсортированному массиву.The result is a sorted array. Пример поиска массив для трех строк.The example then searches the array for three strings. Для каждой строки поиска, он вызывает CompareInfo.GetSortKey(String, CompareOptions) метод для извлечения ключа сортировки строки, а затем вызывает Array.FindIndex метод для извлечения индекса, ключ сортировки в массив ключей сортировки.For each search string, it calls the CompareInfo.GetSortKey(String, CompareOptions) method to retrieve the string's sort key, and then calls the Array.FindIndex method to retrieve the index of that sort key in the array of sort keys. Так как имя и сортировки массивов ключа параллельны, возвращаемый индекс — это также индекс имени в names массива.Because the name and sort key arrays are parallel, the returned index is also the index of the name in the names array.

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      // Define names.
      String[] names= { "Adam", "Ignatius", "Batholomew", "Gregory", 
                        "Clement", "Frances", "Harold", "Dalmatius", 
                        "Edgar", "John", "Benedict", "Paul", "George" }; 
      SortKey[] sortKeys = new SortKey[names.Length];
      CompareInfo ci = CultureInfo.CurrentCulture.CompareInfo;

      for (int ctr = 0; ctr < names.Length; ctr++)
         sortKeys[ctr] = ci.GetSortKey(names[ctr], CompareOptions.IgnoreCase);         
      
      // Sort array based on value of sort keys.
      Array.Sort(names, sortKeys);
      
      Console.WriteLine("Sorted array: ");
      foreach (var name in names)
         Console.WriteLine(name);

      Console.WriteLine();
      
      String[] namesToFind = { "Paul", "PAUL", "Wilberforce" };
      
      Console.WriteLine("Searching an array:");
      foreach (var nameToFind in namesToFind) {
         SortKey searchKey = ci.GetSortKey(nameToFind, CompareOptions.IgnoreCase);
         int index = Array.FindIndex(sortKeys, (x) => x.Equals(searchKey)); 
         if (index >= 0)
            Console.WriteLine("{0} found at index {1}: {2}", nameToFind,
                              index, names[index]);
         else
            Console.WriteLine("{0} not found", nameToFind);
      } 
   }
}
// The example displays the following output:
//       Sorted array:
//       Adam
//       Batholomew
//       Benedict
//       Clement
//       Dalmatius
//       Edgar
//       Frances
//       George
//       Gregory
//       Harold
//       Ignatius
//       John
//       Paul
//       
//       Searching an array:
//       Paul found at index 12: Paul
//       PAUL found at index 12: Paul
//       Wilberforce not found
Imports System.Globalization

Module Example
   Public Sub Main()
      ' Define names.
      Dim names() As String = { "Adam", "Ignatius", "Batholomew", 
                                "Gregory", "Clement", "Frances",  
                                "Harold", "Dalmatius", "Edgar",    
                                "John", "Benedict", "Paul", "George" } 
      Dim sortKeys(names.Length - 1) As SortKey
      Dim ci As CompareInfo = CultureInfo.CurrentCulture.CompareInfo

      For ctr As Integer = 0 To names.Length - 1
         sortKeys(ctr) = ci.GetSortKey(names(ctr), CompareOptions.IgnoreCase)         
      Next   
      
      ' Sort array based on value of sort keys.
      Array.Sort(names, sortKeys)
      
      Console.WriteLine("Sorted array: ")
      For Each name In names
         Console.WriteLine(name)
      Next          
      Console.WriteLine()
      
      Dim namesToFind() As String = { "Paul", "PAUL", "Wilberforce" }
      
      Console.WriteLine("Searching an array:")
      For Each nameToFind In namesToFind
         Dim searchKey As SortKey = ci.GetSortKey(nameToFind, CompareOptions.IgnoreCase)
         Dim index As Integer = Array.FindIndex(sortKeys, 
                                                Function(x) x.Equals(searchKey)) 
         If index >= 0 Then
            Console.WriteLine("{0} found at index {1}: {2}", nameToFind,
                              index, names(index))
         Else
            Console.WriteLine("{0} not found", nameToFind)
         End If                     
      Next                     
   End Sub
End Module
' The example displays the following output:
'       Sorted array:
'       Adam
'       Batholomew
'       Benedict
'       Clement
'       Dalmatius
'       Edgar
'       Frances
'       George
'       Gregory
'       Harold
'       Ignatius
'       John
'       Paul
'       
'       Searching an array:
'       Paul found at index 12: Paul
'       PAUL found at index 12: Paul
'       Wilberforce not found

Комментарии

Сравнение с учетом языка и региональных параметров двух строк зависит от каждого символа в строках, наличие несколько категорий весового значения сортировки, включая скрипт, является буквой алфавита, регистра и диакритических знаков.A culture-sensitive comparison of two strings depends on each character in the strings having several categories of sort weights, including script, alphabetic, case, and diacritic weights. Ключ сортировки служит хранилищем этих значений для определенной строки.A sort key serves as the repository of these weights for a particular string.

CompareInfo.GetSortKey Метод возвращает экземпляр SortKey класс, который отражает региональных сопоставление символов в указанной строке.The CompareInfo.GetSortKey method returns an instance of the SortKey class that reflects the culture-sensitive mapping of characters in a specified string. Значение SortKey объекта является его данных ключа, который возвращается методом KeyData свойство.The value of a SortKey object is its key data, which is returned by the KeyData property. Эти ключевые данные состоит из последовательности байтов, кодировать строки, правила сортировки конкретного языка и региональных параметров и параметров сравнения, определяемые пользователем.This key data consists of a series of bytes that encode the string, culture-specific sorting rules, and user-specified comparison options. Сравнение с помощью ключей сортировки состоит из побитовое сравнение соответствующих данных ключа в каждом ключе сортировки.A comparison using sort keys consists of a bitwise comparison of the corresponding key data in each sort key. Например, при создании ключа сортировки, вызвав GetSortKey(String, CompareOptions) метод со значением CompareOptions.IgnoreCase, операции сравнения строк, который использует ключ сортировки без учета регистра.For example, if you create a sort key by calling the GetSortKey(String, CompareOptions) method with a value of CompareOptions.IgnoreCase, a string comparison operation that uses the sort key is case-insensitive.

После создания ключа сортировки для строки, сравнивать ключи сортировки путем вызова статического SortKey.Compare метод.After you create a sort key for a string, you compare sort keys by calling the static SortKey.Compare method. Этот метод осуществляет сравнение по байтам, так что это намного быстрее, чем String.Compare или CompareInfo.Compare метод.This method performs a simple byte-by-byte comparison, so it is much faster than the String.Compare or CompareInfo.Compare method.

Примечание

Вы можете скачать сортировки таблицы вес, набор текстовых файлов, которые содержат сведения по весу символ, используемый в операциях сортировки и сравнения для операционных систем Windows, Юникода по умолчанию Таблица параметров сортировки элементов, таблицы сортировки вес для Linux и macOS.You can download the Sorting Weight Tables, a set of text files that contain information on the character weights used in sorting and comparison operations for Windows operating systems, the Default Unicode Collation Element Table, the sort weight table for Linux and macOS.

Особенности производительностиPerformance considerations

При выполнении сравнения строк, Compare и CompareInfo.Compare методы дают одинаковые результаты, но они ориентированы на различные сценарии.When performing a string comparison, the Compare and CompareInfo.Compare methods yield the same results, but they target different scenarios.

На высоком уровне CompareInfo.Compare метод создает ключ сортировки для каждой строки, выполняет сравнение и затем удаляет ключ сортировки и возвращает результат сравнения.At a high level, the CompareInfo.Compare method generates the sort key for each string, performs the comparison, and then discards the sort key and returns the result of the comparison. Тем не менее CompareInfo.Compare метод фактически не генерирует ключ сортировки полностью для выполнения сравнения.However, the CompareInfo.Compare method actually doesn't generate an entire sort key to perform the comparison. Вместо этого метод создает данные ключа для каждого элемента текста (т. е базового символа, суррогатная пара или объединенная последовательность символов) в каждой строке.Instead, the method generates the key data for each text element (that is, base character, surrogate pair, or combining character sequence) in each string. Затем метод сравнивает данные ключа для соответствующих элементов текста.The method then compares the key data for the corresponding text elements. Операция заканчивается сразу же определить лучший результат сравнения.The operation terminates as soon as the ultimate result of the comparison is determined. Основные сведения о сортировке является вычисляемым, но не SortKey создается объект.Sort key information is computed, but no SortKey object is created. Эта стратегия является экономичным с точки зрения производительности, если обе строки сравниваются только один раз, но становится высокой, если те же строки сравниваются несколько раз.This strategy is economical in terms of performance if both strings are compared once, but becomes expensive if the same strings are compared many times.

Compare Метод, необходимо сформировать SortKey для каждой строки перед сравнением.The Compare method requires generation of a SortKey object for each string before performing the comparison. Эта стратегия затратными с точки зрения производительности для первого сравнения из-за времени и памяти, значительные средства для создания SortKey объектов.This strategy is expensive in terms of performance for the first comparison because of the time and memory invested to generate the SortKey objects. Тем не менее он становится экономичной, если те же ключи сортировки сравниваются несколько раз.However, it becomes economical if the same sort keys are compared many times.

Например предположим, что написать приложение, которое выполняет таблицу базы данных для строки, в которой столбец индекса на основе строки соответствует заданной строке поиска.For example, suppose you write an application that searches a database table for the row in which the string-based index column matches a specified search string. В таблице содержатся тысячи строк, и сравнение строки поиска по индексу в каждой строке займет много времени.The table contains thousands of rows, and comparing the search string to the index in each row will take a long time. Таким образом когда приложение сохраняет строки со столбцом индекса, он также создает и сохраняет ключ сортировки для индекса в столбце, предназначенном для улучшения производительности при поиске.Therefore, when the application stores a row and its index column, it also generates and stores the sort key for the index in a column dedicated to improving search performance. Когда приложение выполняет поиск в целевой строке, он сравнивает ключ сортировки для строки поиска, ключ сортировки для строки индекса вместо сравнения строки поиска строка индекса.When the application searches for a target row, it compares the sort key for the search string to the sort key for the index string, instead of comparing the search string to the index string.

Замечания по безопасностиSecurity considerations

CompareInfo.GetSortKey(String, CompareOptions) Возвращает SortKey со значением на основе указанной строке и CompareOptions значение, а также язык и региональные параметры, связанные с основной CompareInfo объекта.The CompareInfo.GetSortKey(String, CompareOptions) method returns a SortKey object with the value based on a specified string and CompareOptions value, and the culture associated with the underlying CompareInfo object. Если решение безопасности зависит от того, сравнения строк или изменения регистра, следует использовать CompareInfo.GetSortKey(String, CompareOptions) метод инвариантного языка и региональных параметров для обеспечения согласованности, независимо от настроек языка и региональных параметров операционной системы поведение операции.If a security decision depends on a string comparison or case change, you should use the CompareInfo.GetSortKey(String, CompareOptions) method of the invariant culture to ensure that the behavior of the operation is consistent, regardless of the culture settings of the operating system.

Следуйте инструкциям ниже, чтобы получить ключ сортировки:Use the following steps to obtain a sort key:

  1. Получить инвариантного языка и региональных параметров из CultureInfo.InvariantCulture свойство.Retrieve the invariant culture from the CultureInfo.InvariantCulture property.

  2. Получить CompareInfo объект для инвариантного языка и региональных параметров из CultureInfo.CompareInfo свойство.Retrieve a CompareInfo object for the invariant culture from the CultureInfo.CompareInfo property.

  3. Вызовите метод CompareInfo.GetSortKey(String, CompareOptions).Call the CompareInfo.GetSortKey(String, CompareOptions) method.

Работа со значением SortKey объекта эквивалентно вызову Windows LCMapString метод с указанным значением LCMAP_SORTKEY.Working with the value of a SortKey object is equivalent to calling the Windows LCMapString method with the LCMAP_SORTKEY value specified. Однако для SortKey объекта, ключи сортировки для английского алфавита предшествовать ключи сортировки для корейских символов.However, for the SortKey object, the sort keys for English characters precede the sort keys for Korean characters.

SortKey объекты могут быть сериализованный, но только таким образом, чтобы они может пересекать AppDomain объектов.SortKey objects can be serialized, but only so that they can cross AppDomain objects. Если приложение выполняет сериализацию SortKey объекта, приложение необходимо повторно создать все ключи сортировки, при наличии новой версии платформы .NET Framework.If an application serializes a SortKey object, the application must regenerate all the sort keys when there is a new version of the .NET Framework.

Дополнительные сведения о ключи сортировки, см. в разделе Юникода Technical Standard #10, «Unicode Collation Algorithm» на веб-узле консорциума Юникода.For more information about sort keys, see Unicode Technical Standard #10, "Unicode Collation Algorithm" on the Unicode Consortium website.

Свойства

KeyData KeyData KeyData KeyData

Возвращает массив байтов, представляющий текущий объект SortKey.Gets the byte array representing the current SortKey object.

OriginalString OriginalString OriginalString OriginalString

Возвращает исходную строку, используемую для создания текущего объекта SortKey.Gets the original string used to create the current SortKey object.

Методы

Compare(SortKey, SortKey) Compare(SortKey, SortKey) Compare(SortKey, SortKey) Compare(SortKey, SortKey)

Сравнивает два ключа сортировки.Compares two sort keys.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту SortKey.Determines whether the specified object is equal to the current SortKey object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией текущего объекта SortKey для использования в алгоритмах и структурах данных хеширования, например в хэш-таблице.Serves as a hash function for the current SortKey object that is suitable for hashing algorithms and data structures such as a hash table.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект SortKey.Returns a string that represents the current SortKey object.

Применяется к

Дополнительно