ParallelExecutionMode.xml 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="ParallelExecutionMode" FullName="System.Linq.ParallelExecutionMode">
  3. <TypeSignature Language="C#" Value="public enum ParallelExecutionMode" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed ParallelExecutionMode extends System.Enum" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.Core</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Enum</BaseTypeName>
  11. </Base>
  12. <Docs>
  13. <remarks>To be added.</remarks>
  14. <summary>
  15. <attribution license="cc4" from="Microsoft" modified="false" />
  16. <para>The query execution mode is a hint that specifies how the system should handle performance trade-offs when parallelizing queries.</para>
  17. </summary>
  18. </Docs>
  19. <Members>
  20. <Member MemberName="Default">
  21. <MemberSignature Language="C#" Value="Default" />
  22. <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Linq.ParallelExecutionMode Default = int32(0)" />
  23. <MemberType>Field</MemberType>
  24. <AssemblyInfo>
  25. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  26. </AssemblyInfo>
  27. <ReturnValue>
  28. <ReturnType>System.Linq.ParallelExecutionMode</ReturnType>
  29. </ReturnValue>
  30. <Docs>
  31. <summary>
  32. <attribution license="cc4" from="Microsoft" modified="false" />
  33. <para>This is the default setting. PLINQ will examine the query's structure and will only parallelize the query if will likely result in speedup. If the query structure indicates that speedup is not likely to be obtained, then PLINQ will execute the query as an ordinary LINQ to Objects query.</para>
  34. </summary>
  35. </Docs>
  36. </Member>
  37. <Member MemberName="ForceParallelism">
  38. <MemberSignature Language="C#" Value="ForceParallelism" />
  39. <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Linq.ParallelExecutionMode ForceParallelism = int32(1)" />
  40. <MemberType>Field</MemberType>
  41. <AssemblyInfo>
  42. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  43. </AssemblyInfo>
  44. <ReturnValue>
  45. <ReturnType>System.Linq.ParallelExecutionMode</ReturnType>
  46. </ReturnValue>
  47. <Docs>
  48. <summary>
  49. <attribution license="cc4" from="Microsoft" modified="false" />
  50. <para>Parallelize the entire query, even if that means using high-overhead algorithms. Use this flag in cases where you know that parallel execution of the query will result in speedup, but PLINQ in the Default mode would execute it as sequential.</para>
  51. </summary>
  52. </Docs>
  53. </Member>
  54. </Members>
  55. </Type>