/*
    Copyright (C) 2012 Bartosz Broda, Jacek Bochenek, Łukasz Biłeńkij, 
    Damian Jaworski, Wojciech Mazur, Dominik Piasecki, Maciej Piasecki, 
    Radosław Ramocki
    
    This program 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 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 LICENSE and COPYING files for more details.
*/

#ifndef SMARTCOMPARATOR_SIMPLEMIWEIGHT_H
#define SMARTCOMPARATOR_SIMPLEMIWEIGHT_H
#include "../comparator_stdheaders.h"
#include "WeightFeature.h"
#include "QuantizationWeight.h"

namespace smartcomparator
{
	namespace weights
	{
		/*
		 * MI weight.(As counted by eg. Patrick Pantel in CBC).
		 * This weight is based on the equation: MI(X,Y) = log( P(X,Y)/P(X)P(Y) ).
		 * Unlike in version used by Lin, it does not diffrenciate between types of
		 * relation in matrix.
		 */ 
		class SMART_COMPARATOR_API SimpleMIWeight : public WeightFeature
		{
		public:
			/**
			 * \param dicount Use dicounting factor for MI. See Patick Pantel - CBC.
			 */ 
			SimpleMIWeight(Matrices::SuperMatrixPtr m, bool dicount = true, double mi_threshold=0);
			virtual ~SimpleMIWeight();
			virtual void Weight(size_t rowindex, Matrices::CompressedVector *v, std::set<size_t> &filteredIndices);
		private:
			void Initalize();
			double m_dN;
			bool m_bDiscount;
			double threshold;
		};

		typedef SimpleMIWeight PMIWeight;

		class SMART_COMPARATOR_API PMIQuantifiedWeight : public QuantizationWeight
		{
		public:
			PMIQuantifiedWeight(Matrices::SuperMatrixPtr m, bool discount = true);

		};


	}//namespace weights

}//namespace smartcomparator

#endif

