Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Tuple<T1, T2, T3, T4> Class

July 28, 2014

Represents a 4-tuple, or quadruple.

System.Object
  System.Tuple<T1, T2, T3, T4>

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

public class Tuple<T1, T2, T3, T4> : IStructuralComparable, 
	IStructuralEquatable, IComparable

Type Parameters

T1

The type of the tuple's first component.

T2

The type of the tuple's second component.

T3

The type of the tuple's third component.

T4

The type of the tuple's fourth component.

The Tuple<T1, T2, T3, T4> type exposes the following members.

  NameDescription
Public methodTuple<T1, T2, T3, T4>Initializes a new instance of the Tuple<T1, T2, T3, T4> class.
Top

  NameDescription
Public propertyItem1Gets the value of the current Tuple<T1, T2, T3, T4> object's first component.
Public propertyItem2Gets the value of the current Tuple<T1, T2, T3, T4> object's second component.
Public propertyItem3Gets the value of the current Tuple<T1, T2, T3, T4> object's third component.
Public propertyItem4Gets the value of the current Tuple<T1, T2, T3, T4> object's fourth component.
Top

  NameDescription
Public methodEqualsReturns a value that indicates whether the current Tuple<T1, T2, T3, T4> object is equal to a specified object. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for the current Tuple<T1, T2, T3, T4> object. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the value of this Tuple<T1, T2, T3, T4> instance. (Overrides Object.ToString().)
Top

  NameDescription
Explicit interface implemetationPrivate methodIComparable.CompareToCompares the current Tuple<T1, T2, T3, T4> 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 methodIStructuralComparable.CompareToCompares the current Tuple<T1, T2, T3, T4> 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 methodIStructuralEquatable.EqualsReturns a value that indicates whether the current Tuple<T1, T2, T3, T4> object is equal to a specified object based on a specified comparison method.
Explicit interface implemetationPrivate methodIStructuralEquatable.GetHashCodeCalculates the hash code for the current Tuple<T1, T2, T3, T4> object by using a specified computation method.
Top

A tuple is a data structure that has a specific number and sequence of values. The Tuple<T1, T2, T3, T4> class represents a 4-tuple, or quadruple, which is a tuple that has four components.

You can instantiate a Tuple<T1, T2, T3, T4> object by calling either the Tuple<T1, T2, T3, T4> constructor or the static Tuple.Create<T1, T2, T3, T4>(T1, T2, T3, T4) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, and Item4 instance properties.

Tuples are commonly used in four different ways:

  • To represent a single set of data. For example, a tuple can represent a database record, and its components can represent individual fields of the record.

  • To provide easy access to, and manipulation of, a data set. The following example defines an array of Tuple<T1, T2, T3, T4> objects that contain the names of baseball pitchers, the number of innings they pitched, and the number of earned runs (runs that scored without fielding errors), and hits that they gave up. The array is passed to the ComputeStatistics method, which calculates each pitcher's earned run average (the average number of runs given up in a nine-inning game), and the average number of hits given up per inning. The method also uses these two averages to compute a hypothetical effectiveness average.

  • To return multiple values from a method without the use of out parameters (in C#) or ByRef parameters (in Visual Basic). For example, the previous example returns its computed statistics, along with the name of the pitcher, in an array of Tuple<T1, T2, T3, T4> objects.

  • To pass multiple values to a method through a single parameter. For example, the Thread.Start(Object) method has a single parameter that lets you supply one value to the method that the thread executes at startup. If you supply a Tuple<T1, T2, T3, T4> object as the method argument, you can supply the thread’s startup routine with four items of data.

Windows Phone OS

Supported in: 8.1, 8.0

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

Show:
© 2014 Microsoft