{"id":1399,"date":"2023-04-05T13:11:01","date_gmt":"2023-04-05T06:11:01","guid":{"rendered":"https:\/\/csharptutorial.net\/?page_id=1399"},"modified":"2023-06-16T19:10:06","modified_gmt":"2023-06-16T12:10:06","slug":"csharp-tuples","status":"publish","type":"page","link":"https:\/\/www.csharptutorial.net\/csharp-tutorial\/csharp-tuples\/","title":{"rendered":"C# Tuples"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use C# tuples to represent a set of values as a single unit.<\/p>\n\n\n\n

Introduction to the C# tuples<\/h2>\n\n\n\n

A tuple allows you to represent a set of values as a single unit. The type of tuples is System.ValueTuple<\/code>.<\/p>\n\n\n\n

Creating tuples & accessing elements<\/h3>\n\n\n\n

The following shows how to create a new tuple type:<\/p>\n\n\n

using<\/span> static<\/span> System.Console;\n\nvar<\/span> person = (\"John Doe\"<\/span>, 22<\/span>);\nWriteLine(person);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
(John Doe, 22<\/span>)<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
In this example, we define a tuple named person<\/code> with two fields. The first field is a string that represents the person’s name and the second field is an integer that represents the person’s age.<\/p>\n\n\n\n
To access a field, you use the dot syntax:<\/p>\n\n\n
tuple.field<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Because fields of the person<\/code> tuple have no names, C# assigns default field names to them as Item1<\/code>, Item2<\/code>, etc. For example:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nvar<\/span> person = (\"John Doe\"<\/span>, 22<\/span>);\n\nWriteLine($\"Name: {person.Item1}<\/span>, Age: {person.Item2}<\/span>\"<\/span>);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
Name: John Doe, Age: 22<\/span><\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
To assign names to the fields of the tuple, you can use the following syntax:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nvar<\/span> person = (Name: \"John Doe\"<\/span>, Age: 22<\/span>) ;\n\nWriteLine($\"Name: {person.Name}<\/span>, Age: {person.Age}<\/span>\"<\/span>);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
In this example, we assign names to the fields of the person<\/code> tuple and access their values via the field names.<\/p>\n\n\n\n
Deconstructing tuple elements<\/h3>\n\n\n\n
Deconstructing a tuple means assigning elements of the tuple to multiple variables<\/a>. To deconstruct elements of a tuple, you use the =<\/code> operator. For example:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nvar<\/span> point = (10<\/span>,20<\/span>);\n\nvar<\/span> (x,y) = point; \/\/ deconstructing a tuple<\/span>\n\nWriteLine($\"x:{x}<\/span>, y:{y}<\/span>\"<\/span>);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
x:10<\/span>, y:20<\/span><\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
In this example, we assign the first and second elements of a tuple to the x<\/code> and y<\/code> variables.<\/p>\n\n\n\n
You can also specify the types of variables explicitly when deconstructing a tuple:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nvar<\/span> point = (10<\/span>,20<\/span>);\n\n(int<\/span> x,int<\/span> y) = point; \/\/ deconstructing a tuple<\/span>\n\nWriteLine($\"x:{x}<\/span>, y:{y}<\/span>\"<\/span>);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Returning tuples<\/h3>\n\n\n\n
Tuples are useful when you want to return multiple values from a method. For example:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nstatic<\/span> (int<\/span> sum, int<\/span> product) Calculate(int<\/span> x, int<\/span> y)\n{\n    return<\/span> (x + y, x * y);\n}\n\nvar<\/span> result = Calculate(20<\/span>, 30<\/span>);\n\nWriteLine(result.sum);     \/\/ output: 50<\/span>\nWriteLine(result.product); \/\/ output: 600<\/span><\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
In this example, the method Calculate<\/code> returns a named tuple with two elements: sum<\/code> and product<\/code>. When calling the method, we can assign the returned tuple to a variable result<\/code> and access its elements using dot notation.<\/p>\n\n\n\n
Note that you can deconstruct the tuple returned by the method like this:<\/p>\n\n\n
using<\/span> static<\/span> System.Console;\n\nstatic<\/span> (int<\/span> sum, int<\/span> product) Calculate(int<\/span> x, int<\/span> y)\n{\n    return<\/span> (x + y, x * y);\n}\n\nvar<\/span> (sum,product) = Calculate(20<\/span>, 30<\/span>);\n\nWriteLine(sum);     \/\/ output: 50<\/span>\nWriteLine(product); \/\/ output: 600<\/span><\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Comparing Tuples<\/h3>\n\n\n\n
Tuples support the ==<\/code> and !=<\/code> operators. Two tuples are comparable when they comply with the following conditions:<\/p>\n\n\n\n
    \n
  • Both tuples have the same number of elements.<\/li>\n\n\n\n
  • The corresponding tuple elements are comparable using the ==<\/code> and !=<\/code> operators.<\/li>\n<\/ul>\n\n\n\n
    For example, the following example will result in an error because the number of elements is different:<\/p>\n\n\n
    var<\/span> point2D = (10<\/span>,20<\/span>);\nvar<\/span> point3D = (10<\/span>,20<\/span>,30<\/span>);\n\npoint2D == point3D; \/\/ ERROR<\/span><\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
    The following example demonstrates that two tuples are equal:<\/p>\n\n\n
    using<\/span> static<\/span> System.Console;\n\nvar<\/span> point1 = (10<\/span>,20<\/span>,30<\/span>);\nvar<\/span> point2 = (10<\/span>, 20<\/span>,30<\/span>);\n\nvar<\/span> result = point1 == point2;\nWriteLine($\"Result:{result}<\/span>\"<\/span>);<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
    Output:<\/p>\n\n\n
    Result:True<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
    System.ValueTuple vs. System.Tuple<\/h2>\n\n\n\n
    So far, you have learned the tuples that belong to the System.ValueTuple<\/code> type. They are completely different from tuples backed by the System.Tuple<\/code> types. <\/p>\n\n\n\n
    The following table illustrates the main differences:<\/p>\n\n\n\n
    System.ValueTupe<\/th>System.Tuple<\/th><\/tr><\/thead>
    Tuples are value types<\/td>Tuples are reference types<\/td><\/tr>
    Tuples are mutable<\/td>Tuples are immutable<\/td><\/tr>
    Data members are fields<\/td>Data members are properties<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Summary<\/h2>\n\n\n\n
      \n
    • Use a tuple to represent a set of values as a single variable.<\/li>\n\n\n\n
    • Do use tuples to make your code more readable and expressive.<\/li>\n<\/ul>\n
      \n\t
      \n\t\t
      Was this tutorial helpful ?<\/div>\n\t\t
      \n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t
      \n\t\t
      \n\t\t\t
      <\/div>\n\t\t\t\n\t\t\t