ITestPolicy.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TEST_POLICY_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TEST_POLICY_H

// ============================================================================
#include <agrum/core/smallobjectallocator/smallObjectAllocator.h>
// ============================================================================
#include <agrum/graphs/parts/nodeGraphPart.h>
// ============================================================================

namespace gum {

  template < typename GUM_SCALAR >
  class ITestPolicy {
    public:
    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    ITestPolicy() : __isModified(false), __nbObs(0) {
      GUM_CONSTRUCTOR(ITestPolicy);
    }

    // ============================================================================
    // ============================================================================
    virtual ~ITestPolicy() { GUM_DESTRUCTOR(ITestPolicy); }

    // ============================================================================
    // ============================================================================
    void* operator new(size_t s) {
      return SmallObjectAllocator::instance().allocate(s);
    }
    void operator delete(void* p) {
      SmallObjectAllocator::instance().deallocate(p, sizeof(ITestPolicy));
    }



    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    virtual void addObservation(Idx attr, GUM_SCALAR value) {
      __isModified = true;
      __nbObs++;
    }

    // ============================================================================
    // ============================================================================
    Idx nbObservation() const { return __nbObs; }



    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    virtual bool isTestRelevant() const = 0;

    // ============================================================================
    // ============================================================================
    virtual void computeScore() const { __isModified = false; }

    // ============================================================================
    // ============================================================================
    virtual double score() const = 0;

    // ============================================================================
    // ============================================================================
    virtual double secondaryscore() const = 0;



    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    void add(const ITestPolicy< GUM_SCALAR >& src) {
      __isModified = true;
      __nbObs += src.nbObservation();
    }



    // ############################################################################
    // ############################################################################

    // ============================================================================
    // ============================================================================
    std::string toString() const {
      std::stringstream ss;
      ss << "\t\t\tNb Obs : " << __nbObs << std::endl;
      return ss.str();
    }


    protected:
    bool _isModified() const { return __isModified; }

    private:
    mutable bool __isModified;

    Idx __nbObs;
  };

}   // End of namespace gum

#endif /* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TEST_POLICY_H */