docs/CAS/Atan.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CAS::Atan - 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-init_simplify_dict">::init_simplify_dict</a>
<li ><a href="#method-i-call">#call</a>
<li ><a href="#method-i-diff">#diff</a>
<li class="calls-super" ><a href="#method-i-simplify">#simplify</a>
<li ><a href="#method-i-to_code">#to_code</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CAS::Atan">
<h1 id="class-CAS::Atan" class="class">
class CAS::Atan
</h1>
<section class="description">
<p>Representation for the <code>arctan(x)</code> function. It is implemented
as a <code>CAS::Op</code>. It is the inverse of the <code>tan(x)</code>
function</p>
</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-init_simplify_dict" class="method-detail ">
<div class="method-heading">
<span class="method-name">init_simplify_dict</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="init_simplify_dict-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 485</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">init_simplify_dict</span>
<span class="ruby-ivar">@simplify_dict</span> = {
<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Zero</span> =<span class="ruby-operator">></span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Zero</span>,
<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">One</span> =<span class="ruby-operator">></span> (<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Pi</span><span class="ruby-operator">/</span><span class="ruby-value">4</span>),
<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Infinity</span> =<span class="ruby-operator">></span> (<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Pi</span><span class="ruby-operator">/</span><span class="ruby-value">2</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-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>Call resolves the operation tree in a <code>Numeric</code> (if
<code>Fixnum</code>) or <code>Float</code> (depends upon promotions). As
input, it requires an hash with <code>CAS::Variable</code> or
<code>CAS::Variable#name</code> as keys, and a <code>Numeric</code> as a
value</p>
<ul><li>
<p><strong>argument</strong>: <code>Hash</code> with feed dictionary</p>
</li><li>
<p><strong>returns</strong>: <code>Numeric</code></p>
</li></ul>
<div class="method-source-code" id="call-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 462</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">f</span>)
<span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Help</span>.<span class="ruby-identifier">assert</span>(<span class="ruby-identifier">f</span>, <span class="ruby-constant">Hash</span>)
<span class="ruby-constant">Math</span><span class="ruby-operator">::</span><span class="ruby-identifier">atan</span>(<span class="ruby-ivar">@x</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">f</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>Return the derivative of the <code>arctan(x)</code> function using the
chain rule. The input is a <code>CAS::Op</code> because it can handle
derivatives with respect to functions.</p>
<ul><li>
<p><strong>argument</strong>: <code>CAS::Op</code> object of the derivative</p>
</li><li>
<p><strong>returns</strong>: <code>CAS::Op</code> a derivated object, or
<code>CAS::Zero</code> for constants</p>
</li></ul>
<div class="method-source-code" id="diff-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 447</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@x</span>.<span class="ruby-identifier">depend?</span> <span class="ruby-identifier">v</span>
<span class="ruby-keyword">return</span> (<span class="ruby-ivar">@x</span>.<span class="ruby-identifier">diff</span>(<span class="ruby-identifier">v</span>) <span class="ruby-operator">/</span> (<span class="ruby-constant">CAS</span>.<span class="ruby-identifier">pow</span>(<span class="ruby-ivar">@x</span>, <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Two</span>) <span class="ruby-operator">+</span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">One</span>))
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Zero</span>
<span class="ruby-keyword">end</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-calls-super">
Calls superclass method
<a href="Op.html#method-i-simplify">CAS::Op#simplify</a>
</div>
<div class="method-source-code" id="simplify-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 479</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">simplify</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@x</span>.<span class="ruby-identifier">x</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@x</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Tan</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">simplify_dictionary</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_code" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_code</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert expression to code (internal, for <code>CAS::Op#to_proc</code>
method)</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code> that represent Ruby code to
be parsed in <code>CAS::Op#to_proc</code></p>
</li></ul>
<div class="method-source-code" id="to_code-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 496</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_code</span>
<span class="ruby-node">"Math::atan(#{@x.to_code})"</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>Convert expression to string</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code> to print on screen</p>
</li></ul>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-trig.rb, line 470</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
<span class="ruby-node">"atan(#{@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>