QCTraceSimulator.GetMetricStatistic Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetMetricStatistic<T>(String, String, OperationFunctor) |
Returns a statistic of a given metric for a top level operation. |
| GetMetricStatistic<TOperation,TCaller>(String, String, OperationFunctor, OperationFunctor) |
Returns a statistic of a given metric associated with an edge of the call graph. |
GetMetricStatistic<T>(String, String, OperationFunctor)
Returns a statistic of a given metric for a top level operation.
public double GetMetricStatistic<T> (string metric, string statistic, Microsoft.Quantum.Simulation.Core.OperationFunctor functor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body);override this.GetMetricStatistic : string * string * Microsoft.Quantum.Simulation.Core.OperationFunctor -> doublePublic Function GetMetricStatistic(Of T) (metric As String, statistic As String, Optional functor As OperationFunctor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body) As DoubleType Parameters
- T
The C# type corresponding to the Q# operation for which the metric is requested.
Parameters
- metric
- String
The name of the metric requested for the top level
operation specified by T.
- statistic
- String
The name of a statistic of the specified metric for the specified top level operation.
- functor
- Microsoft.Quantum.Simulation.Core.OperationFunctor
The functor specialization of the operation for which the metric is requested. If not specified, this defaults to the "body" variant.
Returns
Remarks
For a more detailed discussion of metrics, statistics, call graph edges and operation specializations, see the Remarks section of the QCTraceSimulator class documentation.
Applies to
GetMetricStatistic<TOperation,TCaller>(String, String, OperationFunctor, OperationFunctor)
Returns a statistic of a given metric associated with an edge of the call graph.
public double GetMetricStatistic<TOperation,TCaller> (string metric, string statistic, Microsoft.Quantum.Simulation.Core.OperationFunctor functor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body, Microsoft.Quantum.Simulation.Core.OperationFunctor callerFunctor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body);override this.GetMetricStatistic : string * string * Microsoft.Quantum.Simulation.Core.OperationFunctor * Microsoft.Quantum.Simulation.Core.OperationFunctor -> doublePublic Function GetMetricStatistic(Of TOperation, TCaller) (metric As String, statistic As String, Optional functor As OperationFunctor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body, Optional callerFunctor As OperationFunctor = Microsoft.Quantum.Simulation.Core.OperationFunctor.Body) As DoubleType Parameters
- TOperation
The C# type corresponding to the Q# operation for which the metric is requested.
- TCaller
The C# type corresponding to the caller of the Q# operation for which the metric is requested.
Parameters
- metric
- String
The name of the metric requested for the specified call graph edge.
- statistic
- String
The name of the statistic of the metric requested for a given call graph edge.
- functor
- Microsoft.Quantum.Simulation.Core.OperationFunctor
The functor specialization of the operation for which the metric is requested. If not specified, this defaults to the "body" specialization.
- callerFunctor
- Microsoft.Quantum.Simulation.Core.OperationFunctor
The functor specialization of the caller of the operation for which the metric is requested. If not specified, this defaults to the "body" specialization.
Returns
Remarks
For a more detailed discussion of metrics, statistics, call graph edges and operation specializations, see the Remarks section of the QCTraceSimulator class documentation.