doc/CSVDecision/Paths.html in csv_decision2-0.5.1 vs doc/CSVDecision/Paths.html in csv_decision2-0.5.2

- old
+ new

@@ -1,742 +1,777 @@ <!DOCTYPE html> <html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Class: CSVDecision::Paths - + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <title> + Class: CSVDecision2::Paths + &mdash; Documentation by YARD 0.9.12 - -</title> + </title> + <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" /> <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" /> -<script type="text/javascript" charset="utf-8"> - pathId = "CSVDecision::Paths"; - relpath = '../'; -</script> + <script type="text/javascript" charset="utf-8"> + pathId = "CSVDecision2::Paths"; + relpath = '../'; + </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> - </head> - <body> - <div class="nav_wrap"> - <iframe id="nav" src="../class_list.html?1"></iframe> - <div id="resizer"></div> +</head> + +<body> + <div class="nav_wrap"> + <iframe id="nav" src="../class_list.html?1"></iframe> + <div id="resizer"></div> + </div> + + <div id="main" tabindex="-1"> + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (P)</a> &raquo; + <span class='title'><span class='object_link'><a href="../CSVDecision2.html" + title="CSVDecision (module)">CSVDecision</a></span></span> + &raquo; + <span class="title">Paths</span> + + </div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" href="../class_list.html"> + + <svg width="24" height="24"> + <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> + </svg> + </a> + + </div> + <div class="clear"></div> </div> - <div id="main" tabindex="-1"> - <div id="header"> - <div id="menu"> - - <a href="../_index.html">Index (P)</a> &raquo; - <span class='title'><span class='object_link'><a href="../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></span> - &raquo; - <span class="title">Paths</span> - -</div> + <div id="content"> + <h1>Class: CSVDecision2::Paths - <div id="search"> - - <a class="full_list_link" id="class_list_link" - href="../class_list.html"> - <svg width="24" height="24"> - <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> - </svg> - </a> - -</div> - <div class="clear"></div> + <span class="private note title">Private</span> + </h1> + <div class="box_info"> + + <dl> + <dt>Inherits:</dt> + <dd> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">CSVDecision2::Paths</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + </dl> + + + + + + + + + + + + <dl> + <dt>Defined in:</dt> + <dd>lib/csv_decision2/paths.rb</dd> + </dl> + </div> - <div id="content"><h1>Class: CSVDecision::Paths - - - <span class="private note title">Private</span> -</h1> -<div class="box_info"> - - <dl> - <dt>Inherits:</dt> - <dd> - <span class="inheritName">Object</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">CSVDecision::Paths</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - </dl> - + <h2>Overview</h2> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This class is part of a private API.</strong> + You should avoid using this class if possible, as it may be removed or be changed in the future. + </p> - - - - - + <p>Build an index for a decision table with one or more input columns + designated as keys</p> - - - <dl> - <dt>Defined in:</dt> - <dd>lib/csv_decision/paths.rb</dd> - </dl> - -</div> + </div> + </div> + <div class="tags"> -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This class is part of a private API.</strong> - You should avoid using this class if possible, as it may be removed or be changed in the future. -</p> -<p>Build an index for a decision table with one or more input columns -designated as keys</p> + </div> - </div> -</div> -<div class="tags"> - -</div> + <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> + <ul class="summary"> + <li class="public "> + <span class="summary_signature"> + <a href="#paths-instance_method" title="#paths (instance method)">#<strong>paths</strong> &#x21d2; Hash </a> - <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#paths-instance_method" title="#paths (instance method)">#<strong>paths</strong> &#x21d2; Hash </a> - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - <span class="private note title">private</span> - - <span class="summary_desc"><div class='inline'> -<p>The index hash mapping in input values to one or more data array row -indexes.</p> -</div></span> - -</li> + </span> - - </ul> + <span class="note title readonly">readonly</span> - - <h2> - Class Method Summary - <small><a href="#" class="summary_toggle">collapse</a></small> - </h2> - <ul class="summary"> - + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"> + <div class='inline'> + <p>The index hash mapping in input values to one or more data array row + indexes.</p> + </div> + </span> + + </li> + + + </ul> + + + + + + <h2> + Class Method Summary + <small><a href="#" class="summary_toggle">collapse</a></small> + </h2> + + <ul class="summary"> + <li class="public "> - <span class="summary_signature"> - - <a href="#scan-class_method" title="scan (class method)">.<strong>scan</strong>(table:) &#x21d2; CSVDecision::Paths </a> - + <span class="summary_signature"> - - </span> - - - - - - - <span class="private note title">private</span> + <a href="#scan-class_method" title="scan (class method)">.<strong>scan</strong>(table:) &#x21d2; + CSVDecision2::Paths </a> - - <span class="summary_desc"><div class='inline'> -<p>Build the index of paths.</p> -</div></span> - -</li> - + + </span> + + + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"> + <div class='inline'> + <p>Build the index of paths.</p> + </div> + </span> + + </li> + + <li class="public "> - <span class="summary_signature"> - - <a href="#symbol-class_method" title="symbol (class method)">.<strong>symbol</strong>(value) &#x21d2; nil, Symbol </a> - + <span class="summary_signature"> - - </span> - - - - - - - <span class="private note title">private</span> + <a href="#symbol-class_method" title="symbol (class method)">.<strong>symbol</strong>(value) &#x21d2; nil, + Symbol </a> - - <span class="summary_desc"><div class='inline'> -<p>Non-empty string converted to a symbol.</p> -</div></span> - -</li> - + + </span> + + + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"> + <div class='inline'> + <p>Non-empty string converted to a symbol.</p> + </div> + </span> + + </li> + + <li class="public "> - <span class="summary_signature"> - - <a href="#value-class_method" title="value (class method)">.<strong>value</strong>(current_value, index) &#x21d2; Integer, Array </a> - + <span class="summary_signature"> - - </span> - - - - - - - <span class="private note title">private</span> + <a href="#value-class_method" title="value (class method)">.<strong>value</strong>(current_value, index) + &#x21d2; Integer, Array </a> - - <span class="summary_desc"><div class='inline'> -<p>New path key value.</p> -</div></span> - -</li> - - </ul> - - <h2> - Instance Method Summary - <small><a href="#" class="summary_toggle">collapse</a></small> - </h2> - <ul class="summary"> - + </span> + + + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"> + <div class='inline'> + <p>New path key value.</p> + </div> + </span> + + </li> + + + </ul> + + <h2> + Instance Method Summary + <small><a href="#" class="summary_toggle">collapse</a></small> + </h2> + + <ul class="summary"> + <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(table:, columns:) &#x21d2; Paths </a> - + <span class="summary_signature"> - - </span> - - - <span class="note title constructor">constructor</span> - - - - - - <span class="private note title">private</span> + <a href="#initialize-instance_method" + title="#initialize (instance method)">#<strong>initialize</strong>(table:, columns:) &#x21d2; Paths </a> - - <span class="summary_desc"><div class='inline'> -<p>A new instance of Paths.</p> -</div></span> - -</li> - - </ul> - -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <div class="method_details first"> - <h3 class="signature first" id="initialize-instance_method"> - - #<strong>initialize</strong>(table:, columns:) &#x21d2; <tt><span class='object_link'><a href="" title="CSVDecision::Paths (class)">Paths</a></span></tt> - + </span> - - -</h3><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This method is part of a private API.</strong> - You should avoid using this method if possible, as it may be removed or be changed in the future. -</p> + <span class="note title constructor">constructor</span> -<p>Returns a new instance of Paths</p> - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>table</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="CSVDecision::Table (class)">CSVDecision::Table</a></span></tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Decision table.</p> -</div> - - </li> - - <li> - - <span class='name'>columns</span> - - - <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Index.html" title="CSVDecision::Index (class)">Index</a></span>&gt;</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Array of column indexes to be indexed.</p> -</div> - - </li> - -</ul> -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> + <span class="private note title">private</span> + <span class="summary_desc"> + <div class='inline'> + <p>A new instance of Paths.</p> + </div> + </span> + + </li> + + + </ul> + + + <div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <h3 class="signature first" id="initialize-instance_method"> + + #<strong>initialize</strong>(table:, columns:) &#x21d2; <tt><span class='object_link'><a href="" + title="CSVDecision2::Paths (class)">Paths</a></span></tt> + + + + + + </h3> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. + </p> + + <p>Returns a new instance of Paths</p> + + + </div> + </div> + <div class="tags"> + <p class="tag_title">Parameters:</p> + <ul class="param"> + + <li> + + <span class='name'>table</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Table.html" + title="CSVDecision2::Table (class)">CSVDecision2::Table</a></span></tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Decision table.</p> + </div> + + </li> + + <li> + + <span class='name'>columns</span> + + + <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Index.html" + title="CSVDecision2::Index (class)">Index</a></span>&gt;</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Array of column indexes to be indexed.</p> + </div> + + </li> + + </ul> + + + </div> + <table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 45 46 47 48 49 50 51 52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/paths.rb', line 45</span> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision2/paths.rb', line 45</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>table:</span><span class='comma'>,</span> <span class='label'>columns:</span><span class='rparen'>)</span> <span class='ivar'>@paths</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='ivar'>@columns</span> <span class='op'>=</span> <span class='id identifier rubyid_columns'>columns</span> <span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='rparen'>)</span> <span class='id identifier rubyid_freeze'>freeze</span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - -</div> + </td> + </tr> + </table> + </div> - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id=""></span> - <div class="method_details first"> - <h3 class="signature first" id="paths-instance_method"> - - #<strong>paths</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span> - + </div> - + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> - -</h3><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This method is part of a private API.</strong> - You should avoid using this method if possible, as it may be removed or be changed in the future. -</p> -<p>Returns The index hash mapping in input values to one or more data array -row indexes.</p> + <span id=""></span> + <div class="method_details first"> + <h3 class="signature first" id="paths-instance_method"> + #<strong>paths</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span> - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>The index hash mapping in input values to one or more data array row -indexes.</p> -</div> - - </li> - -</ul> -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> + + </h3> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. + </p> + + <p>Returns The index hash mapping in input values to one or more data array + row indexes.</p> + + + </div> + </div> + <div class="tags"> + + <p class="tag_title">Returns:</p> + <ul class="return"> + + <li> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>The index hash mapping in input values to one or more data array row + indexes.</p> + </div> + + </li> + + </ul> + + </div> + <table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 41 42 43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/paths.rb', line 41</span> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision2/paths.rb', line 41</span> <span class='kw'>def</span> <span class='id identifier rubyid_paths'>paths</span> <span class='ivar'>@paths</span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> + </td> + </tr> + </table> + </div> + </div> - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - <div class="method_details first"> - <h3 class="signature first" id="scan-class_method"> - - .<strong>scan</strong>(table:) &#x21d2; <tt><span class='object_link'><a href="" title="CSVDecision::Paths (class)">CSVDecision::Paths</a></span></tt> - + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> - - -</h3><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This method is part of a private API.</strong> - You should avoid using this method if possible, as it may be removed or be changed in the future. -</p> + <div class="method_details first"> + <h3 class="signature first" id="scan-class_method"> -<p>Build the index of paths</p> + .<strong>scan</strong>(table:) &#x21d2; <tt><span class='object_link'><a href="" + title="CSVDecision2::Paths (class)">CSVDecision2::Paths</a></span></tt> - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>table</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Table.html" title="CSVDecision::Table (class)">CSVDecision::Table</a></span></tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Decision table being indexed.</p> -</div> - - </li> - -</ul> -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="CSVDecision::Paths (class)">CSVDecision::Paths</a></span></tt>)</span> - - - - &mdash; - <div class='inline'> -<p>The built index of paths.</p> -</div> - - </li> - -</ul> -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> + </h3> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. + </p> + <p>Build the index of paths</p> + + + </div> + </div> + <div class="tags"> + <p class="tag_title">Parameters:</p> + <ul class="param"> + + <li> + + <span class='name'>table</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Table.html" + title="CSVDecision2::Table (class)">CSVDecision2::Table</a></span></tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Decision table being indexed.</p> + </div> + + </li> + + </ul> + + <p class="tag_title">Returns:</p> + <ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="" + title="CSVDecision2::Paths (class)">CSVDecision2::Paths</a></span></tt>)</span> + + + + &mdash; + <div class='inline'> + <p>The built index of paths.</p> + </div> + + </li> + + </ul> + + </div> + <table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 16 17 18 19 20 21 22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/paths.rb', line 16</span> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision2/paths.rb', line 16</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='label'>table:</span><span class='rparen'>)</span> <span class='comment'># Do we even have paths? </span> <span class='id identifier rubyid_columns'>columns</span> <span class='op'>=</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='period'>.</span><span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_columns'>columns</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> - <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="CSVDecision::Paths (class)">Paths</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="CSVDecision::Paths#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>columns:</span> <span class='id identifier rubyid_columns'>columns</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_paths'><span class='object_link'><a href="#paths-instance_method" title="CSVDecision::Paths#paths (method)">paths</a></span></span> + <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="CSVDecision2::Paths (class)">Paths</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="CSVDecision2::Paths#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>columns:</span> <span class='id identifier rubyid_columns'>columns</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_paths'><span class='object_link'><a href="#paths-instance_method" title="CSVDecision2::Paths#paths (method)">paths</a></span></span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="symbol-class_method"> - - .<strong>symbol</strong>(value) &#x21d2; <tt>nil</tt>, <tt>Symbol</tt> - + </td> + </tr> + </table> + </div> - + <div class="method_details "> + <h3 class="signature " id="symbol-class_method"> - -</h3><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This method is part of a private API.</strong> - You should avoid using this method if possible, as it may be removed or be changed in the future. -</p> + .<strong>symbol</strong>(value) &#x21d2; <tt>nil</tt>, <tt>Symbol</tt> -<p>Returns Non-empty string converted to a symbol.</p> - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>value</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Cell value for the path: column.</p> -</div> - - </li> - -</ul> -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>nil</tt>, <tt>Symbol</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Non-empty string converted to a symbol.</p> -</div> - - </li> - -</ul> -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> + </h3> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. + </p> + <p>Returns Non-empty string converted to a symbol.</p> + + </div> + </div> + <div class="tags"> + <p class="tag_title">Parameters:</p> + <ul class="param"> + + <li> + + <span class='name'>value</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Cell value for the path: column.</p> + </div> + + </li> + + </ul> + + <p class="tag_title">Returns:</p> + <ul class="return"> + + <li> + + + <span class='type'>(<tt>nil</tt>, <tt>Symbol</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Non-empty string converted to a symbol.</p> + </div> + + </li> + + </ul> + + </div> + <table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 36 37 38</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/paths.rb', line 36</span> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision2/paths.rb', line 36</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_symbol'>symbol</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <h3 class="signature " id="value-class_method"> - - .<strong>value</strong>(current_value, index) &#x21d2; <tt>Integer</tt>, <tt>Array</tt> - + </td> + </tr> + </table> + </div> - + <div class="method_details "> + <h3 class="signature " id="value-class_method"> - -</h3><div class="docstring"> - <div class="discussion"> - <p class="note private"> - <strong>This method is part of a private API.</strong> - You should avoid using this method if possible, as it may be removed or be changed in the future. -</p> + .<strong>value</strong>(current_value, index) &#x21d2; <tt>Integer</tt>, <tt>Array</tt> -<p>Returns New path key value.</p> - </div> -</div> -<div class="tags"> - <p class="tag_title">Parameters:</p> -<ul class="param"> - - <li> - - <span class='name'>current_value</span> - - - <span class='type'>(<tt>Integer</tt>, <tt>Array</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Current path value.</p> -</div> - - </li> - - <li> - - <span class='name'>index</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>Array row index to be included in the path entry.</p> -</div> - - </li> - -</ul> -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>, <tt>Array</tt>)</span> - - - - &mdash; - <div class='inline'> -<p>New path key value.</p> -</div> - - </li> - -</ul> -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> + </h3> + <div class="docstring"> + <div class="discussion"> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. + </p> + <p>Returns New path key value.</p> + + </div> + </div> + <div class="tags"> + <p class="tag_title">Parameters:</p> + <ul class="param"> + + <li> + + <span class='name'>current_value</span> + + + <span class='type'>(<tt>Integer</tt>, <tt>Array</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Current path value.</p> + </div> + + </li> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>Array row index to be included in the path entry.</p> + </div> + + </li> + + </ul> + + <p class="tag_title">Returns:</p> + <ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>, <tt>Array</tt>)</span> + + + + &mdash; + <div class='inline'> + <p>New path key value.</p> + </div> + + </li> + + </ul> + + </div> + <table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 27 28 29 30 31 32</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/csv_decision/paths.rb', line 27</span> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/csv_decision2/paths.rb', line 27</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='lparen'>(</span><span class='id identifier rubyid_current_value'>current_value</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span> <span class='kw'>return</span> <span class='lbracket'>[</span><span class='id identifier rubyid_current_value'>current_value</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_value'>current_value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='id identifier rubyid_current_value'>current_value</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span> <span class='id identifier rubyid_current_value'>current_value</span> <span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> + </td> + </tr> + </table> + </div> -</div> + </div> - <div id="footer"> - Generated on Sun Feb 11 10:26:08 2018 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.12 (ruby-2.4.0). -</div> + </div> + <div id="footer"> + Generated on Sun Feb 11 10:26:08 2018 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.12 (ruby-2.4.0). </div> - </body> -</html> \ No newline at end of file + + </div> +</body> + +</html>