pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::CounterfactualTarget Struct Reference

What the counterfactual must achieve. More...

#include <counterfactual.hpp>

Public Types

enum class  Kind { Class , Range }
 

Static Public Member Functions

static CounterfactualTarget ToClass (int64_t class_index, float margin=0.0f)
 
static CounterfactualTarget ToRange (int64_t output_index, float low, float high)
 

Public Attributes

Kind kind = Kind::Class
 
int64_t index = 0
 
float margin = 0.0f
 
float low = 0.0f
 
float high = 0.0f
 

Detailed Description

What the counterfactual must achieve.

Member Enumeration Documentation

◆ Kind

Enumerator
Class 

Output index must exceed every other output by at least margin (a class).

Range 

Output index must land in [low, high] (a regression value).

Member Function Documentation

◆ ToClass()

static CounterfactualTarget pulsatrix::CounterfactualTarget::ToClass ( int64_t  class_index,
float  margin = 0.0f 
)
inlinestatic

◆ ToRange()

static CounterfactualTarget pulsatrix::CounterfactualTarget::ToRange ( int64_t  output_index,
float  low,
float  high 
)
inlinestatic

Member Data Documentation

◆ high

float pulsatrix::CounterfactualTarget::high = 0.0f

◆ index

int64_t pulsatrix::CounterfactualTarget::index = 0

◆ kind

Kind pulsatrix::CounterfactualTarget::kind = Kind::Class

◆ low

float pulsatrix::CounterfactualTarget::low = 0.0f

◆ margin

float pulsatrix::CounterfactualTarget::margin = 0.0f

The documentation for this struct was generated from the following file: