edu.cmu.tetradapp.model.KnowledgeBoxModel 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
There is a newer version: 7.6.6
///////////////////////////////////////////////////////////////////////////////
// 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.data.KnowledgeBoxInput;
import edu.cmu.tetrad.data.KnowledgeTransferable;
import edu.cmu.tetrad.graph.EdgeListGraph;
import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.graph.Node;
import edu.cmu.tetrad.graph.NodeType;
import edu.cmu.tetrad.session.ParamsResettable;
import edu.cmu.tetrad.session.SessionModel;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradLogger;
import edu.cmu.tetrad.util.TetradSerializableUtils;

import java.util.*;

/**
 * @author kaalpurush
 */
public class KnowledgeBoxModel implements SessionModel, ParamsResettable, KnowledgeEditable {

    private static final long serialVersionUID = 23L;
    private final Graph sourceGraph = new EdgeListGraph();
    private String name;
    private Parameters params;
    private Knowledge knowledge = new Knowledge();
    private List variables = new ArrayList<>();
    private List variableNames = new ArrayList<>();
    private int numTiers = 3;

    public KnowledgeBoxModel(Parameters params) {
        this.knowledge = new Knowledge();
        this.numTiers = 3;
        this.variables = new ArrayList<>();
        this.params = params;
        this.params.set("__myKnowledge", this.knowledge);
    }

    /**
     * Constructor from dataWrapper edge
     */
    public KnowledgeBoxModel(KnowledgeBoxInput[] inputs, Parameters params) {
        if (params == null) {
            throw new NullPointerException();
        }

        if (inputs.length == 1 && inputs[0] instanceof TimeLagGraphWrapper) {
            this.knowledge = ((TimeLagGraphWrapper) inputs[0]).getKnowledge();
            return;
        }

        if (inputs.length == 1 && inputs[0] instanceof KnowledgeTransferable) {
            this.knowledge = ((KnowledgeTransferable) inputs[0]).getKnowledge();
            this.numTiers = this.knowledge.getNumTiers();
            return;
        }

        for (KnowledgeBoxInput input : inputs) {
            if (input == null) {
                throw new NullPointerException();
            }
        }

        SortedSet variableNodes = new TreeSet<>();
        SortedSet variableNames = new TreeSet<>();

        for (KnowledgeBoxInput input : inputs) {
            for (Node node : input.getVariables()) {
                if (node.getNodeType() == NodeType.MEASURED) {
                    variableNodes.add(node);
                    variableNames.add(node.getName());
                    this.knowledge.addVariable(node.getName());
                }
            }
        }

        this.variables = new ArrayList<>(variableNodes);
        this.variableNames = new ArrayList<>(variableNames);

        this.params = params;

        Object myKnowledge = params.get("__myKnowledge");
        if (myKnowledge instanceof Knowledge
                && new HashSet<>(((Knowledge) myKnowledge).getVariables())
                .equals(new HashSet<>(variableNames))) {
            this.knowledge = (Knowledge) myKnowledge;
        } else {
            this.knowledge = new Knowledge();

            for (String var : variableNames) {
                this.knowledge.addVariable(var);
            }

            params.set("__myKnowledge", this.knowledge);
        }

        TetradLogger.getInstance().log("info", "Knowledge");
    }

    /**
     * Generates a simple exemplar of this class to test serialization.
     *
     * @see TetradSerializableUtils
     */
    public static KnowledgeBoxModel serializableInstance() {
        return new KnowledgeBoxModel(new KnowledgeBoxInput[]{GraphWrapper.serializableInstance()}, new Parameters());
    }

    private void freshenKnowledgeIfEmpty(List varNames) {
        if (this.knowledge.isEmpty()) {
            createKnowledge(this.knowledge);

            for (String varName : varNames) {
                if (!varName.startsWith("E_")) {
                    varNames.add(varName);
                }
            }
        }
    }

    private void createKnowledge(Knowledge knowledge) {
        knowledge.clear();
        this.variableNames.clear();
        for (String varName : knowledge.getVariables()) {
            knowledge.addVariable(varName);
        }
    }

    @Override
    public String getName() {
        return this.name;
    }

    @Override
    public void setName(String name) {
        this.name = name;
    }

    @Override
    public Graph getSourceGraph() {
        return this.sourceGraph;
    }

    //    @Override
    public Graph getResultGraph() {
        return this.sourceGraph;
    }

    @Override
    public List getVarNames() {
        return this.variableNames;
    }

    @Override
    public Knowledge getKnowledge() {
        return this.knowledge;
    }

    @Override
    public void setKnowledge(Knowledge knowledge) {
        if (knowledge == null) {
            throw new NullPointerException();
        }
        this.knowledge = knowledge;
        this.numTiers = knowledge.getNumTiers();
        this.params.set("__myKnowledge", knowledge);

        // printing out is bad for large knowledge input
//        TetradLogger.getInstance().log("knowledge", knowledge.toString());
    }

    @Override
    public void resetParams(Object params) {
        this.params = (Parameters) params;
        freshenKnowledgeIfEmpty(this.variableNames);

        // printing out is bad for large knowledge input
//        TetradLogger.getInstance().log("knowledge", knowledge.toString());
    }

    @Override
    public Object getResettableParams() {
        return this.params;
    }

    //    @Override
    public List getVariables() {
        return this.variables;
    }

    //    @Override
    public List getVariableNames() {
        return this.variableNames;
    }

    public int getNumTiers() {
        return this.numTiers;
    }

    public void setNumTiers(int numTiers) {
        this.numTiers = numTiers;
    }
}