Hierarchical.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) 2007-2009 Soeren Sonnenburg
 * Copyright (C) 2007-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _HIERARCHICAL_H__
#define _HIERARCHICAL_H__

#include <stdio.h>
#include "lib/common.h"
#include "lib/io.h"
#include "distance/Distance.h"
#include "classifier/DistanceMachine.h"

namespace shogun
{
class CDistanceMachine;

class CHierarchical : public CDistanceMachine
{
    public:
        CHierarchical();

        CHierarchical(int32_t merges, CDistance* d);
        virtual ~CHierarchical();

        virtual inline EClassifierType get_classifier_type() { return CT_HIERARCHICAL; }

        virtual bool train(CFeatures* data=NULL);

        virtual bool load(FILE* srcfile);

        virtual bool save(FILE* dstfile);

        inline void set_merges(int32_t m)
        {
            ASSERT(m>0);
            merges=m;
        }

        inline int32_t get_merges()
        {
            return merges;
        }

        inline void get_assignment(int32_t*& assign, int32_t& num)
        {
            assign=assignment;
            num=table_size;
        }

        inline void get_merge_distance(float64_t*& dist, int32_t& num)
        {
            dist=merge_distance;
            num=merges;
        }

        inline void get_merge_distances(float64_t** dist, int32_t* num)
        {
            size_t sz=sizeof(*merge_distance)*merges;
            *dist=(float64_t*) malloc(sz);
            ASSERT(*dist);

            memcpy(*dist, merge_distance, sz);
            *num=merges;
        }

        inline void get_pairs(int32_t*& tuples, int32_t& rows, int32_t& num)
        {
            tuples=pairs;
            rows=2;
            num=merges;
        }

        inline void get_cluster_pairs(
            int32_t** tuples, int32_t* rows, int32_t* num)
        {
            *rows=2;
            size_t sz=sizeof(*pairs)*(*rows)*merges;
            *tuples=(int32_t*) malloc(sz);
            ASSERT(*tuples);

            memcpy(*tuples, pairs, sz);
            *num=merges;
        }

        virtual CLabels* classify()
        {
            SG_NOTIMPLEMENTED;
            return NULL;
        }

        virtual CLabels* classify(CFeatures* data)
        {
            SG_NOTIMPLEMENTED;
            return NULL;
        }

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

    protected:
        int32_t merges;

        int32_t dimensions;

        int32_t assignment_size;

        int32_t* assignment;

        int32_t table_size;

        int32_t* pairs;

        float64_t* merge_distance;
};
}
#endif