mootEval.h

Go to the documentation of this file.

/* -*- Mode: C++ -*- */

/*
   libmoot : moocow's part-of-speech tagging library
   Copyright (C) 2003-2009 by Bryan Jurish <moocow@cpan.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.
   
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.
   
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

/*--------------------------------------------------------------------------
 * File: mootEval.h
 * Author: Bryan Jurish <moocow@cpan.org>
 * Description:
 *   + moot PoS tagger : evaluator
 *--------------------------------------------------------------------------*/

#ifndef _moot_EVAL_H
#define _moot_EVAL_H

#include <mootToken.h>

moot_BEGIN_NAMESPACE

/*--------------------------------------------------------------------------
 * mootEval : evaluation class
 *--------------------------------------------------------------------------*/

class mootEval {
public:

  typedef enum {
    MEF_None           = 0x0000, 
    //MEF_SentMismatch = 0x0001, /**< sentence lengths differ */
    MEF_TokMismatch    = 0x0002, 
    MEF_BestMismatch   = 0x0004, 
    MEF_EmptyClass1    = 0x0008, 
    MEF_EmptyClass2    = 0x0010, 
    MEF_ImpClass1      = 0x0020, 
    MEF_ImpClass2      = 0x0040, 
    MEF_XImpClass1     = 0x0080, 
    MEF_XImpClass2     = 0x0100  
  } evalStatus;

public:
  int status;                    
public:
  mootEval(void) : status(MEF_None) {};

  inline void clear(void) { status = MEF_None; };

  int compareTokens(const mootToken &tok1, const mootToken &tok2);

  //list<mootEvalFlag> compareSentences(const mootSentence &sent1, const mootSentence &sent2);

  /*----------------------------------------------------
   * Accessors
   */
  inline bool isTokenMismatch(void) { return status&MEF_TokMismatch; };

  inline bool isBestMismatch(void) { return status&MEF_BestMismatch; };

  inline bool isEmptyClass1(void) { return status&MEF_EmptyClass1; };

  inline bool isEmptyClass2(void) { return status&MEF_EmptyClass2; };

  inline bool isImpClass1(void) { return status&MEF_ImpClass1; };

  inline bool isImpClass2(void) { return status&MEF_ImpClass2; };

  inline bool isXImpClass1(void) { return status&MEF_XImpClass1; };

  inline bool isXImpClass2(void) { return status&MEF_XImpClass2; };


  /*----------------------------------------------------
   * Stringification
   */
  string status_string(void);
};


moot_END_NAMESPACE

#endif /* _moot_EVAL_H */