Tuple(T1, T2, T3) Class
TOC
Collapse the table of content
Expand the table of content

Tuple<'T1, 'T2, 'T3> Class

 

Represents a 3-tuple, or triple.

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

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

[<SerializableAttribute>]
type Tuple<'T1, 'T2, 'T3> = 
    class
        interface IStructuralEquatable
        interface IStructuralComparable
        interface IComparable
    end

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.

NameDescription
System_CAPS_pubmethodTuple<'T1, 'T2, 'T3>('T1, 'T2, 'T3)

Initializes a new instance of the Tuple<'T1, 'T2, 'T3> class.

NameDescription
System_CAPS_pubpropertyItem1

Gets the value of the current Tuple<'T1, 'T2, 'T3> object's first component.

System_CAPS_pubpropertyItem2

Gets the value of the current Tuple<'T1, 'T2, 'T3> object's second component.

System_CAPS_pubpropertyItem3

Gets the value of the current Tuple<'T1, 'T2, 'T3> object's third component.

NameDescription
System_CAPS_pubmethodEquals(Object)

Returns a value that indicates whether the current Tuple<'T1, 'T2, 'T3> object is equal to a specified object.(Overrides Object.Equals(Object).)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for the current Tuple<'T1, 'T2, 'T3> object.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the value of this Tuple<'T1, 'T2, 'T3> instance.(Overrides Object.ToString().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStructuralComparable.CompareTo(Object, IComparer)

Compares the current Tuple<'T1, 'T2, 'T3> 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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStructuralEquatable.Equals(Object, IEqualityComparer)

Returns a value that indicates whether the current Tuple<'T1, 'T2, 'T3> object is equal to a specified object based on a specified comparison method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStructuralEquatable.GetHashCode(IEqualityComparer)

Calculates the hash code for the current Tuple<'T1, 'T2, 'T3> object by using a specified computation method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIComparable.CompareTo(Object)

Compares the current Tuple<'T1, 'T2, 'T3> 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.

A tuple is a data structure that has a specific number and sequence of values. The Tuple<'T1, 'T2, 'T3> class represents a 3-tuple, or triple, which is a tuple that has three components.

You can instantiate a Tuple<'T1, 'T2, 'T3> object by calling either the Tuple<'T1, 'T2, 'T3> constructor or the static Tuple.Create<'T1, 'T2, 'T3>('T1, 'T2, 'T3) method. You can retrieve the values of the tuple's components by using the read-only Item1, Item2, and Item3 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> objects that contain the names of students, their average test scores, and the number of tests taken. The array is passed to the ComputeStatistics method, which calculates the mean and standard deviation of the test scores.

    No code example is currently available or this language may not be supported.
  • 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 summary test score statistics in a Tuple<'T1, 'T2, 'T3> object.

  • 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> object as the method argument, you can supply the thread’s startup routine with three items of data.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1

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

Return to top
Show:
© 2016 Microsoft