libjava/java/awt/image/DataBufferFloat.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  * @author Rolf W. Rasmussen (rolfwr@ii.uib.no)
  51  * @author Sascha Brawer (brawer@dandelis.ch)
  52  */
  53 public final class DataBufferFloat
  54   extends DataBuffer
  55 {
  56   private float[] data;
  57   private float[][] bankData;
  58
  59   /**
  60    * Creates a new data buffer with a single data bank containing the
  61    * specified number of <code>float</code> elements.
  62    *
  63    * @param size the number of elements in the data bank.
  64    */
  65   public DataBufferFloat(int size)
  66   {
  67     super(TYPE_FLOAT, size, 1, 0);
  68     bankData = new float[1][];
  69     data = new float[size];
  70     bankData[0] = data;
  71   }
  72
  73   /**
  74    * Creates a new data buffer with the specified number of data banks,
  75    * each containing the specified number of <code>float</code> elements.
  76    *
  77    * @param size the number of elements in the data bank.
  78    * @param numBanks the number of data banks.
  79    */
  80   public DataBufferFloat(int size, int numBanks)
  81   {
  82     super(TYPE_FLOAT, size, numBanks);
  83     bankData = new float[numBanks][size];
  84     data = bankData[0];
  85   }
  86
  87   /**
  88    * Creates a new data buffer backed by the specified data bank.
  89    * <p>
  90    * Note: there is no exception when <code>dataArray</code> is
  91    * <code>null</code>, but in that case an exception will be thrown
  92    * later if you attempt to access the data buffer.
  93    *
  94    * @param dataArray the data bank.
  95    * @param size the number of elements in the data bank.
  96    */
  97   public DataBufferFloat(float[] dataArray, int size)
  98   {
  99     super(TYPE_FLOAT, size, 1, 0);
 100     bankData = new float[1][];
 101     data = dataArray;
 102     bankData[0] = data;
 103   }
 104
 105   /**
 106    * Creates a new data buffer backed by the specified data bank, with
 107    * the specified offset to the first element.
 108    * <p>
 109    * Note: there is no exception when <code>dataArray</code> is
 110    * <code>null</code>, but in that case an exception will be thrown
 111    * later if you attempt to access the data buffer.
 112    *
 113    * @param dataArray the data bank.
 114    * @param size the number of elements in the data bank.
 115    * @param offset the offset to the first element in the array.
 116    */
 117   public DataBufferFloat(float[] dataArray, int size, int offset)
 118   {
 119     super(TYPE_FLOAT, size, 1, offset);
 120     bankData = new float[1][];
 121     data = dataArray;
 122     bankData[0] = data;
 123   }
 124
 125   /**
 126    * Creates a new data buffer backed by the specified data banks.
 127    *
 128    * @param dataArray the data banks.
 129    * @param size the number of elements in the data bank.
 130    *
 131    * @throws NullPointerException if <code>dataArray</code> is
 132    *         <code>null</code>.
 133    */
 134   public DataBufferFloat(float[][] dataArray, int size)
 135   {
 136     super(TYPE_FLOAT, size, dataArray.length);
 137     bankData = dataArray;
 138     data = bankData[0];
 139   }
 140
 141   /**
 142    * Creates a new data buffer backed by the specified data banks, with
 143    * the specified offsets to the first element in each bank.
 144    *
 145    * @param dataArray the data banks.
 146    * @param size the number of elements in the data bank.
 147    * @param offsets the offsets to the first element in each data bank.
 148    *
 149    * @throws NullPointerException if <code>dataArray</code> is
 150    *         <code>null</code>.
 151    */
 152   public DataBufferFloat(float[][] dataArray, int size, int[] offsets)
 153   {
 154     super(TYPE_FLOAT, size, dataArray.length, offsets);
 155     bankData = dataArray;
 156     data = bankData[0];
 157   }
 158
 159   /**
 160    * Returns the first data bank.
 161    *
 162    * @return The first data bank.
 163    */
 164   public float[] getData()
 165   {
 166     return data;
 167   }
 168
 169   /**
 170    * Returns a data bank.
 171    *
 172    * @param bank the bank index.
 173    * @return A data bank.
 174    */
 175   public float[] getData(int bank)
 176   {
 177     return bankData[bank];
 178   }
 179
 180   /**
 181    * Returns the array underlying this <code>DataBuffer</code>.
 182    *
 183    * @return The data banks.
 184    */
 185   public float[][] getBankData()
 186   {
 187     return bankData;
 188   }
 189
 190   /**
 191    * Returns an element from the first data bank.  The offset (specified in
 192    * the constructor) is added to <code>i</code> before accessing the
 193    * underlying data array.
 194    *
 195    * @param i the element index.
 196    * @return The element.
 197    */
 198   public int getElem(int i)
 199   {
 200     return (int) data[i+offset];
 201   }
 202
 203   /**
 204    * Returns an element from a particular data bank.  The offset (specified in
 205    * the constructor) is added to <code>i</code> before accessing the
 206    * underlying data array.
 207    *
 208    * @param bank the bank index.
 209    * @param i the element index.
 210    * @return The element.
 211    */
 212   public int getElem(int bank, int i)
 213   {
 214     return (int) bankData[bank][i+offsets[bank]];
 215   }
 216
 217   /**
 218    * Sets an element in the first data bank.  The offset (specified in the
 219    * constructor) is added to <code>i</code> before updating the underlying
 220    * data array.
 221    *
 222    * @param i the element index.
 223    * @param val the new element value.
 224    */
 225   public void setElem(int i, int val)
 226   {
 227     data[i+offset] = (float) val;
 228   }
 229
 230   /**
 231    * Sets an element in a particular data bank.  The offset (specified in the
 232    * constructor) is added to <code>i</code> before updating the underlying
 233    * data array.
 234    *
 235    * @param bank the data bank index.
 236    * @param i the element index.
 237    * @param val the new element value.
 238    */
 239   public void setElem(int bank, int i, int val)
 240   {
 241     bankData[bank][i+offsets[bank]] = (float) val;
 242   }
 243
 244   public float getElemFloat(int i)
 245   {
 246     return data[i+offset];
 247   }
 248
 249   public float getElemFloat(int bank, int i)
 250   {
 251     return bankData[bank][i+offsets[bank]];
 252   }
 253
 254   public void setElemFloat(int i, float val)
 255   {
 256     data[i+offset] = val;
 257   }
 258
 259   public void setElemFloat(int bank, int i, float val)
 260   {
 261     bankData[bank][i+offsets[bank]] = val;
 262   }
 263
 264   public double getElemDouble(int i)
 265   {
 266     return getElemFloat(i);
 267   }
 268
 269   public double getElemDouble(int bank, int i)
 270   {
 271     return getElemFloat(bank, i);
 272   }
 273
 274   public void setElemDouble(int i, double val)
 275   {
 276     setElemFloat(i, (float) val);
 277   }
 278
 279   public void setElemDouble(int bank, int i, double val)
 280   {
 281     setElemFloat(bank, i, (float) val);
 282   }
 283 }