edu.cmu.tetradapp.model.DirichletEstimatorWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
There is a newer version: 7.6.6
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// 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 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program is distributed in the hope that it will be useful,           //
// but WITHOUT ANY WARRANTY; without even the implied warranty of            //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////
package edu.cmu.tetradapp.model;

import edu.cmu.tetrad.bayes.DirichletBayesIm;
import edu.cmu.tetrad.bayes.DirichletEstimator;
import edu.cmu.tetrad.data.DataSet;
import edu.cmu.tetrad.data.DataUtils;
import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.session.SessionModel;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradLogger;
import edu.cmu.tetrad.util.TetradSerializableUtils;

import java.io.IOException;
import java.io.ObjectInputStream;

/**
 * Wraps a DirichletEstimator.
 *
 * @author josephramsey
 */
public class DirichletEstimatorWrapper implements SessionModel {

    private static final long serialVersionUID = 23L;
    /**
     * @serial Cannot be null.
     */
    private final DirichletBayesIm dirichletBayesIm;
    /**
     * @serial Can be null.
     */
    private String name;

    //============================CONSTRUCTORS============================//
    public DirichletEstimatorWrapper(DataWrapper dataWrapper,
                                     DirichletBayesImWrapper dirichletPriorWrapper) {
        if (dataWrapper == null) {
            throw new NullPointerException();
        }

        if (dirichletPriorWrapper == null) {
            throw new NullPointerException();
        }

        DataSet dataSet
                = (DataSet) dataWrapper.getSelectedDataModel();

        if (DataUtils.containsMissingValue(dataSet)) {
            throw new IllegalArgumentException("Please remove or impute missing values.");
        }

        DirichletBayesIm dirichletBayesIm
                = dirichletPriorWrapper.getDirichletBayesIm();

        try {
            this.dirichletBayesIm
                    = DirichletEstimator.estimate(dirichletBayesIm, dataSet);
        } catch (IllegalArgumentException e) {
            throw new RuntimeException(
                    "Please fully specify the Dirichlet prior first.");
        }
        log(dirichletBayesIm);
    }

    public DirichletEstimatorWrapper(DataWrapper dataWrapper,
                                     BayesPmWrapper bayesPmWrapper, Parameters params) {
        if (dataWrapper == null) {
            throw new NullPointerException();
        }

        if (bayesPmWrapper == null) {
            throw new NullPointerException();
        }

        if (params == null) {
            throw new NullPointerException();
        }

        DataSet dataSet
                = (DataSet) dataWrapper.getSelectedDataModel();

        if (DataUtils.containsMissingValue(dataSet)) {
            throw new IllegalArgumentException("Please remove or impute missing values.");
        }

        DirichletBayesIm dirichletBayesIm
                = DirichletBayesIm.symmetricDirichletIm(
                bayesPmWrapper.getBayesPm(),
                params.getDouble("symmetricAlpha", 1.0));

        if (DataUtils.containsMissingValue(dataSet)) {
            throw new IllegalArgumentException("Please remove or impute missing values.");
        }

        try {
            this.dirichletBayesIm
                    = DirichletEstimator.estimate(dirichletBayesIm, dataSet);
        } catch (IllegalArgumentException e) {
            throw new RuntimeException(
                    "Please fully specify the Dirichlet prior first.");
        }
        log(dirichletBayesIm);
    }

    /**
     * Generates a simple exemplar of this class to test serialization.
     *
     * @see TetradSerializableUtils
     */
    public static PcRunner serializableInstance() {
        return PcRunner.serializableInstance();
    }

    //===============================PUBLIC METHODS=======================//
    public DirichletBayesIm getEstimatedBayesIm() {
        return this.dirichletBayesIm;
    }

    /**
     * Adds semantic checks to the default deserialization method. This method must have the standard signature for a
     * readObject method, and the body of the method must begin with "s.defaultReadObject();". Other than that, any
     * semantic checks can be specified and do not need to stay the same from version to version. A readObject method of
     * this form may be added to any class, even if Tetrad sessions were previously saved out using a version of the
     * class that didn't include it. (That's what the "s.defaultReadObject();" is for. See J. Bloch, Effective Java, for
     * help.
     * 
     * LogUtils.getInstance().finer("Estimated Bayes IM:");
     */
    private void readObject(ObjectInputStream s)
            throws IOException, ClassNotFoundException {
        s.defaultReadObject();

        if (this.dirichletBayesIm == null) {
            throw new NullPointerException();
        }
    }

    public Graph getGraph() {
        return this.dirichletBayesIm.getBayesPm().getDag();
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    private void log(DirichletBayesIm im) {
        TetradLogger.getInstance().log("info", "Estimated Dirichlet Bayes IM");
        TetradLogger.getInstance().log("im", "" + im);
        TetradLogger.getInstance().reset();
    }

}