• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<title>TJScalingFactor</title>
6<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
7</head>
8<body>
9<script type="text/javascript"><!--
10    try {
11        if (location.href.indexOf('is-external=true') == -1) {
12            parent.document.title="TJScalingFactor";
13        }
14    }
15    catch(err) {
16    }
17//-->
18</script>
19<noscript>
20<div>JavaScript is disabled on your browser.</div>
21</noscript>
22<!-- ========= START OF TOP NAVBAR ======= -->
23<div class="topNav"><a name="navbar_top">
24<!--   -->
25</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
26<!--   -->
27</a>
28<ul class="navList" title="Navigation">
29<li><a href="../../../org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../index-all.html">Index</a></li>
34<li><a href="../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../index.html?org/libjpegturbo/turbojpeg/TJScalingFactor.html" target="_top">Frames</a></li>
44<li><a href="TJScalingFactor.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">org.libjpegturbo.turbojpeg</div>
83<h2 title="Class TJScalingFactor" class="title">Class TJScalingFactor</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li>java.lang.Object</li>
88<li>
89<ul class="inheritance">
90<li>org.libjpegturbo.turbojpeg.TJScalingFactor</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<hr>
98<br>
99<pre>public class <span class="strong">TJScalingFactor</span>
100extends java.lang.Object</pre>
101<div class="block">Fractional scaling factor</div>
102</li>
103</ul>
104</div>
105<div class="summary">
106<ul class="blockList">
107<li class="blockList">
108<!-- ======== CONSTRUCTOR SUMMARY ======== -->
109<ul class="blockList">
110<li class="blockList"><a name="constructor_summary">
111<!--   -->
112</a>
113<h3>Constructor Summary</h3>
114<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
115<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
116<tr>
117<th class="colOne" scope="col">Constructor and Description</th>
118</tr>
119<tr class="altColor">
120<td class="colOne"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#TJScalingFactor(int,%20int)">TJScalingFactor</a></strong>(int&nbsp;num,
121               int&nbsp;denom)</code>
122<div class="block">Create a TurboJPEG scaling factor instance.</div>
123</td>
124</tr>
125</table>
126</li>
127</ul>
128<!-- ========== METHOD SUMMARY =========== -->
129<ul class="blockList">
130<li class="blockList"><a name="method_summary">
131<!--   -->
132</a>
133<h3>Method Summary</h3>
134<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
135<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Method and Description</th>
139</tr>
140<tr class="altColor">
141<td class="colFirst"><code>boolean</code></td>
142<td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#equals(org.libjpegturbo.turbojpeg.TJScalingFactor)">equals</a></strong>(<a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>&nbsp;other)</code>
143<div class="block">Returns true or false, depending on whether this instance and
144 <code>other</code> have the same numerator and denominator.</div>
145</td>
146</tr>
147<tr class="rowColor">
148<td class="colFirst"><code>int</code></td>
149<td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getDenom()">getDenom</a></strong>()</code>
150<div class="block">Returns denominator</div>
151</td>
152</tr>
153<tr class="altColor">
154<td class="colFirst"><code>int</code></td>
155<td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getNum()">getNum</a></strong>()</code>
156<div class="block">Returns numerator</div>
157</td>
158</tr>
159<tr class="rowColor">
160<td class="colFirst"><code>int</code></td>
161<td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#getScaled(int)">getScaled</a></strong>(int&nbsp;dimension)</code>
162<div class="block">Returns the scaled value of <code>dimension</code>.</div>
163</td>
164</tr>
165<tr class="altColor">
166<td class="colFirst"><code>boolean</code></td>
167<td class="colLast"><code><strong><a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html#isOne()">isOne</a></strong>()</code>
168<div class="block">Returns true or false, depending on whether this instance is equal to
169 1/1.</div>
170</td>
171</tr>
172</table>
173<ul class="blockList">
174<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
175<!--   -->
176</a>
177<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
178<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
179</ul>
180</li>
181</ul>
182</li>
183</ul>
184</div>
185<div class="details">
186<ul class="blockList">
187<li class="blockList">
188<!-- ========= CONSTRUCTOR DETAIL ======== -->
189<ul class="blockList">
190<li class="blockList"><a name="constructor_detail">
191<!--   -->
192</a>
193<h3>Constructor Detail</h3>
194<a name="TJScalingFactor(int, int)">
195<!--   -->
196</a>
197<ul class="blockListLast">
198<li class="blockList">
199<h4>TJScalingFactor</h4>
200<pre>public&nbsp;TJScalingFactor(int&nbsp;num,
201               int&nbsp;denom)</pre>
202<div class="block">Create a TurboJPEG scaling factor instance.</div>
203<dl><dt><span class="strong">Parameters:</span></dt><dd><code>num</code> - numerator</dd><dd><code>denom</code> - denominator</dd></dl>
204</li>
205</ul>
206</li>
207</ul>
208<!-- ============ METHOD DETAIL ========== -->
209<ul class="blockList">
210<li class="blockList"><a name="method_detail">
211<!--   -->
212</a>
213<h3>Method Detail</h3>
214<a name="getNum()">
215<!--   -->
216</a>
217<ul class="blockList">
218<li class="blockList">
219<h4>getNum</h4>
220<pre>public&nbsp;int&nbsp;getNum()</pre>
221<div class="block">Returns numerator</div>
222<dl><dt><span class="strong">Returns:</span></dt><dd>numerator</dd></dl>
223</li>
224</ul>
225<a name="getDenom()">
226<!--   -->
227</a>
228<ul class="blockList">
229<li class="blockList">
230<h4>getDenom</h4>
231<pre>public&nbsp;int&nbsp;getDenom()</pre>
232<div class="block">Returns denominator</div>
233<dl><dt><span class="strong">Returns:</span></dt><dd>denominator</dd></dl>
234</li>
235</ul>
236<a name="getScaled(int)">
237<!--   -->
238</a>
239<ul class="blockList">
240<li class="blockList">
241<h4>getScaled</h4>
242<pre>public&nbsp;int&nbsp;getScaled(int&nbsp;dimension)</pre>
243<div class="block">Returns the scaled value of <code>dimension</code>.  This function
244 performs the integer equivalent of
245 <code>ceil(dimension * scalingFactor)</code>.</div>
246<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dimension</code> - width or height to multiply by this scaling factor</dd>
247<dt><span class="strong">Returns:</span></dt><dd>the scaled value of <code>dimension</code>.</dd></dl>
248</li>
249</ul>
250<a name="equals(org.libjpegturbo.turbojpeg.TJScalingFactor)">
251<!--   -->
252</a>
253<ul class="blockList">
254<li class="blockList">
255<h4>equals</h4>
256<pre>public&nbsp;boolean&nbsp;equals(<a href="../../../org/libjpegturbo/turbojpeg/TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>&nbsp;other)</pre>
257<div class="block">Returns true or false, depending on whether this instance and
258 <code>other</code> have the same numerator and denominator.</div>
259<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - the scaling factor against which to compare this one</dd>
260<dt><span class="strong">Returns:</span></dt><dd>true or false, depending on whether this instance and
261 <code>other</code> have the same numerator and denominator.</dd></dl>
262</li>
263</ul>
264<a name="isOne()">
265<!--   -->
266</a>
267<ul class="blockListLast">
268<li class="blockList">
269<h4>isOne</h4>
270<pre>public&nbsp;boolean&nbsp;isOne()</pre>
271<div class="block">Returns true or false, depending on whether this instance is equal to
272 1/1.</div>
273<dl><dt><span class="strong">Returns:</span></dt><dd>true or false, depending on whether this instance is equal to
274 1/1.</dd></dl>
275</li>
276</ul>
277</li>
278</ul>
279</li>
280</ul>
281</div>
282</div>
283<!-- ========= END OF CLASS DATA ========= -->
284<!-- ======= START OF BOTTOM NAVBAR ====== -->
285<div class="bottomNav"><a name="navbar_bottom">
286<!--   -->
287</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
288<!--   -->
289</a>
290<ul class="navList" title="Navigation">
291<li><a href="../../../org/libjpegturbo/turbojpeg/package-summary.html">Package</a></li>
292<li class="navBarCell1Rev">Class</li>
293<li><a href="package-tree.html">Tree</a></li>
294<li><a href="../../../deprecated-list.html">Deprecated</a></li>
295<li><a href="../../../index-all.html">Index</a></li>
296<li><a href="../../../help-doc.html">Help</a></li>
297</ul>
298</div>
299<div class="subNav">
300<ul class="navList">
301<li><a href="../../../org/libjpegturbo/turbojpeg/TJException.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Prev Class</span></a></li>
302<li><a href="../../../org/libjpegturbo/turbojpeg/TJTransform.html" title="class in org.libjpegturbo.turbojpeg"><span class="strong">Next Class</span></a></li>
303</ul>
304<ul class="navList">
305<li><a href="../../../index.html?org/libjpegturbo/turbojpeg/TJScalingFactor.html" target="_top">Frames</a></li>
306<li><a href="TJScalingFactor.html" target="_top">No Frames</a></li>
307</ul>
308<ul class="navList" id="allclasses_navbar_bottom">
309<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
310</ul>
311<div>
312<script type="text/javascript"><!--
313  allClassesLink = document.getElementById("allclasses_navbar_bottom");
314  if(window==top) {
315    allClassesLink.style.display = "block";
316  }
317  else {
318    allClassesLink.style.display = "none";
319  }
320  //-->
321</script>
322</div>
323<div>
324<ul class="subNavList">
325<li>Summary:&nbsp;</li>
326<li>Nested&nbsp;|&nbsp;</li>
327<li>Field&nbsp;|&nbsp;</li>
328<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
329<li><a href="#method_summary">Method</a></li>
330</ul>
331<ul class="subNavList">
332<li>Detail:&nbsp;</li>
333<li>Field&nbsp;|&nbsp;</li>
334<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
335<li><a href="#method_detail">Method</a></li>
336</ul>
337</div>
338<a name="skip-navbar_bottom">
339<!--   -->
340</a></div>
341<!-- ======== END OF BOTTOM NAVBAR ======= -->
342</body>
343</html>
344