mcs/class/corlib/Documentation/en/System/Comparison`1.xml

   1 <Type Name="Comparison&lt;T&gt;" FullName="System.Comparison&lt;T&gt;">
   2   <TypeSignature Language="C#" Value="public delegate int Comparison&lt;in T&gt;(T x, T y);" />
   3   <AssemblyInfo>
   4     <AssemblyName>mscorlib</AssemblyName>
   5     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   6     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <TypeParameters>
   9     <TypeParameter Name="T">
  10       <Constraints>
  11         <ParameterAttribute>Contravariant</ParameterAttribute>
  12       </Constraints>
  13     </TypeParameter>
  14   </TypeParameters>
  15   <Base>
  16     <BaseTypeName>System.Delegate</BaseTypeName>
  17   </Base>
  18   <Parameters>
  19     <Parameter Name="x" Type="T" />
  20     <Parameter Name="y" Type="T" />
  21   </Parameters>
  22   <ReturnValue>
  23     <ReturnType>System.Int32</ReturnType>
  24   </ReturnValue>
  25   <Docs>
  26     <typeparam name="T">To be added.</typeparam>
  27     <param name="x">The first object to compare.</param>
  28     <param name="y">The second object to compare.</param>
  29     <summary>
  30       <para>Represents the method that compares two objects of the same type.</para>
  31     </summary>
  32     <value>
  33       <para>A <see cref="T:System.Int32" /> containing a value that reflects the sort order of the objects.</para>
  34       <list type="table">
  35         <listheader>
  36           <term>Value</term>
  37           <description>Condition</description>
  38         </listheader>
  39         <item>
  40           <term>Less than zero</term>
  41           <description>
  42             <paramref name="x" /> is less than <paramref name="y" />.</description>
  43         </item>
  44         <item>
  45           <term>Zero
  46    </term>
  47           <description>
  48             <paramref name="x" /> equals <paramref name="y" />.</description>
  49         </item>
  50         <item>
  51           <term>Greater than zero</term>
  52           <description>
  53             <paramref name="x" /> is greater than <paramref name="y" />.</description>
  54         </item>
  55       </list>
  56     </value>
  57     <value>
  58       <para>A <see cref="T:System.Int32" /> containing a value that reflects the sort order of the objects.</para>
  59       <list type="table">
  60         <listheader>
  61           <term>Value</term>
  62           <description>Condition</description>
  63         </listheader>
  64         <item>
  65           <term>Less than zero</term>
  66           <description>
  67             <paramref name="x" /> is less than <paramref name="y" />.</description>
  68         </item>
  69         <item>
  70           <term>Zero
  71    </term>
  72           <description>
  73             <paramref name="x" /> equals <paramref name="y" />.</description>
  74         </item>
  75         <item>
  76           <term>Greater than zero</term>
  77           <description>
  78             <paramref name="x" /> is greater than <paramref name="y" />.</description>
  79         </item>
  80       </list>
  81     </value>
  82     <value>To be added.</value>
  83     <remarks>
  84       <block subset="none" type="note">
  85         <para>This delegate is used by the method <see cref="M:System.Array.Sort(T[], Comparison&lt;T&gt;)" /><see langword="(T[], Comparison&lt;T&gt;)" />, and in <see cref="T:System.Collections.Generic.List&lt;T&gt; " />to sort the elements of the collection.</para>
  86       </block>
  87     </remarks>
  88     <since version=".NET 2.0" />
  89   </Docs>
  90 </Type>