Struct GcStats

Implements
Namespace: BenchmarkDotNet.Engines
Assembly: BenchmarkDotNet.dll
Syntax
public struct GcStats : IEquatable<GcStats>

Fields

AllocationQuantum

Declaration
public static readonly long AllocationQuantum
Field Value
Type Description
Int64

Empty

Declaration
public static readonly GcStats Empty
Field Value
Type Description
GcStats

Properties

Gen0Collections

Declaration
public readonly int Gen0Collections { get; }
Property Value
Type Description
Int32

Gen1Collections

Declaration
public readonly int Gen1Collections { get; }
Property Value
Type Description
Int32

Gen2Collections

Declaration
public readonly int Gen2Collections { get; }
Property Value
Type Description
Int32

TotalOperations

Declaration
public readonly long TotalOperations { get; }
Property Value
Type Description
Int64

Methods

Equals(GcStats)

Declaration
public bool Equals(GcStats other)
Parameters
Type Name Description
GcStats other
Returns
Type Description
Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

FromForced(Int32)

Declaration
public static GcStats FromForced(int forcedFullGarbageCollections)
Parameters
Type Name Description
Int32 forcedFullGarbageCollections
Returns
Type Description
GcStats

GetBytesAllocatedPerOperation(BenchmarkCase)

Declaration
public long GetBytesAllocatedPerOperation(BenchmarkCase benchmarkCase)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
Returns
Type Description
Int64

GetCollectionsCount(Int32)

Declaration
public int GetCollectionsCount(int generation)
Parameters
Type Name Description
Int32 generation
Returns
Type Description
Int32

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

GetTotalAllocatedBytes(Boolean)

returns total allocated bytes (not per operation)

Declaration
public long GetTotalAllocatedBytes(bool excludeAllocationQuantumSideEffects)
Parameters
Type Name Description
Boolean excludeAllocationQuantumSideEffects

Allocation quantum can affecting some of our nano-benchmarks in non-deterministic way. when this parameter is set to true and the number of all allocated bytes is less or equal AQ, we ignore AQ and put 0 to the results
Returns
Type Description
Int64

Parse(String)

Declaration
public static GcStats Parse(string line)
Parameters
Type Name Description
String line
Returns
Type Description
GcStats

ReadFinal()

Declaration
public static GcStats ReadFinal()
Returns
Type Description
GcStats

ReadInitial()

Declaration
public static GcStats ReadInitial()
Returns
Type Description
GcStats

ToOutputLine()

Declaration
public string ToOutputLine()
Returns
Type Description
String

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

WithTotalOperations(Int64)

Declaration
public GcStats WithTotalOperations(long totalOperationsCount)
Parameters
Type Name Description
Int64 totalOperationsCount
Returns
Type Description
GcStats

Operators

Addition(GcStats, GcStats)

Declaration
public static GcStats operator +(GcStats left, GcStats right)
Parameters
Type Name Description
GcStats left
GcStats right
Returns
Type Description
GcStats

Subtraction(GcStats, GcStats)

Declaration
public static GcStats operator -(GcStats left, GcStats right)
Parameters
Type Name Description
GcStats left
GcStats right
Returns
Type Description
GcStats

Implements