java/org/libjpegturbo/turbojpeg/TJScalingFactor.java

   1 /*
   2  * Copyright (C)2011 D. R. Commander.  All Rights Reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  * - Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  * - Redistributions in binary form must reproduce the above copyright notice,
  10  *   this list of conditions and the following disclaimer in the documentation
  11  *   and/or other materials provided with the distribution.
  12  * - Neither the name of the libjpeg-turbo Project nor the names of its
  13  *   contributors may be used to endorse or promote products derived from this
  14  *   software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS",
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 package org.libjpegturbo.turbojpeg;
  30
  31 /**
  32  * Fractional scaling factor
  33  */
  34 public class TJScalingFactor {
  35
  36   public TJScalingFactor(int num, int denom) throws Exception {
  37     if (num < 1 || denom < 1)
  38       throw new Exception("Numerator and denominator must be >= 1");
  39     this.num = num;
  40     this.denom = denom;
  41   }
  42
  43   /**
  44    * Returns numerator
  45    * @return numerator
  46    */
  47   public int getNum() {
  48     return num;
  49   }
  50
  51   /**
  52    * Returns denominator
  53    * @return denominator
  54    */
  55   public int getDenom() {
  56     return denom;
  57   }
  58
  59   /**
  60    * Returns the scaled value of <code>dimension</code>.  This function
  61    * performs the integer equivalent of
  62    * <code>ceil(dimension * scalingFactor)</code>.
  63    * @return the scaled value of <code>dimension</code>
  64    */
  65   public int getScaled(int dimension) {
  66     return (dimension * num + denom - 1) / denom;
  67   }
  68
  69   /**
  70    * Returns true or false, depending on whether this instance and
  71    * <code>other</code> have the same numerator and denominator.
  72    * @return true or false, depending on whether this instance and
  73    * <code>other</code> have the same numerator and denominator
  74    */
  75   public boolean equals(TJScalingFactor other) {
  76     return (this.num == other.num && this.denom == other.denom);
  77   }
  78
  79   /**
  80    * Returns true or false, depending on whether this instance is equal to
  81    * 1/1.
  82    * @return true or false, depending on whether this instance is equal to
  83    * 1/1
  84    */
  85   public boolean isOne() {
  86     return (num == 1 && denom == 1);
  87   }
  88
  89   /**
  90    * Numerator
  91    */
  92   private int num = 1;
  93
  94   /**
  95    * Denominator
  96    */
  97   private int denom = 1;
  98 };