docs/CAS/Piecewise.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CAS::Piecewise - 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="BinaryOp.html">CAS::BinaryOp</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-call">#call</a>
<li ><a href="#method-i-diff">#diff</a>
<li ><a href="#method-i-dot_graph">#dot_graph</a>
<li ><a href="#method-i-to_code">#to_code</a>
<li ><a href="#method-i-to_latex">#to_latex</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CAS::Piecewise">
<h1 id="class-CAS::Piecewise" class="class">
class CAS::Piecewise
</h1>
<section class="description">
<p><a href="Piecewise.html">Piecewise</a> function. The function returns when
called a result that dependes upon the evaluation of a condition. In
practice:</p>
<pre>/
| f(x) if condition(x) is True
<
| g(x) otherwise
\</pre>
<p>From this class other classes will inherit like <code>CAS::Max</code> and
<code>CAS::Min</code> classes</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-condition" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">condition</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</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, y, condition)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initialize a new piecewise function. It requires first the function that
returns when condition is true, than the function when condition is false,
and finally the condition that must be of class <code>CAS::Condition</code></p>
<ul><li>
<p><strong>argument</strong>: <code>CAS::Op</code> first function</p>
</li><li>
<p><strong>argument</strong>: <code>CAS::Op</code> second function</p>
</li><li>
<p><strong>argument</strong>: <code>CAS::Condition</code> evaluated condition</p>
</li><li>
<p><strong>returns</strong>: <code>CAS::Piecewise</code> new instance</p>
</li></ul>
<div class="method-calls-super">
Calls superclass method
<a href="BinaryOp.html#method-c-new">CAS::BinaryOp.new</a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-piecewise.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">x</span>, <span class="ruby-identifier">y</span>, <span class="ruby-identifier">condition</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">condition</span>, <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Condition</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">x</span>, <span class="ruby-identifier">y</span>)
<span class="ruby-ivar">@condition</span> = <span class="ruby-identifier">condition</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>Checks if two <code>CAS::Piecewise</code> are equal. Checks equality on all
functions+ and conditions</p>
<ul><li>
<p><strong>argument</strong>: <code>CAS::Op</code> to be checked against</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/functions/fnc-piecewise.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">op</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">op</span>, <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Op</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">op</span>.<span class="ruby-identifier">class</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</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">and</span> (<span class="ruby-ivar">@y</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">op</span>.<span class="ruby-identifier">y</span>) <span class="ruby-keyword">and</span> (<span class="ruby-ivar">@condition</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">op</span>.<span class="ruby-identifier">condition</span>))
<span class="ruby-keyword">end</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">(fd)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Executes the condition. If it is <code>true</code> it returns the first
function, else it returns the value of the second function.</p>
<ul><li>
<p><strong>argument</strong>: <code>Hash</code> with value tables</p>
</li><li>
<p><strong>returns</strong>: <code>Numeric</code> the result of the call</p>
</li></ul>
<div class="method-source-code" id="call-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-piecewise.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">fd</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">fd</span>, <span class="ruby-constant">Hash</span>)
(<span class="ruby-ivar">@condition</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">fd</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@x</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">fd</span>) <span class="ruby-operator">:</span> <span class="ruby-ivar">@y</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">fd</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>Derivative of a function is performed as derivative of the two internal
functions while condition is unchanged</p>
<p>warning:: <a href="Piecewise.html">Piecewise</a> functions are in general
not differentiable. Thus differentiability is left to the user</p>
<pre>/ /
d | f(x) if condition(x) is True | f'(x) if condition(x) is True
-- < = <
dx | g(x) otherwise | g'(x) otherwise
\ \</pre>
<ul><li>
<p><strong>argument</strong>: <code>CAS::Op</code> argument of derivative</p>
</li><li>
<p><strong>returns</strong>: <code>CAS::Piecewise</code> with derivated
functions and unchanged condition</p>
</li></ul>
<div class="method-source-code" id="diff-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-piecewise.rb, line 79</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">Help</span>.<span class="ruby-identifier">assert</span>(<span class="ruby-identifier">v</span>, <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Op</span>)
<span class="ruby-keyword">return</span> <span class="ruby-constant">CAS</span><span class="ruby-operator">::</span><span class="ruby-constant">Piecewise</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@x</span>.<span class="ruby-identifier">diff</span>(<span class="ruby-identifier">v</span>).<span class="ruby-identifier">simplify</span>, <span class="ruby-ivar">@y</span>.<span class="ruby-identifier">diff</span>(<span class="ruby-identifier">v</span>).<span class="ruby-identifier">simplify</span>, <span class="ruby-ivar">@condition</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dot_graph" class="method-detail ">
<div class="method-heading">
<span class="method-name">dot_graph</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert piecewise function into a dot graphviz representation</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code></p>
</li></ul>
<div class="method-source-code" id="dot_graph-source">
<pre><span class="ruby-comment"># File lib/Mr.CAS/graphviz.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">dot_graph</span>
<span class="ruby-identifier">cls</span> = <span class="ruby-node">"#{self.class.to_s.gsub("CAS::", "")}_#{self.object_id}"</span>
<span class="ruby-node">"#{cls} -> #{@x.dot_graph}\n #{cls} -> #{@y.dot_graph}\n #{cls} -> #{@condition.dot_graph}"</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 the piecewise funtion to a String of Ruby code</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code> of code</p>
</li></ul>
<div class="method-source-code" id="to_code-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-piecewise.rb, line 111</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_code</span>
<span class="ruby-node">"(#{@condition.to_code} ? (#{@x.to_code}) : (#{@y.to_code}))"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_latex" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_latex</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert piecewise function into LaTeX representation</p>
<ul><li>
<p><strong>returns</strong>: <code>String</code> of LaTeX code</p>
</li></ul>
<div class="method-source-code" id="to_latex-source">
<pre><span class="ruby-comment"># File lib/functions/fnc-piecewise.rb, line 125</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_latex</span>
<span class="ruby-node">"\\left\\{ \\begin{array}{lr} #{@x.to_latex} & #{@condition.to_latex} \\\\ #{@y.to_latex} \\end{array} \\right."</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 the piecewise function into a String</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/functions/fnc-piecewise.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
<span class="ruby-node">"(#{@condition} ? #{@x} : #{@y})"</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>