java/doc/org/libjpegturbo/turbojpeg/TJScalingFactor.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_29) on Sun Dec 18 20:09:44 CST 2011 -->
   6 <TITLE>
   7 TJScalingFactor
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2011-12-18">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     if (location.href.indexOf('is-external=true') == -1) {
  18         parent.document.title="TJScalingFactor";
  19     }
  20 }
  21 </SCRIPT>
  22 <NOSCRIPT>
  23 </NOSCRIPT>
  24
  25 </HEAD>
  26
  27 <BODY BGCOLOR="white" onload="windowTitle();">
  28 <HR>
  29
  30
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <A NAME="navbar_top"><!-- --></A>
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35 <TR>
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37 <A NAME="navbar_top_firstrow"><!-- --></A>
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39   <TR ALIGN="center" VALIGN="top">
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../org/libjpegturbo/turbojpeg/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  46   </TR>
  47 </TABLE>
  48 </TD>
  49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50 </EM>
  51 </TD>
  52 </TR>
  53
  54 <TR>
  55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56 &nbsp;<A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html" title="class in org.libjpegturbo.turbojpeg"><B>PREV CLASS</B></A>&nbsp;
  57 &nbsp;<A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><B>NEXT CLASS</B></A></FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../index.html?org/libjpegturbo/turbojpeg/TJScalingFactor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="TJScalingFactor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61 &nbsp;<SCRIPT type="text/javascript">
  62   <!--
  63   if(window==top) {
  64     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  65   }
  66   //-->
  67 </SCRIPT>
  68 <NOSCRIPT>
  69   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  70 </NOSCRIPT>
  71
  72
  73 </FONT></TD>
  74 </TR>
  75 <TR>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  80 </TR>
  81 </TABLE>
  82 <A NAME="skip-navbar_top"></A>
  83 <!-- ========= END OF TOP NAVBAR ========= -->
  84
  85 <HR>
  86 <!-- ======== START OF CLASS DATA ======== -->
  87 <H2>
  88 <FONT SIZE="-1">
  89 org.libjpegturbo.turbojpeg</FONT>
  90 <BR>
  91 Class TJScalingFactor</H2>
  92 <PRE>
  93 java.lang.Object
  94   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.libjpegturbo.turbojpeg.TJScalingFactor</B>
  95 </PRE>
  96 <HR>
  97 <DL>
  98 <DT><PRE>public class <B>TJScalingFactor</B><DT>extends java.lang.Object</DL>
  99 </PRE>
 100
 101 <P>
 102 Fractional scaling factor
 103 <P>
 104
 105 <P>
 106 <HR>
 107
 108 <P>
 109
 110 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 111
 112 <A NAME="constructor_summary"><!-- --></A>
 113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 116 <B>Constructor Summary</B></FONT></TH>
 117 </TR>
 118 <TR BGCOLOR="white" CLASS="TableRowColor">
 119 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#TJScalingFactor(int, int)">TJScalingFactor</A></B>(int&nbsp;num,
 120                 int&nbsp;denom)</CODE>
 121
 122 <BR>
 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 124 </TR>
 125 </TABLE>
 126 &nbsp;
 127 <!-- ========== METHOD SUMMARY =========== -->
 128
 129 <A NAME="method_summary"><!-- --></A>
 130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 133 <B>Method Summary</B></FONT></TH>
 134 </TR>
 135 <TR BGCOLOR="white" CLASS="TableRowColor">
 136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 137 <CODE>&nbsp;boolean</CODE></FONT></TD>
 138 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#equals(org.libjpegturbo.turbojpeg.TJScalingFactor)">equals</A></B>(<A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</A>&nbsp;other)</CODE>
 139
 140 <BR>
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true or false, depending on whether this instance and
 142  <code>other</code> have the same numerator and denominator.</TD>
 143 </TR>
 144 <TR BGCOLOR="white" CLASS="TableRowColor">
 145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 146 <CODE>&nbsp;int</CODE></FONT></TD>
 147 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getDenom()">getDenom</A></B>()</CODE>
 148
 149 <BR>
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns denominator</TD>
 151 </TR>
 152 <TR BGCOLOR="white" CLASS="TableRowColor">
 153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 154 <CODE>&nbsp;int</CODE></FONT></TD>
 155 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getNum()">getNum</A></B>()</CODE>
 156
 157 <BR>
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns numerator</TD>
 159 </TR>
 160 <TR BGCOLOR="white" CLASS="TableRowColor">
 161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 162 <CODE>&nbsp;int</CODE></FONT></TD>
 163 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getScaled(int)">getScaled</A></B>(int&nbsp;dimension)</CODE>
 164
 165 <BR>
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the scaled value of <code>dimension</code>.</TD>
 167 </TR>
 168 <TR BGCOLOR="white" CLASS="TableRowColor">
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 170 <CODE>&nbsp;boolean</CODE></FONT></TD>
 171 <TD><CODE><B><A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#isOne()">isOne</A></B>()</CODE>
 172
 173 <BR>
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true or false, depending on whether this instance is equal to
 175  1/1.</TD>
 176 </TR>
 177 </TABLE>
 178 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 181 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 182 </TR>
 183 <TR BGCOLOR="white" CLASS="TableRowColor">
 184 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 185 </TR>
 186 </TABLE>
 187 &nbsp;
 188 <P>
 189
 190 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 191
 192 <A NAME="constructor_detail"><!-- --></A>
 193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 194 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 195 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 196 <B>Constructor Detail</B></FONT></TH>
 197 </TR>
 198 </TABLE>
 199
 200 <A NAME="TJScalingFactor(int, int)"><!-- --></A><H3>
 201 TJScalingFactor</H3>
 202 <PRE>
 203 public <B>TJScalingFactor</B>(int&nbsp;num,
 204                        int&nbsp;denom)
 205                 throws java.lang.Exception</PRE>
 206 <DL>
 207 <DL>
 208
 209 <DT><B>Throws:</B>
 210 <DD><CODE>java.lang.Exception</CODE></DL>
 211 </DL>
 212
 213 <!-- ============ METHOD DETAIL ========== -->
 214
 215 <A NAME="method_detail"><!-- --></A>
 216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 217 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 218 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 219 <B>Method Detail</B></FONT></TH>
 220 </TR>
 221 </TABLE>
 222
 223 <A NAME="getNum()"><!-- --></A><H3>
 224 getNum</H3>
 225 <PRE>
 226 public int <B>getNum</B>()</PRE>
 227 <DL>
 228 <DD>Returns numerator
 229 <P>
 230 <DD><DL>
 231
 232 <DT><B>Returns:</B><DD>numerator</DL>
 233 </DD>
 234 </DL>
 235 <HR>
 236
 237 <A NAME="getDenom()"><!-- --></A><H3>
 238 getDenom</H3>
 239 <PRE>
 240 public int <B>getDenom</B>()</PRE>
 241 <DL>
 242 <DD>Returns denominator
 243 <P>
 244 <DD><DL>
 245
 246 <DT><B>Returns:</B><DD>denominator</DL>
 247 </DD>
 248 </DL>
 249 <HR>
 250
 251 <A NAME="getScaled(int)"><!-- --></A><H3>
 252 getScaled</H3>
 253 <PRE>
 254 public int <B>getScaled</B>(int&nbsp;dimension)</PRE>
 255 <DL>
 256 <DD>Returns the scaled value of <code>dimension</code>.  This function
 257  performs the integer equivalent of
 258  <code>ceil(dimension * scalingFactor)</code>.
 259 <P>
 260 <DD><DL>
 261
 262 <DT><B>Returns:</B><DD>the scaled value of <code>dimension</code></DL>
 263 </DD>
 264 </DL>
 265 <HR>
 266
 267 <A NAME="equals(org.libjpegturbo.turbojpeg.TJScalingFactor)"><!-- --></A><H3>
 268 equals</H3>
 269 <PRE>
 270 public boolean <B>equals</B>(<A HREF="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</A>&nbsp;other)</PRE>
 271 <DL>
 272 <DD>Returns true or false, depending on whether this instance and
 273  <code>other</code> have the same numerator and denominator.
 274 <P>
 275 <DD><DL>
 276
 277 <DT><B>Returns:</B><DD>true or false, depending on whether this instance and
 278  <code>other</code> have the same numerator and denominator</DL>
 279 </DD>
 280 </DL>
 281 <HR>
 282
 283 <A NAME="isOne()"><!-- --></A><H3>
 284 isOne</H3>
 285 <PRE>
 286 public boolean <B>isOne</B>()</PRE>
 287 <DL>
 288 <DD>Returns true or false, depending on whether this instance is equal to
 289  1/1.
 290 <P>
 291 <DD><DL>
 292
 293 <DT><B>Returns:</B><DD>true or false, depending on whether this instance is equal to
 294  1/1</DL>
 295 </DD>
 296 </DL>
 297 <!-- ========= END OF CLASS DATA ========= -->
 298 <HR>
 299
 300
 301 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 302 <A NAME="navbar_bottom"><!-- --></A>
 303 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 304 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 305 <TR>
 306 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 307 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 308 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 309   <TR ALIGN="center" VALIGN="top">
 310   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../org/libjpegturbo/turbojpeg/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 311   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 312   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 313   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 314   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 315   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 316   </TR>
 317 </TABLE>
 318 </TD>
 319 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 320 </EM>
 321 </TD>
 322 </TR>
 323
 324 <TR>
 325 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 326 &nbsp;<A HREF="../../../org/libjpegturbo/turbojpeg/TJDecompressor.html" title="class in org.libjpegturbo.turbojpeg"><B>PREV CLASS</B></A>&nbsp;
 327 &nbsp;<A HREF="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><B>NEXT CLASS</B></A></FONT></TD>
 328 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 329   <A HREF="../../../index.html?org/libjpegturbo/turbojpeg/TJScalingFactor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 330 &nbsp;<A HREF="TJScalingFactor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 331 &nbsp;<SCRIPT type="text/javascript">
 332   <!--
 333   if(window==top) {
 334     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
 335   }
 336   //-->
 337 </SCRIPT>
 338 <NOSCRIPT>
 339   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
 340 </NOSCRIPT>
 341
 342
 343 </FONT></TD>
 344 </TR>
 345 <TR>
 346 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 347   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 348 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 349 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 350 </TR>
 351 </TABLE>
 352 <A NAME="skip-navbar_bottom"></A>
 353 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 354
 355 <HR>
 356
 357 </BODY>
 358 </HTML>