edu.cmu.tetradapp.model.datamanip.ReorderColumnsWrapper 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.datamanip;

import edu.cmu.tetrad.data.*;
import edu.cmu.tetrad.graph.Node;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.RandomUtil;
import edu.cmu.tetrad.util.TetradSerializableUtils;
import edu.cmu.tetradapp.model.DataWrapper;
import edu.cmu.tetradapp.model.PcRunner;

import java.util.ArrayList;
import java.util.List;

/**
 * Tyler was lazy and didn't document this....
 *
 * @author Tyler Gibson
 * @version $Id: $Id
 */
public class ReorderColumnsWrapper extends DataWrapper {
    private static final long serialVersionUID = 23L;


    /**
     * Constructor for ReorderColumnsWrapper.
     *
     * @param data   a {@link edu.cmu.tetradapp.model.DataWrapper} object
     * @param params a {@link edu.cmu.tetrad.util.Parameters} object
     */
    public ReorderColumnsWrapper(DataWrapper data, Parameters params) {
        if (data == null) {
            throw new NullPointerException("The givan data must not be null");
        }

        DataModelList dataModelList = data.getDataModelList();

        List variables = dataModelList.get(0).getVariables();

        DataModelList newData = new DataModelList();
        variables = new ArrayList<>(variables);
        RandomUtil.shuffle(variables);

        if (dataModelList.get(0) instanceof DataSet) {
            List dataSets = new ArrayList<>();
            for (DataModel dataModel : dataModelList) {
                dataSets.add((DataSet) dataModel);
            }
            newData.addAll((DataTransforms.shuffleColumns2(dataSets)));
        } else {

            for (DataModel dataModel : dataModelList) {
//            if (dataModel instanceof DataSet) {
//                DataSet _newData = shuffleColumns((DataSet) dataModel);
//                newData.add(_newData);
//            }
//            else
                if (dataModel instanceof CovarianceMatrix cov) {

                    List vars = new ArrayList<>();

                    for (Node node : variables) {
                        vars.add(node.getName());
                    }

                    ICovarianceMatrix _newData = cov.getSubmatrix(vars);
                    newData.add(_newData);
                }
            }
        }

        this.setDataModel(newData);
        this.setSourceGraph(data.getSourceGraph());

        LogDataUtils.logDataModelList("Parent data in which constant columns have been removed.", getDataModelList());

    }

    /**
     * shuffleColumns.
     *
     * @param dataModel a {@link edu.cmu.tetrad.data.DataSet} object
     * @return a {@link edu.cmu.tetrad.data.DataSet} object
     */
    public static DataSet shuffleColumns(DataSet dataModel) {

        List vars = new ArrayList<>();

        for (Node node : dataModel.getVariables()) {
            Node _node = dataModel.getVariable(node.getName());

            if (_node != null) {
                vars.add(_node);
            }
        }

        RandomUtil.shuffle(vars);
        return dataModel.subsetColumns(vars);
    }

    /**
     * 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();
    }


}