Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjbq7 committed Jul 18, 2024
1 parent 4c273b8 commit 3784679
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 69 deletions.
10 changes: 5 additions & 5 deletions func_groups/cycle_indicators.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,23 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (https://ta-lib.org/).</h2>
<h1>Cycle Indicator Functions</h1>
<h3>HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period</h3>
<p>NOTE: The <code>HT_DCPERIOD</code> function has an unstable period.</p>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPERIOD</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPERIOD</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">)</span>
</pre></div>
<h3>HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase</h3>
<p>NOTE: The <code>HT_DCPHASE</code> function has an unstable period.</p>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPHASE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPHASE</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">)</span>
</pre></div>
<h3>HT_PHASOR - Hilbert Transform - Phasor Components</h3>
<p>NOTE: The <code>HT_PHASOR</code> function has an unstable period.</p>
<div class="highlight"><pre><span></span><span class="highlight n">inphase</span><span class="highlight p">,</span> <span class="highlight n">quadrature</span> <span class="highlight o">=</span> <span class="highlight n">HT_PHASOR</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">inphase</span><span class="highlight p">,</span> <span class="highlight n">quadrature</span> <span class="highlight o">=</span> <span class="highlight n">HT_PHASOR</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">)</span>
</pre></div>
<h3>HT_SINE - Hilbert Transform - SineWave</h3>
<p>NOTE: The <code>HT_SINE</code> function has an unstable period.</p>
<div class="highlight"><pre><span></span><span class="highlight n">sine</span><span class="highlight p">,</span> <span class="highlight n">leadsine</span> <span class="highlight o">=</span> <span class="highlight n">HT_SINE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">sine</span><span class="highlight p">,</span> <span class="highlight n">leadsine</span> <span class="highlight o">=</span> <span class="highlight n">HT_SINE</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">)</span>
</pre></div>
<h3>HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode</h3>
<p>NOTE: The <code>HT_TRENDMODE</code> function has an unstable period.</p>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">HT_TRENDMODE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">HT_TRENDMODE</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">)</span>
</pre></div>
<p><a href="../doc_index.html">Documentation Index</a>
<a class="float-right" href="../funcs.html">All Function Groups</a></p>
Expand Down
22 changes: 11 additions & 11 deletions func_groups/math_operators.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,37 +34,37 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (https://ta-lib.org/).</h2>
<section id="main_content" class="inner">
<h1>Math Operator Functions</h1>
<h3>ADD - Vector Arithmetic Add</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">ADD</span><span class="highlight p">(</span><span class="highlight n">high</span><span class="highlight p">,</span> <span class="highlight n">low</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">ADD</span><span class="highlight p">(</span><span class="highlight n">real0</span><span class="highlight p">,</span> <span class="highlight n">real1</span><span class="highlight p">)</span>
</pre></div>
<h3>DIV - Vector Arithmetic Div</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">DIV</span><span class="highlight p">(</span><span class="highlight n">high</span><span class="highlight p">,</span> <span class="highlight n">low</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">DIV</span><span class="highlight p">(</span><span class="highlight n">real0</span><span class="highlight p">,</span> <span class="highlight n">real1</span><span class="highlight p">)</span>
</pre></div>
<h3>MAX - Highest value over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MAX</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MAX</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MAXINDEX - Index of highest value over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">MAXINDEX</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">MAXINDEX</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MIN - Lowest value over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MIN</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MIN</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MININDEX - Index of lowest value over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">MININDEX</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">MININDEX</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MINMAX - Lowest and highest values over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight nb">min</span><span class="highlight p">,</span> <span class="highlight nb">max</span> <span class="highlight o">=</span> <span class="highlight n">MINMAX</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight nb">min</span><span class="highlight p">,</span> <span class="highlight nb">max</span> <span class="highlight o">=</span> <span class="highlight n">MINMAX</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MINMAXINDEX - Indexes of lowest and highest values over a specified period</h3>
<div class="highlight"><pre><span></span><span class="highlight n">minidx</span><span class="highlight p">,</span> <span class="highlight n">maxidx</span> <span class="highlight o">=</span> <span class="highlight n">MINMAXINDEX</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">minidx</span><span class="highlight p">,</span> <span class="highlight n">maxidx</span> <span class="highlight o">=</span> <span class="highlight n">MINMAXINDEX</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<h3>MULT - Vector Arithmetic Mult</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MULT</span><span class="highlight p">(</span><span class="highlight n">high</span><span class="highlight p">,</span> <span class="highlight n">low</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">MULT</span><span class="highlight p">(</span><span class="highlight n">real0</span><span class="highlight p">,</span> <span class="highlight n">real1</span><span class="highlight p">)</span>
</pre></div>
<h3>SUB - Vector Arithmetic Subtraction</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">SUB</span><span class="highlight p">(</span><span class="highlight n">high</span><span class="highlight p">,</span> <span class="highlight n">low</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">SUB</span><span class="highlight p">(</span><span class="highlight n">real0</span><span class="highlight p">,</span> <span class="highlight n">real1</span><span class="highlight p">)</span>
</pre></div>
<h3>SUM - Summation</h3>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">SUM</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">SUM</span><span class="highlight p">(</span><span class="highlight n">real</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">30</span><span class="highlight p">)</span>
</pre></div>
<p><a href="../doc_index.html">Documentation Index</a>
<a class="float-right" href="../funcs.html">All Function Groups</a></p>
Expand Down
Loading

0 comments on commit 3784679

Please sign in to comment.