sam/pyFTS
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity
40bcd43230
pyFTS/docs/build/html/pyFTS.common.html
Petrônio Cândido 2d5414f01f Documentation update
2019-12-17 17:39:03 -03:00

2050 lines
116 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-55120145-3']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>pyFTS.common package &#8212; pyFTS 1.6 documentation</title>
<link rel="stylesheet" href="_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/bizstyle.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyFTS.data package" href="pyFTS.data.html" />
<link rel="prev" title="pyFTS.benchmarks package" href="pyFTS.benchmarks.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.data.html" title="pyFTS.data package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyFTS.benchmarks.html" title="pyFTS.benchmarks package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.6 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" accesskey="U">pyFTS package</a> &#187;</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo_heading2.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">pyFTS.common package</a><ul>
<li><a class="reference internal" href="#module-pyFTS.common">Module contents</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.Composite">pyFTS.common.Composite module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.FLR">pyFTS.common.FLR module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.FuzzySet">pyFTS.common.FuzzySet module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.Membership">pyFTS.common.Membership module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.SortedCollection">pyFTS.common.SortedCollection module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.Transformations">pyFTS.common.Transformations module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.Util">pyFTS.common.Util module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.flrg">pyFTS.common.flrg module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.fts">pyFTS.common.fts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.common.tree">pyFTS.common.tree module</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pyFTS.benchmarks.html"
title="previous chapter">pyFTS.benchmarks package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyFTS.data.html"
title="next chapter">pyFTS.data package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyFTS.common.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pyfts-common-package">
<h1>pyFTS.common package<a class="headerlink" href="#pyfts-common-package" title="Permalink to this headline"></a></h1>
<div class="section" id="module-pyFTS.common">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyFTS.common" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-pyFTS.common.Composite">
<span id="pyfts-common-composite-module"></span><h2>pyFTS.common.Composite module<a class="headerlink" href="#module-pyFTS.common.Composite" title="Permalink to this headline"></a></h2>
<p>Composite Fuzzy Sets</p>
<dl class="class">
<dt id="pyFTS.common.Composite.FuzzySet">
<em class="property">class </em><code class="descclassname">pyFTS.common.Composite.</code><code class="descname">FuzzySet</code><span class="sig-paren">(</span><em>name</em>, <em>superset=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.FuzzySet.FuzzySet" title="pyFTS.common.FuzzySet.FuzzySet"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.FuzzySet.FuzzySet</span></code></a></p>
<p>Composite Fuzzy Set</p>
<dl class="method">
<dt id="pyFTS.common.Composite.FuzzySet.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>mf</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.append" title="Permalink to this definition"></a></dt>
<dd><p>Adds a new function to composition</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>mf</strong> – </li>
<li><strong>parameters</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Composite.FuzzySet.append_set">
<code class="descname">append_set</code><span class="sig-paren">(</span><em>set</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.append_set" title="Permalink to this definition"></a></dt>
<dd><p>Adds a new function to composition</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>mf</strong> – </li>
<li><strong>parameters</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Composite.FuzzySet.membership">
<code class="descname">membership</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.membership" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the membership value of a given input</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input value</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">membership value of x at this fuzzy set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Composite.FuzzySet.transform">
<code class="descname">transform</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.transform" title="Permalink to this definition"></a></dt>
<dd><p>Preprocess the data point for non native types</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">return a native type value for the structured type</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.FLR">
<span id="pyfts-common-flr-module"></span><h2>pyFTS.common.FLR module<a class="headerlink" href="#module-pyFTS.common.FLR" title="Permalink to this headline"></a></h2>
<p>This module implements functions for Fuzzy Logical Relationship generation</p>
<dl class="class">
<dt id="pyFTS.common.FLR.FLR">
<em class="property">class </em><code class="descclassname">pyFTS.common.FLR.</code><code class="descname">FLR</code><span class="sig-paren">(</span><em>LHS</em>, <em>RHS</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.FLR" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Fuzzy Logical Relationship</p>
<p>Represents a temporal transition of the fuzzy set LHS on time t for the fuzzy set RHS on time t+1.</p>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.FLR.IndexedFLR">
<em class="property">class </em><code class="descclassname">pyFTS.common.FLR.</code><code class="descname">IndexedFLR</code><span class="sig-paren">(</span><em>index</em>, <em>LHS</em>, <em>RHS</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.IndexedFLR" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.FLR.FLR" title="pyFTS.common.FLR.FLR"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.FLR.FLR</span></code></a></p>
<p>Season Indexed Fuzzy Logical Relationship</p>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FLR.generate_high_order_recurrent_flr">
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_high_order_recurrent_flr</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.generate_high_order_recurrent_flr" title="Permalink to this definition"></a></dt>
<dd><p>Create a ordered FLR set from a list of fuzzy sets with recurrence</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FLR.generate_indexed_flrs">
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_indexed_flrs</code><span class="sig-paren">(</span><em>sets</em>, <em>indexer</em>, <em>data</em>, <em>transformation=None</em>, <em>alpha_cut=0.0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.generate_indexed_flrs" title="Permalink to this definition"></a></dt>
<dd><p>Create a season-indexed ordered FLR set from a list of fuzzy sets with recurrence</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>sets</strong> – fuzzy sets</li>
<li><strong>indexer</strong> – seasonality indexer</li>
<li><strong>data</strong> – original data</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">ordered list of FLR</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FLR.generate_non_recurrent_flrs">
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_non_recurrent_flrs</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.generate_non_recurrent_flrs" title="Permalink to this definition"></a></dt>
<dd><p>Create a ordered FLR set from a list of fuzzy sets without recurrence</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FLR.generate_recurrent_flrs">
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_recurrent_flrs</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FLR.generate_recurrent_flrs" title="Permalink to this definition"></a></dt>
<dd><p>Create a ordered FLR set from a list of fuzzy sets with recurrence</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.FuzzySet">
<span id="pyfts-common-fuzzyset-module"></span><h2>pyFTS.common.FuzzySet module<a class="headerlink" href="#module-pyFTS.common.FuzzySet" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyFTS.common.FuzzySet.FuzzySet">
<em class="property">class </em><code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">FuzzySet</code><span class="sig-paren">(</span><em>name</em>, <em>mf</em>, <em>parameters</em>, <em>centroid</em>, <em>alpha=1.0</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Fuzzy Set</p>
<dl class="method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.membership">
<code class="descname">membership</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.membership" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the membership value of a given input</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input value</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">membership value of x at this fuzzy set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.partition_function">
<code class="descname">partition_function</code><span class="sig-paren">(</span><em>uod=None</em>, <em>nbins=100</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.partition_function" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the partition function over the membership function.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>uod</strong> – </li>
<li><strong>nbins</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.transform">
<code class="descname">transform</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.transform" title="Permalink to this definition"></a></dt>
<dd><p>Preprocess the data point for non native types</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">return a native type value for the structured type</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.check_bounds">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">check_bounds</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.check_bounds_index">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">check_bounds_index</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy</code><span class="sig-paren">(</span><em>data</em>, <em>partitioner</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy" title="Permalink to this definition"></a></dt>
<dd><p>A general method for fuzzyfication.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data</strong> – input value to be fuzzyfied</li>
<li><strong>partitioner</strong> – a trained pyFTS.partitioners.Partitioner object</li>
<li><strong>kwargs</strong> – dict, optional arguments</li>
<li><strong>alpha_cut</strong> – the minimal membership value to be considered on fuzzyfication (only for mode=’sets’)</li>
<li><strong>method</strong> – the fuzzyfication method (fuzzy: all fuzzy memberships, maximum: only the maximum membership)</li>
<li><strong>mode</strong> – the fuzzyfication mode (sets: return the fuzzy sets names, vector: return a vector with the membership</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>values for all fuzzy sets, both: return a list with tuples (fuzzy set, membership value) )
:returns a list with the fuzzyfied values, depending on the mode</p>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instance">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_instance</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_instance" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the membership values for a data point given fuzzy sets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>inst</strong> – data point</li>
<li><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</li>
<li><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instances">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_instances</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_instances" title="Permalink to this definition"></a></dt>
<dd><p>Calculate the membership values for a data point given fuzzy sets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>inst</strong> – data point</li>
<li><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</li>
<li><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_series</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>method='maximum'</em>, <em>alpha_cut=0.0</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series_old">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_series_old</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>method='maximum'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series_old" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.get_fuzzysets">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_fuzzysets</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em>, <em>alpha_cut=0.0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.get_fuzzysets" title="Permalink to this definition"></a></dt>
<dd><p>Return the fuzzy sets which membership value for a inst is greater than the alpha_cut</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>inst</strong> – data point</li>
<li><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</li>
<li><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</li>
<li><strong>alpha_cut</strong> – Minimal membership to be considered on fuzzyfication process</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_maximum_membership_fuzzyset</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset" title="Permalink to this definition"></a></dt>
<dd><p>Fuzzify a data point, returning the fuzzy set with maximum membership value</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>inst</strong> – data point</li>
<li><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</li>
<li><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">fuzzy set with maximum membership</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_maximum_membership_fuzzyset_index</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index" title="Permalink to this definition"></a></dt>
<dd><p>Fuzzify a data point, returning the fuzzy set with maximum membership value</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>inst</strong> – data point</li>
<li><strong>fuzzy_sets</strong> – dict of fuzzy sets</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">fuzzy set with maximum membership</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.grant_bounds">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">grant_bounds</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.grant_bounds" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.FuzzySet.set_ordered">
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">set_ordered</code><span class="sig-paren">(</span><em>fuzzy_sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.FuzzySet.set_ordered" title="Permalink to this definition"></a></dt>
<dd><p>Order a fuzzy set list by their centroids</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list with the fuzzy sets names ordered by their centroids.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.Membership">
<span id="pyfts-common-membership-module"></span><h2>pyFTS.common.Membership module<a class="headerlink" href="#module-pyFTS.common.Membership" title="Permalink to this headline"></a></h2>
<p>Membership functions for Fuzzy Sets</p>
<dl class="function">
<dt id="pyFTS.common.Membership.bellmf">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">bellmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.bellmf" title="Permalink to this definition"></a></dt>
<dd><p>Bell shaped membership function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>x</strong> – </li>
<li><strong>parameters</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Membership.gaussmf">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">gaussmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.gaussmf" title="Permalink to this definition"></a></dt>
<dd><p>Gaussian fuzzy membership function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>x</strong> – data point</li>
<li><strong>parameters</strong> – a list with 2 real values (mean and variance)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Membership.sigmf">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">sigmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.sigmf" title="Permalink to this definition"></a></dt>
<dd><p>Sigmoid / Logistic membership function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>x</strong> – </li>
<li><strong>parameters</strong> – an list with 2 real values (smoothness and midpoint)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>:return</p>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Membership.singleton">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">singleton</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.singleton" title="Permalink to this definition"></a></dt>
<dd><p>Singleton membership function, a single value fuzzy function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>x</strong> – </li>
<li><strong>parameters</strong> – a list with one real value</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>:returns</p>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Membership.trapmf">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">trapmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.trapmf" title="Permalink to this definition"></a></dt>
<dd><p>Trapezoidal fuzzy membership function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>x</strong> – data point</li>
<li><strong>parameters</strong> – a list with 4 real values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Membership.trimf">
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">trimf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Membership.trimf" title="Permalink to this definition"></a></dt>
<dd><p>Triangular fuzzy membership function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>x</strong> – data point</li>
<li><strong>parameters</strong> – a list with 3 real values</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.SortedCollection">
<span id="pyfts-common-sortedcollection-module"></span><h2>pyFTS.common.SortedCollection module<a class="headerlink" href="#module-pyFTS.common.SortedCollection" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyFTS.common.SortedCollection.SortedCollection">
<em class="property">class </em><code class="descclassname">pyFTS.common.SortedCollection.</code><code class="descname">SortedCollection</code><span class="sig-paren">(</span><em>iterable=()</em>, <em>key=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Sequence sorted by a key function.</p>
<p>SortedCollection() is much easier to work with than using bisect() directly.
It supports key functions like those use in sorted(), min(), and max().
The result of the key function call is saved so that keys can be searched
efficiently.</p>
<p>Instead of returning an insertion-point which can be hard to interpret, the
five find-methods return a specific item in the sequence. They can scan for
exact matches, the last item less-than-or-equal to a key, or the first item
greater-than-or-equal to a key.</p>
<p>Once found, an item’s ordinal position can be located with the index() method.
New items can be added with the insert() and insert_right() methods.
Old items can be deleted with the remove() method.</p>
<p>The usual sequence methods are provided to support indexing, slicing,
length lookup, clearing, copying, forward and reverse iteration, contains
checking, item counts, item removal, and a nice looking repr.</p>
<p>Finding and indexing are O(log n) operations while iteration and insertion
are O(n). The initial sort is O(n log n).</p>
<p>The key function is stored in the ‘key’ attibute for easy introspection or
so that you can assign a new key function (triggering an automatic re-sort).</p>
<p>In short, the class was designed to handle all of the common use cases for
bisect but with a simpler API and support for key functions.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pprint</span> <span class="k">import</span> <span class="n">pprint</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">operator</span> <span class="k">import</span> <span class="n">itemgetter</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">SortedCollection</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">itemgetter</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">record</span> <span class="ow">in</span> <span class="p">[</span>
<span class="gp">... </span> <span class="p">(</span><span class="s1">&#39;roger&#39;</span><span class="p">,</span> <span class="s1">&#39;young&#39;</span><span class="p">,</span> <span class="mi">30</span><span class="p">),</span>
<span class="gp">... </span> <span class="p">(</span><span class="s1">&#39;angela&#39;</span><span class="p">,</span> <span class="s1">&#39;jones&#39;</span><span class="p">,</span> <span class="mi">28</span><span class="p">),</span>
<span class="gp">... </span> <span class="p">(</span><span class="s1">&#39;bill&#39;</span><span class="p">,</span> <span class="s1">&#39;smith&#39;</span><span class="p">,</span> <span class="mi">22</span><span class="p">),</span>
<span class="gp">... </span> <span class="p">(</span><span class="s1">&#39;david&#39;</span><span class="p">,</span> <span class="s1">&#39;thomas&#39;</span><span class="p">,</span> <span class="mi">32</span><span class="p">)]:</span>
<span class="gp">... </span> <span class="n">s</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">s</span><span class="p">))</span> <span class="c1"># show records sorted by age</span>
<span class="go">[(&#39;bill&#39;, &#39;smith&#39;, 22),</span>
<span class="go"> (&#39;angela&#39;, &#39;jones&#39;, 28),</span>
<span class="go"> (&#39;roger&#39;, &#39;young&#39;, 30),</span>
<span class="go"> (&#39;david&#39;, &#39;thomas&#39;, 32)]</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">find_le</span><span class="p">(</span><span class="mi">29</span><span class="p">)</span> <span class="c1"># find oldest person aged 29 or younger</span>
<span class="go">(&#39;angela&#39;, &#39;jones&#39;, 28)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">find_lt</span><span class="p">(</span><span class="mi">28</span><span class="p">)</span> <span class="c1"># find oldest person under 28</span>
<span class="go">(&#39;bill&#39;, &#39;smith&#39;, 22)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">find_gt</span><span class="p">(</span><span class="mi">28</span><span class="p">)</span> <span class="c1"># find youngest person over 28</span>
<span class="go">(&#39;roger&#39;, &#39;young&#39;, 30)</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">r</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">find_ge</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span> <span class="c1"># find youngest person aged 32 or older</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="c1"># get the index of their record</span>
<span class="go">3</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="c1"># fetch the record at that index</span>
<span class="go">(&#39;david&#39;, &#39;thomas&#39;, 32)</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">itemgetter</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># now sort by first name</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">s</span><span class="p">))</span>
<span class="go">[(&#39;angela&#39;, &#39;jones&#39;, 28),</span>
<span class="go"> (&#39;bill&#39;, &#39;smith&#39;, 22),</span>
<span class="go"> (&#39;david&#39;, &#39;thomas&#39;, 32),</span>
<span class="go"> (&#39;roger&#39;, &#39;young&#39;, 30)]</span>
</pre></div>
</div>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.around">
<code class="descname">around</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.around" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.between">
<code class="descname">between</code><span class="sig-paren">(</span><em>ge</em>, <em>le</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.between" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.clear" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.copy" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.count">
<code class="descname">count</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.count" title="Permalink to this definition"></a></dt>
<dd><p>Return number of occurrences of item</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find">
<code class="descname">find</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find" title="Permalink to this definition"></a></dt>
<dd><p>Return first item with a key == k. Raise ValueError if not found.</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_ge">
<code class="descname">find_ge</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_ge" title="Permalink to this definition"></a></dt>
<dd><p>Return first item with a key &gt;= equal to k. Raise ValueError if not found</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_gt">
<code class="descname">find_gt</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_gt" title="Permalink to this definition"></a></dt>
<dd><p>Return first item with a key &gt; k. Raise ValueError if not found</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_le">
<code class="descname">find_le</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_le" title="Permalink to this definition"></a></dt>
<dd><p>Return last item with a key &lt;= k. Raise ValueError if not found.</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_lt">
<code class="descname">find_lt</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_lt" title="Permalink to this definition"></a></dt>
<dd><p>Return last item with a key &lt; k. Raise ValueError if not found.</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.index">
<code class="descname">index</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.index" title="Permalink to this definition"></a></dt>
<dd><p>Find the position of an item. Raise ValueError if not found.</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert">
<code class="descname">insert</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.insert" title="Permalink to this definition"></a></dt>
<dd><p>Insert a new item. If equal keys are found, add to the left</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert_right">
<code class="descname">insert_right</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.insert_right" title="Permalink to this definition"></a></dt>
<dd><p>Insert a new item. If equal keys are found, add to the right</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.inside">
<code class="descname">inside</code><span class="sig-paren">(</span><em>ge</em>, <em>le</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.inside" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyFTS.common.SortedCollection.SortedCollection.key">
<code class="descname">key</code><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.key" title="Permalink to this definition"></a></dt>
<dd><p>key function</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.remove" title="Permalink to this definition"></a></dt>
<dd><p>Remove first occurence of item. Raise ValueError if not found</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.Transformations">
<span id="pyfts-common-transformations-module"></span><h2>pyFTS.common.Transformations module<a class="headerlink" href="#module-pyFTS.common.Transformations" title="Permalink to this headline"></a></h2>
<p>Common data transformation used on pre and post processing of the FTS</p>
<dl class="class">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation">
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">AdaptiveExpectation</code><span class="sig-paren">(</span><em>parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
<p>Adaptive Expectation post processing</p>
<dl class="method">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.apply" title="Permalink to this definition"></a></dt>
<dd><p>Apply the transformation on input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.inverse">
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.inverse" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – transformed data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.parameters">
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.parameters" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.Transformations.BoxCox">
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">BoxCox</code><span class="sig-paren">(</span><em>plambda</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
<p>Box-Cox power transformation</p>
<dl class="method">
<dt id="pyFTS.common.Transformations.BoxCox.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.apply" title="Permalink to this definition"></a></dt>
<dd><p>Apply the transformation on input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Transformations.BoxCox.inverse">
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.inverse" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – transformed data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyFTS.common.Transformations.BoxCox.parameters">
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.parameters" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.Transformations.Differential">
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Differential</code><span class="sig-paren">(</span><em>lag</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Differential" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
<p>Differentiation data transform</p>
<dl class="method">
<dt id="pyFTS.common.Transformations.Differential.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Differential.apply" title="Permalink to this definition"></a></dt>
<dd><p>Apply the transformation on input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Transformations.Differential.inverse">
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Differential.inverse" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – transformed data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyFTS.common.Transformations.Differential.parameters">
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.Differential.parameters" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.Transformations.Scale">
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Scale</code><span class="sig-paren">(</span><em>min=0</em>, <em>max=1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Scale" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
<p>Scale data inside a interval [min, max]</p>
<dl class="method">
<dt id="pyFTS.common.Transformations.Scale.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Scale.apply" title="Permalink to this definition"></a></dt>
<dd><p>Apply the transformation on input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Transformations.Scale.inverse">
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Scale.inverse" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – transformed data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyFTS.common.Transformations.Scale.parameters">
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.Scale.parameters" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.Transformations.Transformation">
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Transformation</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Transformation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Data transformation used on pre and post processing of the FTS</p>
<dl class="method">
<dt id="pyFTS.common.Transformations.Transformation.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Transformation.apply" title="Permalink to this definition"></a></dt>
<dd><p>Apply the transformation on input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.Transformations.Transformation.inverse">
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Transformation.inverse" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – transformed data</li>
<li><strong>param</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Transformations.Z">
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Z</code><span class="sig-paren">(</span><em>original</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.Z" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Transformations.aggregate">
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">aggregate</code><span class="sig-paren">(</span><em>original</em>, <em>operation</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.aggregate" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Transformations.roi">
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">roi</code><span class="sig-paren">(</span><em>original</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.roi" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Transformations.smoothing">
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">smoothing</code><span class="sig-paren">(</span><em>original</em>, <em>lags</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Transformations.smoothing" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-pyFTS.common.Util">
<span id="pyfts-common-util-module"></span><h2>pyFTS.common.Util module<a class="headerlink" href="#module-pyFTS.common.Util" title="Permalink to this headline"></a></h2>
<p>Common facilities for pyFTS</p>
<dl class="function">
<dt id="pyFTS.common.Util.current_milli_time">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">current_milli_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.current_milli_time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.draw_sets_on_axis">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">draw_sets_on_axis</code><span class="sig-paren">(</span><em>axis</em>, <em>model</em>, <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.draw_sets_on_axis" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.enumerate2">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">enumerate2</code><span class="sig-paren">(</span><em>xs</em>, <em>start=0</em>, <em>step=1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.enumerate2" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.load_env">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">load_env</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.load_env" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.load_obj">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">load_obj</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.load_obj" title="Permalink to this definition"></a></dt>
<dd><p>Load to memory an object stored filesystem. This function depends on Dill package</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> – file name where the object is stored</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.persist_env">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">persist_env</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.persist_env" title="Permalink to this definition"></a></dt>
<dd><p>Persist an entire environment on file. This function depends on Dill package</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> – file name to store the environment</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.persist_obj">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">persist_obj</code><span class="sig-paren">(</span><em>obj</em>, <em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.persist_obj" title="Permalink to this definition"></a></dt>
<dd><p>Persist an object on filesystem. This function depends on Dill package</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>obj</strong> – object on memory</li>
<li><strong>file</strong> – file name to store the object</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_compared_intervals_ahead">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_compared_intervals_ahead</code><span class="sig-paren">(</span><em>original, models, colors, distributions, time_from, time_to, intervals=True, save=False, file=None, tam=[20, 5], resolution=None, cmap='Blues', linewidth=1.5</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_compared_intervals_ahead" title="Permalink to this definition"></a></dt>
<dd><p>Plot the forecasts of several one step ahead models, by point or by interval</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>original</strong> – Original time series data (list)</li>
<li><strong>models</strong> – List of models to compare</li>
<li><strong>colors</strong> – List of models colors</li>
<li><strong>distributions</strong> – True to plot a distribution</li>
<li><strong>time_from</strong> – index of data poit to start the ahead forecasting</li>
<li><strong>time_to</strong> – number of steps ahead to forecast</li>
<li><strong>interpol</strong> – Fill space between distribution plots</li>
<li><strong>save</strong> – Save the picture on file</li>
<li><strong>file</strong> – Filename to save the picture</li>
<li><strong>tam</strong> – Size of the picture</li>
<li><strong>resolution</strong> – </li>
<li><strong>cmap</strong> – Color map to be used on distribution plot</li>
<li><strong>option</strong> – Distribution type to be passed for models</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_density_rectange">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_density_rectange</code><span class="sig-paren">(</span><em>ax</em>, <em>cmap</em>, <em>density</em>, <em>fig</em>, <em>resolution</em>, <em>time_from</em>, <em>time_to</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_density_rectange" title="Permalink to this definition"></a></dt>
<dd><p>Auxiliar function to plot_compared_intervals_ahead</p>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_distribution">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_distribution</code><span class="sig-paren">(</span><em>ax</em>, <em>cmap</em>, <em>probabilitydist</em>, <em>fig</em>, <em>time_from</em>, <em>reference_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_distribution" title="Permalink to this definition"></a></dt>
<dd><p>Plot forecasted ProbabilityDistribution objects on a matplotlib axis</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ax</strong> – matplotlib axis</li>
<li><strong>cmap</strong> – matplotlib colormap name</li>
<li><strong>probabilitydist</strong> – list of ProbabilityDistribution objects</li>
<li><strong>fig</strong> – matplotlib figure</li>
<li><strong>time_from</strong> – starting time (on x axis) to begin the plots</li>
<li><strong>reference_data</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_distribution2">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_distribution2</code><span class="sig-paren">(</span><em>probabilitydist</em>, <em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_distribution2" title="Permalink to this definition"></a></dt>
<dd><p>Plot distributions in y-axis over the time (x-axis)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>probabilitydist</strong> – the forecasted probability distributions to plot</li>
<li><strong>data</strong> – the original test sample</li>
<li><strong>start_at</strong> – the time index (inside of data) to start to plot the probability distributions</li>
<li><strong>ax</strong> – a matplotlib axis. If no value was provided a new axis is created.</li>
<li><strong>cmap</strong> – a matplotlib colormap name, the default value is ‘Blues’</li>
<li><strong>quantiles</strong> – the list of quantiles intervals to plot, e. g. [.05, .25, .75, .95]</li>
<li><strong>median</strong> – a boolean value indicating if the median value will be plot.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_distribution_tiled">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_distribution_tiled</code><span class="sig-paren">(</span><em>distributions, data=None, rows=5, cols=5, index=None, axis=None, size=[10, 20]</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_distribution_tiled" title="Permalink to this definition"></a></dt>
<dd><p>Plot one distribution individually in each axis, with probability in y-axis and UoD on x-axis</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>distributions</strong> – </li>
<li><strong>data</strong> – </li>
<li><strong>rows</strong> – </li>
<li><strong>cols</strong> – </li>
<li><strong>index</strong> – </li>
<li><strong>axis</strong> – </li>
<li><strong>size</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_interval">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_interval</code><span class="sig-paren">(</span><em>axis</em>, <em>intervals</em>, <em>order</em>, <em>label</em>, <em>color='red'</em>, <em>typeonlegend=False</em>, <em>ls='-'</em>, <em>linewidth=1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_interval" title="Permalink to this definition"></a></dt>
<dd><p>Plot forecasted intervals on matplotlib</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>axis</strong> – matplotlib axis</li>
<li><strong>intervals</strong> – list of forecasted intervals</li>
<li><strong>order</strong> – order of the model that create the forecasts</li>
<li><strong>label</strong> – figure label</li>
<li><strong>color</strong> – matplotlib color name</li>
<li><strong>typeonlegend</strong> – </li>
<li><strong>ls</strong> – matplotlib line style</li>
<li><strong>linewidth</strong> – matplotlib width</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_interval2">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_interval2</code><span class="sig-paren">(</span><em>intervals</em>, <em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_interval2" title="Permalink to this definition"></a></dt>
<dd><p>Plot forecasted intervals on matplotlib</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>intervals</strong> – list of forecasted intervals</li>
<li><strong>data</strong> – the original test sample</li>
<li><strong>start_at</strong> – the time index (inside of data) to start to plot the intervals</li>
<li><strong>label</strong> – figure label</li>
<li><strong>color</strong> – matplotlib color name</li>
<li><strong>typeonlegend</strong> – </li>
<li><strong>ls</strong> – matplotlib line style</li>
<li><strong>linewidth</strong> – matplotlib width</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_probability_distributions">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_probability_distributions</code><span class="sig-paren">(</span><em>pmfs, lcolors, tam=[15, 7]</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_probability_distributions" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.plot_rules">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_rules</code><span class="sig-paren">(</span><em>model, size=[5, 5], axis=None, rules_by_axis=None, columns=1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.plot_rules" title="Permalink to this definition"></a></dt>
<dd><p>Plot the FLRG rules of a FTS model on a matplotlib axis</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> – FTS model</li>
<li><strong>size</strong> – figure size</li>
<li><strong>axis</strong> – matplotlib axis</li>
<li><strong>rules_by_axis</strong> – number of rules plotted by column</li>
<li><strong>columns</strong> – number of columns</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.show_and_save_image">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">show_and_save_image</code><span class="sig-paren">(</span><em>fig</em>, <em>file</em>, <em>flag</em>, <em>lgd=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.show_and_save_image" title="Permalink to this definition"></a></dt>
<dd><p>Show and image and save on file</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>fig</strong> – Matplotlib Figure object</li>
<li><strong>file</strong> – filename to save the picture</li>
<li><strong>flag</strong> – if True the image will be saved</li>
<li><strong>lgd</strong> – legend</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.sliding_window">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">sliding_window</code><span class="sig-paren">(</span><em>data</em>, <em>windowsize</em>, <em>train=0.8</em>, <em>inc=0.1</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.sliding_window" title="Permalink to this definition"></a></dt>
<dd><p>Sliding window method of cross validation for time series</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – the entire dataset</li>
<li><strong>windowsize</strong> – window size</li>
<li><strong>train</strong> – percentual of the window size will be used for training the models</li>
<li><strong>inc</strong> – percentual of data used for slide the window</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">window count, training set, test set</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.Util.uniquefilename">
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">uniquefilename</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.uniquefilename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-pyFTS.common.flrg">
<span id="pyfts-common-flrg-module"></span><h2>pyFTS.common.flrg module<a class="headerlink" href="#module-pyFTS.common.flrg" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyFTS.common.flrg.FLRG">
<em class="property">class </em><code class="descclassname">pyFTS.common.flrg.</code><code class="descname">FLRG</code><span class="sig-paren">(</span><em>order</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Fuzzy Logical Relationship Group</p>
<p>Group a set of FLR’s with the same LHS. Represents the temporal patterns for time t+1 (the RHS fuzzy sets)
when the LHS pattern is identified on time t.</p>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.append_rhs">
<code class="descname">append_rhs</code><span class="sig-paren">(</span><em>set</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.append_rhs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_key">
<code class="descname">get_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_key" title="Permalink to this definition"></a></dt>
<dd><p>Returns a unique identifier for this FLRG</p>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_lower">
<code class="descname">get_lower</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_lower" title="Permalink to this definition"></a></dt>
<dd><p>Returns the lower bound value for the RHS fuzzy sets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">lower bound value</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_membership">
<code class="descname">get_membership</code><span class="sig-paren">(</span><em>data</em>, <em>sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_membership" title="Permalink to this definition"></a></dt>
<dd><p>Returns the membership value of the FLRG for the input data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>sets</strong> – fuzzy sets</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_midpoint">
<code class="descname">get_midpoint</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_midpoint" title="Permalink to this definition"></a></dt>
<dd><p>Returns the midpoint value for the RHS fuzzy sets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the midpoint value</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_midpoints">
<code class="descname">get_midpoints</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_midpoints" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.get_upper">
<code class="descname">get_upper</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_upper" title="Permalink to this definition"></a></dt>
<dd><p>Returns the upper bound value for the RHS fuzzy sets</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">upper bound value</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.flrg.FLRG.reset_calculated_values">
<code class="descname">reset_calculated_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.flrg.FLRG.reset_calculated_values" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.fts">
<span id="pyfts-common-fts-module"></span><h2>pyFTS.common.fts module<a class="headerlink" href="#module-pyFTS.common.fts" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyFTS.common.fts.FTS">
<em class="property">class </em><code class="descclassname">pyFTS.common.fts.</code><code class="descname">FTS</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Fuzzy Time Series object model</p>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.append_log">
<code class="descname">append_log</code><span class="sig-paren">(</span><em>operation</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.append_log" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.append_rule">
<code class="descname">append_rule</code><span class="sig-paren">(</span><em>flrg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.append_rule" title="Permalink to this definition"></a></dt>
<dd><p>Append FLRG rule to the model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flrg</strong> – rule</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.append_transformation">
<code class="descname">append_transformation</code><span class="sig-paren">(</span><em>transformation</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.append_transformation" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.apply_inverse_transformations">
<code class="descname">apply_inverse_transformations</code><span class="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.apply_inverse_transformations" title="Permalink to this definition"></a></dt>
<dd><p>Apply the data transformations for data postprocessing</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>params</strong> – transformation parameters</li>
<li><strong>updateUoD</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">postprocessed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.apply_transformations">
<code class="descname">apply_transformations</code><span class="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>updateUoD=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.apply_transformations" title="Permalink to this definition"></a></dt>
<dd><p>Apply the data transformations for data preprocessing</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – input data</li>
<li><strong>params</strong> – transformation parameters</li>
<li><strong>updateUoD</strong> – </li>
<li><strong>kwargs</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">preprocessed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.clip_uod">
<code class="descname">clip_uod</code><span class="sig-paren">(</span><em>ndata</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.clip_uod" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.clone_parameters">
<code class="descname">clone_parameters</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.clone_parameters" title="Permalink to this definition"></a></dt>
<dd><p>Import the parameters values from other model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – a model to clone the parameters</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.fit">
<code class="descname">fit</code><span class="sig-paren">(</span><em>ndata</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.fit" title="Permalink to this definition"></a></dt>
<dd><p>Fit the model’s parameters based on the training data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ndata</strong> – training time series data</li>
<li><strong>kwargs</strong> – </li>
<li><strong>num_batches</strong> – split the training data in num_batches to save memory during the training process</li>
<li><strong>save_model</strong> – save final model on disk</li>
<li><strong>batch_save</strong> – save the model between each batch</li>
<li><strong>file_path</strong> – path to save the model</li>
<li><strong>distributed</strong> – boolean, indicate if the training procedure will be distributed in a dispy cluster</li>
<li><strong>nodes</strong> – a list with the dispy cluster nodes addresses</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast">
<code class="descname">forecast</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast" title="Permalink to this definition"></a></dt>
<dd><p>Point forecast one step ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>kwargs</strong> – model specific parameters</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead">
<code class="descname">forecast_ahead</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead" title="Permalink to this definition"></a></dt>
<dd><p>Point forecast n steps ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</li>
<li><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_distribution">
<code class="descname">forecast_ahead_distribution</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead_distribution" title="Permalink to this definition"></a></dt>
<dd><p>Probabilistic forecast n steps ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
<li><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted Probability Distributions</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_interval">
<code class="descname">forecast_ahead_interval</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead_interval" title="Permalink to this definition"></a></dt>
<dd><p>Interval forecast n steps ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
<li><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted intervals</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_multivariate">
<code class="descname">forecast_ahead_multivariate</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>Multivariate forecast n step ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – Pandas dataframe with one column for each variable and with the minimal length equal to the max_lag of the model</li>
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
<li><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a Pandas Dataframe object representing the forecasted values for each variable</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_distribution">
<code class="descname">forecast_distribution</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_distribution" title="Permalink to this definition"></a></dt>
<dd><p>Probabilistic forecast one step ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>kwargs</strong> – model specific parameters</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with probabilistic.ProbabilityDistribution objects representing the forecasted Probability Distributions</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_interval">
<code class="descname">forecast_interval</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_interval" title="Permalink to this definition"></a></dt>
<dd><p>Interval forecast one step ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
<li><strong>kwargs</strong> – model specific parameters</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the prediction intervals</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.forecast_multivariate">
<code class="descname">forecast_multivariate</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>Multivariate forecast one step ahead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – Pandas dataframe with one column for each variable and with the minimal length equal to the max_lag of the model</li>
<li><strong>kwargs</strong> – model specific parameters</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a Pandas Dataframe object representing the forecasted values for each variable</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.fuzzy">
<code class="descname">fuzzy</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.fuzzy" title="Permalink to this definition"></a></dt>
<dd><p>Fuzzify a data point</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – data point</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">maximum membership fuzzy set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.get_UoD">
<code class="descname">get_UoD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.get_UoD" title="Permalink to this definition"></a></dt>
<dd><p>Returns the interval of the known bounds of the universe of discourse (UoD), i. e.,
the known minimum and maximum values of the time series.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A set with the lower and the upper bounds of the UoD</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.len_total">
<code class="descname">len_total</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.len_total" title="Permalink to this definition"></a></dt>
<dd><p>Total length of the model, adding the number of terms in all rules</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.merge">
<code class="descname">merge</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.merge" title="Permalink to this definition"></a></dt>
<dd><p>Merge the FLRG rules from other model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – source model</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.offset">
<code class="descname">offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.offset" title="Permalink to this definition"></a></dt>
<dd><p>Returns the number of lags to skip in the input test data in order to synchronize it with
the forecasted values given by the predict function. This is necessary due to the order of the
model, among other parameters.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An integer with the number of lags to skip</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.predict" title="Permalink to this definition"></a></dt>
<dd><p>Forecast using trained model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> – time series with minimal length to the order of the model</li>
<li><strong>type</strong> – the forecasting type, one of these values: point(default), interval, distribution or multivariate.</li>
<li><strong>steps_ahead</strong> – The forecasting horizon, i. e., the number of steps ahead to forecast (default value: 1)</li>
<li><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default value: 0)</li>
<li><strong>distributed</strong> – boolean, indicate if the forecasting procedure will be distributed in a dispy cluster (default value: False)</li>
<li><strong>nodes</strong> – a list with the dispy cluster nodes addresses</li>
<li><strong>explain</strong> – try to explain, step by step, the one-step-ahead point forecasting result given the input data. (default value: False)</li>
<li><strong>generators</strong> – for multivariate methods on multi step ahead forecasting, generators is a dict where the keys
are the dataframe columun names (except the target_variable) and the values are lambda functions that
accept one value (the actual value of the variable) and return the next value or trained FTS
models that accept the actual values and forecast new ones.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a numpy array with the forecasted data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.reset_calculated_values">
<code class="descname">reset_calculated_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.reset_calculated_values" title="Permalink to this definition"></a></dt>
<dd><p>Reset all pre-calculated values on the FLRG’s</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyFTS.common.fts.FTS.train">
<code class="descname">train</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.fts.FTS.train" title="Permalink to this definition"></a></dt>
<dd><p>Method specific parameter fitting</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data</strong> – training time series data</li>
<li><strong>kwargs</strong> – Method specific parameters</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.common.tree">
<span id="pyfts-common-tree-module"></span><h2>pyFTS.common.tree module<a class="headerlink" href="#module-pyFTS.common.tree" title="Permalink to this headline"></a></h2>
<p>Tree data structure</p>
<dl class="class">
<dt id="pyFTS.common.tree.FLRGTree">
<em class="property">class </em><code class="descclassname">pyFTS.common.tree.</code><code class="descname">FLRGTree</code><a class="headerlink" href="#pyFTS.common.tree.FLRGTree" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Represents a FLRG set with a tree structure</p>
</dd></dl>
<dl class="class">
<dt id="pyFTS.common.tree.FLRGTreeNode">
<em class="property">class </em><code class="descclassname">pyFTS.common.tree.</code><code class="descname">FLRGTreeNode</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Tree node for</p>
<dl class="method">
<dt id="pyFTS.common.tree.FLRGTreeNode.appendChild">
<code class="descname">appendChild</code><span class="sig-paren">(</span><em>child</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.appendChild" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.tree.FLRGTreeNode.getChildren">
<code class="descname">getChildren</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getChildren" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.tree.FLRGTreeNode.getStr">
<code class="descname">getStr</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getStr" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyFTS.common.tree.FLRGTreeNode.paths">
<code class="descname">paths</code><span class="sig-paren">(</span><em>acc=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.paths" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyFTS.common.tree.build_tree_without_order">
<code class="descclassname">pyFTS.common.tree.</code><code class="descname">build_tree_without_order</code><span class="sig-paren">(</span><em>node</em>, <em>lags</em>, <em>level</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.build_tree_without_order" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyFTS.common.tree.flat">
<code class="descclassname">pyFTS.common.tree.</code><code class="descname">flat</code><span class="sig-paren">(</span><em>dados</em><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.tree.flat" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.data.html" title="pyFTS.data package"
>next</a> |</li>
<li class="right" >
<a href="pyFTS.benchmarks.html" title="pyFTS.benchmarks package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.6 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2018, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink