<!doctype html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0"><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 id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <script 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 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>
        <li class="nav-item nav-item-this"><a href="">pyFTS.common package</a></li> 
      </ul>
    </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="py class">
<dt id="pyFTS.common.Composite.FuzzySet">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Composite.</code><code class="sig-name descname">FuzzySet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">superset</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.Composite.FuzzySet.append">
<code class="sig-name descname">append</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mf</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.append"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mf</strong> – </p></li>
<li><p><strong>parameters</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Composite.FuzzySet.append_set">
<code class="sig-name descname">append_set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">set</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.append_set"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mf</strong> – </p></li>
<li><p><strong>parameters</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Composite.FuzzySet.membership">
<code class="sig-name descname">membership</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.membership"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – input value</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>membership value of x at this fuzzy set</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Composite.FuzzySet.transform">
<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.transform"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>return a native type value for the structured type</p>
</dd>
</dl>
</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="py class">
<dt id="pyFTS.common.FLR.FLR">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">FLR</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">LHS</span></em>, <em class="sig-param"><span class="n">RHS</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#FLR"><span class="viewcode-link">[source]</span></a><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>
<dl class="py attribute">
<dt id="pyFTS.common.FLR.FLR.LHS">
<code class="sig-name descname">LHS</code><a class="headerlink" href="#pyFTS.common.FLR.FLR.LHS" title="Permalink to this definition">¶</a></dt>
<dd><p>Left Hand Side fuzzy set</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FLR.FLR.RHS">
<code class="sig-name descname">RHS</code><a class="headerlink" href="#pyFTS.common.FLR.FLR.RHS" title="Permalink to this definition">¶</a></dt>
<dd><p>Right Hand Side fuzzy set</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="pyFTS.common.FLR.IndexedFLR">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">IndexedFLR</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index</span></em>, <em class="sig-param"><span class="n">LHS</span></em>, <em class="sig-param"><span class="n">RHS</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#IndexedFLR"><span class="viewcode-link">[source]</span></a><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>
<dl class="py attribute">
<dt id="pyFTS.common.FLR.IndexedFLR.index">
<code class="sig-name descname">index</code><a class="headerlink" href="#pyFTS.common.FLR.IndexedFLR.index" title="Permalink to this definition">¶</a></dt>
<dd><p>seasonal index</p>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FLR.generate_high_order_recurrent_flr">
<code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">generate_high_order_recurrent_flr</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fuzzyData</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_high_order_recurrent_flr"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>fuzzyData</strong> – ordered list of fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>ordered list of FLR</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FLR.generate_indexed_flrs">
<code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">generate_indexed_flrs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sets</span></em>, <em class="sig-param"><span class="n">indexer</span></em>, <em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">transformation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">alpha_cut</span><span class="o">=</span><span class="default_value">0.0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_indexed_flrs"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sets</strong> – fuzzy sets</p></li>
<li><p><strong>indexer</strong> – seasonality indexer</p></li>
<li><p><strong>data</strong> – original data</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>ordered list of FLR</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FLR.generate_non_recurrent_flrs">
<code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">generate_non_recurrent_flrs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fuzzyData</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_non_recurrent_flrs"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>fuzzyData</strong> – ordered list of fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>ordered list of FLR</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FLR.generate_recurrent_flrs">
<code class="sig-prename descclassname">pyFTS.common.FLR.</code><code class="sig-name descname">generate_recurrent_flrs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fuzzyData</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_recurrent_flrs"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>fuzzyData</strong> – ordered list of fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>ordered list of FLR</p>
</dd>
</dl>
</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="py class">
<dt id="pyFTS.common.FuzzySet.FuzzySet">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">FuzzySet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">mf</span></em>, <em class="sig-param"><span class="n">parameters</span></em>, <em class="sig-param"><span class="n">centroid</span></em>, <em class="sig-param"><span class="n">alpha</span><span class="o">=</span><span class="default_value">1.0</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet"><span class="viewcode-link">[source]</span></a><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="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.Z">
<code class="sig-name descname">Z</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.Z" title="Permalink to this definition">¶</a></dt>
<dd><p>Partition function in respect to the membership function</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.alpha">
<code class="sig-name descname">alpha</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>The alpha cut value</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.centroid">
<code class="sig-name descname">centroid</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.centroid" title="Permalink to this definition">¶</a></dt>
<dd><p>The fuzzy set center of mass (or midpoint)</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.membership">
<code class="sig-name descname">membership</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.membership"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – input value</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>membership value of x at this fuzzy set</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.mf">
<code class="sig-name descname">mf</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.mf" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership function</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.name">
<code class="sig-name descname">name</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The fuzzy set name</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.parameters">
<code class="sig-name descname">parameters</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.parameters" title="Permalink to this definition">¶</a></dt>
<dd><p>The parameters of the membership function</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.partition_function">
<code class="sig-name descname">partition_function</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uod</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nbins</span><span class="o">=</span><span class="default_value">100</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.partition_function"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uod</strong> – </p></li>
<li><p><strong>nbins</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.FuzzySet.FuzzySet.transform">
<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.transform"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>return a native type value for the structured type</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.type">
<code class="sig-name descname">type</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.type" title="Permalink to this definition">¶</a></dt>
<dd><p>The fuzzy set type (common, composite, nonstationary, etc)</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.FuzzySet.FuzzySet.variable">
<code class="sig-name descname">variable</code><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.variable" title="Permalink to this definition">¶</a></dt>
<dd><p>In multivariate time series, indicate for which variable this fuzzy set belogs</p>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.check_bounds">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">check_bounds</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#check_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.check_bounds_index">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">check_bounds_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#check_bounds_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds_index" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">fuzzyfy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">partitioner</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy" title="Permalink to this definition">¶</a></dt>
<dd><p>A general method for fuzzyfication.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input value to be fuzzyfied</p></li>
<li><p><strong>partitioner</strong> – a trained pyFTS.partitioners.Partitioner object</p></li>
<li><p><strong>kwargs</strong> – dict, optional arguments</p></li>
<li><p><strong>alpha_cut</strong> – the minimal membership value to be considered on fuzzyfication (only for mode=’sets’)</p></li>
<li><p><strong>method</strong> – the fuzzyfication method (fuzzy: all fuzzy memberships, maximum: only the maximum membership)</p></li>
<li><p><strong>mode</strong> – the fuzzyfication mode (sets: return the fuzzy sets names, vector: return a vector with the membership</p></li>
</ul>
</dd>
</dl>
<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="py function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instance">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">fuzzyfy_instance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inst</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instance"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inst</strong> – data point</p></li>
<li><p><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</p></li>
<li><p><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>array of membership values</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instances">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">fuzzyfy_instances</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instances"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inst</strong> – data point</p></li>
<li><p><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</p></li>
<li><p><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>array of membership values</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">fuzzyfy_series</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">method</span><span class="o">=</span><span class="default_value">'maximum'</span></em>, <em class="sig-param"><span class="n">alpha_cut</span><span class="o">=</span><span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">ordered_sets</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series_old">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">fuzzyfy_series_old</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">method</span><span class="o">=</span><span class="default_value">'maximum'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series_old"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series_old" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.get_fuzzysets">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">get_fuzzysets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inst</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">alpha_cut</span><span class="o">=</span><span class="default_value">0.0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_fuzzysets"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inst</strong> – data point</p></li>
<li><p><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</p></li>
<li><p><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</p></li>
<li><p><strong>alpha_cut</strong> – Minimal membership to be considered on fuzzyfication process</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>array of membership values</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">get_maximum_membership_fuzzyset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inst</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inst</strong> – data point</p></li>
<li><p><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</p></li>
<li><p><strong>ordered_sets</strong> – a list with the fuzzy sets names ordered by their centroids.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>fuzzy set with maximum membership</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">get_maximum_membership_fuzzyset_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inst</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset_index"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inst</strong> – data point</p></li>
<li><p><strong>fuzzy_sets</strong> – dict of fuzzy sets</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>fuzzy set with maximum membership</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.grant_bounds">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">grant_bounds</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">fuzzy_sets</span></em>, <em class="sig-param"><span class="n">ordered_sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#grant_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.grant_bounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.FuzzySet.set_ordered">
<code class="sig-prename descclassname">pyFTS.common.FuzzySet.</code><code class="sig-name descname">set_ordered</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fuzzy_sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#set_ordered"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>fuzzy_sets</strong> – a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the fuzzy sets names ordered by their centroids.</p>
</dd>
</dl>
</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="py function">
<dt id="pyFTS.common.Membership.bellmf">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">bellmf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#bellmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.bellmf" title="Permalink to this definition">¶</a></dt>
<dd><p>Bell shaped membership function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – </p></li>
<li><p><strong>parameters</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Membership.gaussmf">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">gaussmf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#gaussmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.gaussmf" title="Permalink to this definition">¶</a></dt>
<dd><p>Gaussian fuzzy membership function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – data point</p></li>
<li><p><strong>parameters</strong> – a list with 2 real values (mean and variance)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the membership value of x given the parameters</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Membership.sigmf">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">sigmf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#sigmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.sigmf" title="Permalink to this definition">¶</a></dt>
<dd><p>Sigmoid / Logistic membership function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – </p></li>
<li><p><strong>parameters</strong> – an list with 2 real values (smoothness and midpoint)</p></li>
</ul>
</dd>
</dl>
<p>:return</p>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Membership.singleton">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">singleton</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#singleton"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – </p></li>
<li><p><strong>parameters</strong> – a list with one real value</p></li>
</ul>
</dd>
</dl>
<p>:returns</p>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Membership.trapmf">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">trapmf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#trapmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.trapmf" title="Permalink to this definition">¶</a></dt>
<dd><p>Trapezoidal fuzzy membership function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – data point</p></li>
<li><p><strong>parameters</strong> – a list with 4 real values</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the membership value of x given the parameters</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Membership.trimf">
<code class="sig-prename descclassname">pyFTS.common.Membership.</code><code class="sig-name descname">trimf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#trimf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.trimf" title="Permalink to this definition">¶</a></dt>
<dd><p>Triangular fuzzy membership function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – data point</p></li>
<li><p><strong>parameters</strong> – a list with 3 real values</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the membership value of x given the parameters</p>
</dd>
</dl>
</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="py class">
<dt id="pyFTS.common.SortedCollection.SortedCollection">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.SortedCollection.</code><code class="sig-name descname">SortedCollection</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">iterable</span><span class="o">=</span><span class="default_value">()</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection"><span class="viewcode-link">[source]</span></a><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="doctest 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="kn">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="kn">import</span> <span class="n">itemgetter</span>
</pre></div>
</div>
<div class="doctest 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="doctest 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="doctest 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="doctest 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="doctest 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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.around">
<code class="sig-name descname">around</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.around"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.around" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.between">
<code class="sig-name descname">between</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ge</span></em>, <em class="sig-param"><span class="n">le</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.between"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.between" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.clear">
<code class="sig-name descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.clear" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.copy">
<code class="sig-name descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.count">
<code class="sig-name descname">count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.count"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find">
<code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_ge">
<code class="sig-name descname">find_ge</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_ge"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_gt">
<code class="sig-name descname">find_gt</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_gt"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_le">
<code class="sig-name descname">find_le</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_le"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_lt">
<code class="sig-name descname">find_lt</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_lt"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.index">
<code class="sig-name descname">index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.index"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert">
<code class="sig-name descname">insert</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert_right">
<code class="sig-name descname">insert_right</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert_right"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.inside">
<code class="sig-name descname">inside</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ge</span></em>, <em class="sig-param"><span class="n">le</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.inside"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.inside" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.key">
<em class="property">property </em><code class="sig-name 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="py method">
<dt id="pyFTS.common.SortedCollection.SortedCollection.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.remove"><span class="viewcode-link">[source]</span></a><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="py class">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">AdaptiveExpectation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.apply"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.parameters">
<em class="property">property </em><code class="sig-name 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="py class">
<dt id="pyFTS.common.Transformations.BoxCox">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">BoxCox</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">plambda</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox"><span class="viewcode-link">[source]</span></a><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>
<p>y’(t) = log( y(t) )
y(t) = exp( y’(t) )</p>
<dl class="py method">
<dt id="pyFTS.common.Transformations.BoxCox.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox.apply"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.BoxCox.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.BoxCox.parameters">
<em class="property">property </em><code class="sig-name 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="py class">
<dt id="pyFTS.common.Transformations.Differential">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">Differential</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lag</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential"><span class="viewcode-link">[source]</span></a><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>
<p>y’(t) = y(t) - y(t-1)
y(t) =  y(t-1)  + y’(t)</p>
<dl class="py method">
<dt id="pyFTS.common.Transformations.Differential.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential.apply"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.Differential.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Differential.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.Differential.parameters">
<em class="property">property </em><code class="sig-name 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="py class">
<dt id="pyFTS.common.Transformations.LinearTrend">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">LinearTrend</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend" 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>Linear Trend. Estimate</p>
<p>y’(t) = y(t) - (a*t+b)
y(t) =  y’(t) + (a*t+b)</p>
<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.apply" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the transformation on input data</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.Transformations.LinearTrend.data_field">
<code class="sig-name descname">data_field</code><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.data_field" title="Permalink to this definition">¶</a></dt>
<dd><p>The Pandas Dataframe column to use as data</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.Transformations.LinearTrend.datetime_mask">
<code class="sig-name descname">datetime_mask</code><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.datetime_mask" title="Permalink to this definition">¶</a></dt>
<dd><p>The Pandas Dataframe mask for datetime indexes</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.generate_indexes">
<code class="sig-name descname">generate_indexes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">value</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.generate_indexes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.generate_indexes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.increment">
<code class="sig-name descname">increment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.increment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.increment" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.Transformations.LinearTrend.index_field">
<code class="sig-name descname">index_field</code><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.index_field" title="Permalink to this definition">¶</a></dt>
<dd><p>The Pandas Dataframe column to use as index</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.Transformations.LinearTrend.index_type">
<code class="sig-name descname">index_type</code><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.index_type" title="Permalink to this definition">¶</a></dt>
<dd><p>The type of the time index used to train the regression coefficients. Available types are: field, datetime</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.Transformations.LinearTrend.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.model" title="Permalink to this definition">¶</a></dt>
<dd><p>Regression model</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.train">
<code class="sig-name descname">train</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.train" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.LinearTrend.trend">
<code class="sig-name descname">trend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#LinearTrend.trend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.LinearTrend.trend" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt id="pyFTS.common.Transformations.ROI">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">ROI</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#ROI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.ROI" 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>Return of Investment (ROI) transformation. Retrieved from Sadaei and Lee (2014) - Multilayer Stock
Forecasting Model Using Fuzzy Time Series</p>
<p>y’(t) = ( y(t) - y(t-1) ) / y(t-1)
y(t) = ( y(t-1) * y’(t) ) + y(t-1)</p>
<dl class="py method">
<dt id="pyFTS.common.Transformations.ROI.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#ROI.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.ROI.apply" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the transformation on input data</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.ROI.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#ROI.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.ROI.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="pyFTS.common.Transformations.Scale">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">Scale</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">min</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">max</span><span class="o">=</span><span class="default_value">1</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.Transformations.Scale.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale.apply"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.Scale.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Scale.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.Scale.parameters">
<em class="property">property </em><code class="sig-name 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="py class">
<dt id="pyFTS.common.Transformations.Transformation">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">Transformation</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.Transformations.Transformation.apply">
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation.apply"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with transformed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.Transformations.Transformation.inverse">
<code class="sig-name descname">inverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Transformation.inverse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – transformed data</p></li>
<li><p><strong>param</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>numpy array with inverse transformed data</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Transformations.Z">
<code class="sig-prename descclassname">pyFTS.common.Transformations.</code><code class="sig-name descname">Z</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">original</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Z"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Z" 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="py function">
<dt id="pyFTS.common.Util.current_milli_time">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name 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="py function">
<dt id="pyFTS.common.Util.draw_sets_on_axis">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">draw_sets_on_axis</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">size</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#draw_sets_on_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.draw_sets_on_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.enumerate2">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">enumerate2</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">xs</span></em>, <em class="sig-param"><span class="n">start</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">step</span><span class="o">=</span><span class="default_value">1</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#enumerate2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.enumerate2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.load_env">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">load_env</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#load_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.load_env" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.load_obj">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">load_obj</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#load_obj"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>file</strong> – file name where the object is stored</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>object</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.persist_env">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">persist_env</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#persist_env"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>file</strong> – file name to store the environment</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.persist_obj">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">persist_obj</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">file</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#persist_obj"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> – object on memory</p></li>
<li><p><strong>file</strong> – file name to store the object</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_compared_intervals_ahead">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_compared_intervals_ahead</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">original</span></em>, <em class="sig-param"><span class="n">models</span></em>, <em class="sig-param"><span class="n">colors</span></em>, <em class="sig-param"><span class="n">distributions</span></em>, <em class="sig-param"><span class="n">time_from</span></em>, <em class="sig-param"><span class="n">time_to</span></em>, <em class="sig-param"><span class="n">intervals</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">save</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tam</span><span class="o">=</span><span class="default_value">[20, 5]</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cmap</span><span class="o">=</span><span class="default_value">'Blues'</span></em>, <em class="sig-param"><span class="n">linewidth</span><span class="o">=</span><span class="default_value">1.5</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_compared_intervals_ahead"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>original</strong> – Original time series data (list)</p></li>
<li><p><strong>models</strong> – List of models to compare</p></li>
<li><p><strong>colors</strong> – List of models colors</p></li>
<li><p><strong>distributions</strong> – True to plot a distribution</p></li>
<li><p><strong>time_from</strong> – index of data poit to start the ahead forecasting</p></li>
<li><p><strong>time_to</strong> – number of steps ahead to forecast</p></li>
<li><p><strong>interpol</strong> – Fill space between distribution plots</p></li>
<li><p><strong>save</strong> – Save the picture on file</p></li>
<li><p><strong>file</strong> – Filename to save the picture</p></li>
<li><p><strong>tam</strong> – Size of the picture</p></li>
<li><p><strong>resolution</strong> – </p></li>
<li><p><strong>cmap</strong> – Color map to be used on distribution plot</p></li>
<li><p><strong>option</strong> – Distribution type to be passed for models</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_density_rectange">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_density_rectange</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ax</span></em>, <em class="sig-param"><span class="n">cmap</span></em>, <em class="sig-param"><span class="n">density</span></em>, <em class="sig-param"><span class="n">fig</span></em>, <em class="sig-param"><span class="n">resolution</span></em>, <em class="sig-param"><span class="n">time_from</span></em>, <em class="sig-param"><span class="n">time_to</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_density_rectange"><span class="viewcode-link">[source]</span></a><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="py function">
<dt id="pyFTS.common.Util.plot_distribution">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_distribution</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ax</span></em>, <em class="sig-param"><span class="n">cmap</span></em>, <em class="sig-param"><span class="n">probabilitydist</span></em>, <em class="sig-param"><span class="n">fig</span></em>, <em class="sig-param"><span class="n">time_from</span></em>, <em class="sig-param"><span class="n">reference_data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_distribution"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ax</strong> – matplotlib axis</p></li>
<li><p><strong>cmap</strong> – matplotlib colormap name</p></li>
<li><p><strong>probabilitydist</strong> – list of ProbabilityDistribution objects</p></li>
<li><p><strong>fig</strong> – matplotlib figure</p></li>
<li><p><strong>time_from</strong> – starting time (on x axis) to begin the plots</p></li>
<li><p><strong>reference_data</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_distribution2">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_distribution2</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">probabilitydist</span></em>, <em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_distribution2"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>probabilitydist</strong> – the forecasted probability distributions to plot</p></li>
<li><p><strong>data</strong> – the original test sample</p></li>
<li><p><strong>start_at</strong> – the time index (inside of data) to start to plot the probability distributions</p></li>
<li><p><strong>ax</strong> – a matplotlib axis. If no value was provided a new axis is created.</p></li>
<li><p><strong>cmap</strong> – a matplotlib colormap name, the default value is ‘Blues’</p></li>
<li><p><strong>quantiles</strong> – the list of quantiles intervals to plot, e. g. [.05, .25, .75, .95]</p></li>
<li><p><strong>median</strong> – a boolean value indicating if the median value will be plot.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_distribution_tiled">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_distribution_tiled</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">distributions</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rows</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">cols</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">index</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">size</span><span class="o">=</span><span class="default_value">[10, 20]</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_distribution_tiled"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>distributions</strong> – </p></li>
<li><p><strong>data</strong> – </p></li>
<li><p><strong>rows</strong> – </p></li>
<li><p><strong>cols</strong> – </p></li>
<li><p><strong>index</strong> – </p></li>
<li><p><strong>axis</strong> – </p></li>
<li><p><strong>size</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_interval">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_interval</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">intervals</span></em>, <em class="sig-param"><span class="n">order</span></em>, <em class="sig-param"><span class="n">label</span></em>, <em class="sig-param"><span class="n">color</span><span class="o">=</span><span class="default_value">'red'</span></em>, <em class="sig-param"><span class="n">typeonlegend</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">ls</span><span class="o">=</span><span class="default_value">'-'</span></em>, <em class="sig-param"><span class="n">linewidth</span><span class="o">=</span><span class="default_value">1</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.plot_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot forecasted intervals on matplotlib</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>axis</strong> – matplotlib axis</p></li>
<li><p><strong>intervals</strong> – list of forecasted intervals</p></li>
<li><p><strong>order</strong> – order of the model that create the forecasts</p></li>
<li><p><strong>label</strong> – figure label</p></li>
<li><p><strong>color</strong> – matplotlib color name</p></li>
<li><p><strong>typeonlegend</strong> – </p></li>
<li><p><strong>ls</strong> – matplotlib line style</p></li>
<li><p><strong>linewidth</strong> – matplotlib width</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_interval2">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_interval2</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">intervals</span></em>, <em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_interval2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.plot_interval2" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot forecasted intervals on matplotlib</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>intervals</strong> – list of forecasted intervals</p></li>
<li><p><strong>data</strong> – the original test sample</p></li>
<li><p><strong>start_at</strong> – the time index (inside of data) to start to plot the intervals</p></li>
<li><p><strong>label</strong> – figure label</p></li>
<li><p><strong>color</strong> – matplotlib color name</p></li>
<li><p><strong>typeonlegend</strong> – </p></li>
<li><p><strong>ls</strong> – matplotlib line style</p></li>
<li><p><strong>linewidth</strong> – matplotlib width</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_probability_distributions">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_probability_distributions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pmfs</span></em>, <em class="sig-param"><span class="n">lcolors</span></em>, <em class="sig-param"><span class="n">tam</span><span class="o">=</span><span class="default_value">[15, 7]</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_probability_distributions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.plot_probability_distributions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.plot_rules">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">plot_rules</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">size</span><span class="o">=</span><span class="default_value">[5, 5]</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rules_by_axis</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">columns</span><span class="o">=</span><span class="default_value">1</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_rules"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>model</strong> – FTS model</p></li>
<li><p><strong>size</strong> – figure size</p></li>
<li><p><strong>axis</strong> – matplotlib axis</p></li>
<li><p><strong>rules_by_axis</strong> – number of rules plotted by column</p></li>
<li><p><strong>columns</strong> – number of columns</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.show_and_save_image">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">show_and_save_image</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fig</span></em>, <em class="sig-param"><span class="n">file</span></em>, <em class="sig-param"><span class="n">flag</span></em>, <em class="sig-param"><span class="n">lgd</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#show_and_save_image"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fig</strong> – Matplotlib Figure object</p></li>
<li><p><strong>file</strong> – filename to save the picture</p></li>
<li><p><strong>flag</strong> – if True the image will be saved</p></li>
<li><p><strong>lgd</strong> – legend</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.sliding_window">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">sliding_window</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">windowsize</span></em>, <em class="sig-param"><span class="n">train</span><span class="o">=</span><span class="default_value">0.8</span></em>, <em class="sig-param"><span class="n">inc</span><span class="o">=</span><span class="default_value">0.1</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#sliding_window"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – the entire dataset</p></li>
<li><p><strong>windowsize</strong> – window size</p></li>
<li><p><strong>train</strong> – percentual of the window size will be used for training the models</p></li>
<li><p><strong>inc</strong> – percentual of data used for slide the window</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>window count, training set, test set</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.Util.uniquefilename">
<code class="sig-prename descclassname">pyFTS.common.Util.</code><code class="sig-name descname">uniquefilename</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#uniquefilename"><span class="viewcode-link">[source]</span></a><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="py class">
<dt id="pyFTS.common.flrg.FLRG">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.flrg.</code><code class="sig-name descname">FLRG</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">order</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG"><span class="viewcode-link">[source]</span></a><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="py attribute">
<dt id="pyFTS.common.flrg.FLRG.LHS">
<code class="sig-name descname">LHS</code><a class="headerlink" href="#pyFTS.common.flrg.FLRG.LHS" title="Permalink to this definition">¶</a></dt>
<dd><p>Left Hand Side of the rule</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.flrg.FLRG.RHS">
<code class="sig-name descname">RHS</code><a class="headerlink" href="#pyFTS.common.flrg.FLRG.RHS" title="Permalink to this definition">¶</a></dt>
<dd><p>Right Hand Side of the rule</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.append_rhs">
<code class="sig-name descname">append_rhs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">set</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.append_rhs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.append_rhs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.get_key">
<code class="sig-name descname">get_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_key"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.flrg.FLRG.get_lower">
<code class="sig-name descname">get_lower</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_lower"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sets</strong> – fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>lower bound value</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.get_membership">
<code class="sig-name descname">get_membership</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_membership"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>sets</strong> – fuzzy sets</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the membership value</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.get_midpoint">
<code class="sig-name descname">get_midpoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoint"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sets</strong> – fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the midpoint value</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.get_midpoints">
<code class="sig-name descname">get_midpoints</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_midpoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.get_upper">
<code class="sig-name descname">get_upper</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sets</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_upper"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sets</strong> – fuzzy sets</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>upper bound value</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.flrg.FLRG.order">
<code class="sig-name descname">order</code><a class="headerlink" href="#pyFTS.common.flrg.FLRG.order" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of lags on LHS</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.flrg.FLRG.reset_calculated_values">
<code class="sig-name descname">reset_calculated_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.reset_calculated_values"><span class="viewcode-link">[source]</span></a><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="py class">
<dt id="pyFTS.common.fts.FTS">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.fts.</code><code class="sig-name descname">FTS</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS"><span class="viewcode-link">[source]</span></a><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="py attribute">
<dt id="pyFTS.common.fts.FTS.alpha_cut">
<code class="sig-name descname">alpha_cut</code><a class="headerlink" href="#pyFTS.common.fts.FTS.alpha_cut" title="Permalink to this definition">¶</a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.append_log">
<code class="sig-name descname">append_log</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">operation</span></em>, <em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.append_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.append_log" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.append_rule">
<code class="sig-name descname">append_rule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrg</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.append_rule"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>flrg</strong> – rule</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.append_transformation">
<code class="sig-name descname">append_transformation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">transformation</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.append_transformation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.append_transformation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.apply_inverse_transformations">
<code class="sig-name descname">apply_inverse_transformations</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.apply_inverse_transformations"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>params</strong> – transformation parameters</p></li>
<li><p><strong>updateUoD</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>postprocessed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.apply_transformations">
<code class="sig-name descname">apply_transformations</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updateUoD</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.apply_transformations"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – input data</p></li>
<li><p><strong>params</strong> – transformation parameters</p></li>
<li><p><strong>updateUoD</strong> – </p></li>
<li><p><strong>kwargs</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>preprocessed data</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.auto_update">
<code class="sig-name descname">auto_update</code><a class="headerlink" href="#pyFTS.common.fts.FTS.auto_update" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating that model is incremental</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.benchmark_only">
<code class="sig-name descname">benchmark_only</code><a class="headerlink" href="#pyFTS.common.fts.FTS.benchmark_only" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.clip_uod">
<code class="sig-name descname">clip_uod</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ndata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.clip_uod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.clip_uod" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.clone_parameters">
<code class="sig-name descname">clone_parameters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.clone_parameters"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>model</strong> – a model to clone the parameters</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.detail">
<code class="sig-name descname">detail</code><a class="headerlink" href="#pyFTS.common.fts.FTS.detail" title="Permalink to this definition">¶</a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.fit">
<code class="sig-name descname">fit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ndata</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.fit"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ndata</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – </p></li>
<li><p><strong>num_batches</strong> – split the training data in num_batches to save memory during the training process</p></li>
<li><p><strong>save_model</strong> – save final model on disk</p></li>
<li><p><strong>batch_save</strong> – save the model between each batch</p></li>
<li><p><strong>file_path</strong> – path to save the model</p></li>
<li><p><strong>distributed</strong> – boolean, indicate if the training procedure will be distributed in a dispy cluster</p></li>
<li><p><strong>nodes</strong> – a list with the dispy cluster nodes addresses</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.flrgs">
<code class="sig-name descname">flrgs</code><a class="headerlink" href="#pyFTS.common.fts.FTS.flrgs" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast">
<code class="sig-name descname">forecast</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast" title="Permalink to this definition">¶</a></dt>
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead">
<code class="sig-name descname">forecast_ahead</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_distribution">
<code class="sig-name descname">forecast_ahead_distribution</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_distribution"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted Probability Distributions</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_interval">
<code class="sig-name descname">forecast_ahead_interval</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_interval"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted intervals</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_ahead_multivariate">
<code class="sig-name descname">forecast_ahead_multivariate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_multivariate"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – Pandas dataframe with one column for each variable and with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a Pandas Dataframe object representing the forecasted values for each variable</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_distribution">
<code class="sig-name descname">forecast_distribution</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_distribution"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with probabilistic.ProbabilityDistribution objects representing the forecasted Probability Distributions</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_interval">
<code class="sig-name descname">forecast_interval</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_interval"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the prediction intervals</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.forecast_multivariate">
<code class="sig-name descname">forecast_multivariate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_multivariate"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – Pandas dataframe with one column for each variable and with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a Pandas Dataframe object representing the forecasted values for each variable</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.fuzzy">
<code class="sig-name descname">fuzzy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.fuzzy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.fuzzy" title="Permalink to this definition">¶</a></dt>
<dd><p>Fuzzify a data point</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data</strong> – data point</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>maximum membership fuzzy set</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.get_UoD">
<code class="sig-name descname">get_UoD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.get_UoD"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A set with the lower and the upper bounds of the UoD</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.has_interval_forecasting">
<code class="sig-name descname">has_interval_forecasting</code><a class="headerlink" href="#pyFTS.common.fts.FTS.has_interval_forecasting" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.has_point_forecasting">
<code class="sig-name descname">has_point_forecasting</code><a class="headerlink" href="#pyFTS.common.fts.FTS.has_point_forecasting" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.has_probability_forecasting">
<code class="sig-name descname">has_probability_forecasting</code><a class="headerlink" href="#pyFTS.common.fts.FTS.has_probability_forecasting" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.has_seasonality">
<code class="sig-name descname">has_seasonality</code><a class="headerlink" href="#pyFTS.common.fts.FTS.has_seasonality" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.indexer">
<code class="sig-name descname">indexer</code><a class="headerlink" href="#pyFTS.common.fts.FTS.indexer" title="Permalink to this definition">¶</a></dt>
<dd><p>An pyFTS.models.seasonal.Indexer object for indexing the time series data</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.is_clustered">
<code class="sig-name descname">is_clustered</code><a class="headerlink" href="#pyFTS.common.fts.FTS.is_clustered" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like 
a monovariate method, default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.is_high_order">
<code class="sig-name descname">is_high_order</code><a class="headerlink" href="#pyFTS.common.fts.FTS.is_high_order" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.is_multivariate">
<code class="sig-name descname">is_multivariate</code><a class="headerlink" href="#pyFTS.common.fts.FTS.is_multivariate" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.is_time_variant">
<code class="sig-name descname">is_time_variant</code><a class="headerlink" href="#pyFTS.common.fts.FTS.is_time_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.is_wrapper">
<code class="sig-name descname">is_wrapper</code><a class="headerlink" href="#pyFTS.common.fts.FTS.is_wrapper" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.lags">
<code class="sig-name descname">lags</code><a class="headerlink" href="#pyFTS.common.fts.FTS.lags" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.len_total">
<code class="sig-name descname">len_total</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.len_total"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.log">
<code class="sig-name descname">log</code><a class="headerlink" href="#pyFTS.common.fts.FTS.log" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.max_lag">
<code class="sig-name descname">max_lag</code><a class="headerlink" href="#pyFTS.common.fts.FTS.max_lag" title="Permalink to this definition">¶</a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags 
needed to forecast a single step ahead</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.merge">
<code class="sig-name descname">merge</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.merge"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>model</strong> – source model</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.min_order">
<code class="sig-name descname">min_order</code><a class="headerlink" href="#pyFTS.common.fts.FTS.min_order" title="Permalink to this definition">¶</a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.name">
<code class="sig-name descname">name</code><a class="headerlink" href="#pyFTS.common.fts.FTS.name" title="Permalink to this definition">¶</a></dt>
<dd><p>A string with the model name</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.offset">
<code class="sig-name descname">offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.offset"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>An integer with the number of lags to skip</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.order">
<code class="sig-name descname">order</code><a class="headerlink" href="#pyFTS.common.fts.FTS.order" title="Permalink to this definition">¶</a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.original_max">
<code class="sig-name descname">original_max</code><a class="headerlink" href="#pyFTS.common.fts.FTS.original_max" title="Permalink to this definition">¶</a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.original_min">
<code class="sig-name descname">original_min</code><a class="headerlink" href="#pyFTS.common.fts.FTS.original_min" title="Permalink to this definition">¶</a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.partitioner">
<code class="sig-name descname">partitioner</code><a class="headerlink" href="#pyFTS.common.fts.FTS.partitioner" title="Permalink to this definition">¶</a></dt>
<dd><p>A pyFTS.partitioners.Partitioner object with the Universe of Discourse partitioner used on the model. This is a mandatory dependecy.</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.predict">
<code class="sig-name descname">predict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.predict" title="Permalink to this definition">¶</a></dt>
<dd><p>Forecast using trained model</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series with minimal length to the order of the model</p></li>
<li><p><strong>type</strong> – the forecasting type, one of these values: point(default), interval, distribution or multivariate.</p></li>
<li><p><strong>steps_ahead</strong> – The forecasting horizon, i. e., the number of steps ahead to forecast (default value: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default value: 0)</p></li>
<li><p><strong>distributed</strong> – boolean, indicate if the forecasting procedure will be distributed in a dispy cluster (default value: False)</p></li>
<li><p><strong>nodes</strong> – a list with the dispy cluster nodes addresses</p></li>
<li><p><strong>explain</strong> – try to explain, step by step, the one-step-ahead point forecasting result given the input data. (default value: False)</p></li>
<li><p><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.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a numpy array with the forecasted data</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.reset_calculated_values">
<code class="sig-name descname">reset_calculated_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.reset_calculated_values"><span class="viewcode-link">[source]</span></a><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>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.shortname">
<code class="sig-name descname">shortname</code><a class="headerlink" href="#pyFTS.common.fts.FTS.shortname" title="Permalink to this definition">¶</a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>

<dl class="py method">
<dt id="pyFTS.common.fts.FTS.train">
<code class="sig-name descname">train</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.train" title="Permalink to this definition">¶</a></dt>
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.transformations">
<code class="sig-name descname">transformations</code><a class="headerlink" href="#pyFTS.common.fts.FTS.transformations" title="Permalink to this definition">¶</a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.transformations_param">
<code class="sig-name descname">transformations_param</code><a class="headerlink" href="#pyFTS.common.fts.FTS.transformations_param" title="Permalink to this definition">¶</a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>

<dl class="py attribute">
<dt id="pyFTS.common.fts.FTS.uod_clip">
<code class="sig-name descname">uod_clip</code><a class="headerlink" href="#pyFTS.common.fts.FTS.uod_clip" title="Permalink to this definition">¶</a></dt>
<dd><p>Flag indicating if the test data will be clipped inside the training Universe of Discourse</p>
</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="py class">
<dt id="pyFTS.common.tree.FLRGTree">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.tree.</code><code class="sig-name descname">FLRGTree</code><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTree"><span class="viewcode-link">[source]</span></a><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="py class">
<dt id="pyFTS.common.tree.FLRGTreeNode">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.common.tree.</code><code class="sig-name descname">FLRGTreeNode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode"><span class="viewcode-link">[source]</span></a><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="py method">
<dt id="pyFTS.common.tree.FLRGTreeNode.appendChild">
<code class="sig-name descname">appendChild</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">child</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.appendChild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.appendChild" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.tree.FLRGTreeNode.getChildren">
<code class="sig-name descname">getChildren</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getChildren"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getChildren" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.tree.FLRGTreeNode.getStr">
<code class="sig-name descname">getStr</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">k</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getStr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getStr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="pyFTS.common.tree.FLRGTreeNode.paths">
<code class="sig-name descname">paths</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">acc</span><span class="o">=</span><span class="default_value">[]</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.paths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py function">
<dt id="pyFTS.common.tree.build_tree_without_order">
<code class="sig-prename descclassname">pyFTS.common.tree.</code><code class="sig-name descname">build_tree_without_order</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node</span></em>, <em class="sig-param"><span class="n">lags</span></em>, <em class="sig-param"><span class="n">level</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#build_tree_without_order"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.build_tree_without_order" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt id="pyFTS.common.tree.flat">
<code class="sig-prename descclassname">pyFTS.common.tree.</code><code class="sig-name descname">flat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dados</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#flat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.flat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <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 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </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>
        <li class="nav-item nav-item-this"><a href="">pyFTS.common package</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2018, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.2.
    </div>
  </body>
</html>