libjava/java/awt/image/DataBufferDouble.java

   1 /* Copyright (C) 2004  Free Software Foundation
   2
   3 This file is part of GNU Classpath.
   4
   5 GNU Classpath is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2, or (at your option)
   8 any later version.
   9
  10 GNU Classpath is distributed in the hope that it will be useful, but
  11 WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with GNU Classpath; see the file COPYING.  If not, write to the
  17 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18 02111-1307 USA.
  19
  20 Linking this library statically or dynamically with other modules is
  21 making a combined work based on this library.  Thus, the terms and
  22 conditions of the GNU General Public License cover the whole
  23 combination.
  24
  25 As a special exception, the copyright holders of this library give you
  26 permission to link this library with independent modules to produce an
  27 executable, regardless of the license terms of these independent
  28 modules, and to copy and distribute the resulting executable under
  29 terms of your choice, provided that you also meet, for each linked
  30 independent module, the terms and conditions of the license of that
  31 module.  An independent module is a module which is not derived from
  32 or based on this library.  If you modify this library, you may extend
  33 this exception to your version of the library, but you are not
  34 obligated to do so.  If you do not wish to do so, delete this
  35 exception statement from your version. */
  36
  37 package java.awt.image;
  38
  39 /* This is one of several classes that are nearly identical. Maybe we
  40    should have a central template and generate all these files. This
  41    is one of the cases where templates or macros would have been
  42    useful to have in Java.
  43
  44    This file has been created using search-replace. My only fear is
  45    that these classes will grow out-of-sync as of a result of changes
  46    that are not propagated to the other files. As always, mirroring
  47    code is a maintenance nightmare.  */
  48
  49 /**
  50  * @since 1.4
  51  *
  52  * @author <a href="mailto:rolfwr@ii.uib.no">Rolf W. Rasmussen</a>
  53  * @author <a href="mailto:brawer@dandelis.ch">Sascha Brawer</a>
  54  */
  55 public final class DataBufferDouble
  56   extends DataBuffer
  57 {
  58   private double[] data;
  59   private double[][] bankData;
  60
  61   /**
  62    * Creates a new data buffer with a single data bank containing the
  63    * specified number of <code>double</code> elements.
  64    *
  65    * @param size the number of elements in the data bank.
  66    */
  67   public DataBufferDouble(int size)
  68   {
  69     super(TYPE_DOUBLE, size, 1, 0);
  70     bankData = new double[1][];
  71     data = new double[size];
  72     bankData[0] = data;
  73   }
  74
  75   /**
  76    * Creates a new data buffer with the specified number of data banks,
  77    * each containing the specified number of <code>double</code> elements.
  78    *
  79    * @param size the number of elements in the data bank.
  80    * @param numBanks the number of data banks.
  81    */
  82   public DataBufferDouble(int size, int numBanks)
  83   {
  84     super(TYPE_DOUBLE, size, numBanks);
  85     bankData = new double[numBanks][size];
  86     data = bankData[0];
  87   }
  88
  89   /**
  90    * Creates a new data buffer backed by the specified data bank.
  91    * <p>
  92    * Note: there is no exception when <code>dataArray</code> is
  93    * <code>null</code>, but in that case an exception will be thrown
  94    * later if you attempt to access the data buffer.
  95    *
  96    * @param dataArray the data bank.
  97    * @param size the number of elements in the data bank.
  98    */
  99   public DataBufferDouble(double[] dataArray, int size)
 100   {
 101     super(TYPE_DOUBLE, size, 1, 0);
 102     bankData = new double[1][];
 103     data = dataArray;
 104     bankData[0] = data;
 105   }
 106
 107   /**
 108    * Creates a new data buffer backed by the specified data bank, with
 109    * the specified offset to the first element.
 110    * <p>
 111    * Note: there is no exception when <code>dataArray</code> is
 112    * <code>null</code>, but in that case an exception will be thrown
 113    * later if you attempt to access the data buffer.
 114    *
 115    * @param dataArray the data bank.
 116    * @param size the number of elements in the data bank.
 117    * @param offset the offset to the first element in the array.
 118    */
 119   public DataBufferDouble(double[] dataArray, int size, int offset)
 120   {
 121     super(TYPE_DOUBLE, size, 1, offset);
 122     bankData = new double[1][];
 123     data = dataArray;
 124     bankData[0] = data;
 125   }
 126
 127   /**
 128    * Creates a new data buffer backed by the specified data banks.
 129    *
 130    * @param dataArray the data banks.
 131    * @param size the number of elements in the data bank.
 132    *
 133    * @throws NullPointerException if <code>dataArray</code> is
 134    *         <code>null</code>.
 135    */
 136   public DataBufferDouble(double[][] dataArray, int size)
 137   {
 138     super(TYPE_DOUBLE, size, dataArray.length);
 139     bankData = dataArray;
 140     data = bankData[0];
 141   }
 142
 143   /**
 144    * Creates a new data buffer backed by the specified data banks, with
 145    * the specified offsets to the first element in each bank.
 146    *
 147    * @param dataArray the data banks.
 148    * @param size the number of elements in the data bank.
 149    * @param offsets the offsets to the first element in each data bank.
 150    *
 151    * @throws NullPointerException if <code>dataArray</code> is
 152    *         <code>null</code>.
 153    */
 154   public DataBufferDouble(double[][] dataArray, int size, int[] offsets)
 155   {
 156     super(TYPE_DOUBLE, size, dataArray.length, offsets);
 157     bankData = dataArray;
 158     data = bankData[0];
 159   }
 160
 161   /**
 162    * Returns the first data bank.
 163    *
 164    * @return The first data bank.
 165    */
 166   public double[] getData()
 167   {
 168     return data;
 169   }
 170
 171   /**
 172    * Returns a data bank.
 173    *
 174    * @param bank the bank index.
 175    * @return A data bank.
 176    */
 177   public double[] getData(int bank)
 178   {
 179     return bankData[bank];
 180   }
 181
 182   /**
 183    * Returns the array underlying this <code>DataBuffer</code>.
 184    *
 185    * @return The data banks.
 186    */
 187   public double[][] getBankData()
 188   {
 189     return bankData;
 190   }
 191
 192   /**
 193    * Returns an element from the first data bank.  The offset (specified in
 194    * the constructor) is added to <code>i</code> before accessing the
 195    * underlying data array.
 196    *
 197    * @param i the element index.
 198    * @return The element.
 199    */
 200   public int getElem(int i)
 201   {
 202     return (int) data[i+offset];
 203   }
 204
 205   /**
 206    * Returns an element from a particular data bank.  The offset (specified in
 207    * the constructor) is added to <code>i</code> before accessing the
 208    * underlying data array.
 209    *
 210    * @param bank the bank index.
 211    * @param i the element index.
 212    * @return The element.
 213    */
 214   public int getElem(int bank, int i)
 215   {
 216     return (int) bankData[bank][i+offsets[bank]];
 217   }
 218
 219   /**
 220    * Sets an element in the first data bank.  The offset (specified in the
 221    * constructor) is added to <code>i</code> before updating the underlying
 222    * data array.
 223    *
 224    * @param i the element index.
 225    * @param val the new element value.
 226    */
 227   public void setElem(int i, int val)
 228   {
 229     data[i+offset] = (double) val;
 230   }
 231
 232   /**
 233    * Sets an element in a particular data bank.  The offset (specified in the
 234    * constructor) is added to <code>i</code> before updating the underlying
 235    * data array.
 236    *
 237    * @param bank the data bank index.
 238    * @param i the element index.
 239    * @param val the new element value.
 240    */
 241   public void setElem(int bank, int i, int val)
 242   {
 243     bankData[bank][i+offsets[bank]] = (double) val;
 244   }
 245
 246   public float getElemFloat(int i)
 247   {
 248     return (float) data[i+offset];
 249   }
 250
 251   public float getElemFloat(int bank, int i)
 252   {
 253     return (float) bankData[bank][i+offsets[bank]];
 254   }
 255
 256   public void setElemFloat(int i, float val)
 257   {
 258     data[i+offset] = val;
 259   }
 260
 261   public void setElemFloat(int bank, int i, float val)
 262   {
 263     bankData[bank][i+offsets[bank]] = val;
 264   }
 265
 266   public double getElemDouble(int i)
 267   {
 268     return data[i + offset];
 269   }
 270
 271   public double getElemDouble(int bank, int i)
 272   {
 273     return bankData[bank][i + offsets[bank]];
 274   }
 275
 276   public void setElemDouble(int i, double val)
 277   {
 278     data[i + offset] = val;
 279   }
 280
 281   public void setElemDouble(int bank, int i, double val)
 282   {
 283     bankData[bank][i + offsets[bank]] = val;
 284   }
 285 }