html/classes/Envelope.html in eymiha_util-0.1.5 vs html/classes/Envelope.html in eymiha_util-0.1.6
- old
+ new
@@ -1,329 +1,329 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: Envelope</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">Envelope</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../files/lib/envelope_rb.html">
- lib/envelope.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="BaseEnvelope.html">
- BaseEnvelope
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-An <a href="Envelope.html">Envelope</a> is the minimum envelope that will
-completely contain a set of values. Values may be added to an instance, and
-it can return the number of values considered so far and its <a
-href="Envelope.html#M000019">high</a> and <a
-href="Envelope.html#M000020">low</a> boundaries.
-</p>
-<p>
-Envelopes can be used to generate ranges, however the result may be of
-limited utility if the types of values being enveloped don‘t play
-nicely with ranges.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000022">===</a>
- <a href="#M000018">add</a>
- <a href="#M000021">contains?</a>
- <a href="#M000019">high</a>
- <a href="#M000020">low</a>
- <a href="#M000016">new</a>
- <a href="#M000023">to_range</a>
- <a href="#M000017">to_s</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000016" class="method-detail">
- <a name="M000016"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000016.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000016.html');return false;">
- <span class="method-name">new</span><span class="method-args">(value=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Creates and returns an instance. If an argument is given, it is passed to
-the set method to initialize the <a href="Envelope.html#M000016">new</a>
-instance.
-</p>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000022" class="method-detail">
- <a name="M000022"></a>
-
- <div class="method-heading">
- <span class="method-name">===</span><span class="method-args">(value)</span>
- </div>
-
- <div class="method-description">
- <p>
-Alias for contains?
-</p>
- </div>
- </div>
-
- <div id="method-M000018" class="method-detail">
- <a name="M000018"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000018.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000018.html');return false;">
- <span class="method-name">add</span><span class="method-args">(value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Adds a value to the instance. When
-</p>
-<ul>
-<li>x is an <a href="Envelope.html">Envelope</a>, it is coalesced into the
-instance.
-
-</li>
-<li>otherwise, the envelope is extened to contain the value.
-
-</li>
-<li>if the value cannot be compared to the boundaries, an <a
-href="EnvelopeException.html">EnvelopeException</a> is raised.
-
-</li>
-</ul>
-<p>
-The modified instance is returned.
-</p>
- </div>
- </div>
-
- <div id="method-M000021" class="method-detail">
- <a name="M000021"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000021.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000021.html');return false;">
- <span class="method-name">contains?</span><span class="method-args">(value)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns true if the instance completely contains the argument:
-</p>
-<ul>
-<li>value is an <a href="Envelope.html">Envelope</a>, its <a
-href="Envelope.html#M000019">high</a> and <a
-href="Envelope.html#M000020">low</a> are contained.
-
-</li>
-<li>otherwise, the value is contained.
-
-</li>
-<li>if the value cannot be compared to the boundaries, an <a
-href="EnvelopeException.html">EnvelopeException</a> is raised.
-
-</li>
-</ul>
- </div>
- </div>
-
- <div id="method-M000019" class="method-detail">
- <a name="M000019"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000019.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000019.html');return false;">
- <span class="method-name">high</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the <a href="Envelope.html#M000019">high</a> boundary of the
-instance.
-</p>
-<ul>
-<li>if there are no boundaries, an <a
-href="EnvelopeException.html">EnvelopeException</a> is raised.
-
-</li>
-</ul>
- </div>
- </div>
-
- <div id="method-M000020" class="method-detail">
- <a name="M000020"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000020.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000020.html');return false;">
- <span class="method-name">low</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the <a href="Envelope.html#M000020">low</a> boundary of the
-instance.
-</p>
-<ul>
-<li>if there are no boundaries, an <a
-href="EnvelopeException.html">EnvelopeException</a> is raised.
-
-</li>
-</ul>
- </div>
- </div>
-
- <div id="method-M000023" class="method-detail">
- <a name="M000023"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000023.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000023.html');return false;">
- <span class="method-name">to_range</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns an inclusive range from the <a href="Envelope.html#M000020">low</a>
-to <a href="Envelope.html#M000019">high</a> boundaries
-</p>
- </div>
- </div>
-
- <div id="method-M000017" class="method-detail">
- <a name="M000017"></a>
-
- <div class="method-heading">
- <a href="Envelope.src/M000017.html" target="Code" class="method-signature"
- onclick="popupCode('Envelope.src/M000017.html');return false;">
- <span class="method-name">to_s</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns a string representation of the instance.
-</p>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: Envelope</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">Envelope</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../files/lib/envelope_rb.html">
+ lib/envelope.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ <a href="BaseEnvelope.html">
+ BaseEnvelope
+ </a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+An <a href="Envelope.html">Envelope</a> is the minimum envelope that will
+completely contain a set of values. Values may be added to an instance, and
+it can return the number of values considered so far and its <a
+href="Envelope.html#M000019">high</a> and <a
+href="Envelope.html#M000020">low</a> boundaries.
+</p>
+<p>
+Envelopes can be used to generate ranges, however the result may be of
+limited utility if the types of values being enveloped don‘t play
+nicely with ranges.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000022">===</a>
+ <a href="#M000018">add</a>
+ <a href="#M000021">contains?</a>
+ <a href="#M000019">high</a>
+ <a href="#M000020">low</a>
+ <a href="#M000016">new</a>
+ <a href="#M000023">to_range</a>
+ <a href="#M000017">to_s</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000016" class="method-detail">
+ <a name="M000016"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000016.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000016.html');return false;">
+ <span class="method-name">new</span><span class="method-args">(value=nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Creates and returns an instance. If an argument is given, it is passed to
+the set method to initialize the <a href="Envelope.html#M000016">new</a>
+instance.
+</p>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000022" class="method-detail">
+ <a name="M000022"></a>
+
+ <div class="method-heading">
+ <span class="method-name">===</span><span class="method-args">(value)</span>
+ </div>
+
+ <div class="method-description">
+ <p>
+Alias for contains?
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000018" class="method-detail">
+ <a name="M000018"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000018.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000018.html');return false;">
+ <span class="method-name">add</span><span class="method-args">(value)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Adds a value to the instance. When
+</p>
+<ul>
+<li>x is an <a href="Envelope.html">Envelope</a>, it is coalesced into the
+instance.
+
+</li>
+<li>otherwise, the envelope is extened to contain the value.
+
+</li>
+<li>if the value cannot be compared to the boundaries, an <a
+href="EnvelopeException.html">EnvelopeException</a> is raised.
+
+</li>
+</ul>
+<p>
+The modified instance is returned.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000021" class="method-detail">
+ <a name="M000021"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000021.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000021.html');return false;">
+ <span class="method-name">contains?</span><span class="method-args">(value)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns true if the instance completely contains the argument:
+</p>
+<ul>
+<li>value is an <a href="Envelope.html">Envelope</a>, its <a
+href="Envelope.html#M000019">high</a> and <a
+href="Envelope.html#M000020">low</a> are contained.
+
+</li>
+<li>otherwise, the value is contained.
+
+</li>
+<li>if the value cannot be compared to the boundaries, an <a
+href="EnvelopeException.html">EnvelopeException</a> is raised.
+
+</li>
+</ul>
+ </div>
+ </div>
+
+ <div id="method-M000019" class="method-detail">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000019.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000019.html');return false;">
+ <span class="method-name">high</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns the <a href="Envelope.html#M000019">high</a> boundary of the
+instance.
+</p>
+<ul>
+<li>if there are no boundaries, an <a
+href="EnvelopeException.html">EnvelopeException</a> is raised.
+
+</li>
+</ul>
+ </div>
+ </div>
+
+ <div id="method-M000020" class="method-detail">
+ <a name="M000020"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000020.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000020.html');return false;">
+ <span class="method-name">low</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns the <a href="Envelope.html#M000020">low</a> boundary of the
+instance.
+</p>
+<ul>
+<li>if there are no boundaries, an <a
+href="EnvelopeException.html">EnvelopeException</a> is raised.
+
+</li>
+</ul>
+ </div>
+ </div>
+
+ <div id="method-M000023" class="method-detail">
+ <a name="M000023"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000023.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000023.html');return false;">
+ <span class="method-name">to_range</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns an inclusive range from the <a href="Envelope.html#M000020">low</a>
+to <a href="Envelope.html#M000019">high</a> boundaries
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000017" class="method-detail">
+ <a name="M000017"></a>
+
+ <div class="method-heading">
+ <a href="Envelope.src/M000017.html" target="Code" class="method-signature"
+ onclick="popupCode('Envelope.src/M000017.html');return false;">
+ <span class="method-name">to_s</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns a string representation of the instance.
+</p>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
</html>
\ No newline at end of file