Partitioner.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / clr / src / BCL / System / Collections / Concurrent / Partitioner.cs / 1305376 / Partitioner.cs
                        

                        
                            // ==++== 
//
//   Copyright (c) Microsoft Corporation.  All rights reserved.
//
// ==--== 
// =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
// 
// Partitioner.cs 
//
// [....] 
//
// Represents a particular way of splitting a collection into multiple partitions.
//
// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- 

using System; 
using System.Collections.Generic; 
using System.Security.Permissions;
using System.Threading; 

namespace System.Collections.Concurrent
{
    ///  
    /// Represents a particular manner of splitting a data source into multiple partitions.
    ///  
    /// Type of the elements in the collection. 
    /// 
    ///  
    /// Inheritors of  must adhere to the following rules:
    /// 
    
    /// 
  1.  should throw a
    ///  if the requested partition count is less than or 
    /// equal to zero.
    2. 
    /// 
  2.  should always return a number of enumerables equal to the requested 
    /// partition count. If the partitioner runs out of data and cannot create as many partitions as 
    /// requested, an empty enumerator should be returned for each of the remaining partitions. If this rule
    /// is not followed, consumers of the implementation may throw a .
    3. 
    /// 
  3.  and 
    /// should never return null. If null is returned, a consumer of the implementation may throw a
    /// .
    4.  
    /// 
  4.  and  should always return
    /// partitions that can fully and uniquely enumerate the input data source. All of the data and only the 
    /// data contained in the input source should be enumerated, with no duplication that was not already in 
    /// the input, unless specifically required by the particular partitioner's design. If this is not
    /// followed, the output ordering may be scrambled.
    5.  
    /// 

    /// 
    /// 
    [HostProtection(Synchronization = true, ExternalThreading = true)] 
    public abstract class Partitioner
    { 
        ///  
        /// Partitions the underlying collection into the given number of partitions.
        ///  
        /// The number of partitions to create.
        /// A list containing  enumerators.
        public abstract IList> GetPartitions(int partitionCount);
 
        /// 
        /// Gets whether additional partitions can be created dynamically. 
        ///  
        /// 
        /// true if the  can create partitions dynamically as they are 
        /// requested; false if the  can only allocate
        /// partitions statically.
        /// 
        ///  
        /// 
        /// If a derived class does not override and implement , 
        ///  should return false. The value of  should not vary over the lifetime of this instance.
        ///  
        /// 
        public virtual bool SupportsDynamicPartitions
        {
            get { return false; } 
        }
 
        ///  
        /// Creates an object that can partition the underlying collection into a variable number of
        /// partitions. 
        /// 
        /// 
        /// 
        /// The returned object implements the  interface. Calling GetEnumerator on the 
        /// object creates another partition over the sequence. 
        /// 
        ///  
        /// The  method is only supported if the 
        /// property returns true.
        ///  
        /// 
        /// An object that can create partitions over the underlying data source. 
        /// Dynamic partitioning is not supported by this 
        /// partitioner.
        public virtual IEnumerable GetDynamicPartitions() 
        {
            throw new NotSupportedException(Environment.GetResourceString("Partitioner_DynamicPartitionsNotSupported"));
        }
    } 
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// ==++== 
//
//   Copyright (c) Microsoft Corporation.  All rights reserved.
//
// ==--== 
// =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
// 
// Partitioner.cs 
//
// [....] 
//
// Represents a particular way of splitting a collection into multiple partitions.
//
// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- 

using System; 
using System.Collections.Generic; 
using System.Security.Permissions;
using System.Threading; 

namespace System.Collections.Concurrent
{
    ///  
    /// Represents a particular manner of splitting a data source into multiple partitions.
    ///  
    /// Type of the elements in the collection. 
    /// 
    ///  
    /// Inheritors of  must adhere to the following rules:
    /// 
    
    /// 
  1.  should throw a
    ///  if the requested partition count is less than or 
    /// equal to zero.
    2. 
    /// 
  2.  should always return a number of enumerables equal to the requested 
    /// partition count. If the partitioner runs out of data and cannot create as many partitions as 
    /// requested, an empty enumerator should be returned for each of the remaining partitions. If this rule
    /// is not followed, consumers of the implementation may throw a .
    3. 
    /// 
  3.  and 
    /// should never return null. If null is returned, a consumer of the implementation may throw a
    /// .
    4.  
    /// 
  4.  and  should always return
    /// partitions that can fully and uniquely enumerate the input data source. All of the data and only the 
    /// data contained in the input source should be enumerated, with no duplication that was not already in 
    /// the input, unless specifically required by the particular partitioner's design. If this is not
    /// followed, the output ordering may be scrambled.
    5.  
    /// 

    /// 
    /// 
    [HostProtection(Synchronization = true, ExternalThreading = true)] 
    public abstract class Partitioner
    { 
        ///  
        /// Partitions the underlying collection into the given number of partitions.
        ///  
        /// The number of partitions to create.
        /// A list containing  enumerators.
        public abstract IList> GetPartitions(int partitionCount);
 
        /// 
        /// Gets whether additional partitions can be created dynamically. 
        ///  
        /// 
        /// true if the  can create partitions dynamically as they are 
        /// requested; false if the  can only allocate
        /// partitions statically.
        /// 
        ///  
        /// 
        /// If a derived class does not override and implement , 
        ///  should return false. The value of  should not vary over the lifetime of this instance.
        ///  
        /// 
        public virtual bool SupportsDynamicPartitions
        {
            get { return false; } 
        }
 
        ///  
        /// Creates an object that can partition the underlying collection into a variable number of
        /// partitions. 
        /// 
        /// 
        /// 
        /// The returned object implements the  interface. Calling GetEnumerator on the 
        /// object creates another partition over the sequence. 
        /// 
        ///  
        /// The  method is only supported if the 
        /// property returns true.
        ///  
        /// 
        /// An object that can create partitions over the underlying data source. 
        /// Dynamic partitioning is not supported by this 
        /// partitioner.
        public virtual IEnumerable GetDynamicPartitions() 
        {
            throw new NotSupportedException(Environment.GetResourceString("Partitioner_DynamicPartitionsNotSupported"));
        }
    } 
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK