com.bbn.bue.common.evaluation.SummaryConfusionMatrix Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-core-open Show documentation

The newest version!

package com.bbn.bue.common.evaluation;

import com.bbn.bue.common.symbols.Symbol;

import com.google.common.base.Function;

import java.util.Set;

/**
 * Represents a confusion matrix which only tracks counts.  Asking for {@code #cell(x,y)} will give
 * you the number of times an object was assigned the label {@code x} by the "left system" but
 * {@code y} by the "right system". By convention, when comparing against a gold standard, the gold
 * standard is the "right system".
 *
 * To build one of these, see {@link SummaryConfusionMatrices#builder()}.
 *
 * If you also want to track exactly what objects were confused instead of just the counts, you want
 * a {@link ProvenancedConfusionMatrix}.
 */
public interface SummaryConfusionMatrix {

  double cell(final Symbol row, final Symbol col);
  /**
   * The left-hand labels of the confusion matrix.
   */
  Set leftLabels();
  /**
   * The right hand labels of the confusion matrix.
   */
  Set rightLabels();

  double sumOfallCells();

  double rowSum(Symbol row);

  double columnSum(Symbol column);

  SummaryConfusionMatrix filteredCopy(CellFilter filter);

  SummaryConfusionMatrix copyWithTransformedLabels(Function f);

  void accumulateTo(SummaryConfusionMatrices.Builder builder);

  interface CellFilter {
    boolean keepCell(Symbol row, Symbol column);
  }
}