Skip to content

Fix display strings for multidimensional array parameters (fixes #2891) #2892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timcassell merged 4 commits into from
Dec 3, 2025
+32 −1
Merged

Fix display strings for multidimensional array parameters (fixes #2891) #2892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40c6ff8
Show dimensions of arrays in parameter display string
User0332 Dec 3, 2025
d2c5887
Add test for multidimensional array display string
User0332 Dec 3, 2025
2734373
Remove leftover comment from multidimensional array test
User0332 Dec 3, 2025
79653c9
Remove unnecessary code from multidimensional array test
User0332 Dec 3, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/BenchmarkDotNet/Code/ArrayParam.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ namespace BenchmarkDotNet.Code
internal static class ArrayParam
{
public static string GetDisplayString(Array array)
=> $"{array.GetType().GetElementType()?.GetDisplayName()}[{array.Length}]";
{
string dimensionRepr = string.Join(", ", Enumerable.Range(0, array.Rank).Select(array.GetLength));

return $"{array.GetType().GetElementType()?.GetDisplayName()}[{dimensionRepr}]";
}
}

public class ArrayParam<T> : IParam
Expand Down
27 changes: 27 additions & 0 deletions tests/BenchmarkDotNet.IntegrationTests/ArgumentsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,33 @@ public void AcceptsArrays2(int[] arr)
}
}

[Theory, MemberData(nameof(GetToolchains), DisableDiscoveryEnumeration = true)]
public void MultidimensionalArraysAreProperlyDisplayed(IToolchain toolchain)
{
var summary = CanExecute<WithMultidimensionalArrayArgument>(toolchain);

Assert.Equal(
"Int32[2, 3]",
summary.Table.Columns.Where(col => col.Header == "arr").First().Content[0]
);
}

public class WithMultidimensionalArrayArgument
{
public IEnumerable<int[,]> GetArrays()
{
yield return new int[,] { { 1, 2, 3 }, { 4, 5, 6 } };
}

[Benchmark]
[ArgumentsSource(nameof(GetArrays))]
public void AcceptsMultidimensionalArray(int[,] arr)
{
if (arr.Length == 0)
throw new ArgumentException("Incorrect length");
}
}

[Theory, MemberData(nameof(GetToolchains), DisableDiscoveryEnumeration = true)]
public void VeryBigIntegersAreSupported(IToolchain toolchain) => CanExecute<WithVeryBigInteger>(toolchain);

Expand Down