doc/RubyProf/CallInfo.html in ruby-prof-0.13.1 vs doc/RubyProf/CallInfo.html in ruby-prof-0.14.0

- old
+ new

@@ -1,176 +1,110 @@ <!DOCTYPE html> <html> <head> -<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> +<meta charset="UTF-8"> <title>class RubyProf::CallInfo - ruby-prof</title> -<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> +<link href="../fonts.css" rel="stylesheet"> +<link href="../rdoc.css" rel="stylesheet"> <script type="text/javascript"> var rdoc_rel_prefix = "../"; </script> -<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> -<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> +<script src="../js/jquery.js"></script> +<script src="../js/navigation.js"></script> +<script src="../js/search_index.js"></script> +<script src="../js/search.js"></script> +<script src="../js/searcher.js"></script> +<script src="../js/darkfish.js"></script> -<body id="top" class="class"> -<nav id="metadata"> - <nav id="home-section" class="section"> - <h3 class="section-header"> - <a href="../index.html">Home</a> +<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> - </h3> -</nav> + </div> +</div> - - <nav id="search-section" class="section project-section" class="initially-hidden"> + <div id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> - <h3 class="section-header"> - <input type="text" name="search" placeholder="Search" id="search-field" + <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"> - </h3> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> </form> +</div> - <ul id="search-results" class="initially-hidden"></ul> -</nav> - - - <div id="file-metadata"> - <nav id="file-list-section" class="section"> - <h3 class="section-header">Defined In</h3> - <ul> - <li>lib/ruby-prof/call_info.rb - </ul> -</nav> - - </div> + + <div id="class-metadata"> - <nav id="parent-class-section" class="section"> - <h3 class="section-header">Parent</h3> + <div id="parent-class-section" class="nav-section"> + <h3>Parent</h3> + <p class="link">Object -</nav> +</div> + <!-- Method Quickref --> -<nav id="method-list-section" class="section"> - <h3 class="section-header">Methods</h3> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> - <ul class="link-list"> + <ul class="link-list" role="directory"> - <li><a href="#method-i-call_sequence">#call_sequence</a> + <li ><a href="#method-i-call_sequence">#call_sequence</a> - <li><a href="#method-i-children_time">#children_time</a> + <li ><a href="#method-i-children_time">#children_time</a> - <li><a href="#method-i-eliminate-21">#eliminate!</a> + <li ><a href="#method-i-eliminate-21">#eliminate!</a> - <li><a href="#method-i-find_call">#find_call</a> + <li ><a href="#method-i-find_call">#find_call</a> - <li><a href="#method-i-merge_call_tree">#merge_call_tree</a> + <li ><a href="#method-i-merge_call_tree">#merge_call_tree</a> - <li><a href="#method-i-root-3F">#root?</a> + <li ><a href="#method-i-root-3F">#root?</a> - <li><a href="#method-i-stack">#stack</a> + <li ><a href="#method-i-stack">#stack</a> - <li><a href="#method-i-to_s">#to_s</a> + <li ><a href="#method-i-to_s">#to_s</a> </ul> -</nav> +</div> </div> - - <div id="project-metadata"> - <nav id="fileindex-section" class="section project-section"> - <h3 class="section-header">Pages</h3> - - <ul> - - <li class="file"><a href="../LICENSE.html">LICENSE</a> - - <li class="file"><a href="../README_rdoc.html">README</a> - - <li class="file"><a href="../examples/flat_txt.html">flat</a> - - <li class="file"><a href="../examples/graph_txt.html">graph</a> - - </ul> </nav> - <nav id="classindex-section" class="section project-section"> - <h3 class="section-header">Class and Module Index</h3> +<main role="main" aria-labelledby="class-RubyProf::CallInfo"> + <h1 id="class-RubyProf::CallInfo" class="class"> + class RubyProf::CallInfo + </h1> - <ul class="link-list"> - - <li><a href="../RubyProf.html">RubyProf</a> - - <li><a href="../RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a> - - <li><a href="../RubyProf/AggregateCallInfo.html">RubyProf::AggregateCallInfo</a> - - <li><a href="../RubyProf/CallInfo.html">RubyProf::CallInfo</a> - - <li><a href="../RubyProf/CallInfoPrinter.html">RubyProf::CallInfoPrinter</a> - - <li><a href="../RubyProf/CallInfoVisitor.html">RubyProf::CallInfoVisitor</a> - - <li><a href="../RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a> - - <li><a href="../RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a> - - <li><a href="../RubyProf/Cmd.html">RubyProf::Cmd</a> - - <li><a href="../RubyProf/DotPrinter.html">RubyProf::DotPrinter</a> - - <li><a href="../RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a> - - <li><a href="../RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a> - - <li><a href="../RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a> - - <li><a href="../RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a> - - <li><a href="../RubyProf/MethodInfo.html">RubyProf::MethodInfo</a> - - <li><a href="../RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a> - - <li><a href="../RubyProf/Profile.html">RubyProf::Profile</a> - - <li><a href="../RubyProf/ProfileTask.html">RubyProf::ProfileTask</a> - - <li><a href="../RubyProf/Test.html">RubyProf::Test</a> - - <li><a href="../RubyProf/Thread.html">RubyProf::Thread</a> - - <li><a href="../Rack.html">Rack</a> - - <li><a href="../Rack/RubyProf.html">Rack::RubyProf</a> - - </ul> -</nav> - - </div> -</nav> - -<div id="documentation"> - <h1 class="class">class RubyProf::CallInfo</h1> - - <div id="description" class="description"> + <section class="description"> - </div><!-- description --> + </section> <section id="5Buntitled-5D" class="documentation-section"> @@ -179,13 +113,14 @@ - <!-- Attributes --> - <section id="attribute-method-details" class="method-section section"> - <h3 class="section-header">Attributes</h3> + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> <div id="attribute-i-recursive" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">recursive</span><span @@ -197,98 +132,108 @@ </div> </div> - </section><!-- attribute-method-details --> + </section> - <!-- Methods --> - <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> - <h3 class="section-header">Public Instance Methods</h3> + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> <div id="method-i-call_sequence" class="method-detail "> <div class="method-heading"> <span class="method-name">call_sequence</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="call_sequence-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 25</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">call_sequence</span> <span class="ruby-ivar">@call_sequence</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span> <span class="ruby-identifier">stack</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">method</span><span class="ruby-operator">|</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">full_name</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;-&gt;&#39;</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> - </div><!-- call_sequence-source --> + </div> </div> - </div><!-- call_sequence-method --> + </div> <div id="method-i-children_time" class="method-detail "> <div class="method-heading"> <span class="method-name">children_time</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="children_time-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 6</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">children_time</span> <span class="ruby-identifier">children</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sum</span>, <span class="ruby-identifier">call_info</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">call_info</span>.<span class="ruby-identifier">total_time</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> - </div><!-- children_time-source --> + </div> </div> - </div><!-- children_time-method --> + </div> <div id="method-i-eliminate-21" class="method-detail "> <div class="method-heading"> <span class="method-name">eliminate!</span><span class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> <div class="method-description"> <p>eliminate call info from the call tree. adds self and wait time to parent and attaches called methods to parent. merges call trees for methods called from both praent end self.</p> + <div class="method-source-code" id="eliminate-21-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 42</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">eliminate!</span> @@ -305,69 +250,75 @@ <span class="ruby-identifier">kid</span>.<span class="ruby-identifier">parent</span> = <span class="ruby-identifier">parent</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">end</span></pre> - </div><!-- eliminate-21-source --> + </div> </div> - </div><!-- eliminate-21-method --> + </div> <div id="method-i-find_call" class="method-detail "> <div class="method-heading"> <span class="method-name">find_call</span><span class="method-args">(other)</span> + <span class="method-click-advice">click to toggle source</span> + </div> <div class="method-description"> <p>find a specific call in list of children. returns nil if not found. note: there can&#39;t be more than one child with a given target method. in other words: x.children.grep{|y|y.target==m}.size &lt;= 1 for all method infos m and call infos x</p> + <div class="method-source-code" id="find_call-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 62</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">find_call</span>(<span class="ruby-identifier">other</span>) <span class="ruby-identifier">matching</span> = <span class="ruby-identifier">children</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">kid</span><span class="ruby-operator">|</span> <span class="ruby-identifier">kid</span>.<span class="ruby-identifier">target</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">target</span> } <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;inconsistent call tree&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">matching</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-value">1</span> <span class="ruby-identifier">matching</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword">end</span></pre> - </div><!-- find_call-source --> + </div> </div> - </div><!-- find_call-method --> + </div> <div id="method-i-merge_call_tree" class="method-detail "> <div class="method-heading"> <span class="method-name">merge_call_tree</span><span class="method-args">(other)</span> + <span class="method-click-advice">click to toggle source</span> + </div> <div class="method-description"> <p>merge two call trees. adds self, wait, and total time of other to self and merges children of other into children of self.</p> + <div class="method-source-code" id="merge_call_tree-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 69</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_call_tree</span>(<span class="ruby-identifier">other</span>) @@ -386,63 +337,69 @@ <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">clear</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">target</span>.<span class="ruby-identifier">call_infos</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">other</span>) <span class="ruby-keyword">end</span></pre> - </div><!-- merge_call_tree-source --> + </div> </div> - </div><!-- merge_call_tree-method --> + </div> <div id="method-i-root-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">root?</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="root-3F-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 31</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">root?</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">end</span></pre> - </div><!-- root-3F-source --> + </div> </div> - </div><!-- root-3F-method --> + </div> <div id="method-i-stack" class="method-detail "> <div class="method-heading"> <span class="method-name">stack</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="stack-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 12</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">stack</span> @@ -455,58 +412,60 @@ <span class="ruby-identifier">call_info</span> = <span class="ruby-identifier">call_info</span>.<span class="ruby-identifier">parent</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">methods</span>.<span class="ruby-identifier">reverse</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> - </div><!-- stack-source --> + </div> </div> - </div><!-- stack-method --> + </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"> + <div class="method-source-code" id="to_s-source"> <pre><span class="ruby-comment"># File lib/ruby-prof/call_info.rb, line 35</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span> <span class="ruby-node">&quot;#{self.target.full_name} (c: #{self.called}, tt: #{self.total_time}, st: #{self.self_time}, ct: #{self.children_time})&quot;</span> <span class="ruby-keyword">end</span></pre> - </div><!-- to_s-source --> + </div> </div> - </div><!-- to_s-method --> + </div> - </section><!-- public-instance-method-details --> + </section> - </section><!-- 5Buntitled-5D --> + </section> +</main> -</div><!-- documentation --> - -<footer id="validator-badges"> - <p><a href="http://validator.w3.org/check/referer">[Validate]</a> - <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1. - <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>