Tuple(T1, T2, T3, T4, T5) Class
Represents a 5-tuple, or quintuple.
Assembly: mscorlib (in mscorlib.dll)
[<SerializableAttribute>] type Tuple<'T1, 'T2, 'T3, 'T4, 'T5> = class interface IStructuralEquatable interface IStructuralComparable interface IComparable end
The type of the tuple's first component.
The type of the tuple's second component.
The type of the tuple's third component.
The type of the tuple's fourth component.
The type of the tuple's fifth component.
Thetype exposes the following members.
|Item1||Gets the value of the current object's first component.|
|Item2||Gets the value of the current object's second component.|
|Item3||Gets the value of the current object's third component.|
|Item4||Gets the value of the current object's fourth component.|
|Item5||Gets the value of the current object's fifth component.|
|Equals||Returns a value that indicates whether the current object is equal to a specified object. (Overrides Object.Equals(Object).)|
|Finalize||Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)|
|GetHashCode||Returns the hash code for the current object. (Overrides Object.GetHashCode().)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|MemberwiseClone||Creates a shallow copy of the current Object. (Inherited from Object.)|
|ToString||Returns a string that represents the value of this instance. (Overrides Object.ToString().)|
|IComparable.CompareTo||Compares the current 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.|
|IStructuralComparable.CompareTo||Compares the current 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.|
|IStructuralEquatable.Equals||Returns a value that indicates whether the current object is equal to a specified object based on a specified comparison method.|
|IStructuralEquatable.GetHashCode||Calculates the hash code for the current object by using a specified computation method.|
A tuple is a data structure that has a specific number and sequence of values. The class represents a 5-tuple, or quintuple, which is a tuple that has five components.
You can instantiate a object by calling either the Tuple(T1, T2, T3, T4, T5) constructor or the static Tuple.Create(T1, T2, T3, T4, T5)(T1, T2, T3, T4, T5) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, Item4, and Item5 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 objects that contain the names of running backs in American football, the number of games in which they played, and the number of carries, total yards gained, and touchdowns scored during those games. The array is passed to the ComputeStatistics method, which calculates each running back's number of carries per game, average yards per game, average yards per carry, and average number of touchdowns per attempt.
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 player, in an array of 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 object as the method argument, you can supply the thread’s startup routine with five items of data.