Fortsätt till huvudinnehåll

When to use out parameters in C#

The out keyword

In C# you can use the out keyword to define output parameters in your method signature. For example, the Int32.TryParse method in the System namespace has the following signature:

public static bool Int32.TryParse(string s, out int result)

From this you can read out that the TryParse method returns a boolean but also provides a result as an out parameter. The boolean will indicate whether it was possible to parse an integer value from the string s and store it in the result variable.

You can call the TryParse method like this:

 if (Int32.TryParse(str, out var result))
{
    Console.WriteLine($"The result is: {result}");
}
else
{
    Console.WriteLine("Parsing failed");
}

When is it a good idea to use out parameters?

Most of the time the use of out parameters adds complexity to your program. It will make the source code harder to follow since anyone reading the code will have to juggle several return values instead of just one.

One of the most important jobs as a programmer is to minimize complexity, hence you should avoid using out parameters and as much as possible write simple methods that returns a single, obvious, result. However, there are a couple of use cases when out parameters can be useful.

The Try-Parse Pattern

I have already showed the Try-Parse Pattern in action when showing the Int32.TryParse method above. The pattern is useful in situations where the operation might fail and you want to avoid the overhead of dealing with exceptions. Throwing and catching exceptions is very bad for performance and using the Try-Parse Pattern can be a good alternative.

Returning multiple values

There might be situations where you want a method to be able to return multiple values. You could create a separate struct just for holding these values and let the method return an instance of that struct, also known as a Value object. However, if the usage is very limited, introducing a separate struct just for holding a few values might add more complexity than just introducing a few out parameters. If in doubt, create both implementations and use your best judgement on which one to keep.

Additional resources

Out parameter modifier
Exceptions and Performance (Try-Parse Pattern)
Value object

Kommentarer

Skicka en kommentar

Populära inlägg i den här bloggen

Does TDD really improve software quality?

I have asked myself this question several times, and searched for answers, without coming up with any clear answer. Therefore I have decided to go hard core TDD for a longer period of time (at least 6 months) to really evaluate the effects. There are several things that I find confusing when it comes to TDD. One example is what actually defines a unit test. What is a "unit" anyway? After reading a bit about it I found a text claiming that the "unit" is "a unit of work", i.e. something quite small. Like converting a string to UPPERCASE or splitting a string into an ['a','r', 'r', 'a', 'y'] of chars. This work is usually performed by a single call to a single method in a single, isolated, class. So, what does it mean that a class is isolated? Does it mean that it doesn't have any dependencies to other classes? NO! In the context of TDD it means that any dependencies are supplied by the test environment, for exa...
3 kommentarer
Läs mer

Codility tasks - Part I

I was recently faced with two codility tasks when applying for a job as an Embedded Software Engineer. For those of you who arn't familiar with Codility you can check out their website here:  www.codility.com Task one - Dominator The first task was called Dominator. The goal was to, given a std::vector of integers, find an integer that occurs in more than half of the positions in the vector. If no dominator was found -1 should be returned. My approach was to loop through the vector from the first to the last element, using a std::map to count the number of occurences of each integer. If the count ever reached above half the size of the vector I stopped and returned that integer and if I reached the end without finding a dominator I returned -1. So was that a good approach? Well, the reviewer at the company rated the solution as 'pretty ok'. His preferred solution was store the first integer in the array and set a counter to 1. Then loop through the remaining i...
7 kommentarer
Läs mer

Codility tasks - Part II

Now, the second codility task I was faced with was a bit tougher. The goal was to create a function that, given a vector of integers A and an integer K, returned the number of integer pairs in the vector that, when added, sums up to K. Let me give you an example. Assume that you are given a vector A = [0, -1, 3, 2, -5, 7] and K = 2. Possible combinations to get K are (0, 2), (-1, 3), (3, -1), (2, 0),  (-5, 7), and (7, -5). In other words, the function should return 6. Now, how did I solve this task? The first solution that came to mind involved nested for-loops. The outer loop picking one integer at the time from the vector and the inner loop adding the integer to the others one by one to see if the result is K. This solution works, but it does not scale well. Time complexity will be O(N**2) ,   something that for large vectors will result in very long execution times. My second approach was to use my old friend, the integer counter, and count all occurences of each...
2 kommentarer
Läs mer