Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 1f7d14130c4a2657e0fb5e1ff2b6ea1d > files > 844

erlang-doc-R15B-03.3.fc18.noarch.rpm

<!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_09-icedtea) on Sat Mar 02 06:46:25 UTC 2013 -->
<title>OtpErlangDouble (Java-Erlang Interface Library)</title>
<meta name="date" content="2013-03-02">
<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="OtpErlangDouble (Java-Erlang Interface Library)";
    }
//-->
</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="../../../../com/ericsson/otp/erlang/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangException.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpErlangDouble.html" target="_top">Frames</a></li>
<li><a href="OtpErlangDouble.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><a href="#nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">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>Field&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">com.ericsson.otp.erlang</div>
<h2 title="Class OtpErlangDouble" class="title">Class OtpErlangDouble</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">com.ericsson.otp.erlang.OtpErlangObject</a></li>
<li>
<ul class="inheritance">
<li>com.ericsson.otp.erlang.OtpErlangDouble</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/ericsson/otp/erlang/OtpErlangFloat.html" title="class in com.ericsson.otp.erlang">OtpErlangFloat</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">OtpErlangDouble</span>
extends <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a>
implements java.io.Serializable, java.lang.Cloneable</pre>
<div class="block">Provides a Java representation of Erlang floats and doubles. Erlang defines
 only one floating point numeric type, however this class and its subclass
 <a href="../../../../com/ericsson/otp/erlang/OtpErlangFloat.html" title="class in com.ericsson.otp.erlang"><code>OtpErlangFloat</code></a> are used to provide representations corresponding to
 the Java types Double and Float.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.ericsson.otp.erlang.OtpErlangDouble">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!--   -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.Hash.html" title="class in com.ericsson.otp.erlang">OtpErlangObject.Hash</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#hashCodeValue">hashCodeValue</a></code></li>
</ul>
</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="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#OtpErlangDouble(double)">OtpErlangDouble</a></strong>(double&nbsp;d)</code>
<div class="block">Create an Erlang float from the given double value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#OtpErlangDouble(com.ericsson.otp.erlang.OtpInputStream)">OtpErlangDouble</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</a>&nbsp;buf)</code>
<div class="block">Create an Erlang float from a stream containing a double encoded in
 Erlang external format.</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>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#doHashCode()">doHashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#doubleValue()">doubleValue</a></strong>()</code>
<div class="block">Get the value, as a double.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#encode(com.ericsson.otp.erlang.OtpOutputStream)">encode</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpOutputStream.html" title="class in com.ericsson.otp.erlang">OtpOutputStream</a>&nbsp;buf)</code>
<div class="block">Convert this double to the equivalent Erlang external representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;o)</code>
<div class="block">Determine if two floats are equal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#floatValue()">floatValue</a></strong>()</code>
<div class="block">Get the value, as a float.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangDouble.html#toString()">toString</a></strong>()</code>
<div class="block">Get the string representation of this double.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#clone()">clone</a>, <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#decode(com.ericsson.otp.erlang.OtpInputStream)">decode</a>, <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#hashCode()">hashCode</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="OtpErlangDouble(double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OtpErlangDouble</h4>
<pre>public&nbsp;OtpErlangDouble(double&nbsp;d)</pre>
<div class="block">Create an Erlang float from the given double value.</div>
</li>
</ul>
<a name="OtpErlangDouble(com.ericsson.otp.erlang.OtpInputStream)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OtpErlangDouble</h4>
<pre>public&nbsp;OtpErlangDouble(<a href="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</a>&nbsp;buf)
                throws <a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</a></pre>
<div class="block">Create an Erlang float from a stream containing a double encoded in
 Erlang external format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - the stream containing the encoded value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</a></code> - if the buffer does not contain a valid external
                    representation of an Erlang float.</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="doubleValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doubleValue</h4>
<pre>public&nbsp;double&nbsp;doubleValue()</pre>
<div class="block">Get the value, as a double.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of this object, as a double.</dd></dl>
</li>
</ul>
<a name="floatValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>floatValue</h4>
<pre>public&nbsp;float&nbsp;floatValue()
                 throws <a href="../../../../com/ericsson/otp/erlang/OtpErlangRangeException.html" title="class in com.ericsson.otp.erlang">OtpErlangRangeException</a></pre>
<div class="block">Get the value, as a float.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of this object, as a float.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangRangeException.html" title="class in com.ericsson.otp.erlang">OtpErlangRangeException</a></code> - if the value cannot be represented as a float.</dd></dl>
</li>
</ul>
<a name="toString()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Get the string representation of this double.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation of this double.</dd></dl>
</li>
</ul>
<a name="encode(com.ericsson.otp.erlang.OtpOutputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public&nbsp;void&nbsp;encode(<a href="../../../../com/ericsson/otp/erlang/OtpOutputStream.html" title="class in com.ericsson.otp.erlang">OtpOutputStream</a>&nbsp;buf)</pre>
<div class="block">Convert this double to the equivalent Erlang external representation.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#encode(com.ericsson.otp.erlang.OtpOutputStream)">encode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - an output stream to which the encoded value should be
                written.</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(java.lang.Object&nbsp;o)</pre>
<div class="block">Determine if two floats are equal. Floats are equal if they contain the
 same value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the float to compare to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the floats have the same value.</dd></dl>
</li>
</ul>
<a name="doHashCode()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doHashCode</h4>
<pre>protected&nbsp;int&nbsp;doHashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#doHashCode()">doHashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></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="../../../../com/ericsson/otp/erlang/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangException.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpErlangDouble.html" target="_top">Frames</a></li>
<li><a href="OtpErlangDouble.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><a href="#nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">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>Field&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 ======= -->
</body>
</html>