ParameterMap.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 2011 Heiko Strathmann
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
 */

#ifndef __PARAMETERMAP_
#define __PARAMETERMAP_

#include <shogun/base/DynArray.h>

namespace shogun
{

class SGParamInfo
{
public:
    SGParamInfo();

    SGParamInfo(const char* name, EContainerType ctype, EStructType stype,
            EPrimitiveType ptype);

    virtual ~SGParamInfo();

    void print_param_info();

    SGParamInfo* duplicate() const;

    bool operator==(const SGParamInfo& other) const;

    bool operator<(const SGParamInfo& other) const;

    bool operator>(const SGParamInfo& other) const;

private:
    void init();

public:
    char* m_name;
    EContainerType m_ctype;
    EStructType m_stype;
    EPrimitiveType m_ptype;
};

class ParameterMapElement
{
public:
    ParameterMapElement();

    ParameterMapElement(SGParamInfo* key, SGParamInfo* value);

    virtual ~ParameterMapElement();

    bool operator==(const ParameterMapElement& other) const;

    bool operator<(const ParameterMapElement& other) const;

    bool operator>(const ParameterMapElement& other) const;

    inline virtual const char* get_name() const
    {
        return "ParameterMapElement";
    }

private:
    void init();

public:
    SGParamInfo* m_key;
    SGParamInfo* m_value;

};

class ParameterMap
{
public:
    ParameterMap();

    virtual ~ParameterMap();

    void put(SGParamInfo* key, SGParamInfo* value);

    SGParamInfo* get(SGParamInfo* key) const;

    void finalize_map();

    void print_map();

private:
    void init();

protected:
    DynArray<ParameterMapElement*> m_map_elements;

    bool m_finalized;
};

}

#endif /* __PARAMETERMAP_ */