Skip to content

ExperimentPairedContinuousComparisonEvidence

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentPairedContinuousComparisonEvidence Class

Describes paired continuous X-minus-Y comparison evidence and its case-level bootstrap summary.

public sealed record ExperimentPairedContinuousComparisonEvidence : System.IEquatable<NexusLabs.Foundry.Evaluation.Experiments.ExperimentPairedContinuousComparisonEvidence>

Inheritance System.Object 🡒 ExperimentPairedContinuousComparisonEvidence

Implements System.IEquatable<ExperimentPairedContinuousComparisonEvidence>

Properties

ExperimentPairedContinuousComparisonEvidence.BootstrapResampleCount Property

Gets the exact number of bootstrap resamples.

public int BootstrapResampleCount { get; }

Property Value

System.Int32

ExperimentPairedContinuousComparisonEvidence.BootstrapSeed Property

Gets the deterministic seed for the internal bootstrap RNG.

public ulong BootstrapSeed { get; }

Property Value

System.UInt64

ExperimentPairedContinuousComparisonEvidence.Cases Property

Gets a defensive snapshot of the analyzed paired case measurements.

public System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentPairedContinuousCaseMeasurement> Cases { get; }

Property Value

System.Collections.Generic.IReadOnlyList<ExperimentPairedContinuousCaseMeasurement>

ExperimentPairedContinuousComparisonEvidence.ConfidenceLevel Property

Gets the two-sided interval confidence level.

public double ConfidenceLevel { get; }

Property Value

System.Double

ExperimentPairedContinuousComparisonEvidence.DroppedCaseCount Property

Gets the number of comparable case pairs dropped because they were not full-success or did not produce finite values for both arms.

public int DroppedCaseCount { get; }

Property Value

System.Int32

ExperimentPairedContinuousComparisonEvidence.IsInsufficientSample Property

Gets whether fewer than four valid case pairs remained for the interval.

public bool IsInsufficientSample { get; }

Property Value

System.Boolean

ExperimentPairedContinuousComparisonEvidence.LowerBound Property

Gets the lower percentile-bootstrap bound for the mean paired difference when at least four valid pairs remain; otherwise null.

public System.Nullable<double> LowerBound { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.MeanDifference Property

Gets the mean X-minus-Y paired difference, when at least one valid pair remains.

public System.Nullable<double> MeanDifference { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.MedianDifference Property

Gets the median X-minus-Y paired difference, when at least one valid pair remains.

public System.Nullable<double> MedianDifference { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.NonComparableCaseCount Property

Gets the number of case pairs excluded because the metric was non-comparable.

public int NonComparableCaseCount { get; }

Property Value

System.Int32

ExperimentPairedContinuousComparisonEvidence.TotalCaseCount Property

Gets the total number of supplied case pairs before exclusions.

public int TotalCaseCount { get; }

Property Value

System.Int32

ExperimentPairedContinuousComparisonEvidence.UpperBound Property

Gets the upper percentile-bootstrap bound for the mean paired difference when at least four valid pairs remain; otherwise null.

public System.Nullable<double> UpperBound { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.ValidPairCount Property

Gets the number of valid case pairs included in the continuous comparison.

public int ValidPairCount { get; }

Property Value

System.Int32

ExperimentPairedContinuousComparisonEvidence.XLabel Property

Gets the stable label for arm X.

public string XLabel { get; }

Property Value

System.String

ExperimentPairedContinuousComparisonEvidence.XMean Property

Gets the mean of the valid X case-level values, when at least one valid pair remains.

public System.Nullable<double> XMean { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.XMedian Property

Gets the median of the valid X case-level values, when at least one valid pair remains.

public System.Nullable<double> XMedian { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.YLabel Property

Gets the stable label for arm Y.

public string YLabel { get; }

Property Value

System.String

ExperimentPairedContinuousComparisonEvidence.YMean Property

Gets the mean of the valid Y case-level values, when at least one valid pair remains.

public System.Nullable<double> YMean { get; }

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousComparisonEvidence.YMedian Property

Gets the median of the valid Y case-level values, when at least one valid pair remains.

public System.Nullable<double> YMedian { get; }

Property Value

System.Nullable<System.Double>

Methods

ExperimentPairedContinuousComparisonEvidence.Create(string, string, IReadOnlyList<ExperimentPairedContinuousCaseMeasurement>, ulong, double) Method

Creates validated paired continuous X-minus-Y evidence.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentPairedContinuousComparisonEvidence Create(string xLabel, string yLabel, System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentPairedContinuousCaseMeasurement> cases, ulong bootstrapSeed, double confidenceLevel);

Parameters

xLabel System.String

The stable label for arm X.

yLabel System.String

The stable label for arm Y.

cases System.Collections.Generic.IReadOnlyList<ExperimentPairedContinuousCaseMeasurement>

The paired continuous case measurements to analyze.

bootstrapSeed System.UInt64

The deterministic seed for the internal 10,000-resample case-level bootstrap.

confidenceLevel System.Double

The two-sided interval confidence level.

Returns

ExperimentPairedContinuousComparisonEvidence
Validated paired continuous comparison evidence.

Exceptions

System.ArgumentNullException
cases or one of its elements is null.

System.ArgumentException
xLabel or yLabel is blank, both labels are equal, or the paired case IDs are not unique.

System.ArgumentOutOfRangeException
confidenceLevel is not finite and strictly between zero and one.