Sign upLogin

MatteoRagni/cas-rb

View on GitHub
Star
docs/CAS/CLib.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class CAS::CLib - 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">Hash
  
</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-create">::create</a>
    
    <li ><a href="#method-c-new">::new</a>
    
    <li ><a href="#method-i-as_double">#as_double</a>
    
    <li ><a href="#method-i-as_float">#as_float</a>
    
    <li ><a href="#method-i-as_int">#as_int</a>
    
    <li ><a href="#method-i-as_long_int">#as_long_int</a>
    
    <li ><a href="#method-i-define">#define</a>
    
    <li ><a href="#method-i-header">#header</a>
    
    <li ><a href="#method-i-implements_as">#implements_as</a>
    
    <li ><a href="#method-i-include">#include</a>
    
    <li ><a href="#method-i-include_local">#include_local</a>
    
    <li ><a href="#method-i-include_type">#include_type</a>
    
    <li ><a href="#method-i-source">#source</a>
    
    <li ><a href="#method-i-undefine">#undefine</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-CAS::CLib">
  <h1 id="class-CAS::CLib" class="class">
    class CAS::CLib
  </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-create" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">create</span><span
            class="method-args">(name, &blk)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="create-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>)
  <span class="ruby-identifier">a</span> = <span class="ruby-constant">CLib</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">a</span>.<span class="ruby-identifier">instance_eval</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>)
  <span class="ruby-keyword">return</span> <span class="ruby-identifier">a</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(name)</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/Mr.CAS/c-opt.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Name for the library undefined&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
  <span class="ruby-ivar">@name</span>            = <span class="ruby-identifier">name</span>
  <span class="ruby-ivar">@define</span>          = {}
  <span class="ruby-ivar">@include</span>         = {}
  <span class="ruby-ivar">@include</span>[<span class="ruby-value">:std</span>]   = []
  <span class="ruby-ivar">@include</span>[<span class="ruby-value">:local</span>] = []
  <span class="ruby-ivar">@type</span>            = <span class="ruby-string">&quot;double&quot;</span>

  <span class="ruby-comment"># Default definitions</span>
  <span class="ruby-comment"># self.define &quot;M_PI&quot;, Math::PI</span>
  <span class="ruby-comment"># self.define &quot;M_INFINITY&quot;,&quot;HUGE_VAL&quot;</span>
  <span class="ruby-comment"># self.define &quot;M_E&quot;, Math::E</span>
  <span class="ruby-comment"># self.define &quot;M_EPSILON&quot;, 1E-16</span>

  <span class="ruby-comment"># Default inclusions</span>
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">include</span> <span class="ruby-string">&quot;math.h&quot;</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-as_double" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">as_double</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="as_double-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">as_double</span>;   <span class="ruby-ivar">@type</span> = <span class="ruby-string">&quot;double&quot;</span>;   <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-as_float" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">as_float</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="as_float-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">as_float</span>;    <span class="ruby-ivar">@type</span> = <span class="ruby-string">&quot;float&quot;</span>;    <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-as_int" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">as_int</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="as_int-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">as_int</span>;      <span class="ruby-ivar">@type</span> = <span class="ruby-string">&quot;int&quot;</span>;      <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-as_long_int" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">as_long_int</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="as_long_int-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">as_long_int</span>; <span class="ruby-ivar">@type</span> = <span class="ruby-string">&quot;long int&quot;</span>; <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-define" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">define</span><span
            class="method-args">(k, v)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="define-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>)
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;k must be a String, received a #{k.class}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
  <span class="ruby-ivar">@define</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span>
  <span class="ruby-ivar">@define</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-header" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">header</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="header-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 87</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">header</span>
      <span class="ruby-value">&lt;&lt;-TO_HEADER
// Header file for library: #{@name}.c

#ifndef #{@name}_H
#define #{@name}_H

// Standard Libraries
#{ @include[:std].map { |e| &quot;#include &lt;#{e}&gt;&quot; }.join(&quot;\n&quot;) }

// Local Libraries
#{ @include[:local].map { |e| &quot;#include \&quot;#{e}\&quot;&quot; }.join(&quot;\n&quot;) }

// Definitions
#{ @define.map { |k, v| &quot;#define #{k} #{v}&quot; }.join(&quot;\n&quot;) }

// Functions
#{
  self.keys.map do |fname|
    &quot;#{@type} #{fname}(#{ self[fname].args.map { |x| &quot;#{@type} #{x.name}&quot; }.join(&quot;, &quot;)});&quot;
  end.join(&quot;\n&quot;)
}

#endif // #{@name}_H
      TO_HEADER</span>
    <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-implements_as" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">implements_as</span><span
            class="method-args">(name, op)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="implements_as-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">implements_as</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">op</span>); <span class="ruby-keyword">self</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">op</span>; <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-include" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">include</span><span
            class="method-args">(lib)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="include-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">include</span>(<span class="ruby-identifier">lib</span>); <span class="ruby-keyword">self</span>.<span class="ruby-identifier">include_type</span>(<span class="ruby-value">:std</span>, <span class="ruby-identifier">lib</span>); <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-include_local" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">include_local</span><span
            class="method-args">(lib)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="include_local-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">include_local</span>(<span class="ruby-identifier">lib</span>); <span class="ruby-keyword">self</span>.<span class="ruby-identifier">include_type</span>(<span class="ruby-value">:local</span>, <span class="ruby-identifier">lib</span>); <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-include_type" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">include_type</span><span
            class="method-args">(type, lib)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="include_type-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">include_type</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">lib</span>)
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;type must be a Symbol (:std, :local), received #{type}&quot;</span> <span class="ruby-keyword">unless</span> [<span class="ruby-value">:std</span>, <span class="ruby-value">:local</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">type</span>
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;lib must be a String, received a #{lib.class}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">lib</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
  <span class="ruby-ivar">@include</span>[<span class="ruby-identifier">type</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">lib</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@include</span>[<span class="ruby-identifier">type</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">lib</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-source" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">source</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="source-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 114</span>
    <span class="ruby-keyword">def</span> <span class="ruby-identifier">source</span>
      <span class="ruby-identifier">functions</span> = []

      <span class="ruby-keyword">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">fname</span>, <span class="ruby-identifier">op</span><span class="ruby-operator">|</span>
        <span class="ruby-identifier">c_op</span> = <span class="ruby-identifier">op</span>.<span class="ruby-identifier">to_c</span>.<span class="ruby-identifier">sort_by</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_k</span>, <span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>[<span class="ruby-value">:id</span>] }
        <span class="ruby-identifier">nf</span> = <span class="ruby-value">&lt;&lt;-NEWFUNCTION
#{@type} #{fname}(#{ op.args.map { |x| &quot;#{@type} #{x.name}&quot; }.join(&quot;, &quot;)}) {
#{c_op.map { |e| &quot;  double #{e[1][:var]} = #{e[1][:def]};&quot;}.join(&quot;\n&quot;)}

  return #{c_op[-1][1][:var]};
}
NEWFUNCTION</span>
        <span class="ruby-identifier">functions</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">nf</span>
      <span class="ruby-keyword">end</span>

      <span class="ruby-value">&lt;&lt;-TO_SOURCE
// Source file for library: #{@name}.c

#include &quot;#{@name}.h&quot;

#{functions.join(&quot;\n&quot;)}
// end of #{@name}.c
      TO_SOURCE</span>
    <span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-undefine" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">undefine</span><span
            class="method-args">(k)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="undefine-source">
            <pre><span class="ruby-comment"># File lib/Mr.CAS/c-opt.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">undefine</span>(<span class="ruby-identifier">k</span>)
  <span class="ruby-ivar">@define</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">k</span>
  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@define</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>