edu.cmu.tetradapp.model.FasRunner Maven / Gradle / Ivy
The 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.tetradapp.model;
import edu.cmu.tetrad.data.Knowledge;
import edu.cmu.tetrad.graph.*;
import edu.cmu.tetrad.search.Fas;
import edu.cmu.tetrad.search.IndependenceTest;
import edu.cmu.tetrad.search.utils.GraphSearchUtils;
import edu.cmu.tetrad.search.utils.MeekRules;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.Params;
import edu.cmu.tetrad.util.TetradSerializableUtils;
import edu.cmu.tetradapp.util.IndTestType;
import java.io.Serial;
import java.util.ArrayList;
import java.util.List;
/**
* Extends AbstractAlgorithmRunner to produce a wrapper for the PC algorithm.
*
* @author josephramsey
* @version $Id: $Id
*/
public class FasRunner extends AbstractAlgorithmRunner
implements IndTestProducer {
@Serial
private static final long serialVersionUID = 23L;
/**
* The graph to use as a starting point for the search.
*/
private Graph externalGraph;
//============================CONSTRUCTORS============================//
/**
* Constructs a wrapper for the given DataWrapper. The DataWrapper must contain a DataSet that is either a DataSet
* or a DataSet or a DataList containing either a DataSet or a DataSet as its selected model.
*
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(DataWrapper dataWrapper, Parameters params) {
super(dataWrapper, params, null);
}
/**
* Constructor for FasRunner.
*
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
* @param knowledgeBoxModel a {@link edu.cmu.tetradapp.model.KnowledgeBoxModel} object
*/
public FasRunner(DataWrapper dataWrapper, Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
}
// Starts PC from the given graph.
/**
* Constructor for FasRunner.
*
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(DataWrapper dataWrapper, GraphWrapper graphWrapper, Parameters params) {
super(dataWrapper, params, null);
this.externalGraph = graphWrapper.getGraph();
}
/**
* Constructor for FasRunner.
*
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
* @param knowledgeBoxModel a {@link edu.cmu.tetradapp.model.KnowledgeBoxModel} object
*/
public FasRunner(DataWrapper dataWrapper, GraphWrapper graphWrapper, Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.externalGraph = graphWrapper.getGraph();
}
/**
* Constucts a wrapper for the given EdgeListGraph.
*
* @param graph a {@link edu.cmu.tetrad.graph.Graph} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(Graph graph, Parameters params) {
super(graph, params);
}
/**
* Constucts a wrapper for the given EdgeListGraph.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(GraphWrapper graphWrapper, Parameters params) {
super(graphWrapper.getGraph(), params);
}
/**
* Constucts a wrapper for the given EdgeListGraph.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphSource} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
* @param knowledgeBoxModel a {@link edu.cmu.tetradapp.model.KnowledgeBoxModel} object
*/
public FasRunner(GraphSource graphWrapper, Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(graphWrapper.getGraph(), params, knowledgeBoxModel);
}
/**
* Constructor for FasRunner.
*
* @param dagWrapper a {@link edu.cmu.tetradapp.model.DagWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(DagWrapper dagWrapper, Parameters params) {
super(dagWrapper.getDag(), params);
}
/**
* Constructor for FasRunner.
*
* @param dagWrapper a {@link edu.cmu.tetradapp.model.SemGraphWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(SemGraphWrapper dagWrapper, Parameters params) {
super(dagWrapper.getGraph(), params);
}
/**
* Constructor for FasRunner.
*
* @param model a {@link edu.cmu.tetradapp.model.IndependenceFactsModel} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public FasRunner(IndependenceFactsModel model, Parameters params) {
super(model, params, null);
}
/**
* Constructor for FasRunner.
*
* @param model a {@link edu.cmu.tetradapp.model.IndependenceFactsModel} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
* @param knowledgeBoxModel a {@link edu.cmu.tetradapp.model.KnowledgeBoxModel} object
*/
public FasRunner(IndependenceFactsModel model, Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(model, params, knowledgeBoxModel);
}
/**
* Generates a simple exemplar of this class to test serialization.
*
* @return a {@link edu.cmu.tetradapp.model.FasRunner} object
* @see TetradSerializableUtils
*/
public static FasRunner serializableInstance() {
return new FasRunner(Dag.serializableInstance(), new Parameters());
}
/**
* getMeekRules.
*
* @return a {@link edu.cmu.tetrad.search.utils.MeekRules} object
*/
public MeekRules getMeekRules() {
MeekRules rules = new MeekRules();
rules.setMeekPreventCycles(this.isMeekPreventCycles());
rules.setKnowledge((Knowledge) getParams().get("knowledge", new Knowledge()));
rules.setVerbose(false);
return rules;
}
/**
* {@inheritDoc}
*/
@Override
public String getAlgorithmName() {
return "FAS";
}
//===================PUBLIC METHODS OVERRIDING ABSTRACT================//
/**
* execute.
*/
public void execute() {
Knowledge knowledge = (Knowledge) getParams().get("knowledge", new Knowledge());
int depth = getParams().getInt("depth", -1);
Graph graph = new EdgeListGraph(getIndependenceTest().getVariables());
Fas fas = new Fas(getIndependenceTest());
fas.setKnowledge(knowledge);
fas.setDepth(depth);
try {
graph = fas.search();
} catch (InterruptedException e) {
throw new RuntimeException(e);
}
System.out.println(graph);
for (Node node : graph.getNodes()) {
System.out.println(node + " " + graph.getAdjacentNodes(node).size());
}
if (getSourceGraph() != null) {
LayoutUtil.arrangeBySourceGraph(graph, getSourceGraph());
} else if (knowledge.isDefaultToKnowledgeLayout()) {
GraphSearchUtils.arrangeByKnowledgeTiers(graph, knowledge);
} else {
LayoutUtil.defaultLayout(graph);
}
setResultGraph(graph);
}
/**
* getIndependenceTest.
*
* @return a {@link edu.cmu.tetrad.search.IndependenceTest} object
*/
public IndependenceTest getIndependenceTest() {
Object dataModel = getDataModel();
if (dataModel == null) {
dataModel = getSourceGraph();
}
IndTestType testType = (IndTestType) (getParams()).get("indTestType", IndTestType.FISHER_Z);
return new IndTestChooser().getTest(dataModel, getParams(), testType);
}
/**
* getGraph.
*
* @return a {@link edu.cmu.tetrad.graph.Graph} object
*/
public Graph getGraph() {
return getResultGraph();
}
/**
* getTriplesClassificationTypes.
*
* @return the names of the triple classifications. Coordinates with getTriplesList.
*/
public List getTriplesClassificationTypes() {
return new ArrayList<>();
}
/**
* {@inheritDoc}
*/
public List> getTriplesLists(Node node) {
return new ArrayList<>();
}
/**
* supportsKnowledge.
*
* @return a boolean
*/
public boolean supportsKnowledge() {
return true;
}
//========================== Private Methods ===============================//
private boolean isMeekPreventCycles() {
Parameters params = getParams();
if (params != null) {
return params.getBoolean(Params.GUARANTEE_CPDAG, true);
}
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy