edu.cmu.tetradapp.model.PValueImproverWrapper 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.*;
import edu.cmu.tetrad.graph.*;
import edu.cmu.tetrad.search.utils.GraphSearchUtils;
import edu.cmu.tetrad.search.utils.MeekRules;
import edu.cmu.tetrad.search.work_in_progress.Hbsms;
import edu.cmu.tetrad.search.work_in_progress.HbsmsBeam;
import edu.cmu.tetrad.search.work_in_progress.HbsmsGes;
import edu.cmu.tetrad.sem.SemIm;
import edu.cmu.tetrad.util.*;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serial;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
/**
* Extends AbstractAlgorithmRunner to produce a wrapper for the GES algorithm.
*
* @author Ricardo Silva
* @version $Id: $Id
*/
public class PValueImproverWrapper extends AbstractAlgorithmRunner {
@Serial
private static final long serialVersionUID = 23L;
/**
* The data wrapper.
*/
private final DataWrapper dataWrapper;
/**
* The parameters object, so the GUI can remember stuff for logging.
*/
private final Parameters params = new Parameters();
/**
* The algorithm type.
*/
private AlgorithmType algorithmType = AlgorithmType.BEAM;
/**
* The name of the algorithm.
*/
private String name;
/**
* The external graph.
*/
private Graph externalGraph;
/**
* The graph.
*/
private Graph graph;
/**
* The list of property change listeners.
*/
private transient List listeners;
/**
* The parameters object, so the GUI can remember stuff for logging.
*/
private Parameters params2;
/**
* The original SEM IM.
*/
private SemIm originalSemIm;
/**
* The new SEM IM.
*/
private SemIm newSemIm;
/**
* Constructor for PValueImproverWrapper.
*
* @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 PValueImproverWrapper(DataWrapper dataWrapper,
Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.dataWrapper = dataWrapper;
this.params2 = params;
this.graph = new EdgeListGraph(dataWrapper.getSelectedDataModel().getVariables());
}
//============================CONSTRUCTORS============================//
/**
* Constructor for PValueImproverWrapper.
*
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public PValueImproverWrapper(DataWrapper dataWrapper,
Parameters params) {
super(dataWrapper, params, null);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(dataWrapper.getSelectedDataModel().getVariables()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @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 PValueImproverWrapper(GraphWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public PValueImproverWrapper(GraphWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params) {
super(dataWrapper, params);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.DagWrapper} object
* @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 PValueImproverWrapper(DagWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.DagWrapper} object
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public PValueImproverWrapper(DagWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params) {
super(dataWrapper, params);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.SemGraphWrapper} object
* @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 PValueImproverWrapper(SemGraphWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.SemGraphWrapper} object
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public PValueImproverWrapper(SemGraphWrapper graphWrapper,
DataWrapper dataWrapper,
Parameters params) {
super(dataWrapper, params);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.AbstractAlgorithmRunner} object
* @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 PValueImproverWrapper(AbstractAlgorithmRunner graphWrapper,
DataWrapper dataWrapper,
Parameters params, KnowledgeBoxModel knowledgeBoxModel) {
super(dataWrapper, params, knowledgeBoxModel);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Constructor for PValueImproverWrapper.
*
* @param graphWrapper a {@link edu.cmu.tetradapp.model.AbstractAlgorithmRunner} object
* @param dataWrapper a {@link edu.cmu.tetradapp.model.DataWrapper} object
* @param params a {@link edu.cmu.tetrad.util.Parameters} object
*/
public PValueImproverWrapper(AbstractAlgorithmRunner graphWrapper,
DataWrapper dataWrapper,
Parameters params) {
super(dataWrapper, params);
this.dataWrapper = dataWrapper;
this.params2 = params;
setGraph(new EdgeListGraph(graphWrapper.getGraph()));
}
/**
* Generates a simple exemplar of this class to test serialization.
*
* @return a {@link edu.cmu.tetradapp.model.PcRunner} object
* @see TetradSerializableUtils
*/
public static PcRunner serializableInstance() {
return PcRunner.serializableInstance();
}
/**
* Getter for the field algorithmType.
*
* @return a {@link edu.cmu.tetradapp.model.PValueImproverWrapper.AlgorithmType} object
*/
public AlgorithmType getAlgorithmType() {
return this.algorithmType;
}
/**
* Setter for the field algorithmType.
*
* @param algorithmType a {@link edu.cmu.tetradapp.model.PValueImproverWrapper.AlgorithmType} object
*/
public void setAlgorithmType(AlgorithmType algorithmType) {
this.algorithmType = algorithmType;
}
//============================PUBLIC METHODS==========================//
/**
* Getter for the field name.
*
* @return a {@link java.lang.String} object
*/
public String getName() {
return this.name;
}
/**
* {@inheritDoc}
*/
public void setName(String name) {
this.name = name;
}
/**
* isShuffleMoves.
*
* @return a boolean
*/
public boolean isShuffleMoves() {
return false;
}
/**
* Executes the algorithm, producing (at least) a result workbench. Must be implemented in the extending class.
*/
public void execute() {
DataModel dataModel = getDataModel();
Knowledge knowledge = (Knowledge) this.params2.get("knowledge", new Knowledge());
if (this.externalGraph == null) {
this.externalGraph = new EdgeListGraph(dataModel.getVariables());
}
Graph graph2 = new EdgeListGraph(this.externalGraph);
graph2 = GraphUtils.replaceNodes(graph2, dataModel.getVariables());
Hbsms search;
if (dataModel instanceof DataSet dataSet) {
if (getAlgorithmType() == AlgorithmType.BEAM) {
search = new HbsmsBeam(graph2, dataSet, knowledge);
} else if (getAlgorithmType() == AlgorithmType.FGES) {
search = new HbsmsGes(graph2, dataSet);
search.setKnowledge(knowledge);
} else {
throw new IllegalStateException();
}
} else if (dataModel instanceof CovarianceMatrix covarianceMatrix) {
if (getAlgorithmType() == AlgorithmType.BEAM) {
search = new HbsmsBeam(graph2, covarianceMatrix, knowledge);
} else if (getAlgorithmType() == AlgorithmType.FGES) {
throw new IllegalArgumentException("GES method requires a dataset; a covariance matrix was provided.");
} else {
throw new IllegalStateException();
}
} else {
throw new IllegalStateException();
}
Parameters params = getParams();
search.setAlpha(params.getDouble("alpha", 0.001));
search.setBeamWidth(params.getInt("beamWidth", 5));
search.setHighPValueAlpha(params.getDouble("zeroEdgeP", 0.05));
this.graph = search.search();
// this.graph = search.getNewSemIm().getSemPm().getGraph();
setOriginalSemIm(search.getOriginalSemIm());
this.newSemIm = search.getNewSemIm();
fireGraphChange(this.graph);
if (getSourceGraph() != null) {
LayoutUtil.arrangeBySourceGraph(this.graph, getSourceGraph());
} else if (knowledge.isDefaultToKnowledgeLayout()) {
GraphSearchUtils.arrangeByKnowledgeTiers(this.graph, knowledge);
} else {
LayoutUtil.defaultLayout(this.graph);
}
setResultGraph(GraphTransforms.dagToCpdag(this.graph));
}
/**
* supportsKnowledge.
*
* @return a boolean
*/
public boolean supportsKnowledge() {
return true;
}
/**
* getMeekRules.
*
* @return a {@link edu.cmu.tetrad.search.utils.MeekRules} object
*/
public MeekRules getMeekRules() {
MeekRules rules = new MeekRules();
rules.setKnowledge((Knowledge) this.params.get("knowledge", new Knowledge()));
rules.setVerbose(false);
return rules;
}
/**
* {@inheritDoc}
*/
@Override
public String getAlgorithmName() {
return "BFF";
}
/**
* addPropertyChangeListener.
*
* @param l a {@link java.beans.PropertyChangeListener} object
*/
public void addPropertyChangeListener(PropertyChangeListener l) {
if (!getListeners().contains(l)) getListeners().add(l);
}
private void fireGraphChange(Graph graph) {
for (PropertyChangeListener l : getListeners()) {
l.propertyChange(new PropertyChangeEvent(this, "graph", null, graph));
}
}
/**
* Getter for the field graph.
*
* @return a {@link edu.cmu.tetrad.graph.Graph} object
*/
public Graph getGraph() {
return getResultGraph();
}
private void setGraph(EdgeListGraph graph) {
this.graph = new EdgeListGraph(graph);
this.externalGraph = new EdgeListGraph(graph);
}
/**
* getTriplesClassificationTypes.
*
* @return the names of the triple classifications. Coordinates with
*/
public List getTriplesClassificationTypes() {
return new LinkedList<>();
}
/**
* {@inheritDoc}
*/
public List> getTriplesLists(Node node) {
return new LinkedList<>();
}
private List getListeners() {
if (this.listeners == null) {
this.listeners = new ArrayList<>();
}
return this.listeners;
}
/**
* simulateDataCholesky.
*
* @param sampleSize a int
* @param covar a {@link edu.cmu.tetrad.util.Matrix} object
* @param variableNodes a {@link java.util.List} object
* @return a {@link edu.cmu.tetrad.data.DataSet} object
*/
public DataSet simulateDataCholesky(int sampleSize, Matrix covar, List variableNodes) {
List variables = new LinkedList<>(variableNodes);
List newVariables = new ArrayList<>();
for (Node node : variables) {
ContinuousVariable continuousVariable = new ContinuousVariable(node.getName());
continuousVariable.setNodeType(node.getNodeType());
newVariables.add(continuousVariable);
}
DataSet fullDataSet = new BoxDataSet(new VerticalDoubleDataBox(sampleSize, newVariables.size()), newVariables);
Matrix cholesky = MatrixUtils.cholesky(covar);
// Simulate the data by repeatedly calling the Cholesky.exogenousData
// method. Store only the data for the measured variables.
for (int row = 0; row < sampleSize; row++) {
// Step 1. Generate normal samples.
double[] exoData = new double[cholesky.getNumRows()];
for (int i = 0; i < exoData.length; i++) {
exoData[i] = RandomUtil.getInstance().nextNormal(0, 1);
// exoData[i] = randomUtil.nextUniform(-1, 1);
}
// Step 2. Multiply by cholesky to get correct covariance.
double[] point = new double[exoData.length];
for (int i = 0; i < exoData.length; i++) {
double sum = 0.0;
for (int j = 0; j <= i; j++) {
sum += cholesky.get(i, j) * exoData[j];
}
point[i] = sum;
}
for (int col = 0; col < variables.size(); col++) {
int index = variableNodes.indexOf(variables.get(col));
double value = point[index];
if (Double.isNaN(value) || Double.isInfinite(value)) {
throw new IllegalArgumentException("Value out of range: " + value);
}
fullDataSet.setDouble(row, col, value);
}
}
return DataTransforms.restrictToMeasured(fullDataSet);
}
/**
* Writes the object to the specified ObjectOutputStream.
*
* @param out The ObjectOutputStream to write the object to.
* @throws IOException If an I/O error occurs.
*/
@Serial
private void writeObject(ObjectOutputStream out) throws IOException {
try {
out.defaultWriteObject();
} catch (IOException e) {
TetradLogger.getInstance().log("Failed to serialize object: " + getClass().getCanonicalName()
+ ", " + e.getMessage());
throw e;
}
}
/**
* Reads the object from the specified ObjectInputStream. This method is used during deserialization
* to restore the state of the object.
*
* @param in The ObjectInputStream to read the object from.
* @throws IOException If an I/O error occurs.
* @throws ClassNotFoundException If the class of the serialized object cannot be found.
*/
@Serial
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
try {
in.defaultReadObject();
} catch (IOException e) {
TetradLogger.getInstance().log("Failed to deserialize object: " + getClass().getCanonicalName()
+ ", " + e.getMessage());
throw e;
}
}
/**
* Getter for the field originalSemIm.
*
* @return a {@link edu.cmu.tetrad.sem.SemIm} object
*/
public SemIm getOriginalSemIm() {
return this.originalSemIm;
}
private void setOriginalSemIm(SemIm originalSemIm) {
if (this.originalSemIm == null) {
this.originalSemIm = originalSemIm;
}
}
/**
* Getter for the field newSemIm.
*
* @return a {@link edu.cmu.tetrad.sem.SemIm} object
*/
public SemIm getNewSemIm() {
return this.newSemIm;
}
/**
* Setter for the field newSemIm.
*
* @param newSemIm a {@link edu.cmu.tetrad.sem.SemIm} object
*/
public void setNewSemIm(SemIm newSemIm) {
this.newSemIm = newSemIm;
}
/**
* Which algorithm to use.
*/
public enum AlgorithmType {
/**
* The BEAM algorithm.
*/
BEAM,
/**
* The FGES algorithm.
*/
FGES
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy