SortedAndCutPointSet.java

/*
 * Class:        SortedAndCutPointSet
 * Description:  
 * Environment:  Java
 * Software:     SSJ 
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author       Adam L'Archevêque Gaudet  and Pierre L'Ecuyer
 * @since
 
 * 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.hups;
 
import umontreal.ssj.rng.RandomStream;
import umontreal.ssj.util.PrintfFormat;
// import java.util.Comparator;
// import java.util.Arrays;
import umontreal.ssj.util.multidimsort.MultiDimSort;

public class SortedAndCutPointSet extends CachedPointSet {
   protected int[] index; // Index that represents the permutation of the sort.
   protected MultiDimSort sort; // Seems to be needed only by the constructor.
   protected int numSortCoord; // Number of coordinates used for the sort.

   public SortedAndCutPointSet(PointSet p, MultiDimSort sort) {
      super(p, 0, p.getNumPoints(), 0, sort.dimension() + 1);
      numPoints = p.getNumPoints();
      numSortCoord = sort.dimension();
      this.sort = sort;
      this.P = p;
      makeIndex();
      dim = p.getDimension() - numSortCoord;
      x = new double[numPoints][dim];
      fillCacheByIndex(numSortCoord, dim);
   }

   protected int[] makeIndex() {
      for (int i = 0; i < numPoints; ++i)
         x[i][numSortCoord] = i; // Adds extra coordinate that saves the point number.
      sort.sort(x, 0, numPoints);
      index = new int[numPoints];
      for (int i = 0; i < numPoints; ++i)
         index[(int) x[i][numSortCoord]] = i;
      return index;
   }

   protected void fillCacheByIndex(int fromDim, int dim) {
      PointSetIterator itr = P.iterator();
      for (int i = 0; i < numPoints; ++i) {
         itr.nextPoint(x[index[i]], fromDim, dim);
      }
   }

   public int getDimension() {
      return dim;
   }

   public MultiDimSort getSort() {
      return sort;
   }

   public PointSetIterator iterator() {
      return new SortedAndCutPointSetIterator();
   }

   public void addRandomShift(int d1, int d2, RandomStream stream) {
      P.addRandomShift(d1 + numSortCoord, d2 + numSortCoord, stream);
      fillCacheByIndex(d1 + numSortCoord, d2 + numSortCoord);
   }

   public void randomize(PointSetRandomization rand) {
      P.randomize(rand);
      // Actually we could randomize only from coordinate numSortCoord. ****
      fillCacheByIndex(numSortCoord, dim);
   }

   public String toString() {
      StringBuffer sb = new StringBuffer("SortAndCutPointSet " + PrintfFormat.NEWLINE);
      sb.append(PrintfFormat.NEWLINE + "Cached point set information {" + PrintfFormat.NEWLINE);
      sb.append(P.toString());
      sb.append(PrintfFormat.NEWLINE + "}");
      return sb.toString();
   }
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// This class implements a SortedAndCutPointSet iterator.
// which takes the value in x rather than calling the function
// getCoordinate inherited from CachedPointSet.
 
   protected class SortedAndCutPointSetIterator extends DefaultPointSetIterator {
 
      public double nextCoordinate() {
         if (getCurPointIndex() >= numPoints || getCurCoordIndex() >= dim)
            outOfBounds();
         return x[curPointIndex][curCoordIndex++];
      }
   }
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// This class implements a SortedAndCutPointSet iterator that takes the points
// directly in P instead of using the cache. 
   /*
    * protected class SortedAndCutPointSetIteratorNoCache extends
    * DefaultPointSetIterator {
    * 
    * public double nextCoordinate() { if (getCurPointIndex() >= numPoints ||
    * getCurCoordIndex() >= dim) outOfBounds(); // Not implemented!! To be done...
    * } }
    */
}