edu.cmu.tetradapp.model.ScoredGraphsWrapper 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.graph.EdgeListGraph;
import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.graph.GraphTransforms;
import edu.cmu.tetrad.search.utils.DagScorer;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradLogger;
import edu.cmu.tetrad.util.TetradSerializableUtils;
import edu.cmu.tetrad.util.Unmarshallable;
import edu.cmu.tetradapp.session.DoNotAddOldModel;
import edu.cmu.tetradapp.session.SessionModel;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serial;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Holds a list of graphs.
*
* @author josephramsey
* @version $Id: $Id
*/
public class ScoredGraphsWrapper implements SessionModel, GraphSource, Unmarshallable, DoNotAddOldModel {
@Serial
private static final long serialVersionUID = 23L;
/**
* The graphs and their scores.
*/
private final Map graphsToScores;
/**
* Transient graph scorer, null if non exists (or needs to be refreshed).
*/
private final transient DagScorer graphScorer;
/**
* The name of the set of graphs.
*/
private String name;
/**
* deprecated;
*/
private Graph selectedGraph;
//=============================CONSTRUCTORS==========================//
private ScoredGraphsWrapper() {
this.graphsToScores = null;
this.graphScorer = null;
}
/**
* Constructor for ScoredGraphsWrapper.
*
* @param graph a {@link edu.cmu.tetrad.graph.Graph} object
* @param scorer a {@link edu.cmu.tetrad.search.utils.DagScorer} object
*/
public ScoredGraphsWrapper(Graph graph, DagScorer scorer) {
List dags = GraphTransforms.generateCpdagDags(graph, true);
this.graphsToScores = new HashMap<>();
this.graphScorer = scorer;
for (Graph _graph : dags) {
double score = Double.NaN;
if (scorer != null) {
score = scorer.scoreDag(_graph);
}
this.graphsToScores.put(_graph, score);
}
if (!this.graphsToScores.keySet().isEmpty()) {
/*
The index of the selected graph.
*/
final int index = 0;
this.selectedGraph = this.graphsToScores.keySet().iterator().next();
}
log();
}
/**
* Constructor for ScoredGraphsWrapper.
*
* @param wrapper a {@link edu.cmu.tetradapp.model.DagWrapper} object
* @param parameters a {@link edu.cmu.tetrad.util.Parameters} object
*/
public ScoredGraphsWrapper(DagWrapper wrapper, Parameters parameters) {
this(wrapper.getGraph(), null);
}
/**
* Constructor for ScoredGraphsWrapper.
*
* @param wrapper a {@link edu.cmu.tetradapp.model.GraphWrapper} object
* @param parameters a {@link edu.cmu.tetrad.util.Parameters} object
*/
public ScoredGraphsWrapper(GraphWrapper wrapper, Parameters parameters) {
this(wrapper.getGraph(), null);
}
/**
* Constructor for ScoredGraphsWrapper.
*
* @param wrapper a {@link edu.cmu.tetradapp.model.SemGraphWrapper} object
* @param parameters a {@link edu.cmu.tetrad.util.Parameters} object
*/
public ScoredGraphsWrapper(SemGraphWrapper wrapper, Parameters parameters) {
this(wrapper.getGraph(), null);
}
/**
* Constructor for ScoredGraphsWrapper.
*
* @param wrapper a {@link edu.cmu.tetradapp.model.PcRunner} object
* @param parameters a {@link edu.cmu.tetrad.util.Parameters} object
*/
public ScoredGraphsWrapper(PcRunner wrapper, Parameters parameters) {
this(wrapper.getGraph(), null);
}
/**
* Generates a simple exemplar of this class to test serialization.
*
* @return a {@link edu.cmu.tetradapp.model.ScoredGraphsWrapper} object
* @see TetradSerializableUtils
*/
public static ScoredGraphsWrapper serializableInstance() {
return new ScoredGraphsWrapper(PcRunner.serializableInstance(), new Parameters());
}
//==============================PUBLIC METHODS======================//
/**
* Getter for the field graphsToScores.
*
* @return a {@link java.util.Map} object
*/
public Map getGraphsToScores() {
Map _graphsToScores = new LinkedHashMap<>();
for (Graph graph : this.graphsToScores.keySet()) {
_graphsToScores.put(new EdgeListGraph(graph), this.graphsToScores.get(graph));
}
return _graphsToScores;
}
/**
* 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;
}
//==========================PRIVATE METHODS===========================//
private void log() {
TetradLogger.getInstance().log("DAGs in forbid_latent_common_causes");
TetradLogger.getInstance().log("\nSelected Graph\n");
String message1 = getGraph() + "";
TetradLogger.getInstance().log(message1);
TetradLogger.getInstance().log("\nAll Graphs:\n");
int index = 0;
for (Graph graph : this.graphsToScores.keySet()) {
String message = "\nGraph #" + (++index);
TetradLogger.getInstance().log(message);
TetradLogger.getInstance().log(graph + "");
}
}
/**
* 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;
}
}
/**
* May be null; a selected graph must be set.
*
* @return a {@link edu.cmu.tetrad.graph.Graph} object
*/
public Graph getGraph() {
return this.selectedGraph;
}
/**
* May be null; a selected graph must be set.
*
* @return a {@link edu.cmu.tetrad.graph.Graph} object
*/
public Graph getSelectedGraph() {
return this.selectedGraph;
}
/**
* Sets a selected graph. Must be one of the graphs in getGraphToScore().keySet.
*
* @param graph a {@link edu.cmu.tetrad.graph.Graph} object
*/
public void setSelectedGraph(Graph graph) {
if (!this.graphsToScores.containsKey(graph)) {
throw new IllegalArgumentException("Not a graph in this set.");
}
this.selectedGraph = graph;
}
/**
* Getter for the field graphScorer.
*
* @return a {@link edu.cmu.tetrad.search.utils.DagScorer} object
*/
public DagScorer getGraphScorer() {
return this.graphScorer;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy