AnyParameter.h

#ifndef __ANYPARAMETER_H__
#define __ANYPARAMETER_H__

#include <shogun/lib/any.h>
#include <shogun/io/CerealVisitor.h>

#include <memory>
#include <string>

namespace shogun
{

	/** model selection availability */
	enum EModelSelectionAvailability
	{
		MS_NOT_AVAILABLE = 0,
		MS_AVAILABLE = 1,
	};

	/** gradient availability */
	enum EGradientAvailability
	{
		GRADIENT_NOT_AVAILABLE = 0,
		GRADIENT_AVAILABLE = 1
	};

	class AnyParameterProperties
	{
	public:
		AnyParameterProperties()
		    : m_description(), m_model_selection(MS_NOT_AVAILABLE),
		      m_gradient(GRADIENT_NOT_AVAILABLE)
		{
		}
		AnyParameterProperties(
		    std::string description,
		    EModelSelectionAvailability model_selection = MS_NOT_AVAILABLE,
		    EGradientAvailability gradient = GRADIENT_NOT_AVAILABLE)
		    : m_description(description), m_model_selection(model_selection),
		      m_gradient(gradient)
		{
		}
		AnyParameterProperties(const AnyParameterProperties& other)
		    : m_description(other.m_description),
		      m_model_selection(other.m_model_selection),
		      m_gradient(other.m_gradient)
		{
		}

		std::string get_description() const
		{
			return m_description;
		}

		EModelSelectionAvailability get_model_selection() const
		{
			return m_model_selection;
		}

		EGradientAvailability get_gradient() const
		{
			return m_gradient;
		}

		/** serialize the object using cereal
		 *
		 * @param ar Archive type
		 */
		template<class Archive>
		void serialize(Archive& ar)
		{
			ar(m_description, m_model_selection, m_gradient);
		}

	private:
		std::string m_description;
		EModelSelectionAvailability m_model_selection;
		EGradientAvailability m_gradient;
	};

	class AnyParameter
	{
	public:
		AnyParameter() : m_value(), m_properties()
		{
		}
		explicit AnyParameter(const Any& value) : m_value(value), m_properties()
		{
		}
		AnyParameter(const Any& value, AnyParameterProperties properties)
		    : m_value(value), m_properties(properties)
		{
		}
		AnyParameter(const AnyParameter& other)
		    : m_value(other.m_value), m_properties(other.m_properties)
		{
		}

		Any get_value() const
		{
			return m_value;
		}

		void set_value(const Any& value)
		{
			m_value = value;
		}

		AnyParameterProperties get_properties() const
		{
			return m_properties;
		}

		/** Equality operator which compares value but not properties.
		 * @return true if value of other parameter equals own */
		inline bool operator==(const AnyParameter& other) const
		{
			return m_value == other.get_value();
		}

		/** @see operator==() */
		inline bool operator!=(const AnyParameter& other) const
		{
			return !(*this == other);
		}

		template <class Archive>
		void cereal_save(Archive& ar) const
		{
			std::unique_ptr<CerealWriterVisitor<Archive>> visitor(new CerealWriterVisitor<Archive>(ar));
			m_value.visit(visitor.get());
			ar(m_properties);
		}

		template <class Archive>
		void cereal_load(Archive& ar)
		{
			std::unique_ptr<CerealReaderVisitor<Archive>> visitor(new CerealReaderVisitor<Archive>(ar));
			m_value.visit(visitor.get());
			ar(m_properties);
		}

	private:
		Any m_value;
		AnyParameterProperties m_properties;
	};
}

#endif