Tuple<T1> Class

Represents a 1-tuple, or singleton.

Inheritance Hierarchy

System.Object
  System.Tuple<T1>

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Class Tuple(Of T1) _
    Implements IStructuralEquatable, IStructuralComparable, IComparable
public class Tuple<T1> : IStructuralEquatable, IStructuralComparable, 
    IComparable

Type Parameters

  • T1
    The type of the tuple's only component.

The Tuple<T1> type exposes the following members.

Constructors

  Name Description
Public method Tuple<T1> Initializes a new instance of the Tuple<T1> class.

Top

Properties

  Name Description
Public property Item1 Gets the value of the Tuple<T1> object's single component.

Top

Methods

  Name Description
Public method Equals Returns a value that indicates whether the current Tuple<T1> object is equal to a specified object. (Overrides Object.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for the current Tuple<T1> object. (Overrides Object.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the value of this Tuple<T1> instance. (Overrides Object.ToString().)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IComparable.CompareTo Compares the current Tuple<T1> object to a specified object, and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.
Explicit interface implemetationPrivate method IStructuralComparable.CompareTo Compares the current Tuple<T1> object to a specified object by using a specified comparer, and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.
Explicit interface implemetationPrivate method IStructuralEquatable.Equals Returns a value that indicates whether the current Tuple<T1> object is equal to a specified object based on a specified comparison method.
Explicit interface implemetationPrivate method IStructuralEquatable.GetHashCode Calculates the hash code for the current Tuple<T1> object by using a specified computation method.

Top

Remarks

A tuple is a data structure that has a specific number and sequence of values. The Tuple<T1> class represents a 1-tuple, or singleton, which is a tuple that has a single component. A singleton is used comparatively rarely in application development.

You can instantiate a Tuple<T1> object by calling either the Tuple<T1> constructor or the static Tuple.Create method. You can retrieve the value of the tuple's single component by using the read-only Item1 instance property.

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.