deploy: a92b4c1

dev/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 52c0b581119d200ece1735f51218c3a0
+config: bb02456495e814d47203ae98a39802c1
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_sources/api/argus/test_utils/signals_gen/index.rst.txt

@@ -26,11 +26,14 @@ Functions
 .. py:function:: gen_element_fn(dtype_: Union[Type[argus.AllowedDtype], argus.dtype]) -> hypothesis.strategies.SearchStrategy[argus.AllowedDtype]
 
 
-.. py:function:: gen_samples(min_size: int, max_size: int, dtype_: Union[Type[argus.AllowedDtype], argus.dtype]) -> List[Tuple[float, argus.AllowedDtype]]
+.. py:function:: gen_samples(min_size: int, max_size: int, dtype_: Union[Type[argus.AllowedDtype], argus.dtype], n_lists: int = 1) -> Union[List[Tuple[float, argus.AllowedDtype]], List[List[Tuple[float, argus.AllowedDtype]]]]
 
    Generate arbitrary samples for a signal where the time stamps are strictly
    monotonically increasing
 
+   :param n_lists: used to generate multiple sample lists with the same time domain. This is used for testing against
+                   `metric-temporal-logic` as it doesn't check for non-overlapping domains.
+
 
 .. py:function:: empty_signal(dtype_: Union[Type[argus.AllowedDtype], argus.dtype]) -> hypothesis.strategies.SearchStrategy[argus.Signal]
 

dev/api/argus/test_utils/signals_gen/index.html

@@ -238,7 +238,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <tr class="row-odd"><td><p><a class="reference internal" href="#argus.test_utils.signals_gen.gen_element_fn" title="argus.test_utils.signals_gen.gen_element_fn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gen_element_fn</span></code></a>(...)</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#argus.test_utils.signals_gen.gen_samples" title="argus.test_utils.signals_gen.gen_samples"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gen_samples</span></code></a>(→ List[Tuple[float, argus.AllowedDtype]])</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#argus.test_utils.signals_gen.gen_samples" title="argus.test_utils.signals_gen.gen_samples"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gen_samples</span></code></a>(→ Union[List[Tuple[float, ...)</p></td>
 <td><p>Generate arbitrary samples for a signal where the time stamps are strictly</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#argus.test_utils.signals_gen.empty_signal" title="argus.test_utils.signals_gen.empty_signal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">empty_signal</span></code></a>(...)</p></td>
@@ -266,9 +266,15 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
 <dl class="py function">
 <dt class="sig sig-object py" id="argus.test_utils.signals_gen.gen_samples">
-<span class="sig-prename descclassname"><span class="pre">argus.test_utils.signals_gen.</span></span><span class="sig-name descname"><span class="pre">gen_samples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">argus.AllowedDtype</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="../../index.html#argus.dtype" title="argus.dtype"><span class="pre">argus.dtype</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">argus.AllowedDtype</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#argus.test_utils.signals_gen.gen_samples" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">argus.test_utils.signals_gen.</span></span><span class="sig-name descname"><span class="pre">gen_samples</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">argus.AllowedDtype</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="../../index.html#argus.dtype" title="argus.dtype"><span class="pre">argus.dtype</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_lists</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">argus.AllowedDtype</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">argus.AllowedDtype</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#argus.test_utils.signals_gen.gen_samples" title="Link to this definition">#</a></dt>
 <dd><p>Generate arbitrary samples for a signal where the time stamps are strictly
 monotonically increasing</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>n_lists</strong> – used to generate multiple sample lists with the same time domain. This is used for testing against
+<cite>metric-temporal-logic</cite> as it doesn’t check for non-overlapping domains.</p>
+</dd>
+</dl>
 </dd></dl>
 
 <dl class="py function">