/*
    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_SIMILAIRITYFUNCTION_H
#define SMARTCOMPARATOR_SIMILAIRITYFUNCTION_H

#include "../comparator_stdheaders.h"

namespace smartcomparator
{
	namespace simfunctions
	{
		/**
		Funkcja podobieństwa... Funkcja ma zwracać wartość pomiędzy 0 (totalnie niepodobne) a 1 (bardzo podobne)
		*/
		class SMART_COMPARATOR_API SimilarityFunction
		{
		public:
			SimilarityFunction(Matrices::SuperMatrixPtr m);
			virtual ~SimilarityFunction(void);

			virtual double CountSimilarity(Matrices::CompressedVector& v1, Matrices::CompressedVector& v2,
				size_t v1ind, size_t v2ind,	const std::set<size_t> &v1Ind, const std::set<size_t> &v2Ind) = 0;

			virtual double MinValue() const = 0;

			/// Retruns true if a given function is symmetrical, i.e., sim(a,b) = sim(b,a); defaults to true
			virtual bool IsSymmetrical() const;

		protected:
			Matrices::SuperMatrixPtr m_pMatrix;




		};
		typedef boost::shared_ptr<SimilarityFunction> SimilarityFunctionPtr;
	}
}
#endif //SMARTCOMPARATOR_SIMILAIRITYFUNCTION_H
