ExcessCriterion (JCP API)

java.lang.Object
- se.hb.jcp.cp.measures.AbstractSignificanceBasedMeasure
- - se.hb.jcp.cp.measures.ExcessCriterion

All Implemented Interfaces:

IMeasure, IPriorMeasure
```
public class ExcessCriterion
extends AbstractSignificanceBasedMeasure
implements IPriorMeasure
```
The E/Excess criterion is a prior efficiency measure based on how much the size of the label set exceeds 1. See [V. Vovk, V. Fedorova, I. Nouretdinov and A. Gammerman, "Criteria of Efficiency for Conformal Prediction", COPA 2016, LNAI 9653, pp. 23-39, 2016] for the definitions used here.

Author:

anders.gidenstam(at)hb.se

Constructor Summary

Constructors
Constructor Description

ExcessCriterion(double significanceLevel)
Creates an E/Excess criterion measure.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`compute(ConformalClassification prediction)`	Computes the E/Excess criterion measure for this prediction.

Methods inherited from class se.hb.jcp.cp.measures.AbstractSignificanceBasedMeasure
getName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface se.hb.jcp.cp.measures.IMeasure
getName

- Constructor Detail
  - ExcessCriterion
```
public ExcessCriterion(double significanceLevel)
```
    Creates an E/Excess criterion measure.
    
    Parameters:
    
    significanceLevel - the significance level used for the label sets.
- Method Detail
  - compute
```
public double compute(ConformalClassification prediction)
```
    Computes the E/Excess criterion measure for this prediction.
    
    Specified by:
    
    compute in interface IPriorMeasure
    
    Parameters:
    
    prediction - the prediction.
    
    Returns:
    
    the Excess criterion measure for this prediction. Small values are preferable.