docs/CAS/Constant.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CAS::Constant - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
<script src="../js/jquery.js"></script>
<script src="../js/darkfish.js"></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Op.html">CAS::Op</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-args">#args</a>
<li ><a href="#method-i-call">#call</a>
<li ><a href="#method-i-depend-3F">#depend?</a>
<li ><a href="#method-i-diff">#diff</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-simplify">#simplify</a>
<li ><a href="#method-i-subs">#subs</a>
<li ><a href="#method-i-to_dot">#to_dot</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CAS::Constant">
<h1 id="class-CAS::Constant" class="class">
class CAS::Constant
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(x)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">x</span>)
<span class="ruby-ivar">@x</span> = <span class="ruby-identifier">x</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">==</span><span
class="method-args">(op)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Check if a constant is equal to another <code>CAS::Op</code> object</p>
<ul><li>
<p><strong>argument</strong>: <code>CAs::Op</code></p>
</li><li>
<p><strong>returns</strong>: <code>TrueClass</code> or <code>FalseClass</code></p>
</li></ul>
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">op</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">op</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Constant</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@x</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">op</span>.<span class="ruby-identifier">x</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-args" class="method-detail ">
<div class="method-heading">
<span class="method-name">args</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Args of a constant is an empty <code>Array</code></p>
<ul><li>
<p><strong>returns</strong>: <code>Array</code> empty</p>
</li></ul>
<div class="method-source-code" id="args-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">args</span>
[]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-call" class="method-detail ">
<div class="method-heading">
<span class="method-name">call</span><span
class="method-args">(_f)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calling a constant will return the value of the constant itself.</p>
<ul><li>
<p><strong>argument</strong>: Unused argument</p>
</li><li>
<p><strong>returns</strong>: <code>Numeric</code> value of the constant</p>
</li></ul>
<div class="method-source-code" id="call-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">_f</span>)
<span class="ruby-ivar">@x</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-depend-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">depend?</span><span
class="method-args">(_v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>There is no dependency in a constant, thus this method will always return
false</p>
<ul><li>
<p><strong>argument</strong>: Unused argument</p>
</li><li>
<p><strong>returns</strong>: <code>FalseClass</code></p>
</li></ul>
<div class="method-source-code" id="depend-3F-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">depend?</span>(<span class="ruby-identifier">_v</span>)
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-diff" class="method-detail ">
<div class="method-heading">
<span class="method-name">diff</span><span
class="method-args">(_v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Evaluates the derivative of a constant. The derivative is always a
<code>CAS::Zero</code></p>
<pre class="ruby"><span class="ruby-identifier">d</span>
<span class="ruby-operator">-</span><span class="ruby-operator">-</span> <span class="ruby-identifier">c</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">dx</span>
</pre>
<div class="method-source-code" id="diff-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">_v</span>)
<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Zero</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Inspection for <code>CAS::Constant</code> class</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code></p>
</li></ul>
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-node">"Const(#{self})"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-simplify" class="method-detail ">
<div class="method-heading">
<span class="method-name">simplify</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Simplification callback. It simplify the subgraph of each node until all
possible simplification are performed (thus the execution time is not
deterministic).</p>
<ul><li>
<p><strong>returns</strong>: <code>CAS::Op</code> simplified version</p>
</li></ul>
<div class="method-source-code" id="simplify-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">simplify</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subs" class="method-detail ">
<div class="method-heading">
<span class="method-name">subs</span><span
class="method-args">(_dt)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Subs for a constant is a dummy method that returns always <code>self</code></p>
<ul><li>
<p><strong>argument</strong>: Unused argument</p>
</li><li>
<p><strong>returns</strong>: <code>CAS::Constant</code> that represent
<code>self</code></p>
</li></ul>
<div class="method-source-code" id="subs-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">subs</span>(<span class="ruby-identifier">_dt</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_dot" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_dot</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the local Graphviz node of the tree</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code> of local Graphiz node</p>
</li></ul>
<div class="method-source-code" id="to_dot-source">
<pre><span class="ruby-comment"># File lib/Mr.CAS/graphviz.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_dot</span>
<span class="ruby-node">"Const(#{@x})"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The string representation of a constant is the value of the constant</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code></p>
</li></ul>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/numbers/constants.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
<span class="ruby-node">"#{@x}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>