Skip to content

ExperimentPairedContinuousCaseMeasurement

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentPairedContinuousCaseMeasurement Class

Describes one paired case measurement for a continuous X-minus-Y comparison.

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

Inheritance System.Object 🡒 ExperimentPairedContinuousCaseMeasurement

Implements System.IEquatable<ExperimentPairedContinuousCaseMeasurement>

Constructors

ExperimentPairedContinuousCaseMeasurement(string, Nullable<double>, ExperimentItemStatus, Nullable<double>, ExperimentItemStatus, bool) Constructor

Initializes one paired continuous case measurement.

public ExperimentPairedContinuousCaseMeasurement(string caseId, System.Nullable<double> xValue, NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus xStatus, System.Nullable<double> yValue, NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus yStatus, bool isComparable);

Parameters

caseId System.String

The stable case identifier.

xValue System.Nullable<System.Double>

The case-level continuous value for arm X when xStatus is Succeeded; otherwise null.

xStatus ExperimentItemStatus

The case-level status for arm X.

yValue System.Nullable<System.Double>

The case-level continuous value for arm Y when yStatus is Succeeded; otherwise null.

yStatus ExperimentItemStatus

The case-level status for arm Y.

isComparable System.Boolean

true when the paired metric is comparable across both arms; otherwise false.

Exceptions

System.ArgumentException
caseId is blank, a succeeded arm omits its continuous value, or a non-succeeded arm supplies a continuous value.

System.ArgumentOutOfRangeException
xStatus or yStatus is not defined.

Properties

ExperimentPairedContinuousCaseMeasurement.CaseId Property

Gets the stable case identifier.

public string CaseId { get; }

Property Value

System.String

ExperimentPairedContinuousCaseMeasurement.IsComparable Property

Gets whether the paired metric is comparable across both arms.

public bool IsComparable { get; }

Property Value

System.Boolean

ExperimentPairedContinuousCaseMeasurement.XStatus Property

Gets the case-level status for arm X.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus XStatus { get; }

Property Value

ExperimentItemStatus

ExperimentPairedContinuousCaseMeasurement.XValue Property

Gets the case-level continuous value for arm X when available.

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

Property Value

System.Nullable<System.Double>

ExperimentPairedContinuousCaseMeasurement.YStatus Property

Gets the case-level status for arm Y.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus YStatus { get; }

Property Value

ExperimentItemStatus

ExperimentPairedContinuousCaseMeasurement.YValue Property

Gets the case-level continuous value for arm Y when available.

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

Property Value

System.Nullable<System.Double>