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