Files
2016-04-27 01:07:35 -04:00

874 lines
41 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Apr 06 13:11:04 EDT 2016 -->
<title>Int96 (Parallel Java 2 Library Documentation)</title>
<meta name="date" content="2016-04-06">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Int96 (Parallel Java 2 Library Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Int96.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../edu/rit/numeric/Histogram.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../edu/rit/numeric/Interpolation.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?edu/rit/numeric/Int96.html" target="_top">Frames</a></li>
<li><a href="Int96.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.rit.numeric</div>
<h2 title="Class Int96" class="title">Class Int96</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>edu.rit.numeric.Int96</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Int96</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&gt;</pre>
<div class="block">Class Int96 provides a fixed-size 96-bit signed integer.
<P>
Int96 objects are mutable. Many of the methods alter the state of the Int96
object on which they are invoked. This avoids creation of unnecessary Int96
objects when performing a series of operations. However, if necessary, you
must explicitly create a new Int96 object upon which to perform a series of
operations.
<P>
Class Int96 defines the <a href="../../../edu/rit/numeric/Int96.html#equals(java.lang.Object)"><code>equals()</code></a> and <a href="../../../edu/rit/numeric/Int96.html#hashCode()"><code>hashCode()</code></a> methods, so Int96 objects can be used as keys in
hashed data structures. However, be careful not to alter the state of an
Int96 object once it is used as a key. Also, never alter the state of the
predefined <a href="../../../edu/rit/numeric/Int96.html#ZERO"><code>ZERO</code></a>, <a href="../../../edu/rit/numeric/Int96.html#ONE"><code>ONE</code></a>, <a href="../../../edu/rit/numeric/Int96.html#TWO"><code>TWO</code></a>, and <a href="../../../edu/rit/numeric/Int96.html#TEN"><code>TEN</code></a>
objects.
<P>
Class Int96 is not multiple thread safe. However, each constructor and method
only alters the Int96 object on which the constructor or method is called.
The constructors and methods do not alter their arguments.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#ONE">ONE</a></strong></code>
<div class="block">96-bit integer with the value 1.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#TEN">TEN</a></strong></code>
<div class="block">96-bit integer with the value 10.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#TWO">TWO</a></strong></code>
<div class="block">96-bit integer with the value 2.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#ZERO">ZERO</a></strong></code>
<div class="block">96-bit integer with the value 0.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../edu/rit/numeric/Int96.html#Int96()">Int96</a></strong>()</code>
<div class="block">Construct a new integer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../edu/rit/numeric/Int96.html#Int96(int)">Int96</a></strong>(int&nbsp;val)</code>
<div class="block">Construct a new integer with the given <TT>int</TT> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../edu/rit/numeric/Int96.html#Int96(edu.rit.numeric.Int96)">Int96</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Construct a new integer with the given Int96 value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../edu/rit/numeric/Int96.html#Int96(long)">Int96</a></strong>(long&nbsp;val)</code>
<div class="block">Construct a new integer with the given <TT>long</TT> value.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#add(edu.rit.numeric.Int96)">add</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the sum of itself and the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#assign(int)">assign</a></strong>(int&nbsp;val)</code>
<div class="block">Set this integer to the given <TT>int</TT> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#assign(edu.rit.numeric.Int96)">assign</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the given Int96 value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#assign(long)">assign</a></strong>(long&nbsp;val)</code>
<div class="block">Set this integer to the given <TT>long</TT> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#compareTo(edu.rit.numeric.Int96)">compareTo</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Compare this integer to the given integer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#decr()">decr</a></strong>()</code>
<div class="block">Set this integer to itself decremented by 1.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#div(edu.rit.numeric.Int96)">div</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the quotient of itself and the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>
<div class="block">Determine if this integer equals the given object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#eqzero()">eqzero</a></strong>()</code>
<div class="block">Determine if this integer equals 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns a hash code for this integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#incr()">incr</a></strong>()</code>
<div class="block">Set this integer to itself incremented by 1.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#intval()">intval</a></strong>()</code>
<div class="block">Returns this integer converted to type <TT>int</TT>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#longval()">longval</a></strong>()</code>
<div class="block">Returns this integer converted to type <TT>long</TT>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#lsh()">lsh</a></strong>()</code>
<div class="block">Set this integer to itself left-shifted one bit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#max(edu.rit.numeric.Int96)">max</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the larger of itself and the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#min(edu.rit.numeric.Int96)">min</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the smaller of itself and the given value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#mul(edu.rit.numeric.Int96)">mul</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the product of itself and the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#neg()">neg</a></strong>()</code>
<div class="block">Negate this integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#of(int)">of</a></strong>(int&nbsp;val)</code>
<div class="block">Returns a new integer with the given <TT>int</TT> value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#of(edu.rit.numeric.Int96)">of</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Returns a new integer with the given Int96 value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#of(long)">of</a></strong>(long&nbsp;val)</code>
<div class="block">Returns a new integer with the given <TT>long</TT> value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#rsh()">rsh</a></strong>()</code>
<div class="block">Set this integer to itself right-shifted one bit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#sub(edu.rit.numeric.Int96)">sub</a></strong>(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</code>
<div class="block">Set this integer to the difference of itself and the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string version of this integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a></code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Int96.html#ursh()">ursh</a></strong>()</code>
<div class="block">Set this integer to itself unsigned-right-shifted one bit.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ZERO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZERO</h4>
<pre>public static final&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a> ZERO</pre>
<div class="block">96-bit integer with the value 0.</div>
</li>
</ul>
<a name="ONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ONE</h4>
<pre>public static final&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a> ONE</pre>
<div class="block">96-bit integer with the value 1.</div>
</li>
</ul>
<a name="TWO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TWO</h4>
<pre>public static final&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a> TWO</pre>
<div class="block">96-bit integer with the value 2.</div>
</li>
</ul>
<a name="TEN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TEN</h4>
<pre>public static final&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a> TEN</pre>
<div class="block">96-bit integer with the value 10.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Int96()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Int96</h4>
<pre>public&nbsp;Int96()</pre>
<div class="block">Construct a new integer. Its value is 0.</div>
</li>
</ul>
<a name="Int96(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Int96</h4>
<pre>public&nbsp;Int96(int&nbsp;val)</pre>
<div class="block">Construct a new integer with the given <TT>int</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd></dl>
</li>
</ul>
<a name="Int96(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Int96</h4>
<pre>public&nbsp;Int96(long&nbsp;val)</pre>
<div class="block">Construct a new integer with the given <TT>long</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd></dl>
</li>
</ul>
<a name="Int96(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Int96</h4>
<pre>public&nbsp;Int96(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Construct a new integer with the given Int96 value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="of(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;of(int&nbsp;val)</pre>
<div class="block">Returns a new integer with the given <TT>int</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>New integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="of(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;of(long&nbsp;val)</pre>
<div class="block">Returns a new integer with the given <TT>long</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>New integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="of(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;of(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Returns a new integer with the given Int96 value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>New integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="intval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intval</h4>
<pre>public&nbsp;int&nbsp;intval()</pre>
<div class="block">Returns this integer converted to type <TT>int</TT>. The most significant
64 bits are discarded.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><TT>int</TT> value.</dd></dl>
</li>
</ul>
<a name="longval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>longval</h4>
<pre>public&nbsp;long&nbsp;longval()</pre>
<div class="block">Returns this integer converted to type <TT>long</TT>. The most
significant 32 bits are discarded.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><TT>long</TT> value.</dd></dl>
</li>
</ul>
<a name="assign(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assign</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;assign(int&nbsp;val)</pre>
<div class="block">Set this integer to the given <TT>int</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="assign(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assign</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;assign(long&nbsp;val)</pre>
<div class="block">Set this integer to the given <TT>long</TT> value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="assign(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assign</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;assign(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the given Int96 value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>val</TT>.</dd></dl>
</li>
</ul>
<a name="neg()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>neg</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;neg()</pre>
<div class="block">Negate this integer.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>-this</TT>.</dd></dl>
</li>
</ul>
<a name="add(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;add(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the sum of itself and the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this+val</TT>.</dd></dl>
</li>
</ul>
<a name="incr()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incr</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;incr()</pre>
<div class="block">Set this integer to itself incremented by 1.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this+1</TT>.</dd></dl>
</li>
</ul>
<a name="sub(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sub</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;sub(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the difference of itself and the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this-val</TT>.</dd></dl>
</li>
</ul>
<a name="decr()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decr</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;decr()</pre>
<div class="block">Set this integer to itself decremented by 1.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this-1</TT>.</dd></dl>
</li>
</ul>
<a name="mul(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mul</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;mul(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the product of itself and the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this*val</TT>.</dd></dl>
</li>
</ul>
<a name="div(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>div</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;div(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the quotient of itself and the given value. The
remainder is discarded.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this/val</TT>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - (unchecked exception) Thrown if <TT>val</TT> is 0.</dd></dl>
</li>
</ul>
<a name="lsh()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lsh</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;lsh()</pre>
<div class="block">Set this integer to itself left-shifted one bit.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this&lt;&lt;1</TT>.</dd></dl>
</li>
</ul>
<a name="rsh()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rsh</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;rsh()</pre>
<div class="block">Set this integer to itself right-shifted one bit.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this&gt;&gt;1</TT>.</dd></dl>
</li>
</ul>
<a name="ursh()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ursh</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;ursh()</pre>
<div class="block">Set this integer to itself unsigned-right-shifted one bit.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>this&gt;&gt;&gt;1</TT>.</dd></dl>
</li>
</ul>
<a name="min(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;min(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the smaller of itself and the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>min(this,val)</TT>.</dd></dl>
</li>
</ul>
<a name="max(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public&nbsp;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;max(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Set this integer to the larger of itself and the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This integer, with its value set to <TT>max(this,val)</TT>.</dd></dl>
</li>
</ul>
<a name="eqzero()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eqzero</h4>
<pre>public&nbsp;boolean&nbsp;eqzero()</pre>
<div class="block">Determine if this integer equals 0.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if this integer equals 0, false if it doesn't.</dd></dl>
</li>
</ul>
<a name="compareTo(edu.rit.numeric.Int96)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&nbsp;val)</pre>
<div class="block">Compare this integer to the given integer.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../edu/rit/numeric/Int96.html" title="class in edu.rit.numeric">Int96</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A number less than, equal to, or greater than 0 if this integer
is less than, equal to, or greater than <TT>val</TT>,
respectively.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<div class="block">Determine if this integer equals the given object.
<P>
<I>Note:</I> Class Int96 provides the <TT>equals()</TT> and
<TT>hashCode()</TT> methods, and Int96 objects can be used as keys in
hashed data structures. However, Int96 objects are mutable. If an Int96
object is used as a hash key, be sure not to change its value.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - Object to compare.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if this integer equals <TT>obj</TT>, false otherwise.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code for this integer.
<P>
<I>Note:</I> Class Int96 provides the <TT>equals()</TT> and
<TT>hashCode()</TT> methods, and Int96 objects can be used as keys in
hashed data structures. However, Int96 objects are mutable. If an Int96
object is used as a hash key, be sure not to change its value.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Hash code.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<div class="block">Returns a string version of this integer. The string is a 24-digit
hexadecimal number.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>String version.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Int96.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../edu/rit/numeric/Histogram.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../edu/rit/numeric/Interpolation.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?edu/rit/numeric/Int96.html" target="_top">Frames</a></li>
<li><a href="Int96.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><FONT SIZE="-2">Copyright &copy; 2013&ndash;2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">&shy;</FONT><FONT SIZE="-2">&#64;</FONT><FONT SIZE="1" COLOR="#FFFFFF">&shy;</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
</body>
</html>