edu.cmu.tetradapp.model.CheckKnowledgeModel 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
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.Edge;
import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.search.CheckKnowledge;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradLogger;
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.List;


/**
 * Compares a target workbench with a reference workbench by counting errors of omission and commission.  (for edge
 * presence only, not orientation).
 *
 * @author josephramsey
 * @author Erin Korber (added remove latents functionality July 2004)
 * @version $Id: $Id
 */
public final class CheckKnowledgeModel implements SessionModel {
    @Serial
    private static final long serialVersionUID = 23L;

    /**
     * The graph to be checked.
     */
    private final Graph graph;

    /**
     * The knowledge to be checked against.
     */
    private final Knowledge knowledge;

    /**
     * The parameters for the check.
     */
    private final Parameters params;

    /**
     * The name of the model.
     */
    private final String modelName;

    /**
     * The name of the model.
     */
    private String name = "Check Knowledge";

    /**
     * Compares the results of a PC to a reference workbench by counting errors of omission and commission. The counts
     * can be retrieved using the methods
     * countOmissionErrors and countCommissionErrors.
     *
     * @param model             a {@link edu.cmu.tetradapp.model.GraphSource} object
     * @param knowledgeBoxModel a {@link edu.cmu.tetradapp.model.KnowledgeBoxModel} object
     * @param params            a {@link edu.cmu.tetrad.util.Parameters} object
     */
    public CheckKnowledgeModel(GraphSource model, KnowledgeBoxModel knowledgeBoxModel, Parameters params) {
        if (params == null) {
            throw new NullPointerException("Parameters must not be null");
        }

        if (model == null) {
            throw new NullPointerException("Null graph source>");
        }

        if (knowledgeBoxModel == null) {
            throw new NullPointerException("Null knowledge box model");
        }

        this.graph = model.getGraph();
        this.knowledge = knowledgeBoxModel.getKnowledge();
        this.params = params;
        this.modelName = model.getName();
    }


    /**
     * getComparisonString.
     *
     * @return a {@link java.lang.String} object
     */
    public String getComparisonString() {
        List forbiddenViolations = CheckKnowledge.forbiddenViolations(graph, knowledge);
        List requiredViolations = CheckKnowledge.requiredViolations(graph, knowledge);

        StringBuilder sb = new StringBuilder();
        sb.append("Violations of knowledge for ").append(modelName).append(": ");

        sb.append("\n\nForbidden Violations:\n");

        for (Edge edge : forbiddenViolations) {
            sb.append("\n");
            sb.append(edge.toString());
            sb.append(", ");
        }

        sb.append("\n\nRequired Violations:\n");

        for (Edge edge : requiredViolations) {
            sb.append("\n");
            sb.append(edge.toString());
            sb.append(", ");
        }

        sb.append("\n\nKnowledge:\n\n");
        sb.append(knowledge);

        sb.append("\n\nGraph:\n\n");
        sb.append(graph);

        return sb.toString();
    }

    /**
     * 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 params.
     *
     * @return a {@link edu.cmu.tetrad.util.Parameters} object
     */
    public Parameters getParams() {
        return this.params;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * {@inheritDoc}
     */
    public void setName(String name) {
        this.name = name;
    }
}