ListOfFunctionOfMultipleMeansTallies.java

/*
 * Class:        ListOfFunctionOfMultipleMeansTallies
 * Description:  List of statistical collectors for a vector of functions
 * Environment:  Java
 * Software:     SSJ 
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author       Éric Buist 
 * @since        2007
 
 * SSJ is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License (GPL) as published by the
 * Free Software Foundation, either version 3 of the License, or
 * any later version.
 
 * SSJ 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.
 
 * A copy of the GNU General Public License is available at
   <a href="http://www.gnu.org/licenses">GPL licence site</a>.
 */
package umontreal.ssj.stat.list;
 
import umontreal.ssj.stat.FunctionOfMultipleMeansTally;
import umontreal.ssj.util.MultivariateFunction;
import cern.colt.matrix.DoubleMatrix1D;
import cern.colt.matrix.DoubleMatrix2D;

public class ListOfFunctionOfMultipleMeansTallies<E extends FunctionOfMultipleMeansTally> extends ListOfStatProbes<E> {
   double[][] temp = null;

   public ListOfFunctionOfMultipleMeansTallies() {
      super();
   }

   public ListOfFunctionOfMultipleMeansTallies(String name) {
      super(name);
   }

   public static ListOfFunctionOfMultipleMeansTallies<FunctionOfMultipleMeansTally> create(MultivariateFunction func,
         int d, int size) {
      ListOfFunctionOfMultipleMeansTallies<FunctionOfMultipleMeansTally> list = new ListOfFunctionOfMultipleMeansTallies<FunctionOfMultipleMeansTally>();
      for (int i = 0; i < size; i++)
         list.add(new FunctionOfMultipleMeansTally(func, d));
      return list;
   }

   public void add(double[][] x) {
      if (x.length != size())
         throw new IllegalArgumentException("Invalid number of vectors of observations: the given length is " + x.length
               + ", but the required length is " + size());
      if (collect)
         for (int i = 0; i < size(); i++) {
            FunctionOfMultipleMeansTally ta = get(i);
            if (ta != null)
               ta.add(x[i]);
         }
   }

   public void add(DoubleMatrix2D x) {
      if (x.rows() != size())
         throw new IllegalArgumentException("Invalid number of vectors of observations: the given number is " + x.rows()
               + ", but the required number is " + size());
      if (collect)
         for (int i = 0; i < size(); i++) {
            FunctionOfMultipleMeansTally ta = get(i);
            if (ta != null)
               ta.add(x.viewRow(i).toArray());
         }
   }

   public void addSameDimension(double[]... x) {
      final int l = size();
      final int d = getDimension();
      if (x.length != d)
         throw new IllegalArgumentException(
               "The length of the given array must be " + d + " while its actual length is " + x.length);
 
      if (x.length == 0 || l == 0)
         return;
 
      if (l != x[0].length)
         throw new IllegalArgumentException("The given arrays must have the same length");
 
      for (int i = 0; i < x.length - 1; i++)
         if (x[i].length != x[i + 1].length)
            throw new IllegalArgumentException("The given arrays must have the same length");
 
      if ((temp == null) || (temp.length != l) || (temp[0].length != d))
         temp = new double[l][d];
 
      for (int i = 0; i < l; i++)
         for (int j = 0; j < d; j++)
            temp[i][j] = x[j][i];
      add(temp);
   }

   public void addSameDimension(DoubleMatrix1D... x) {
      final int l = size();
      final int d = getDimension();
      if (x.length != d)
         throw new IllegalArgumentException(
               "The length of the given array must be " + d + " while its actual length is " + x.length);
 
      if (x.length == 0 || l == 0)
         return;
 
      if (l != x[0].size())
         throw new IllegalArgumentException("The given arrays must have the same length");
 
      for (int i = 0; i < x.length - 1; i++)
         if (x[i].size() != x[i + 1].size())
            throw new IllegalArgumentException("The given arrays must have the same length");
 
      if ((temp == null) || (temp.length != l) || (temp[0].length != d))
         temp = new double[l][d];
 
      for (int i = 0; i < l; i++)
         for (int j = 0; j < d; j++)
            temp[i][j] = x[j].get(i);
      add(temp);
   }

   public int getDimension() {
      if (size() == 0)
         return 0;
      FunctionOfMultipleMeansTally t0 = get(0);
      return t0 == null ? 0 : t0.getDimension();
   }

   public int numberObs() {
      if (size() == 0)
         return 0;
      FunctionOfMultipleMeansTally t0 = get(0);
      return t0 == null ? 0 : t0.numberObs();
   }

   public boolean areAllNumberObsEqual() {
      final int l = size();
      int n = numberObs();
      for (int i = 1; i < l; i++) {
         FunctionOfMultipleMeansTally t = get(i);
         if (t.numberObs() != n)
            return false;
      }
      return true;
   }

   public void average(double[] a) {
      super.average(a);
      for (int i = 0; i < a.length; i++)
         if (!Double.isNaN(a[i]) && get(i).numberObs() == 0)
            a[i] = Double.NaN;
   }

   public void variance(double[] v) {
      if (v.length != size())
         throw new IllegalArgumentException("Incompatible array length: the given length is " + v.length
               + " while the required length is " + size());
      for (int i = 0; i < v.length; i++) {
         FunctionOfMultipleMeansTally tally = get(i);
         if (tally == null || tally.numberObs() < 2)
            v[i] = Double.NaN;
         else
            v[i] = tally.variance();
      }
   }

   public void standardDeviation(double[] v) {
      if (v.length != size())
         throw new IllegalArgumentException("Incompatible array length: the given length is " + v.length
               + " while the required length is " + size());
      for (int i = 0; i < v.length; i++) {
         FunctionOfMultipleMeansTally tally = get(i);
         if (tally == null || tally.numberObs() < 2)
            v[i] = Double.NaN;
         else
            v[i] = tally.standardDeviation();
      }
   }

   public ListOfFunctionOfMultipleMeansTallies<E> clone() {
      ListOfFunctionOfMultipleMeansTallies<E> clone = (ListOfFunctionOfMultipleMeansTallies<E>) super.clone();
      if (temp != null) {
         clone.temp = new double[temp.length][temp[0].length];
         for (int i = 0; i < temp.length; i++)
            for (int j = 0; j < temp[i].length; i++)
               clone.temp[i][j] = temp[i][j];
      }
 
      return clone;
   }
}