Squashed commit of the following:

commit 33022c0
Author: ian <tycheng@nus.edu.sg>
Date:   Tue Jul 2 21:15:36 2024 +0800

    v2024.7.0

    util.__init__ : ref_count_hfunc() to greedily find tpl_sim with min hfunc calls
    vinecop._data_vcp : one visit() for both hfunc and hinv in sim
    vinecop._factory_vcp: code refactoring to include the above

commit d203c34
Merge: 1d367d7 72a37a3
Author: ian <tycheng@nus.edu.sg>
Date:   Mon Jun 24 19:55:55 2024 +0800

    Merge branch 'main' into dev_ian

commit 1d367d7
Merge: b943dc0 057d3ef
Author: ian <tycheng@nus.edu.sg>
Date:   Mon Jun 24 14:49:51 2024 +0800

    Merge branch 'main' into dev_ian

commit b943dc0
Author: Tuoyuan Cheng <tycheng@nus.edu.sg>
Date:   Mon Jun 24 14:42:01 2024 +0800

    Update python-package.yml

commit 48b0aab
Author: Tuoyuan Cheng <tycheng@nus.edu.sg>
Date:   Mon Jun 24 14:39:30 2024 +0800

    Update python-package.yml

commit 4e87861
Author: ian <tycheng@nus.edu.sg>
Date:   Mon Jun 24 14:31:09 2024 +0800

    Update python-package.yml

.gitignore

@@ -1,12 +1,11 @@
 # manual
-scratch*.ipynb
-poetry.lock
-/docs/_build/doctrees/
-/docs/conf.py
-/docs/Makefile
-/docs/*.rst
 !/docs/_build/html
 !/docs/index.rst
+/docs/*.rst
+/docs/Makefile
+/docs/_build/doctrees/
+/docs/conf.py
+scratch*.ipynb
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -109,7 +108,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+poetry.lock
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.

README.md

@@ -13,7 +13,7 @@
 
 Yet another vine copula package, using [PyTorch](https://pytorch.org/get-started/locally/).
 
-- C/D/R-Vine full simulation/ quantile-regression/ conditoinal-simulation, all in one package
+- C/D/R-Vine full simulation/ quantile-regression/ conditional-simulation, all in one package
   - Flexible simulation workflow for experienced users
 - Vectorized tensor computation with GPU (`device='cuda'`) support
 - Shorter runtimes for higher dimension simulations
@@ -58,9 +58,9 @@ Need to use proper file name.
 
 ```bash
 # inside project root folder
-pip install ./dist/torchvinecopulib-2024.6.1-py3-none-any.whl
+pip install ./dist/torchvinecopulib-2024.7.0-py3-none-any.whl
 # or
-pip install ./dist/torchvinecopulib-2024.6.1.tar.gz
+pip install ./dist/torchvinecopulib-2024.7.0.tar.gz
 ```
 
 ## Examples
@@ -88,6 +88,8 @@ sphinx-apidoc -o ./docs ./torchvinecopulib && cd ./docs && make html && cd ..
 ```python
 # inside project root folder
 python -m pytest ./tests
+# coverage report
+coverage run -m pytest ./tests && coverage html
 ```
 
 ## Contributing

docs/_build/html/.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: e5d53680b89d54aac260acbfe1a1cdbe
+config: ac8190e8985cd084259e3da30f4d8bc5
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_modules/index.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>Overview: module code - torchvinecopulib 2024.6.1 documentation</title>
+        <title>Overview: module code - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -294,7 +294,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../_static/documentation_options.js?v=67095315"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_clayton.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._clayton - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._clayton - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -360,7 +360,7 @@ <h1>Source code for torchvinecopulib.bicop._clayton</h1><div class="highlight"><
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_data_bcp.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._data_bcp - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._data_bcp - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -571,7 +571,7 @@ <h1>Source code for torchvinecopulib.bicop._data_bcp</h1><div class="highlight">
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_factory_bcp.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._factory_bcp - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._factory_bcp - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -404,7 +404,7 @@ <h1>Source code for torchvinecopulib.bicop._factory_bcp</h1><div class="highligh
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_frank.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._frank - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._frank - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -400,7 +400,7 @@ <h1>Source code for torchvinecopulib.bicop._frank</h1><div class="highlight"><pr
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_gaussian.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._gaussian - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._gaussian - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -351,7 +351,7 @@ <h1>Source code for torchvinecopulib.bicop._gaussian</h1><div class="highlight">
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_gumbel.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._gumbel - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._gumbel - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -379,7 +379,7 @@ <h1>Source code for torchvinecopulib.bicop._gumbel</h1><div class="highlight"><p
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>

docs/_build/html/_modules/torchvinecopulib/bicop/_independent.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
-        <title>torchvinecopulib.bicop._independent - torchvinecopulib 2024.6.1 documentation</title>
+        <title>torchvinecopulib.bicop._independent - torchvinecopulib 2024.7.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=387cc868" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -178,7 +178,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.6.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">torchvinecopulib 2024.7.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -202,7 +202,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">torchvinecopulib 2024.6.1 documentation</span>
+  <span class="sidebar-brand-text">torchvinecopulib 2024.7.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -353,7 +353,7 @@ <h1>Source code for torchvinecopulib.bicop._independent</h1><div class="highligh
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=b2a49d55"></script>
+</div><script src="../../../_static/documentation_options.js?v=67095315"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>