All Downloads are FREE. Search and download functionalities are using the official Maven repository.

edu.cmu.tetrad.data.MixedDataBox Maven / Gradle / Ivy

There is a newer version: 7.6.4
Show 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.tetrad.data;

import edu.cmu.tetrad.graph.Node;

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

/**
 * Stores a 2D array of double continuousData. Note that the missing value marker for this box is -99.
 */
public class MixedDataBox implements DataBox {

    private static final long serialVersionUID = 23L;

    private final List variables;
    private final int numRows;
    private double[][] continuousData;
    private int[][] discreteData;

    /**
     * The variables here are used only to determine which columns are discrete and which are continuous; bounds
     * checking is not done.
     */
    public MixedDataBox(List variables, int numRows) {
        this.variables = variables;
        this.numRows = numRows;

        this.continuousData = new double[variables.size()][];
        this.discreteData = new int[variables.size()][];

        for (int j = 0; j < variables.size(); j++) {
            if (variables.get(j) instanceof ContinuousVariable) {
                this.continuousData[j] = new double[numRows];
                Arrays.fill(this.continuousData[j], Double.NaN);
            } else if (variables.get(j) instanceof DiscreteVariable) {
                this.discreteData[j] = new int[numRows];
                Arrays.fill(this.discreteData[j], -99);
            }
        }


    }

    /**
     * This constructor allows other data readers to populate the fields directly.
     *
     * @param variables      list of discrete and continuous variables
     * @param numRows        number of cases in the dataset
     * @param continuousData continuous data
     * @param discreteData   discrete data
     */
    public MixedDataBox(List variables, int numRows, double[][] continuousData, int[][] discreteData) {
        this.variables = variables;
        this.numRows = numRows;
        this.continuousData = continuousData;
        this.discreteData = discreteData;

        if (variables == null) {
            throw new IllegalArgumentException("Parameter variables cannot be null.");
        }
        if (numRows < 0) {
            throw new IllegalArgumentException("Parameter numRows cannot be negative.");
        }
        if (continuousData == null) {
            throw new IllegalArgumentException("Parameter continuousData cannot be null.");
        }
        if (discreteData == null) {
            throw new IllegalArgumentException("Parameter discreteData cannot be null.");
        }

        // ensure the number of variables for both datasets are the same
        int numOfVars = variables.size();
        if (continuousData.length != numOfVars) {
            throw new IllegalArgumentException(String.format("Continuous Data: expect %d variables but found %d.", numOfVars, continuousData.length));
        }
        if (discreteData.length != numOfVars) {
            throw new IllegalArgumentException(String.format("Discrete Data: expect %d variables but found %d.", numOfVars, discreteData.length));
        }

        for (int i = 0; i < numOfVars; i++) {
            // ensure there is data for either dataset, not both
            if ((continuousData[i] == null) == (discreteData[i] == null)) {
                String errMsg = String.format("Variable at index %d either has data for both discrete and continuous or has no data for both.", i);
                throw new IllegalArgumentException(errMsg);
            }

            // ensure the number of rows for both dataset is consistent
            if (continuousData[i] != null && continuousData[i].length != numRows) {
                String errMsg = String.format("Continuous Data: Inconsistent row number at index %d.  Expect %d rows but found %d.", i, numRows, continuousData[i].length);
                throw new IllegalArgumentException(errMsg);
            }
            if (discreteData[i] != null && discreteData[i].length != numRows) {
                String errMsg = String.format("Discrete Data: Inconsistent row number at index %d.  Expect %d rows but found %d.", i, numRows, discreteData[i].length);
                throw new IllegalArgumentException(errMsg);
            }
        }
    }

    /**
     * Generates a simple exemplar of this class to test serialization.
     */
    public static BoxDataSet serializableInstance() {
        List vars = new ArrayList<>();
        for (int i = 0; i < 4; i++) vars.add(new ContinuousVariable("X" + i));
        return new BoxDataSet(new ShortDataBox(4, 4), vars);
    }

    /**
     * @return the number of rows in this continuousData box.
     */
    @Override
    public int numRows() {
        return this.numRows;
    }

    /**
     * @return the number of columns in this continuousData box.
     */
    @Override
    public int numCols() {
        return this.variables.size();
    }

    /**
     * Sets the value at the given row/column to the given Number value. The value used is number.doubleValue().
     */
    @Override
    public void set(int row, int col, Number value) {
        if (value == null) {
            if (this.continuousData[col] != null) {
                this.continuousData[col][row] = Double.NaN;
            } else if (this.discreteData[col] != null) {
                this.discreteData[col][row] = -99;
            } else {
                throw new IllegalArgumentException("Indices out of bounds or null value.");
            }
        } else {
            if (this.continuousData[col] != null) {
                this.continuousData[col][row] = value.doubleValue();
            } else if (this.discreteData[col] != null) {
                this.discreteData[col][row] = value.intValue();
            } else {
                throw new IllegalArgumentException("Indices out of bounds or null value.");
            }
        }
    }

    /**
     * @return the Number value at the given row and column. If the value is missing (-99), null, is returned.
     */
    @Override
    public Number get(int row, int col) {
        if (col >= this.continuousData.length || row >= numRows()) {
            return null;
        }

        if (this.continuousData[col] != null) {
            double v = this.continuousData[col][row];
            return Double.isNaN(v) ? null : v;
        } else if (this.discreteData[col] != null) {
            double v = this.discreteData[col][row];
            return v == -99 ? null : v;
        }

        throw new IllegalArgumentException("Indices out of range.");
    }

    /**
     * @return a copy of this continuousData box.
     */
    @Override
    public DataBox copy() {
        MixedDataBox box = new MixedDataBox(this.variables, numRows());

        for (int i = 0; i < numRows(); i++) {
            for (int j = 0; j < numCols(); j++) {
                box.set(i, j, get(i, j));
            }
        }

        return box;
    }

    /**
     * @return a DataBox of type DoubleDataBox, but with the given dimensions.
     */
    @Override
    public DataBox like() {
        int[] rows = new int[numRows()];
        int[] cols = new int[numCols()];

        for (int i = 0; i < numRows(); i++) {
            rows[i] = i;
        }
        for (int j = 0; j < numCols(); j++) {
            cols[j] = j;
        }

        return viewSelection(rows, cols);
    }

    public void addVariable(Node variable) {
        this.variables.add(variable);

        this.continuousData = Arrays.copyOf(this.continuousData, this.continuousData.length + 1);
        this.discreteData = Arrays.copyOf(this.discreteData, this.discreteData.length + 1);

        if (variable instanceof ContinuousVariable) {
            this.continuousData[this.continuousData.length - 1] = new double[this.numRows];
        } else if (variable instanceof DiscreteVariable) {
            this.discreteData[this.discreteData.length - 1] = new int[this.numRows];
        } else {
            throw new IllegalStateException();
        }
    }

    @Override
    public DataBox viewSelection(int[] rows, int[] cols) {
        List newVars = new ArrayList<>();

        for (int c : cols) {
            newVars.add(this.variables.get(c));
        }

        int row_num = rows.length;
        int col_num = cols.length;

        DataBox _dataBox = new MixedDataBox(newVars, row_num);

        for (int i = 0; i < row_num; i++) {
            for (int j = 0; j < col_num; j++) {
                _dataBox.set(i, j, get(rows[i], cols[j]));
            }
        }

        return _dataBox;
    }

    public double[][] getContinuousData() {
        return this.continuousData;
    }

    public int[][] getDiscreteData() {
        return this.discreteData;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy