edu.cmu.tetradapp.editor.GraphPropertiesAction 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.editor;

import edu.cmu.tetrad.graph.*;
import edu.cmu.tetradapp.util.DesktopController;
import edu.cmu.tetradapp.workbench.GraphWorkbench;

import javax.swing.*;
import java.awt.*;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.ClipboardOwner;
import java.awt.datatransfer.Transferable;
import java.awt.event.ActionEvent;
import java.text.NumberFormat;

/**
 * Puts up a panel showing some graph properties, e.g., number of nodes and
 * edges in the graph, etc.
 *
 * @author Joseph Ramsey [email protected]
 */
class GraphPropertiesAction extends AbstractAction implements ClipboardOwner {
    private GraphWorkbench workbench;

    /**
     * Creates a new copy subsession action for the given LayoutEditable and
     * clipboard.
     */
    public GraphPropertiesAction(GraphWorkbench workbench) {
        super("Graph Properties");
        this.workbench = workbench;
    }

    /**
     * Copies a parentally closed selection of session nodes in the frontmost
     * session editor to the clipboard.
     */
    public void actionPerformed(ActionEvent e) {
        Box b = Box.createVerticalBox();

        int numLatents = 0;
        for (Node node : getGraph().getNodes()) {
            if (node.getNodeType() == NodeType.LATENT) {
                numLatents++;
            }
        }

        int maxIndegree = 0;
        for (Node node : getGraph().getNodes()) {
            int indegree = getGraph().getNodesInTo(node, Endpoint.ARROW).size();

            if (indegree > maxIndegree) {
                maxIndegree = indegree;
            }
        }

        int maxOutdegree = 0;
        for (Node node : getGraph().getNodes()) {
            int outdegree = getGraph().getNodesOutTo(node, Endpoint.ARROW).size();

            if (outdegree > maxOutdegree) {
                maxOutdegree = outdegree;
            }
        }

        int numDirectedEdges = 0;
        int numBidirectedEdges = 0;
        int numUndirectedEdges = 0;

        for (Edge edge : getGraph().getEdges()) {
            if (Edges.isDirectedEdge(edge)) numDirectedEdges++;
            else if (Edges.isBidirectedEdge(edge)) numBidirectedEdges++;
            else if (Edges.isUndirectedEdge(edge)) numUndirectedEdges++;
        }

        boolean cyclic = getGraph().existsDirectedCycle();

        JTextArea textArea = new JTextArea();
        JScrollPane scroll = new JScrollPane(textArea);
        scroll.setPreferredSize(new Dimension(300, 300));

        textArea.append("\nNumber of nodes: " + getGraph().getNumNodes());
        textArea.append("\nNumber of latents: " + numLatents);
        textArea.append("\nNumber of edges: " + getGraph().getNumEdges());
        textArea.append("\nNumber of directed edges: " + numDirectedEdges);
        textArea.append("\nNumber of bidirected edges: " + numBidirectedEdges);
        textArea.append("\nNumber of undirected edges: " + numUndirectedEdges);
        textArea.append("\nMax degree: " + getGraph().getConnectivity());
        textArea.append("\nMax indegree: " + maxIndegree);
        textArea.append("\nMax outdegree: " + maxOutdegree);

        int numEdges = getGraph().getNumEdges();
        int numVars = getGraph().getNumNodes();
        double avgDegree = 2 * numEdges / ((double) (numVars));
        double density = avgDegree / (numVars - 1);

        textArea.append("\nAverage degree: " + NumberFormat.getInstance().format(avgDegree));
        textArea.append("\nDensity: " + NumberFormat.getInstance().format(density));

        textArea.append("\nNumber of latents: " + numLatents);
        textArea.append("\n" + (cyclic ? "Cyclic" : "Acyclic"));

        Box b2 = Box.createHorizontalBox();
        b2.add(scroll);
        textArea.setCaretPosition(0);
        b.add(b2);

        JPanel panel = new JPanel();
        panel.setLayout(new BorderLayout());
        panel.add(b);

        EditorWindow window = new EditorWindow(panel,
                "Graph Properties", "Close", false, workbench);
        DesktopController.getInstance().addEditorWindow(window, JLayeredPane.PALETTE_LAYER);
        window.setVisible(true);
    }

    /**
     * Required by the AbstractAction interface; does nothing.
     */
    public void lostOwnership(Clipboard clipboard, Transferable contents) {
    }


    public void setGraph(Graph graph, GraphWorkbench workbench) {
        workbench.setGraph(graph);
        this.workbench = workbench;
    }

    public Graph getGraph() {
        return this.workbench.getGraph();
    }
}