All Downloads are FREE. Search and download functionalities are using the official Maven repository.

edu.cmu.tetrad.bayes.ManipulatingBayesUpdater Maven / Gradle / Ivy

There is a newer version: 7.6.5
Show newest version
///////////////////////////////////////////////////////////////////////////////
// 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.tetrad.bayes;

import edu.cmu.tetrad.graph.Graph;

/**
 * Interface for a Bayes updating algorithm that's capable of doing manipulation. In general, manipulating a variable X
 * will eliminate edges into X, so the updating operation on the manipulated model will produce different results.
 *
 * @author josephramsey
 */
public interface ManipulatingBayesUpdater extends BayesUpdater {
    long serialVersionUID = 23L;

    /**
     * Returns the manipulated Bayes IM. This is the Bayes IM in which the variables in the manipulation have been
     * removed from the graph.
     *
     * @return the Bayes instantiated model after manipulations have been applied.
     */
    BayesIm getManipulatedBayesIm();

    /**
     * Returns the manipulated graph. This is the graph in which the variables in the manipulation have been removed
     * from the graph.
     *
     * @return the graph for the manipulated BayesIm.
     */
    Graph getManipulatedGraph();

    /**
     * Returns the manipulation that was used to manipulate the Bayes IM.
     *
     * @return a defensive copy of the evidence.
     */
    Evidence getEvidence();

    /**
     * Sets new evidence for the updater. Once this is called, old updating results should not longer be available.
     *
     * @param evidence the new evidence.
     */
    void setEvidence(Evidence evidence);

    /**
     * Returns the updated Bayes IM. This is the Bayes IM in which all probabilities of variables conditional on their
     * parents have been updated.
     * @return the updated Bayes IM--that is, the Bayes IM in which all probabilities of variables conditional on their
     * parents have been updated.
     */
    BayesIm getUpdatedBayesIm();

    /**
     * Returns the updated graph. This is the graph in which all probabilities of variables conditional on their
     * parents have been updated.
     * @return P(variable = category | evidence) where evidence is getEvidence().
     */
    double getMarginal(int variable, int category);

}









© 2015 - 2024 Weber Informatics LLC | Privacy Policy