docs/Yk/ESet.html in YkESet-0.99.7 vs docs/Yk/ESet.html in YkESet-0.99.9

- old
+ new

@@ -193,10 +193,32 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> + <a href="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(*args) &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#begin-instance_method" title="#begin (instance method)">#<strong>begin</strong> &#x21d2; ESet::Iterator </a> </span> @@ -701,10 +723,24 @@ <div class='inline'> +<p>ArgumentError raised when using argument(s) with erased position</p> +</div> + + </li> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'> <p>RangeError raised when dereferencing end iterator</p> </div> </li> @@ -714,15 +750,15 @@ <tr> <td> <pre class="lines"> -69 -70</pre> +84 +85</pre> </td> <td> - <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 69</span> + <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 84</span> <span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Yk::ESet (class)">ESet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span><span class='comma'>,</span> <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>end</span></pre> </td> </tr> @@ -833,23 +869,37 @@ <p>ArgumentError raised when first and last iterators are not from the same container.</p> </div> </li> + <li> + + + <span class='type'></span> + + + + + <div class='inline'> +<p>ArgumentError raised when using argument(s) with erased position</p> +</div> + + </li> + </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -77 -78</pre> +93 +94</pre> </td> <td> - <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 77</span> + <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 93</span> <span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Yk::ESet (class)">ESet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_for_each'>for_each</span> <span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span> <span class='kw'>end</span></pre> </td> </tr> @@ -861,12 +911,184 @@ <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> - <h3 class="signature first" id="begin-instance_method"> + <h3 class="signature first" id="add-instance_method"> + + <span class="overload">#<strong>add</strong>(position, obj) &#x21d2; <tt>True|False</tt> </span> + + <span class="overload">#<strong>add</strong>(obj) &#x21d2; <tt>True|False</tt> </span> + + + + + + +</h3><div class="docstring"> + <div class="discussion"> + + + </div> +</div> +<div class="tags"> + + <p class="tag_title">Overloads:</p> + <ul class="overload"> + + + <li class="overload_item"> + <span class="signature">#<strong>add</strong>(position, obj) &#x21d2; <tt>True|False</tt> </span> + <div class="docstring"> + <div class="discussion"> + +<p>Insert element with an object using a hint and return true if a new element was inserted or false if an equivalent element already existed. Do not return iterator object. More efficient if you do not need inserted position (removed by GC).</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>position</span> + + + <span class='type'>(<tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>)</span> + + + + &mdash; + <div class='inline'> +<p>Hint for the position where the element can be inserted.</p> +</div> + + </li> + + <li> + + <span class='name'>obj</span> + + + <span class='type'>(<tt>Object</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>Object to be pointed by the inserted elements.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>True|False</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>true if a new element was inserted or false if an equivalent element already existed.</p> +</div> + + </li> + +</ul> + +</div> + </li> + + + <li class="overload_item"> + <span class="signature">#<strong>add</strong>(obj) &#x21d2; <tt>True|False</tt> </span> + <div class="docstring"> + <div class="discussion"> + +<p>Insert element with an object and return true if a new element was inserted or false if an equivalent element already existed. Do not return iterator object. More efficient if you do not need inserted position (removed by GC).</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>obj</span> + + + <span class='type'>(<tt>Object</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>key object to be pointed by the inserted elements.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>True|False</tt>)</span> + + + + &mdash; + <div class='inline'> +<p>true if a new element was inserted or false if an equivalent element already existed.</p> +</div> + + </li> + +</ul> + +</div> + </li> + + </ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 48</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="begin-instance_method"> + #<strong>begin</strong> &#x21d2; <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> @@ -1043,11 +1265,11 @@ <li class="overload_item"> <span class="signature">#<strong>erase</strong>(position) &#x21d2; <tt>Object</tt> </span> <div class="docstring"> <div class="discussion"> -<p>Removes an element</p> +<p>Erase an element from the container</p> </div> </div> <div class="tags"> @@ -1061,10 +1283,15 @@ <span class='type'>(<tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>)</span> + &mdash; + <div class='inline'> +<p>to erase</p> +</div> + </li> </ul> <p class="tag_title">Raises:</p> @@ -1082,10 +1309,24 @@ <p>ArgumentError raised when an argument is not a compatible iterator.</p> </div> </li> + <li> + + + <span class='type'></span> + + + + + <div class='inline'> +<p>ArgumentError raised when using argument with erased position</p> +</div> + + </li> + </ul> </div> </li> @@ -1093,11 +1334,11 @@ <li class="overload_item"> <span class="signature">#<strong>erase</strong>(frist, last) &#x21d2; <tt>Object</tt> </span> <div class="docstring"> <div class="discussion"> -<p>Removes a range of elements ([first,last)) from the container. Iterators specifying a range within the set container to be removed: [first,last). i.e., the range includes all the elements between first and last, including the element pointed by first but not the one pointed by last.</p> +<p>Erase a range of elements ([first,last)) from the container. Iterators specifying a range within the set container to be removed: [first,last). i.e., the range includes all the elements between first and last, including the element pointed by first but not the one pointed by last.</p> </div> </div> <div class="tags"> @@ -1181,10 +1422,24 @@ <p>RangeError raised when erasing end iterator</p> </div> </li> + <li> + + + <span class='type'></span> + + + + + <div class='inline'> +<p>ArgumentError raised when use argument with erased position</p> +</div> + + </li> + </ul> </div> </li> @@ -1195,15 +1450,15 @@ <tr> <td> <pre class="lines"> -51 -52</pre> +64 +65</pre> </td> <td> - <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 51</span> + <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 64</span> <span class='kw'>def</span> <span class='id identifier rubyid_erase'>erase</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='kw'>end</span></pre> </td> </tr> @@ -1265,22 +1520,40 @@ </div> </li> </ul> +<p class="tag_title">Raises:</p> +<ul class="raise"> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'> +<p>ArgumentError raised when using argument(s) with erased position</p> +</div> + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -56 -57</pre> +70 +71</pre> </td> <td> - <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 56</span> + <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 70</span> <span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span> <span class='id identifier rubyid_arg'>arg</span> <span class='kw'>end</span></pre> </td> </tr> @@ -1315,11 +1588,11 @@ <li class="overload_item"> <span class="signature">#<strong>insert</strong>(position, obj) &#x21d2; <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> </span> <div class="docstring"> <div class="discussion"> -<p>Insert element with an object using a hint</p> +<p>Insert element with an object using a hint and return new iterator object</p> </div> </div> <div class="tags"> @@ -1386,11 +1659,11 @@ <li class="overload_item"> <span class="signature">#<strong>insert</strong>(obj) &#x21d2; <tt>Array</tt> </span> <div class="docstring"> <div class="discussion"> -<p>Insert element with an object</p> +<p>Insert element and return new iterator object</p> </div> </div> <div class="tags"> @@ -1633,10 +1906,10 @@ </div> </div> <div id="footer"> - Generated on Fri Feb 21 22:53:05 2020 by + Generated on Sun Feb 23 08:31:40 2020 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.24 (ruby-2.7.0). </div> </div> \ No newline at end of file