Skip to content

Commit c88f7bf

Browse files
committed
Update SurvivedMemoryMetricDescriptor legend.
Add extra Measurement constructor to preserve old way. Re-add MemoryDiagnoserAttribute paramterless constructor.
1 parent 7647117 commit c88f7bf

File tree

3 files changed

+17
-3
lines changed

3 files changed

+17
-3
lines changed

src/BenchmarkDotNet/Attributes/MemoryDiagnoserAttribute.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ public class MemoryDiagnoserAttribute : Attribute, IConfigSource
99
{
1010
public IConfig Config { get; }
1111

12-
public MemoryDiagnoserAttribute(bool includeSurvived = false)
12+
public MemoryDiagnoserAttribute() : this(false) { }
13+
14+
public MemoryDiagnoserAttribute(bool includeSurvived)
1315
{
1416
Config = ManualConfig.CreateEmpty().AddDiagnoser(includeSurvived ? MemoryDiagnoser.WithSurvived : MemoryDiagnoser.Default);
1517
}

src/BenchmarkDotNet/Diagnosers/MemoryDiagnoser.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ private class SurvivedMemoryMetricDescriptor : IMetricDescriptor
6868

6969
public string Id => "Survived Memory";
7070
public string DisplayName => "Survived";
71-
public string Legend => "Total application memory consumed after all operations, including Cleanups (managed only, inclusive, 1KB = 1024B)";
71+
public string Legend => "Total memory survived after all operations (managed only, inclusive, 1KB = 1024B)";
7272
public string NumberFormat => "N0";
7373
public UnitType UnitType => UnitType.Size;
7474
public string Unit => SizeUnit.B.Name;

src/BenchmarkDotNet/Reports/Measurement.cs

+13-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public struct Measurement : IComparable<Measurement>
2121
private const string OpSymbol = "op";
2222
private const string SBSymbol = "B";
2323

24-
private static Measurement Error() => new Measurement(-1, IterationMode.Unknown, IterationStage.Unknown, 0, 0, 0, 0);
24+
private static Measurement Error() => new Measurement(-1, IterationMode.Unknown, IterationStage.Unknown, 0, 0, 0);
2525

2626
private static readonly int IterationInfoNameMaxWidth
2727
= Enum.GetNames(typeof(IterationMode)).Max(text => text.Length) + Enum.GetNames(typeof(IterationStage)).Max(text => text.Length);
@@ -49,6 +49,18 @@ private static readonly int IterationInfoNameMaxWidth
4949
/// </summary>
5050
public long SurvivedBytes { get; }
5151

52+
/// <summary>
53+
/// Creates an instance of <see cref="Measurement"/> struct.
54+
/// </summary>
55+
/// <param name="launchIndex"></param>
56+
/// <param name="iterationMode"></param>
57+
/// <param name="iterationStage"></param>
58+
/// <param name="iterationIndex"></param>
59+
/// <param name="operations">The number of operations performed.</param>
60+
/// <param name="nanoseconds">The total number of nanoseconds it took to perform all operations.</param>
61+
public Measurement(int launchIndex, IterationMode iterationMode, IterationStage iterationStage, int iterationIndex, long operations, double nanoseconds)
62+
: this(launchIndex, iterationMode, iterationStage, iterationIndex, operations, nanoseconds, 0) { }
63+
5264
/// <summary>
5365
/// Creates an instance of <see cref="Measurement"/> struct.
5466
/// </summary>

0 commit comments

Comments
 (0)