FactorGraph.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) 2013 Shell Hu 
 * Copyright (C) 2013 Shell Hu 
 */

#ifndef __FACTORGRAPH_H__
#define __FACTORGRAPH_H__

#include <shogun/lib/DynamicObjectArray.h>
#include <shogun/lib/SGVector.h>
#include <shogun/structure/Factor.h>
#include <shogun/labels/FactorGraphLabels.h>
#include <shogun/structure/DisjointSet.h>

namespace shogun 
{

class CFactorGraph : public CSGObject
{

public:
    CFactorGraph();

    CFactorGraph(const SGVector<int32_t> card);

    CFactorGraph(const CFactorGraph &fg);

    ~CFactorGraph();

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

    void add_factor(CFactor* factor);

    void add_data_source(CFactorDataSource* datasource);

    CDynamicObjectArray* get_factors() const;

    CDynamicObjectArray* get_factor_data_sources() const;

    int32_t get_num_factors() const;

    SGVector<int32_t> get_cardinalities() const;

    void set_cardinalities(SGVector<int32_t> cards);

    void compute_energies();

    float64_t evaluate_energy(const SGVector<int32_t> state) const;

    float64_t evaluate_energy(const CFactorGraphObservation* obs) const;

    SGVector<float64_t> evaluate_energies() const;

    CDisjointSet* get_disjoint_set() const;

    int32_t get_num_edges() const;

    int32_t get_num_vars() const;

    void connect_components();

    bool is_acyclic_graph() const;

    bool is_connected_graph() const;

    bool is_tree_graph() const;

    virtual void loss_augmentation(CFactorGraphObservation* gt);

    virtual void loss_augmentation(SGVector<int32_t> states_gt, \
        SGVector<float64_t> loss = SGVector<float64_t>());

private:
    void register_parameters();

    void init();

protected:
    // TODO: FactorNode, VariableNode, such that they have IDs

    SGVector<int32_t> m_cardinalities;

    CDynamicObjectArray* m_factors;

    CDynamicObjectArray* m_datasources;

    CDisjointSet* m_dset;

    bool m_has_cycle;

    int32_t m_num_edges;
    
};

}

#endif