/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: UnificatorSub.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_SUB_HPP_
#define _TOPS_UNIFICATOR_SUB_HPP_

#include "tops/WorkingMemory.hpp"
#include "tops/value/Variables.hpp"

#include <boost/shared_ptr.hpp>

namespace tops {

	class Condition;
	typedef boost::shared_ptr<Condition> ConditionPtr;
	class UnificatedElement;
	typedef boost::shared_ptr<UnificatedElement> UnificatedElementPtr;

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

	private:
		/**
		 * 単一化対象となる条件です。
		 */
		ConditionPtr m_condition;

		/**
		 * 探索範囲です。
		 */
		std::pair<const_iterator, const_iterator> m_range;

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

		/**
		 * 単一化に使用する変数表です。
		 */
		Variables& m_variables;

		/**
		 * 変数表の初期状態です。
		 */
		Variables m_initialVariables;

		/**
		 * この単一化反復子（サブ）での単一化が終わったことを示すフラグです。
		 */
		bool m_finished;

	public:
		/**
		 * 単一化反復子（サブ）を構築します。
		 *
		 * @param workingMemory 単一化対象となるワーキングメモリを指定します。
		 * @param condition 単一化対象となる条件を指定します。
		 * @param variables 単一化に使用する変数表です。
		 */
		UnificatorSub(const WorkingMemory& workingMemory, const ConditionPtr& condition, Variables& variables);

		/**
		 * 単一化反復子（サブ）を破棄します。
		 */
		~UnificatorSub();

	public:
		/**
		 * 単一化を行います。
		 *
		 * @return 単一化に成功した場合は単一化した要素を、失敗した場合はNULLを返します。
		 */
		UnificatedElementPtr unificate();
	};

}  // namespace tops

#endif
