CODEWITHSUNDEEP
c#arrays
devuxer
devuxer

Reputation: 42354

How does Array.GetLength(dimension) in C# actually work?

When using Array.GetLength(dimension) in C#, does the size of the array actually get calculated each time it is called, or is the size cached/stored and that value just gets accessed?

What I really want to know is if setting a local variable to the length of the dimension of an array would add any efficiency if used inside a big loop or if I can just call array.GetLength() over and over w/o any speed penalty.

Upvotes: 8

Views: 4645

Answers (4)

Henk Holterman
Henk Holterman

Reputation: 273209

It is most certainly a bad idea to start caching/optimizing by yourself here.

When dealing with arrays, you have to follow a standard path that the (JIT) optimizer can recognize. If you do, not only will the Length property be cached but more important the index bounds-check can be done just once before the loop.

When the optimizer loses your trail you will pay the penalty of a per-access bounds-check.

This is why jagged arrays (int[][]) are faster than multi-dim (int[,]). The optimization for int[,] is simply missing. Up to Fx2 anyway, I didn't check the status of this in Fx4 yet.

If you want to research this further, the caching you propose is usually called 'hoisting' the Length property.

Upvotes: 11

Guffa
Guffa

Reputation: 700262

If you really need the loop to be as fast as possible, you can store the length in a variable. This will give you a slight performance increase, some quick testing that I did shows that it's about 30% faster.

As the difference isn't bigger, it shows that the GetLength method is really fast. Unless you really need to cram the last out of the code, you should just use the method in the loop.

This goes for multidimensional arrays, only. For a single dimensional array it's actually faster to use the Length property in the loop, as the optimiser then can remove bounds checks when you use the array in the loop.

Upvotes: 0

Jason Williams
Jason Williams

Reputation: 57902

The naming convention is a clue. THe "Length" methods (e.g. Array.Length) in .net typically return a known value, while the "Count" methods (e.g. List.Count) will/may enumerate the contents of the collection to work out the number of items. (In later .nets there are extension methods like Any that allow you to check if a collection is non-empty without having to use the potentially expensive Count operation) GetLength should only differ from Length in that you can request the dimension you want the length of.

A local variable is unlikely to make any difference over a call to GetLength - the compiler will optimise most situations pretty well anyway - or you could use foreach which does not need to determine the length before it starts.

(But it would be easy to write a couple of loops and time them (with a high performance counter) to see what effect different calls/types might have on the execution speed. Doing this sort of quick test can be a great way of gaining insights into a language that you might not really take in if you just read the answers)

Upvotes: -1

Brennan Vincent
Brennan Vincent

Reputation: 10665

It is probably inserted at compile time if it is known then. Otherwise, stored in a variable. If it weren't, how would the size be calculated?

However, you shouldn't make assumptions about the internal operations of the framework. If you want to know if something is more or less efficient, test it!

Upvotes: 0

Related Questions