Skip to content

ExperimentPairedBinaryCaseOutcome

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentPairedBinaryCaseOutcome Class

Describes one paired case outcome for a binary X-minus-Y comparison.

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

Inheritance System.Object 🡒 ExperimentPairedBinaryCaseOutcome

Implements System.IEquatable<ExperimentPairedBinaryCaseOutcome>

Constructors

ExperimentPairedBinaryCaseOutcome(string, Nullable<bool>, ExperimentItemStatus, Nullable<bool>, ExperimentItemStatus, bool) Constructor

Initializes one paired binary case outcome.

public ExperimentPairedBinaryCaseOutcome(string caseId, System.Nullable<bool> xOutcome, NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus xStatus, System.Nullable<bool> yOutcome, NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemStatus yStatus, bool isComparable);

Parameters

caseId System.String

The stable case identifier.

xOutcome System.Nullable<System.Boolean>

The observed binary outcome for arm X when xStatus is Succeeded; otherwise null.

xStatus ExperimentItemStatus

The case-level status for arm X.

yOutcome System.Nullable<System.Boolean>

The observed binary outcome 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 observed outcome, or a non-succeeded arm supplies an observed outcome.

System.ArgumentOutOfRangeException
xStatus or yStatus is not defined.

Properties

ExperimentPairedBinaryCaseOutcome.CaseId Property

Gets the stable case identifier.

public string CaseId { get; }

Property Value

System.String

ExperimentPairedBinaryCaseOutcome.IsComparable Property

Gets whether the paired metric is comparable across both arms.

public bool IsComparable { get; }

Property Value

System.Boolean

ExperimentPairedBinaryCaseOutcome.XOutcome Property

Gets the observed binary outcome for arm X when available.

public System.Nullable<bool> XOutcome { get; }

Property Value

System.Nullable<System.Boolean>

ExperimentPairedBinaryCaseOutcome.XStatus Property

Gets the case-level status for arm X.

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

Property Value

ExperimentItemStatus

ExperimentPairedBinaryCaseOutcome.YOutcome Property

Gets the observed binary outcome for arm Y when available.

public System.Nullable<bool> YOutcome { get; }

Property Value

System.Nullable<System.Boolean>

ExperimentPairedBinaryCaseOutcome.YStatus Property

Gets the case-level status for arm Y.

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

Property Value

ExperimentItemStatus