drwnConfusionMatrix.h

/******************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2015, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnConfusionMatrix.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
** 
*****************************************************************************/

#pragma once

#include <vector>
#include <iostream>
#include <string>

#include "drwnDataset.h"
#include "drwnClassifier.h"

// drwnConfusionMatrix ------------------------------------------------------

class drwnConfusionMatrix {
 public:
    static std::string COL_SEP;   
    static std::string ROW_BEGIN; 
    static std::string ROW_END;   

 protected:
    std::vector<std::vector<unsigned> > _matrix;

 public:
    drwnConfusionMatrix(int n);
    drwnConfusionMatrix(int n, int m);
    virtual ~drwnConfusionMatrix();

    int numRows() const;
    int numCols() const;

    void clear();
    void accumulate(int actual, int predicted);
    void accumulate(const std::vector<int>& actual,
    const std::vector<int>& predicted);
    void accumulate(const drwnClassifierDataset& dataset,
        drwnClassifier const *classifier);
    void accumulate(const drwnConfusionMatrix& confusion);

    void printCounts(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printRowNormalized(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printColNormalized(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printNormalized(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printPrecisionRecall(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printF1Score(std::ostream &os = std::cout,
        const char *header = NULL) const;
    void printJaccard(std::ostream &os = std::cout,
        const char *header = NULL) const;

    void write(std::ostream &os) const;
    void read(std::istream &is);

    double rowSum(int n) const;
    double colSum(int m) const;
    double diagSum() const;
    double totalSum() const;
    double accuracy() const;
    double avgPrecision() const;
    double avgRecall() const;
    double avgJaccard() const;

    double precision(int n) const;
    double recall(int n) const;
    double jaccard(int n) const;

    const unsigned& operator()(int x, int y) const;
    unsigned& operator()(int x, int y);
};