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

   1 <!DOCTYPE HTML>
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc -->
   6 <title>TJScalingFactor</title>
   7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
   9 <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
  10 <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
  11 <script type="text/javascript" src="../../../script.js"></script>
  12 <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  13 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14 <!--[if IE]>
  15 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16 <![endif]-->
  17 <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
  18 <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
  19 </head>
  20 <body>
  21 <script type="text/javascript"><!--
  22     try {
  23         if (location.href.indexOf('is-external=true') == -1) {
  24             parent.document.title="TJScalingFactor";
  25         }
  26     }
  27     catch(err) {
  28     }
  29 //-->
  30 var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
  31 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  32 var altColor = "altColor";
  33 var rowColor = "rowColor";
  34 var tableTab = "tableTab";
  35 var activeTableTab = "activeTableTab";
  36 var pathtoroot = "../../../";
  37 var useModuleDirectories = true;
  38 loadScripts(document, 'script');</script>
  39 <noscript>
  40 <div>JavaScript is disabled on your browser.</div>
  41 </noscript>
  42 <header role="banner">
  43 <nav role="navigation">
  44 <div class="fixedNav">
  45 <!-- ========= START OF TOP NAVBAR ======= -->
  46 <div class="topNav"><a id="navbar.top">
  47 <!--   -->
  48 </a>
  49 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  50 <a id="navbar.top.firstrow">
  51 <!--   -->
  52 </a>
  53 <ul class="navList" title="Navigation">
  54 <li><a href="package-summary.html">Package</a></li>
  55 <li class="navBarCell1Rev">Class</li>
  56 <li><a href="package-tree.html">Tree</a></li>
  57 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  58 <li><a href="../../../index-all.html">Index</a></li>
  59 <li><a href="../../../help-doc.html">Help</a></li>
  60 </ul>
  61 </div>
  62 <div class="subNav">
  63 <ul class="navList" id="allclasses_navbar_top">
  64 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  65 </ul>
  66 <ul class="navListSearch">
  67 <li><label for="search">SEARCH:</label>
  68 <input type="text" id="search" value="search" disabled="disabled">
  69 <input type="reset" id="reset" value="reset" disabled="disabled">
  70 </li>
  71 </ul>
  72 <div>
  73 <script type="text/javascript"><!--
  74   allClassesLink = document.getElementById("allclasses_navbar_top");
  75   if(window==top) {
  76     allClassesLink.style.display = "block";
  77   }
  78   else {
  79     allClassesLink.style.display = "none";
  80   }
  81   //-->
  82 </script>
  83 <noscript>
  84 <div>JavaScript is disabled on your browser.</div>
  85 </noscript>
  86 </div>
  87 <div>
  88 <ul class="subNavList">
  89 <li>Summary:&nbsp;</li>
  90 <li>Nested&nbsp;|&nbsp;</li>
  91 <li>Field&nbsp;|&nbsp;</li>
  92 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  93 <li><a href="#method.summary">Method</a></li>
  94 </ul>
  95 <ul class="subNavList">
  96 <li>Detail:&nbsp;</li>
  97 <li>Field&nbsp;|&nbsp;</li>
  98 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  99 <li><a href="#method.detail">Method</a></li>
 100 </ul>
 101 </div>
 102 <a id="skip.navbar.top">
 103 <!--   -->
 104 </a></div>
 105 <!-- ========= END OF TOP NAVBAR ========= -->
 106 </div>
 107 <div class="navPadding">&nbsp;</div>
 108 <script type="text/javascript"><!--
 109 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 110 //-->
 111 </script>
 112 </nav>
 113 </header>
 114 <!-- ======== START OF CLASS DATA ======== -->
 115 <main role="main">
 116 <div class="header">
 117 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.libjpegturbo.turbojpeg</a></div>
 118 <h2 title="Class TJScalingFactor" class="title">Class TJScalingFactor</h2>
 119 </div>
 120 <div class="contentContainer">
 121 <ul class="inheritance">
 122 <li>java.lang.Object</li>
 123 <li>
 124 <ul class="inheritance">
 125 <li>org.libjpegturbo.turbojpeg.TJScalingFactor</li>
 126 </ul>
 127 </li>
 128 </ul>
 129 <div class="description">
 130 <ul class="blockList">
 131 <li class="blockList">
 132 <hr>
 133 <pre>public class <span class="typeNameLabel">TJScalingFactor</span>
 134 extends java.lang.Object</pre>
 135 <div class="block">Fractional scaling factor</div>
 136 </li>
 137 </ul>
 138 </div>
 139 <div class="summary">
 140 <ul class="blockList">
 141 <li class="blockList">
 142 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 143 <section>
 144 <ul class="blockList">
 145 <li class="blockList"><a id="constructor.summary">
 146 <!--   -->
 147 </a>
 148 <h3>Constructor Summary</h3>
 149 <table class="memberSummary">
 150 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 151 <tr>
 152 <th class="colFirst" scope="col">Constructor</th>
 153 <th class="colLast" scope="col">Description</th>
 154 </tr>
 155 <tr class="altColor">
 156 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int)">TJScalingFactor</a></span>&#8203;(int&nbsp;num,
 157                int&nbsp;denom)</code></th>
 158 <td class="colLast">
 159 <div class="block">Create a TurboJPEG scaling factor instance.</div>
 160 </td>
 161 </tr>
 162 </table>
 163 </li>
 164 </ul>
 165 </section>
 166 <!-- ========== METHOD SUMMARY =========== -->
 167 <section>
 168 <ul class="blockList">
 169 <li class="blockList"><a id="method.summary">
 170 <!--   -->
 171 </a>
 172 <h3>Method Summary</h3>
 173 <table class="memberSummary">
 174 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 175 <tr>
 176 <th class="colFirst" scope="col">Modifier and Type</th>
 177 <th class="colSecond" scope="col">Method</th>
 178 <th class="colLast" scope="col">Description</th>
 179 </tr>
 180 <tr id="i0" class="altColor">
 181 <td class="colFirst"><code>boolean</code></td>
 182 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(org.libjpegturbo.turbojpeg.TJScalingFactor)">equals</a></span>&#8203;(<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>&nbsp;other)</code></th>
 183 <td class="colLast">
 184 <div class="block">Returns true or false, depending on whether this instance and
 185  <code>other</code> have the same numerator and denominator.</div>
 186 </td>
 187 </tr>
 188 <tr id="i1" class="rowColor">
 189 <td class="colFirst"><code>int</code></td>
 190 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDenom()">getDenom</a></span>()</code></th>
 191 <td class="colLast">
 192 <div class="block">Returns denominator</div>
 193 </td>
 194 </tr>
 195 <tr id="i2" class="altColor">
 196 <td class="colFirst"><code>int</code></td>
 197 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNum()">getNum</a></span>()</code></th>
 198 <td class="colLast">
 199 <div class="block">Returns numerator</div>
 200 </td>
 201 </tr>
 202 <tr id="i3" class="rowColor">
 203 <td class="colFirst"><code>int</code></td>
 204 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScaled(int)">getScaled</a></span>&#8203;(int&nbsp;dimension)</code></th>
 205 <td class="colLast">
 206 <div class="block">Returns the scaled value of <code>dimension</code>.</div>
 207 </td>
 208 </tr>
 209 <tr id="i4" class="altColor">
 210 <td class="colFirst"><code>boolean</code></td>
 211 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOne()">isOne</a></span>()</code></th>
 212 <td class="colLast">
 213 <div class="block">Returns true or false, depending on whether this instance is equal to
 214  1/1.</div>
 215 </td>
 216 </tr>
 217 </table>
 218 <ul class="blockList">
 219 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 220 <!--   -->
 221 </a>
 222 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 223 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 224 </ul>
 225 </li>
 226 </ul>
 227 </section>
 228 </li>
 229 </ul>
 230 </div>
 231 <div class="details">
 232 <ul class="blockList">
 233 <li class="blockList">
 234 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 235 <section>
 236 <ul class="blockList">
 237 <li class="blockList"><a id="constructor.detail">
 238 <!--   -->
 239 </a>
 240 <h3>Constructor Detail</h3>
 241 <a id="&lt;init&gt;(int,int)">
 242 <!--   -->
 243 </a>
 244 <ul class="blockListLast">
 245 <li class="blockList">
 246 <h4>TJScalingFactor</h4>
 247 <pre>public&nbsp;TJScalingFactor&#8203;(int&nbsp;num,
 248                        int&nbsp;denom)</pre>
 249 <div class="block">Create a TurboJPEG scaling factor instance.</div>
 250 <dl>
 251 <dt><span class="paramLabel">Parameters:</span></dt>
 252 <dd><code>num</code> - numerator</dd>
 253 <dd><code>denom</code> - denominator</dd>
 254 </dl>
 255 </li>
 256 </ul>
 257 </li>
 258 </ul>
 259 </section>
 260 <!-- ============ METHOD DETAIL ========== -->
 261 <section>
 262 <ul class="blockList">
 263 <li class="blockList"><a id="method.detail">
 264 <!--   -->
 265 </a>
 266 <h3>Method Detail</h3>
 267 <a id="getNum()">
 268 <!--   -->
 269 </a>
 270 <ul class="blockList">
 271 <li class="blockList">
 272 <h4>getNum</h4>
 273 <pre class="methodSignature">public&nbsp;int&nbsp;getNum()</pre>
 274 <div class="block">Returns numerator</div>
 275 <dl>
 276 <dt><span class="returnLabel">Returns:</span></dt>
 277 <dd>numerator</dd>
 278 </dl>
 279 </li>
 280 </ul>
 281 <a id="getDenom()">
 282 <!--   -->
 283 </a>
 284 <ul class="blockList">
 285 <li class="blockList">
 286 <h4>getDenom</h4>
 287 <pre class="methodSignature">public&nbsp;int&nbsp;getDenom()</pre>
 288 <div class="block">Returns denominator</div>
 289 <dl>
 290 <dt><span class="returnLabel">Returns:</span></dt>
 291 <dd>denominator</dd>
 292 </dl>
 293 </li>
 294 </ul>
 295 <a id="getScaled(int)">
 296 <!--   -->
 297 </a>
 298 <ul class="blockList">
 299 <li class="blockList">
 300 <h4>getScaled</h4>
 301 <pre class="methodSignature">public&nbsp;int&nbsp;getScaled&#8203;(int&nbsp;dimension)</pre>
 302 <div class="block">Returns the scaled value of <code>dimension</code>.  This function
 303  performs the integer equivalent of
 304  <code>ceil(dimension * scalingFactor)</code>.</div>
 305 <dl>
 306 <dt><span class="paramLabel">Parameters:</span></dt>
 307 <dd><code>dimension</code> - width or height to multiply by this scaling factor</dd>
 308 <dt><span class="returnLabel">Returns:</span></dt>
 309 <dd>the scaled value of <code>dimension</code>.</dd>
 310 </dl>
 311 </li>
 312 </ul>
 313 <a id="equals(org.libjpegturbo.turbojpeg.TJScalingFactor)">
 314 <!--   -->
 315 </a>
 316 <ul class="blockList">
 317 <li class="blockList">
 318 <h4>equals</h4>
 319 <pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>&nbsp;other)</pre>
 320 <div class="block">Returns true or false, depending on whether this instance and
 321  <code>other</code> have the same numerator and denominator.</div>
 322 <dl>
 323 <dt><span class="paramLabel">Parameters:</span></dt>
 324 <dd><code>other</code> - the scaling factor against which to compare this one</dd>
 325 <dt><span class="returnLabel">Returns:</span></dt>
 326 <dd>true or false, depending on whether this instance and
 327  <code>other</code> have the same numerator and denominator.</dd>
 328 </dl>
 329 </li>
 330 </ul>
 331 <a id="isOne()">
 332 <!--   -->
 333 </a>
 334 <ul class="blockListLast">
 335 <li class="blockList">
 336 <h4>isOne</h4>
 337 <pre class="methodSignature">public&nbsp;boolean&nbsp;isOne()</pre>
 338 <div class="block">Returns true or false, depending on whether this instance is equal to
 339  1/1.</div>
 340 <dl>
 341 <dt><span class="returnLabel">Returns:</span></dt>
 342 <dd>true or false, depending on whether this instance is equal to
 343  1/1.</dd>
 344 </dl>
 345 </li>
 346 </ul>
 347 </li>
 348 </ul>
 349 </section>
 350 </li>
 351 </ul>
 352 </div>
 353 </div>
 354 </main>
 355 <!-- ========= END OF CLASS DATA ========= -->
 356 <footer role="contentinfo">
 357 <nav role="navigation">
 358 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 359 <div class="bottomNav"><a id="navbar.bottom">
 360 <!--   -->
 361 </a>
 362 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 363 <a id="navbar.bottom.firstrow">
 364 <!--   -->
 365 </a>
 366 <ul class="navList" title="Navigation">
 367 <li><a href="package-summary.html">Package</a></li>
 368 <li class="navBarCell1Rev">Class</li>
 369 <li><a href="package-tree.html">Tree</a></li>
 370 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 371 <li><a href="../../../index-all.html">Index</a></li>
 372 <li><a href="../../../help-doc.html">Help</a></li>
 373 </ul>
 374 </div>
 375 <div class="subNav">
 376 <ul class="navList" id="allclasses_navbar_bottom">
 377 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
 378 </ul>
 379 <div>
 380 <script type="text/javascript"><!--
 381   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 382   if(window==top) {
 383     allClassesLink.style.display = "block";
 384   }
 385   else {
 386     allClassesLink.style.display = "none";
 387   }
 388   //-->
 389 </script>
 390 <noscript>
 391 <div>JavaScript is disabled on your browser.</div>
 392 </noscript>
 393 </div>
 394 <div>
 395 <ul class="subNavList">
 396 <li>Summary:&nbsp;</li>
 397 <li>Nested&nbsp;|&nbsp;</li>
 398 <li>Field&nbsp;|&nbsp;</li>
 399 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 400 <li><a href="#method.summary">Method</a></li>
 401 </ul>
 402 <ul class="subNavList">
 403 <li>Detail:&nbsp;</li>
 404 <li>Field&nbsp;|&nbsp;</li>
 405 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 406 <li><a href="#method.detail">Method</a></li>
 407 </ul>
 408 </div>
 409 <a id="skip.navbar.bottom">
 410 <!--   -->
 411 </a></div>
 412 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 413 </nav>
 414 </footer>
 415 </body>
 416 </html>