TreeMachineNode.h

Go to the documentation of this file.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (w) 2012 Chiyuan Zhang
 * Written (w) 2014 Parijat Mazumdar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 */

#ifndef TREEMACHINENODE_H__
#define TREEMACHINENODE_H__

#include <shogun/lib/config.h>

#include <shogun/base/SGObject.h>
#include <shogun/base/Parameter.h>
#include <shogun/lib/DynamicObjectArray.h>

namespace shogun
{

template <typename T>
class CTreeMachineNode
    : public CSGObject
{
public:
    CTreeMachineNode() : CSGObject()
    {
        init();
    }

    virtual ~CTreeMachineNode()
    {
        for(int32_t i=0;i<m_children->get_num_elements();i++)
        {
            CTreeMachineNode* child=(CTreeMachineNode*) m_children->get_element(i);
            child->parent(NULL);
            SG_UNREF(child);
        }
        SG_UNREF(m_children);
    }

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

    void machine(int32_t idx)
    {
        m_machine=idx;
    }

    int32_t machine()
    {
        return m_machine;
    }

    void parent(CTreeMachineNode* par)
    {
        m_parent=par;
    }

    CTreeMachineNode* parent()
    {
        return m_parent;
    }

    virtual void set_children(CDynamicObjectArray* children)
    {
        m_children->reset_array();
        for (int32_t i=0; i<children->get_num_elements(); i++)
        {
            CTreeMachineNode* child=(CTreeMachineNode*) children->get_element(i);
            add_child(child);
            SG_UNREF(child);
        }
    }

    virtual void add_child(CTreeMachineNode* child)
    {
        m_children->push_back(child);
        child->parent(this);
    }

    virtual CDynamicObjectArray* get_children()
    {
        SG_REF(m_children);
        return m_children;
    }

    typedef void (*data_print_func_t) (const T&);

    void debug_print(data_print_func_t data_print_func)
    {
        debug_print_impl(data_print_func, this, 0);
    }

protected:
    static void debug_print_impl(data_print_func_t data_print_func,
                CTreeMachineNode<T>* node, int32_t depth)
    {
        for (int32_t i=0;i<depth;++i)
            SG_SPRINT("  ");

        data_print_func(node->data);

        CDynamicObjectArray* children_vector=node->get_children();
        for (int32_t j=0;j<children_vector->get_num_elements();j++)
        {
            CTreeMachineNode<T>* child=(CTreeMachineNode<T>*)
                        children_vector->get_element(j);
            debug_print_impl(data_print_func,child,depth+1);
            SG_UNREF(child);
        }

        SG_UNREF(children_vector);
    }

private:
    void init()
    {
        m_parent=NULL;
        m_machine=-1;
        m_children=new CDynamicObjectArray();
        SG_REF(m_children);
        SG_ADD((CSGObject**)&m_parent,"m_parent", "Parent node", MS_NOT_AVAILABLE);
        SG_ADD(&m_machine,"m_machine", "Index of associated machine", MS_NOT_AVAILABLE);
    }

public:
    T data;

protected:
    CTreeMachineNode* m_parent;

    int32_t m_machine;

    CDynamicObjectArray* m_children;

};

} /* namespace shogun */

#endif /* end of include guard: TREEMACHINENODE_H__ */