/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: UnificatorToWorkingMemory.hpp 11 2011-05-14 02:11:18Z yutaka_at_home $
 * 著作権:: Copyright (C) Ownway.info, 2011. All rights reserved.
 * ライセンス:: CPL(Common Public Licence)
 */

#ifndef _TOPS_UNIFICATOR_TO_WORKING_MEMORY_HPP_
#define _TOPS_UNIFICATOR_TO_WORKING_MEMORY_HPP_

#include "tops/WorkingMemory.hpp"

#include <map>
#include <string>

#include <boost/shared_ptr.hpp>

namespace tops {

	class ProgressiveRule;
	typedef boost::shared_ptr<ProgressiveRule> ProgressiveRulePtr;
	class UnificatedElement;
	typedef boost::shared_ptr<UnificatedElement> UnificatedElementPtr;
	class Variables;

	/**
	 * 反復的に単一化を行う単一化反復子です。
	 *
	 * @author トゥイー
	 */
	class UnificatorToWorkingMemory {
	private:
		typedef WorkingMemory::MapIterator iterator;
		typedef WorkingMemory::ConstMapIterator const_iterator;

	private:
		const WorkingMemory& m_workingMemory;

		/**
		 * 単一化対象となる進行性プロダクションルールです。
		 */
		ProgressiveRulePtr m_progressiveRule;

		/**
		 * 現在の反復子です。
		 */
		const_iterator m_iterator;

	public:
		/**
		 * 単一化反復子を構築します。
		 *
		 * @param workingMemory 単一化対象となるワーキングメモリを指定します。
		 * @param rule 単一化対象となる進行性プロダクションルールを指定します。
		 */
		UnificatorToWorkingMemory(const WorkingMemory& workingMemory, const ProgressiveRulePtr& rule);

	public:
		/**
		 * 単一化を行います。
		 *
		 * @param variables 単一化に使用する変数表を指定します。
		 *
		 * @return 単一化に成功した場合は単一化したワーキングメモリ要素を、そうでない場合はNULLを返します。
		 */
		UnificatedElementPtr unificate(Variables& variables);

		/**
		 * 単一化を行います。
		 *
		 * @return 単一化に成功した場合はtrueを、そうでない場合はfalseを返します。
		 */
		bool unificate();
	};

}  // namespace tops

#endif
