drwnVarUniverse.h

/******************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2015, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnVarUniverse.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
**
*****************************************************************************/

#pragma once

#include <cstdlib>
#include <cassert>
#include <vector>
#include <string>

#include "drwnBase.h"
#include "drwnGraphUtils.h"

using namespace std;

// drwnVarUniverse ---------------------------------------------------------

class drwnVarUniverse : public drwnStdObjIface {
 protected:
    int _numVariables;              
    int _uniformCards;              
    vector<int> _varCards;          
    vector<string> _varNames;       

 public:
    drwnVarUniverse();
    drwnVarUniverse(int numVars, int varCards = 2);
    drwnVarUniverse(const vector<int>& varCards);
    ~drwnVarUniverse();

    // access functions
    virtual const char *type() const { return "drwnVarUniverse"; }
    virtual drwnVarUniverse *clone() const { return new drwnVarUniverse(*this); }

    int numVariables() const { return _numVariables; }
    bool hasUniformCardinality() const { return _varCards.empty(); }
    int varCardinality(int v) const { return _varCards.empty() ? _uniformCards : _varCards[v]; }
    int maxCardinality() const { return _varCards.empty() ? _uniformCards : *max_element(_varCards.begin(), _varCards.end()); }
    int maxCardinality(const drwnClique& c) const;
    double logStateSpace() const;
    double logStateSpace(const drwnClique& c) const;
    string varName(int v) const { return _varNames.empty() ? (string("X") + toString(v)) : _varNames[v]; }
    int findVariable(const char* name) const;

    int addVariable(const char *name = NULL);
    int addVariable(int varCard, const char *name = NULL);

    drwnVarUniverse slice(const vector<int>& vars) const;
    drwnVarUniverse slice(const drwnClique& vars) const;

    // i/o
    void clear();
    bool save(drwnXMLNode& xml) const;
    bool load(drwnXMLNode& xml);

    void print() const;
};

// drwnVarUniversePtr ------------------------------------------------------

typedef drwnSmartPointer<drwnVarUniverse> drwnVarUniversePtr;