+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ On Read the Docs
+
+ Project Home
+
+
+ Builds
+
+
+ Downloads
+
+
+
+ Search
+
+
+
+
+
+
+ Hosted by Read the Docs
+
+
+
+ `;
+
+ // Inject the generated flyout into the body HTML element.
+ document.body.insertAdjacentHTML("beforeend", flyout);
+
+ // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
+ document
+ .querySelector("#flyout-search-form")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+ })
+}
+
+if (themeLanguageSelector || themeVersionSelector) {
+ function onSelectorSwitch(event) {
+ const option = event.target.selectedIndex;
+ const item = event.target.options[option];
+ window.location.href = item.dataset.url;
+ }
+
+ document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ const config = event.detail.data();
+
+ const versionSwitch = document.querySelector(
+ "div.switch-menus > div.version-switch",
+ );
+ if (themeVersionSelector) {
+ let versions = config.versions.active;
+ if (config.versions.current.hidden || config.versions.current.type === "external") {
+ versions.unshift(config.versions.current);
+ }
+ const versionSelect = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ versionSwitch.innerHTML = versionSelect;
+ versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+
+ const languageSwitch = document.querySelector(
+ "div.switch-menus > div.language-switch",
+ );
+
+ if (themeLanguageSelector) {
+ if (config.projects.translations.length) {
+ // Add the current language to the options on the selector
+ let languages = config.projects.translations.concat(
+ config.projects.current,
+ );
+ languages = languages.sort((a, b) =>
+ a.language.name.localeCompare(b.language.name),
+ );
+
+ const languageSelect = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ languageSwitch.innerHTML = languageSelect;
+ languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+ else {
+ languageSwitch.remove();
+ }
+ }
+ });
+}
+
+document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
+ document
+ .querySelector("[role='search'] input")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+});
\ No newline at end of file
diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js
new file mode 100644
index 0000000..c7fe6c6
--- /dev/null
+++ b/docs/build/html/_static/language_data.js
@@ -0,0 +1,192 @@
+/*
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/docs/build/html/_static/minus.png differ
diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/docs/build/html/_static/plus.png differ
diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css
new file mode 100644
index 0000000..6f8b210
--- /dev/null
+++ b/docs/build/html/_static/pygments.css
@@ -0,0 +1,75 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #F00 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666 } /* Operator */
+.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #9C6500 } /* Comment.Preproc */
+.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.highlight .gr { color: #E40000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #008400 } /* Generic.Inserted */
+.highlight .go { color: #717171 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #04D } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #687822 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */
+.highlight .no { color: #800 } /* Name.Constant */
+.highlight .nd { color: #A2F } /* Name.Decorator */
+.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #00F } /* Name.Function */
+.highlight .nl { color: #767600 } /* Name.Label */
+.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #BBB } /* Text.Whitespace */
+.highlight .mb { color: #666 } /* Literal.Number.Bin */
+.highlight .mf { color: #666 } /* Literal.Number.Float */
+.highlight .mh { color: #666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666 } /* Literal.Number.Oct */
+.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #00F } /* Name.Function.Magic */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .vm { color: #19177C } /* Name.Variable.Magic */
+.highlight .il { color: #666 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js
new file mode 100644
index 0000000..91f4be5
--- /dev/null
+++ b/docs/build/html/_static/searchtools.js
@@ -0,0 +1,635 @@
+/*
+ * Sphinx JavaScript utilities for the full-text search.
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename, kind] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+ static get index() { return "index"; }
+ static get object() { return "object"; }
+ static get text() { return "text"; }
+ static get title() { return "title"; }
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
+
+ const [docName, title, anchor, descr, score, _filename, kind] = item;
+
+ let listItem = document.createElement("li");
+ // Add a class representing the item's type:
+ // can be used by a theme's CSS selector for styling
+ // See SearchResultKind for the class names.
+ listItem.classList.add(`kind-${kind}`);
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = contentRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = contentRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms, anchor)
+ );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = Documentation.ngettext(
+ "Search finished, found one page matching the search query.",
+ "Search finished, found ${resultCount} pages matching the search query.",
+ resultCount,
+ ).replace('${resultCount}', resultCount);
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms,
+ highlightTerms,
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms, highlightTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString, anchor) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ for (const removalQuery of [".headerlink", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent) return docContent.textContent;
+
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.setAttribute("role", "list");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ _parseQuery: (query) => {
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // Collect multiple result groups to be sorted separately and then ordered.
+ // Each is an array of [docname, title, anchor, descr, score, filename, kind].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase().trim();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ const score = Math.round(Scorer.title * queryLower.length / title.length);
+ const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
+ normalResults.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score + boost,
+ filenames[file],
+ SearchResultKind.title,
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.index,
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ SearchResultKind.object,
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ // find documents, if any, containing the query word in their text/title term indices
+ // use Object.hasOwnProperty to avoid mismatching against prototype properties
+ const arr = [
+ { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
+ { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, new Map());
+ const fileScores = scoreMap.get(file);
+ fileScores.set(word, record.score);
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.text,
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js
new file mode 100644
index 0000000..8a96c69
--- /dev/null
+++ b/docs/build/html/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ rest,
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '
' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
new file mode 100644
index 0000000..4300325
--- /dev/null
+++ b/docs/build/html/genindex.html
@@ -0,0 +1,488 @@
+
+
+
+
+
+
+
+
Index — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+
Index
+
+
+
A
+ |
C
+ |
D
+ |
E
+ |
G
+ |
L
+ |
M
+ |
N
+ |
R
+ |
S
+ |
V
+
+
+
A
+
+
+
C
+
+
+
D
+
+
+
E
+
+
+
+ estimators.abstract_estimator
+
+
+
+ estimators.estimate_result
+
+
+
+
+
G
+
+
+
+ generators
+
+
+
+ generators.abstract_generator
+
+
+
+ generators.nm_generator
+
+
+
+
+
L
+
+
+
M
+
+
+
N
+
+
+
R
+
+
+
S
+
+
+
V
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
new file mode 100644
index 0000000..6ad5394
--- /dev/null
+++ b/docs/build/html/index.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+
+
ka documentation — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+ka documentation
+Add your content using reStructuredText reStructuredText
+documentation for details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html
new file mode 100644
index 0000000..4004455
--- /dev/null
+++ b/docs/build/html/modules.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+
+
+
+
src — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
new file mode 100644
index 0000000..b50b902
Binary files /dev/null and b/docs/build/html/objects.inv differ
diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
new file mode 100644
index 0000000..5c00c08
--- /dev/null
+++ b/docs/build/html/py-modindex.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
Python Module Index — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ Python Module Index
+
+
+
+
+
+
+
+
+
+
Python Module Index
+
+
+
a |
+
e |
+
g |
+
m |
+
r
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/search.html b/docs/build/html/search.html
new file mode 100644
index 0000000..f5b341e
--- /dev/null
+++ b/docs/build/html/search.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+
Search — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
new file mode 100644
index 0000000..38d20a5
--- /dev/null
+++ b/docs/build/html/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles":{"Contents:":[[0,null]],"Module contents":[[2,"module-contents"],[3,"module-algorithms"],[4,"module-contents"],[5,"module-contents"],[6,"module-contents"],[7,"module-contents"],[8,"module-contents"],[9,"module-contents"],[10,"module-contents"],[11,"module-contents"],[12,"module-estimators"],[13,"module-contents"],[14,"module-contents"],[15,"module-generators"],[16,"module-mixtures"],[17,"module-register"]],"Submodules":[[9,"submodules"],[10,"submodules"],[11,"submodules"],[12,"submodules"],[13,"submodules"],[14,"submodules"],[15,"submodules"],[16,"submodules"],[17,"submodules"]],"Subpackages":[[2,"subpackages"],[3,"subpackages"],[4,"subpackages"],[8,"subpackages"],[12,"subpackages"]],"algorithms package":[[3,null]],"estimators package":[[12,null]],"estimators.abstract_estimator module":[[12,"module-estimators.abstract_estimator"]],"estimators.estimate_result module":[[12,"module-estimators.estimate_result"]],"generators package":[[15,null]],"generators.abstract_generator module":[[15,"module-generators.abstract_generator"]],"generators.nm_generator module":[[15,"module-generators.nm_generator"]],"generators.nmv_generator module":[[15,"module-generators.nmv_generator"]],"generators.nv_generator module":[[15,"module-generators.nv_generator"]],"ka documentation":[[0,null]],"mixtures package":[[16,null]],"mixtures.abstract_mixture module":[[16,"module-mixtures.abstract_mixture"]],"mixtures.nm_mixture module":[[16,"module-mixtures.nm_mixture"]],"mixtures.nmv_mixture module":[[16,"module-mixtures.nmv_mixture"]],"mixtures.nv_mixture module":[[16,"module-mixtures.nv_mixture"]],"register package":[[17,null]],"register.algorithm_purpose module":[[17,"module-register.algorithm_purpose"]],"register.register module":[[17,"module-register.register"]],"src":[[1,null]],"src package":[[2,null]],"src.algorithms.param_algorithms package":[[4,null]],"src.algorithms.param_algorithms.nm_param_algorithms package":[[5,null]],"src.algorithms.param_algorithms.nv_param_algorithms package":[[6,null]],"src.algorithms.param_algorithms.nvm_param_algorithms package":[[7,null]],"src.algorithms.semiparam_algorithms package":[[8,null]],"src.algorithms.semiparam_algorithms.nm_semi_param_algorithms package":[[9,null]],"src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.g_estimation_convolution module":[[9,"src-algorithms-semiparam-algorithms-nm-semi-param-algorithms-g-estimation-convolution-module"]],"src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_eigenvalue_based module":[[9,"src-algorithms-semiparam-algorithms-nm-semi-param-algorithms-sigma-estimation-eigenvalue-based-module"]],"src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_empirical module":[[9,"src-algorithms-semiparam-algorithms-nm-semi-param-algorithms-sigma-estimation-empirical-module"]],"src.algorithms.semiparam_algorithms.nv_semi_param_algorithms package":[[10,null]],"src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_given_mu module":[[10,"src-algorithms-semiparam-algorithms-nv-semi-param-algorithms-g-estimation-given-mu-module"]],"src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_post_widder module":[[10,"src-algorithms-semiparam-algorithms-nv-semi-param-algorithms-g-estimation-post-widder-module"]],"src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms package":[[11,null]],"src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu module":[[11,"src-algorithms-semiparam-algorithms-nvm-semi-param-algorithms-g-estimation-given-mu-module"]],"src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu_rqmc_based module":[[11,"src-algorithms-semiparam-algorithms-nvm-semi-param-algorithms-g-estimation-given-mu-rqmc-based-module"]],"src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_post_widder module":[[11,"src-algorithms-semiparam-algorithms-nvm-semi-param-algorithms-g-estimation-post-widder-module"]],"src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation module":[[11,"src-algorithms-semiparam-algorithms-nvm-semi-param-algorithms-mu-estimation-module"]],"src.estimators.parametric package":[[13,null]],"src.estimators.parametric.abstract_parametric_estimator module":[[13,"src-estimators-parametric-abstract-parametric-estimator-module"]],"src.estimators.parametric.nm_parametric_estimator module":[[13,"src-estimators-parametric-nm-parametric-estimator-module"]],"src.estimators.parametric.nmv_parametric_estimator module":[[13,"src-estimators-parametric-nmv-parametric-estimator-module"]],"src.estimators.parametric.nv_parametric_estimator module":[[13,"src-estimators-parametric-nv-parametric-estimator-module"]],"src.estimators.semiparametric package":[[14,null]],"src.estimators.semiparametric.abstract_semiparametric_estimator module":[[14,"src-estimators-semiparametric-abstract-semiparametric-estimator-module"]],"src.estimators.semiparametric.nm_semiparametric_estimator module":[[14,"src-estimators-semiparametric-nm-semiparametric-estimator-module"]],"src.estimators.semiparametric.nmv_semiparametric_estimator module":[[14,"src-estimators-semiparametric-nmv-semiparametric-estimator-module"]],"src.estimators.semiparametric.nv_semiparametric_estimator module":[[14,"src-estimators-semiparametric-nv-semiparametric-estimator-module"]]},"docnames":["index","modules","src","src.algorithms","src.algorithms.param_algorithms","src.algorithms.param_algorithms.nm_param_algorithms","src.algorithms.param_algorithms.nv_param_algorithms","src.algorithms.param_algorithms.nvm_param_algorithms","src.algorithms.semiparam_algorithms","src.algorithms.semiparam_algorithms.nm_semi_param_algorithms","src.algorithms.semiparam_algorithms.nv_semi_param_algorithms","src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms","src.estimators","src.estimators.parametric","src.estimators.semiparametric","src.generators","src.mixtures","src.register"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1},"filenames":["index.rst","modules.rst","src.rst","src.algorithms.rst","src.algorithms.param_algorithms.rst","src.algorithms.param_algorithms.nm_param_algorithms.rst","src.algorithms.param_algorithms.nv_param_algorithms.rst","src.algorithms.param_algorithms.nvm_param_algorithms.rst","src.algorithms.semiparam_algorithms.rst","src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.rst","src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.rst","src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.rst","src.estimators.rst","src.estimators.parametric.rst","src.estimators.semiparametric.rst","src.generators.rst","src.mixtures.rst","src.register.rst"],"indexentries":{"abstractestimator (class in estimators.abstract_estimator)":[[12,"estimators.abstract_estimator.AbstractEstimator",false]],"algorithmpurpose (class in register.algorithm_purpose)":[[17,"register.algorithm_purpose.AlgorithmPurpose",false]],"algorithms":[[3,"module-algorithms",false]],"default (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.DEFAULT",false]],"dispatch() (register.register.registry method)":[[17,"register.register.Registry.dispatch",false]],"estimate() (estimators.abstract_estimator.abstractestimator method)":[[12,"estimators.abstract_estimator.AbstractEstimator.estimate",false]],"estimateresult (class in estimators.estimate_result)":[[12,"estimators.estimate_result.EstimateResult",false]],"estimators":[[12,"module-estimators",false]],"estimators.abstract_estimator":[[12,"module-estimators.abstract_estimator",false]],"estimators.estimate_result":[[12,"module-estimators.estimate_result",false]],"get_available_algorithms() (estimators.abstract_estimator.abstractestimator method)":[[12,"estimators.abstract_estimator.AbstractEstimator.get_available_algorithms",false]],"get_params() (estimators.abstract_estimator.abstractestimator method)":[[12,"estimators.abstract_estimator.AbstractEstimator.get_params",false]],"list_value (estimators.estimate_result.estimateresult attribute)":[[12,"estimators.estimate_result.EstimateResult.list_value",false]],"message (estimators.estimate_result.estimateresult attribute)":[[12,"estimators.estimate_result.EstimateResult.message",false]],"module":[[3,"module-algorithms",false],[12,"module-estimators",false],[12,"module-estimators.abstract_estimator",false],[12,"module-estimators.estimate_result",false],[17,"module-register",false],[17,"module-register.algorithm_purpose",false],[17,"module-register.register",false]],"nm_parametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NM_PARAMETRIC",false]],"nm_semiparametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NM_SEMIPARAMETRIC",false]],"nmv_parametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NMV_PARAMETRIC",false]],"nmv_semiparametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NMV_SEMIPARAMETRIC",false]],"nv_parametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NV_PARAMETRIC",false]],"nv_semiparametric (register.algorithm_purpose.algorithmpurpose attribute)":[[17,"register.algorithm_purpose.AlgorithmPurpose.NV_SEMIPARAMETRIC",false]],"register":[[17,"module-register",false]],"register() (register.register.registry method)":[[17,"register.register.Registry.register",false]],"register.algorithm_purpose":[[17,"module-register.algorithm_purpose",false]],"register.register":[[17,"module-register.register",false]],"registry (class in register.register)":[[17,"register.register.Registry",false]],"set_params() (estimators.abstract_estimator.abstractestimator method)":[[12,"estimators.abstract_estimator.AbstractEstimator.set_params",false]],"success (estimators.estimate_result.estimateresult attribute)":[[12,"estimators.estimate_result.EstimateResult.success",false]],"value (estimators.estimate_result.estimateresult attribute)":[[12,"estimators.estimate_result.EstimateResult.value",false]]},"objects":{"":[[3,0,0,"-","algorithms"],[12,0,0,"-","estimators"],[15,0,0,"-","generators"],[16,0,0,"-","mixtures"],[17,0,0,"-","register"]],"estimators":[[12,0,0,"-","abstract_estimator"],[12,0,0,"-","estimate_result"]],"estimators.abstract_estimator":[[12,1,1,"","AbstractEstimator"]],"estimators.abstract_estimator.AbstractEstimator":[[12,2,1,"","estimate"],[12,2,1,"","get_available_algorithms"],[12,2,1,"","get_params"],[12,2,1,"","set_params"]],"estimators.estimate_result":[[12,1,1,"","EstimateResult"]],"estimators.estimate_result.EstimateResult":[[12,3,1,"","list_value"],[12,3,1,"","message"],[12,3,1,"","success"],[12,3,1,"","value"]],"generators":[[15,0,0,"-","abstract_generator"],[15,0,0,"-","nm_generator"],[15,0,0,"-","nmv_generator"],[15,0,0,"-","nv_generator"]],"generators.abstract_generator":[[15,1,1,"","AbstractGenerator"]],"generators.abstract_generator.AbstractGenerator":[[15,2,1,"","canonical_generate"],[15,2,1,"","classical_generate"]],"generators.nm_generator":[[15,1,1,"","NMGenerator"]],"generators.nm_generator.NMGenerator":[[15,2,1,"","canonical_generate"],[15,2,1,"","classical_generate"]],"generators.nmv_generator":[[15,1,1,"","NMVGenerator"]],"generators.nmv_generator.NMVGenerator":[[15,2,1,"","canonical_generate"],[15,2,1,"","classical_generate"]],"generators.nv_generator":[[15,1,1,"","NVGenerator"]],"generators.nv_generator.NVGenerator":[[15,2,1,"","canonical_generate"],[15,2,1,"","classical_generate"]],"mixtures":[[16,0,0,"-","abstract_mixture"],[16,0,0,"-","nm_mixture"],[16,0,0,"-","nmv_mixture"],[16,0,0,"-","nv_mixture"]],"mixtures.abstract_mixture":[[16,1,1,"","AbstractMixtures"]],"mixtures.abstract_mixture.AbstractMixtures":[[16,2,1,"","compute_cdf"],[16,2,1,"","compute_logpdf"],[16,2,1,"","compute_moment"],[16,2,1,"","compute_pdf"]],"mixtures.nm_mixture":[[16,1,1,"","NormalMeanMixtures"]],"mixtures.nm_mixture.NormalMeanMixtures":[[16,2,1,"","compute_cdf"],[16,2,1,"","compute_logpdf"],[16,2,1,"","compute_moment"],[16,2,1,"","compute_pdf"]],"mixtures.nmv_mixture":[[16,1,1,"","NormalMeanVarianceMixtures"]],"mixtures.nmv_mixture.NormalMeanVarianceMixtures":[[16,2,1,"","compute_cdf"],[16,2,1,"","compute_logpdf"],[16,2,1,"","compute_moment"],[16,2,1,"","compute_pdf"]],"mixtures.nv_mixture":[[16,1,1,"","NormalVarianceMixtures"]],"mixtures.nv_mixture.NormalVarianceMixtures":[[16,2,1,"","compute_cdf"],[16,2,1,"","compute_logpdf"],[16,2,1,"","compute_moment"],[16,2,1,"","compute_pdf"]],"register":[[17,0,0,"-","algorithm_purpose"],[17,0,0,"-","register"]],"register.algorithm_purpose":[[17,1,1,"","AlgorithmPurpose"]],"register.algorithm_purpose.AlgorithmPurpose":[[17,3,1,"","DEFAULT"],[17,3,1,"","NMV_PARAMETRIC"],[17,3,1,"","NMV_SEMIPARAMETRIC"],[17,3,1,"","NM_PARAMETRIC"],[17,3,1,"","NM_SEMIPARAMETRIC"],[17,3,1,"","NV_PARAMETRIC"],[17,3,1,"","NV_SEMIPARAMETRIC"]],"register.register":[[17,1,1,"","Registry"]],"register.register.Registry":[[17,2,1,"","dispatch"],[17,2,1,"","register"]]},"objnames":{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},"objtypes":{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},"terms":{"1":12,"A":12,"If":15,"No":12,"_nestedsequ":12,"_purpos":12,"_registri":12,"_scalart":[],"_scalartype_co":15,"_supportsarrai":12,"abstract":[12,15,16],"abstract_estim":[1,2],"abstract_gener":[1,2],"abstract_mixtur":[1,2],"abstractestim":[2,12],"abstractgener":[2,15],"abstractmethod":[15,16],"abstractmixtur":[2,15,16],"add":0,"algorithm":[1,2,12,16,17],"algorithm_nam":12,"algorithm_purpos":[1,2],"algorithmpurpos":[2,17],"all":[3,12],"an":12,"analys":12,"ani":[12,16,17],"appli":12,"approxim":16,"arg":[12,15,16,17],"attribut":12,"base":[12,15,16,17],"befor":17,"bool":12,"both":15,"buffer":12,"byte":12,"callabl":17,"can":12,"canon":[15,16],"canonical_gener":[2,15],"cdf":16,"choos":16,"chosen":12,"class":[12,15,16,17],"classic":[15,16],"classical_gener":[2,15],"common":12,"complex":12,"comput":16,"compute_cdf":[2,16],"compute_logpdf":[2,16],"compute_mo":[2,16],"compute_pdf":[2,16],"contain":[3,12],"content":1,"current":12,"data":12,"dataclass":12,"decor":17,"default":[2,17],"defin":[12,15,16,17],"depend":16,"detail":0,"dict":[12,16],"dictionari":12,"dispatch":[2,17],"distribut":[12,15,16],"dtype":[12,15],"enum":17,"enumer":17,"equat":16,"error":16,"estim":[1,2,3,16,17],"estimate_result":[1,2],"estimateresult":[2,12],"factori":12,"fals":12,"find":17,"float":[12,16],"form":[15,16],"found":17,"from":15,"function":[12,17],"g_estimation_convolut":8,"g_estimation_given_mu":8,"g_estimation_given_mu_rqmc_bas":8,"g_estimation_post_widd":8,"gener":[1,2,17],"get":12,"get_available_algorithm":[2,12],"get_param":[2,12],"given":[12,15],"i":15,"implement":[3,16,17],"indic":12,"int":[12,15,16],"integr":16,"kei":12,"kwarg":16,"length":15,"list":12,"list_valu":[2,12],"log":16,"logrqmc":16,"mean":[15,16,17],"messag":[2,12],"metadata":12,"mixtur":[1,2,15],"mixture_form":16,"modul":1,"moment":16,"mu_estim":8,"n":16,"name":17,"ndarrai":15,"new":17,"nm":[15,16],"nm_gener":[1,2],"nm_mixtur":[1,2],"nm_param_algorithm":4,"nm_parametr":[2,17],"nm_semi_param_algorithm":8,"nm_semiparametr":[2,17],"nmgener":[2,15],"nmm":[15,16],"nmparametr":17,"nmsemiparametr":17,"nmv":[15,16],"nmv_gener":[1,2],"nmv_mixtur":[1,2],"nmv_parametr":[2,17],"nmv_semiparametr":[2,17],"nmvgener":[2,15],"nmvm":[3,15],"nmvparametr":17,"nmvsemiparametr":17,"none":[12,17],"normal":[15,16,17],"normalmeanmixtur":[2,16],"normalmeanvariancemixtur":[2,16],"normalvariancemixtur":[2,16],"nv":[15,16],"nv_gener":[1,2],"nv_mixtur":[1,2],"nv_param_algorithm":4,"nv_parametr":[2,17],"nv_semi_param_algorithm":8,"nv_semiparametr":[2,17],"nvgener":[2,15],"nvm":[15,16],"nvm_param_algorithm":4,"nvm_semi_param_algorithm":8,"nvparametr":17,"nvsemiparametr":17,"object":[12,15,16,17],"one":12,"ordin":16,"packag":[0,1],"param":[12,16],"paramet":[12,16],"parametr":[3,12,17],"pattern":17,"pdf":16,"point":16,"provid":[3,12,15,16],"purpos":[12,17],"pysatl":3,"rais":[15,17],"regist":[1,2],"registri":[2,3,12,17],"restructuredtext":0,"result":12,"return":[15,16,17],"rqmc":16,"sampl":[12,15],"see":0,"self":12,"semiparametr":[3,12,17],"set_param":[2,12],"sigma_estimation_eigenvalue_bas":8,"sigma_estimation_empir":8,"size":15,"sourc":[12,15,16,17],"specifi":17,"src":0,"static":15,"store":12,"str":[12,16,17],"string":12,"structur":12,"submodul":[1,2,8],"subpackag":1,"success":[2,12],"syntax":0,"t":17,"th":16,"thi":[3,12,15,16,17],"toler":16,"tupl":[15,16],"type":[15,17],"us":[0,12],"valu":[2,12,17],"valueerror":[15,17],"varianc":[15,16,17],"variou":[15,16],"wa":17,"when":17,"x":16,"your":0},"titles":["ka documentation","src","src package","algorithms package","src.algorithms.param_algorithms package","src.algorithms.param_algorithms.nm_param_algorithms package","src.algorithms.param_algorithms.nv_param_algorithms package","src.algorithms.param_algorithms.nvm_param_algorithms package","src.algorithms.semiparam_algorithms package","src.algorithms.semiparam_algorithms.nm_semi_param_algorithms package","src.algorithms.semiparam_algorithms.nv_semi_param_algorithms package","src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms package","estimators package","src.estimators.parametric package","src.estimators.semiparametric package","generators package","mixtures package","register package"],"titleterms":{"abstract_estim":12,"abstract_gener":15,"abstract_mixtur":16,"abstract_parametric_estim":13,"abstract_semiparametric_estim":14,"algorithm":[3,4,5,6,7,8,9,10,11],"algorithm_purpos":17,"content":[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"document":0,"estim":[12,13,14],"estimate_result":12,"g_estimation_convolut":9,"g_estimation_given_mu":[10,11],"g_estimation_given_mu_rqmc_bas":11,"g_estimation_post_widd":[10,11],"gener":15,"ka":0,"mixtur":16,"modul":[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"mu_estim":11,"nm_gener":15,"nm_mixtur":16,"nm_param_algorithm":5,"nm_parametric_estim":13,"nm_semi_param_algorithm":9,"nm_semiparametric_estim":14,"nmv_gener":15,"nmv_mixtur":16,"nmv_parametric_estim":13,"nmv_semiparametric_estim":14,"nv_gener":15,"nv_mixtur":16,"nv_param_algorithm":6,"nv_parametric_estim":13,"nv_semi_param_algorithm":10,"nv_semiparametric_estim":14,"nvm_param_algorithm":7,"nvm_semi_param_algorithm":11,"packag":[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"param_algorithm":[4,5,6,7],"parametr":13,"regist":17,"semiparam_algorithm":[8,9,10,11],"semiparametr":14,"sigma_estimation_eigenvalue_bas":9,"sigma_estimation_empir":9,"src":[1,2,4,5,6,7,8,9,10,11,13,14],"submodul":[9,10,11,12,13,14,15,16,17],"subpackag":[2,3,4,8,12]}})
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.html b/docs/build/html/src.algorithms.html
new file mode 100644
index 0000000..76834e7
--- /dev/null
+++ b/docs/build/html/src.algorithms.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+
+
algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+algorithms package
+
+
+Module contents
+Algorithms module for PySATL NMVM.
+This module contains all algorithm implementations and provides a registry
+for parametric and semiparametric estimation algorithms.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.param_algorithms.html b/docs/build/html/src.algorithms.param_algorithms.html
new file mode 100644
index 0000000..eba8c44
--- /dev/null
+++ b/docs/build/html/src.algorithms.param_algorithms.html
@@ -0,0 +1,140 @@
+
+
+
+
+
+
+
+
+
src.algorithms.param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+src.algorithms.param_algorithms package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.param_algorithms.nm_param_algorithms.html b/docs/build/html/src.algorithms.param_algorithms.nm_param_algorithms.html
new file mode 100644
index 0000000..f0a705c
--- /dev/null
+++ b/docs/build/html/src.algorithms.param_algorithms.nm_param_algorithms.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+
+
src.algorithms.param_algorithms.nm_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.param_algorithms.nm_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.param_algorithms.nm_param_algorithms package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.param_algorithms.nv_param_algorithms.html b/docs/build/html/src.algorithms.param_algorithms.nv_param_algorithms.html
new file mode 100644
index 0000000..eb45c2d
--- /dev/null
+++ b/docs/build/html/src.algorithms.param_algorithms.nv_param_algorithms.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+
+
src.algorithms.param_algorithms.nv_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.param_algorithms.nv_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.param_algorithms.nv_param_algorithms package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.param_algorithms.nvm_param_algorithms.html b/docs/build/html/src.algorithms.param_algorithms.nvm_param_algorithms.html
new file mode 100644
index 0000000..9a48f3f
--- /dev/null
+++ b/docs/build/html/src.algorithms.param_algorithms.nvm_param_algorithms.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+
+
src.algorithms.param_algorithms.nvm_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.param_algorithms.nvm_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.param_algorithms.nvm_param_algorithms package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.semiparam_algorithms.html b/docs/build/html/src.algorithms.semiparam_algorithms.html
new file mode 100644
index 0000000..4f37548
--- /dev/null
+++ b/docs/build/html/src.algorithms.semiparam_algorithms.html
@@ -0,0 +1,152 @@
+
+
+
+
+
+
+
+
+
src.algorithms.semiparam_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+src.algorithms.semiparam_algorithms package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.html b/docs/build/html/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.html
new file mode 100644
index 0000000..73270dd
--- /dev/null
+++ b/docs/build/html/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.html
@@ -0,0 +1,133 @@
+
+
+
+
+
+
+
+
+
src.algorithms.semiparam_algorithms.nm_semi_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.semiparam_algorithms.nm_semi_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.semiparam_algorithms.nm_semi_param_algorithms package
+
+
+src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.g_estimation_convolution module
+
+
+src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_eigenvalue_based module
+
+
+src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_empirical module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.html b/docs/build/html/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.html
new file mode 100644
index 0000000..b5855dc
--- /dev/null
+++ b/docs/build/html/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.html
@@ -0,0 +1,130 @@
+
+
+
+
+
+
+
+
+
src.algorithms.semiparam_algorithms.nv_semi_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.semiparam_algorithms.nv_semi_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.semiparam_algorithms.nv_semi_param_algorithms package
+
+
+src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_given_mu module
+
+
+src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_post_widder module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.html b/docs/build/html/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.html
new file mode 100644
index 0000000..951fc4f
--- /dev/null
+++ b/docs/build/html/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+
+
src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+ src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms package
+
+ View page source
+
+
+
+
+
+
+
+
+src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms package
+
+
+src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu module
+
+
+src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu_rqmc_based module
+
+
+src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_post_widder module
+
+
+src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.estimators.html b/docs/build/html/src.estimators.html
new file mode 100644
index 0000000..0a55240
--- /dev/null
+++ b/docs/build/html/src.estimators.html
@@ -0,0 +1,215 @@
+
+
+
+
+
+
+
+
+
estimators package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+estimators package
+
+
+
+estimators.abstract_estimator module
+Abstract estimator base class module.
+This module defines the AbstractEstimator base class that provides
+common functionality for all parametric and semiparametric estimators.
+
+
+class estimators.abstract_estimator. AbstractEstimator ( algorithm_name : str params : dict | None = None ) [source]
+Bases: object
+Base class for Estimators
+
+Attributes: algorithm_name: A string indicating chosen algorithm.
+params: A dictionary of algorithm parameters.
+estimate_result: Estimation result.
+_registry: Registry that contains classes of all algorithms.
+_purpose: Defines purpose of algorithm, one of the registry key.
+
+
+
+estimate ( sample : Buffer | _SupportsArray [ dtype [ Any ] ] | _NestedSequence [ _SupportsArray [ dtype [ Any ] ] ] | bool | int | float | complex | str | bytes | _NestedSequence [ bool | int | float | complex | str | bytes ] ) → EstimateResult [source]
+Applies an algorithm to the given sample
+
+Args: sample: sample of the analysed distribution
+
+
+
+
+
+get_available_algorithms ( ) → list [ str ] [source]
+Get all algorithms that can be used for current estimator class
+
+
+
+
+get_params ( ) → dict [source]
+
+
+
+
+set_params ( algorithm_name : str params : dict | None = None ) → Self [source]
+
+
+
+
+
+
+estimators.estimate_result module
+Estimate result data structure module.
+This module defines the EstimateResult dataclass for storing
+estimation results and metadata.
+
+
+class estimators.estimate_result. EstimateResult ( value: float = -1 list_value: List = <factory> success: bool = False message: str = 'No message' ) [source]
+Bases: object
+
+
+list_value : List
+
+
+
+
+message : str = 'No message'
+
+
+
+
+success : bool = False
+
+
+
+
+value : float = -1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.estimators.parametric.html b/docs/build/html/src.estimators.parametric.html
new file mode 100644
index 0000000..969bf54
--- /dev/null
+++ b/docs/build/html/src.estimators.parametric.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+
+
src.estimators.parametric package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+src.estimators.parametric package
+
+
+src.estimators.parametric.abstract_parametric_estimator module
+
+
+src.estimators.parametric.nm_parametric_estimator module
+
+
+src.estimators.parametric.nmv_parametric_estimator module
+
+
+src.estimators.parametric.nv_parametric_estimator module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.estimators.semiparametric.html b/docs/build/html/src.estimators.semiparametric.html
new file mode 100644
index 0000000..841326c
--- /dev/null
+++ b/docs/build/html/src.estimators.semiparametric.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+
+
src.estimators.semiparametric package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+src.estimators.semiparametric package
+
+
+src.estimators.semiparametric.abstract_semiparametric_estimator module
+
+
+src.estimators.semiparametric.nm_semiparametric_estimator module
+
+
+src.estimators.semiparametric.nmv_semiparametric_estimator module
+
+
+src.estimators.semiparametric.nv_semiparametric_estimator module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.generators.html b/docs/build/html/src.generators.html
new file mode 100644
index 0000000..030685c
--- /dev/null
+++ b/docs/build/html/src.generators.html
@@ -0,0 +1,285 @@
+
+
+
+
+
+
+
+
+
generators package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+generators package
+
+
+generators.abstract_generator module
+Abstract generator base class module.
+This module defines the AbstractGenerator base class for generating
+samples from various mixture distributions.
+
+
+class generators.abstract_generator. AbstractGenerator [source]
+Bases: object
+
+
+abstractmethod static canonical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+
+
+
+
+abstractmethod static classical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+
+
+
+
+
+
+generators.nm_generator module
+Normal Mean (NM) generator module.
+This module provides generators for Normal Mean mixtures
+in both classical and canonical forms.
+
+
+class generators.nm_generator. NMGenerator [source]
+Bases: AbstractGenerator
+
+
+static canonical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Canonical form of NMM
+
+Args: mixture: Normal Mean Mixture
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture is not a Normal Mean Mixture
+
+
+
+
+
+static classical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Classical form of NMM
+
+Args: mixture: Normal Mean Mixture
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture is not a Normal Mean Mixture
+
+
+
+
+
+
+
+generators.nmv_generator module
+Normal Mean-Variance (NMV) generator module.
+This module provides generators for Normal Mean-Variance mixtures
+in both classical and canonical forms.
+
+
+class generators.nmv_generator. NMVGenerator [source]
+Bases: AbstractGenerator
+
+
+static canonical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Canonical form of NMVM
+
+Args: mixture: Normal Mean Variance Mixtures
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture type is not Normal Mean Variance Mixtures
+
+
+
+
+
+static classical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Classical form of NMVM
+
+Args: mixture: Normal Mean Variance Mixtures
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture type is not Normal Mean Variance Mixtures
+
+
+
+
+
+
+
+generators.nv_generator module
+Normal Variance (NV) generator module.
+This module provides generators for Normal Variance mixtures
+in both classical and canonical forms.
+
+
+class generators.nv_generator. NVGenerator [source]
+Bases: AbstractGenerator
+
+
+static canonical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Canonical form of NVM
+
+Args: mixture: Normal Variance Mixtures
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture type is not Normal Variance Mixtures
+
+
+
+
+
+static classical_generate ( mixture : AbstractMixtures size : int ) → ndarray [ tuple [ int , ... ] , dtype [ _ScalarType_co ] ] [source]
+Generate a sample of given size. Classical form of NVM
+
+Args: mixture: Normal Variance Mixtures
+size: length of sample
+
+Returns: sample of given size
+
+Raises: ValueError: If mixture type is not Normal Variance Mixtures
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.html b/docs/build/html/src.html
new file mode 100644
index 0000000..3b225cc
--- /dev/null
+++ b/docs/build/html/src.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+
+
+
src package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.mixtures.html b/docs/build/html/src.mixtures.html
new file mode 100644
index 0000000..b11d588
--- /dev/null
+++ b/docs/build/html/src.mixtures.html
@@ -0,0 +1,295 @@
+
+
+
+
+
+
+
+
+
mixtures package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+mixtures package
+
+
+mixtures.abstract_mixture module
+Abstract mixture base class module.
+This module defines the AbstractMixtures base class for various
+mixture distribution implementations.
+
+
+class mixtures.abstract_mixture. AbstractMixtures ( mixture_form : str ** kwargs : Any ) [source]
+Bases: object
+Base class for Mixtures
+
+
+abstractmethod compute_cdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+abstractmethod compute_logpdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+abstractmethod compute_moment ( n : int params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+abstractmethod compute_pdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+
+
+mixtures.nm_mixture module
+Normal Mean (NM) mixture module.
+This module provides the NormalMeanMixtures class for Normal Mean
+mixture distributions in classical and canonical forms.
+
+
+class mixtures.nm_mixture. NormalMeanMixtures ( mixture_form : str ** kwargs : Any ) [source]
+Bases: AbstractMixtures
+
+
+compute_cdf ( x : float params : dict ) → tuple [ float , float ] [source]
+Choose equation for cdf estimation depends on Mixture form.
+
+Args: x: point
+params: parameters of RQMC algorithm
+
+Returns: Computed pdf and error tolerance
+
+
+
+
+compute_logpdf ( x : float params : dict ) → tuple [ float , float ] [source]
+Choose equation for log pdf estimation depends on Mixture form.
+
+Args: x: point
+params: parameters of LogRQMC algorithm
+
+Returns: Computed log pdf and error tolerance
+
+
+
+
+compute_moment ( n : int params : dict ) → tuple [ float , float ] [source]
+Compute n-th moment of NMM
+
+Args: n (): Moment ordinal
+params (): Parameters of integration algorithm
+
+Returns: moment approximation and error tolerance
+
+
+
+
+compute_pdf ( x : float params : dict ) → tuple [ float , float ] [source]
+Choose equation for pdf estimation depends on Mixture form.
+
+Args: x: point
+params: parameters of RQMC algorithm
+
+Returns: Computed pdf and error tolerance
+
+
+
+
+
+
+mixtures.nmv_mixture module
+Normal Mean-Variance (NMV) mixture module.
+This module provides the NormalMeanVarianceMixtures class for Normal Mean-Variance
+mixture distributions in classical and canonical forms.
+
+
+class mixtures.nmv_mixture. NormalMeanVarianceMixtures ( mixture_form : str ** kwargs : Any ) [source]
+Bases: AbstractMixtures
+
+
+compute_cdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+compute_logpdf ( x : float params : dict ) → tuple [ Any , float ] [source]
+
+
+
+
+compute_moment ( n : int params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+compute_pdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+
+
+mixtures.nv_mixture module
+Normal Variance (NV) mixture module.
+This module provides the NormalVarianceMixtures class for Normal Variance
+mixture distributions in classical and canonical forms.
+
+
+class mixtures.nv_mixture. NormalVarianceMixtures ( mixture_form : str ** kwargs : Any ) [source]
+Bases: AbstractMixtures
+
+
+compute_cdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+compute_logpdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+compute_moment ( n : int params : dict ) → tuple [ float , float ] [source]
+Compute n-th moment of NVM.
+
+Args: n: Moment ordinal
+params: Parameters of integration algorithm
+
+Returns: moment approximation and error tolerance
+
+
+
+
+compute_pdf ( x : float params : dict ) → tuple [ float , float ] [source]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/src.register.html b/docs/build/html/src.register.html
new file mode 100644
index 0000000..1b7ea16
--- /dev/null
+++ b/docs/build/html/src.register.html
@@ -0,0 +1,218 @@
+
+
+
+
+
+
+
+
+
register package — PYSATL-NMVM 0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PYSATL-NMVM
+
+
+
+
+
+
+
+
+
+register package
+
+
+register.algorithm_purpose module
+Algorithm purpose enumeration module.
+This module defines the AlgorithmPurpose enum that specifies
+the purpose and type of estimation algorithms.
+
+
+class register.algorithm_purpose. AlgorithmPurpose ( * values ) [source]
+Bases: Enum
+
+
+DEFAULT = 'Any'
+
+
+
+
+NMV_PARAMETRIC = 'Normal Mean-Variance Parametric'
+
+
+
+
+NMV_SEMIPARAMETRIC = 'Normal Mean-Variance Semiparametric'
+
+
+
+
+NM_PARAMETRIC = 'Normal Mean Parametric'
+
+
+
+
+NM_SEMIPARAMETRIC = 'Normal Mean Semiparametric'
+
+
+
+
+NV_PARAMETRIC = 'Normal Variance Parametric'
+
+
+
+
+NV_SEMIPARAMETRIC = 'Normal Variance Semiparametric'
+
+
+
+
+
+
+register.register module
+
+
+class register.register. Registry ( default : Type [ T ] | None = None ) [source]
+Bases: Generic T
+Register of objects. Implementation of Register pattern
+
+
+dispatch ( name : str purpose : AlgorithmPurpose ) → Type [ T ] [source]
+Find object by name.
+
+Args: name: Class name
+purpose: Purpose of the algorithm (“NMParametric, NVParametric, NMVParametric, NMSemiparametric, NVSemiparametric, NMVSemiparametric”)
+
+Returns: object
+
+Raises: ValueError: When object with this name was not found
+
+
+
+
+
+register ( name : str purpose : AlgorithmPurpose ) → Callable [source]
+Register new object.
+
+Args: name: Class name
+purpose: Purpose of the algorithm (“NMParametric, NVParametric, NMVParametric, NMSemiparametric, NVSemiparametric, NMVSemiparametric”)
+
+Returns: Decorator function
+
+Raises: ValueError: When class with this name was registered before
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..747ffb7
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..4e098fb
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,44 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src'))
+project = 'PYSATL-NMVM'
+copyright = 'Copyright (c) 2025-present PySATL Contributors'
+author = 'Copyright (c) 2025-present PySATL Contributors'
+release = '0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src'))
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode']
+
+templates_path = ['_templates']
+exclude_patterns = []
+autosummary_generate = True
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+# RTD theme options
+html_theme_options = {
+ 'navigation_depth': 4,
+ 'collapse_navigation': False,
+ 'sticky_navigation': True,
+ 'includehidden': True,
+ 'titles_only': False
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..d20789b
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,34 @@
+.. ka documentation master file, created by
+ sphinx-quickstart on Sat Jun 21 21:00:53 2025.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+ka documentation
+================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText
`_
+documentation for details.
+
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ modules
+ register
+ mixtures
+ generators
+ estimators
+ estimators.parametric
+ estimators.semiparametric
+ algorithms
+ algorithms.param_algorithms
+ algorithms.param_algorithms.nvm_param_algorithms
+ algorithms.param_algorithms.nv_param_algorithms
+ algorithms.param_algorithms.nm_param_algorithms
+ algorithms.semiparam_algorithms
+ algorithms.semiparam_algorithms.nvm_semi_param_algorithms
+ algorithms.semiparam_algorithms.nv_semi_param_algorithms
+ algorithms.semiparam_algorithms.nm_semi_param_algorithms
+
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 0000000..e9ff8ac
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ src
diff --git a/docs/source/src.algorithms.param_algorithms.nm_param_algorithms.rst b/docs/source/src.algorithms.param_algorithms.nm_param_algorithms.rst
new file mode 100644
index 0000000..1d2bbb3
--- /dev/null
+++ b/docs/source/src.algorithms.param_algorithms.nm_param_algorithms.rst
@@ -0,0 +1,10 @@
+src.algorithms.param\_algorithms.nm\_param\_algorithms package
+==============================================================
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.param_algorithms.nm_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.param_algorithms.nv_param_algorithms.rst b/docs/source/src.algorithms.param_algorithms.nv_param_algorithms.rst
new file mode 100644
index 0000000..6486f96
--- /dev/null
+++ b/docs/source/src.algorithms.param_algorithms.nv_param_algorithms.rst
@@ -0,0 +1,10 @@
+src.algorithms.param\_algorithms.nv\_param\_algorithms package
+==============================================================
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.param_algorithms.nv_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.param_algorithms.nvm_param_algorithms.rst b/docs/source/src.algorithms.param_algorithms.nvm_param_algorithms.rst
new file mode 100644
index 0000000..bb5f9c4
--- /dev/null
+++ b/docs/source/src.algorithms.param_algorithms.nvm_param_algorithms.rst
@@ -0,0 +1,10 @@
+src.algorithms.param\_algorithms.nvm\_param\_algorithms package
+===============================================================
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.param_algorithms.nvm_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.param_algorithms.rst b/docs/source/src.algorithms.param_algorithms.rst
new file mode 100644
index 0000000..6aedf46
--- /dev/null
+++ b/docs/source/src.algorithms.param_algorithms.rst
@@ -0,0 +1,20 @@
+src.algorithms.param\_algorithms package
+========================================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ src.algorithms.param_algorithms.nm_param_algorithms
+ src.algorithms.param_algorithms.nv_param_algorithms
+ src.algorithms.param_algorithms.nvm_param_algorithms
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.rst b/docs/source/src.algorithms.rst
new file mode 100644
index 0000000..e61ef1d
--- /dev/null
+++ b/docs/source/src.algorithms.rst
@@ -0,0 +1,19 @@
+algorithms package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ algorithms.param_algorithms
+ algorithms.semiparam_algorithms
+
+Module contents
+---------------
+
+.. automodule:: algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.rst b/docs/source/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.rst
new file mode 100644
index 0000000..cf763f4
--- /dev/null
+++ b/docs/source/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.rst
@@ -0,0 +1,37 @@
+src.algorithms.semiparam\_algorithms.nm\_semi\_param\_algorithms package
+========================================================================
+
+Submodules
+----------
+
+src.algorithms.semiparam\_algorithms.nm\_semi\_param\_algorithms.g\_estimation\_convolution module
+--------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.g_estimation_convolution
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nm\_semi\_param\_algorithms.sigma\_estimation\_eigenvalue\_based module
+------------------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_eigenvalue_based
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nm\_semi\_param\_algorithms.sigma\_estimation\_empirical module
+----------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_empirical
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nm_semi_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.rst b/docs/source/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.rst
new file mode 100644
index 0000000..11a2523
--- /dev/null
+++ b/docs/source/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.rst
@@ -0,0 +1,29 @@
+src.algorithms.semiparam\_algorithms.nv\_semi\_param\_algorithms package
+========================================================================
+
+Submodules
+----------
+
+src.algorithms.semiparam\_algorithms.nv\_semi\_param\_algorithms.g\_estimation\_given\_mu module
+------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_given_mu
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nv\_semi\_param\_algorithms.g\_estimation\_post\_widder module
+---------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_post_widder
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nv_semi_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.rst b/docs/source/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.rst
new file mode 100644
index 0000000..bfcc45e
--- /dev/null
+++ b/docs/source/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.rst
@@ -0,0 +1,45 @@
+src.algorithms.semiparam\_algorithms.nvm\_semi\_param\_algorithms package
+=========================================================================
+
+Submodules
+----------
+
+src.algorithms.semiparam\_algorithms.nvm\_semi\_param\_algorithms.g\_estimation\_given\_mu module
+-------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nvm\_semi\_param\_algorithms.g\_estimation\_given\_mu\_rqmc\_based module
+--------------------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu_rqmc_based
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nvm\_semi\_param\_algorithms.g\_estimation\_post\_widder module
+----------------------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_post_widder
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.algorithms.semiparam\_algorithms.nvm\_semi\_param\_algorithms.mu\_estimation module
+---------------------------------------------------------------------------------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.algorithms.semiparam_algorithms.rst b/docs/source/src.algorithms.semiparam_algorithms.rst
new file mode 100644
index 0000000..ccc0564
--- /dev/null
+++ b/docs/source/src.algorithms.semiparam_algorithms.rst
@@ -0,0 +1,20 @@
+src.algorithms.semiparam\_algorithms package
+============================================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ src.algorithms.semiparam_algorithms.nm_semi_param_algorithms
+ src.algorithms.semiparam_algorithms.nv_semi_param_algorithms
+ src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms
+
+Module contents
+---------------
+
+.. automodule:: src.algorithms.semiparam_algorithms
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.estimators.parametric.rst b/docs/source/src.estimators.parametric.rst
new file mode 100644
index 0000000..beeeff1
--- /dev/null
+++ b/docs/source/src.estimators.parametric.rst
@@ -0,0 +1,45 @@
+src.estimators.parametric package
+=================================
+
+Submodules
+----------
+
+src.estimators.parametric.abstract\_parametric\_estimator module
+----------------------------------------------------------------
+
+.. automodule:: src.estimators.parametric.abstract_parametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.parametric.nm\_parametric\_estimator module
+----------------------------------------------------------
+
+.. automodule:: src.estimators.parametric.nm_parametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.parametric.nmv\_parametric\_estimator module
+-----------------------------------------------------------
+
+.. automodule:: src.estimators.parametric.nmv_parametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.parametric.nv\_parametric\_estimator module
+----------------------------------------------------------
+
+.. automodule:: src.estimators.parametric.nv_parametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: src.estimators.parametric
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.estimators.rst b/docs/source/src.estimators.rst
new file mode 100644
index 0000000..b9ab462
--- /dev/null
+++ b/docs/source/src.estimators.rst
@@ -0,0 +1,38 @@
+estimators package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ estimators.parametric
+ estimators.semiparametric
+
+Submodules
+----------
+
+estimators.abstract_estimator module
+-----------------------------------------
+
+.. automodule:: estimators.abstract_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+estimators.estimate_result module
+--------------------------------------
+
+.. automodule:: estimators.estimate_result
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: estimators
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.estimators.semiparametric.rst b/docs/source/src.estimators.semiparametric.rst
new file mode 100644
index 0000000..8f74406
--- /dev/null
+++ b/docs/source/src.estimators.semiparametric.rst
@@ -0,0 +1,45 @@
+src.estimators.semiparametric package
+=====================================
+
+Submodules
+----------
+
+src.estimators.semiparametric.abstract\_semiparametric\_estimator module
+------------------------------------------------------------------------
+
+.. automodule:: src.estimators.semiparametric.abstract_semiparametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.semiparametric.nm\_semiparametric\_estimator module
+------------------------------------------------------------------
+
+.. automodule:: src.estimators.semiparametric.nm_semiparametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.semiparametric.nmv\_semiparametric\_estimator module
+-------------------------------------------------------------------
+
+.. automodule:: src.estimators.semiparametric.nmv_semiparametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+src.estimators.semiparametric.nv\_semiparametric\_estimator module
+------------------------------------------------------------------
+
+.. automodule:: src.estimators.semiparametric.nv_semiparametric_estimator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: src.estimators.semiparametric
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.generators.rst b/docs/source/src.generators.rst
new file mode 100644
index 0000000..1798368
--- /dev/null
+++ b/docs/source/src.generators.rst
@@ -0,0 +1,45 @@
+generators package
+======================
+
+Submodules
+----------
+
+generators.abstract_generator module
+-----------------------------------------
+
+.. automodule:: generators.abstract_generator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+generators.nm_generator module
+-----------------------------------
+
+.. automodule:: generators.nm_generator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+generators.nmv_generator module
+------------------------------------
+
+.. automodule:: generators.nmv_generator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+generators.nv_generator module
+-----------------------------------
+
+.. automodule:: generators.nv_generator
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: generators
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.mixtures.rst b/docs/source/src.mixtures.rst
new file mode 100644
index 0000000..ee3312e
--- /dev/null
+++ b/docs/source/src.mixtures.rst
@@ -0,0 +1,45 @@
+mixtures package
+====================
+
+Submodules
+----------
+
+mixtures.abstract_mixture module
+-------------------------------------
+
+.. automodule:: mixtures.abstract_mixture
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+mixtures.nm_mixture module
+-------------------------------
+
+.. automodule:: mixtures.nm_mixture
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+mixtures.nmv_mixture module
+--------------------------------
+
+.. automodule:: mixtures.nmv_mixture
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+mixtures.nv_mixture module
+-------------------------------
+
+.. automodule:: mixtures.nv_mixture
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: mixtures
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.register.rst b/docs/source/src.register.rst
new file mode 100644
index 0000000..84ca96a
--- /dev/null
+++ b/docs/source/src.register.rst
@@ -0,0 +1,29 @@
+register package
+====================
+
+Submodules
+----------
+
+register.algorithm_purpose module
+--------------------------------------
+
+.. automodule:: register.algorithm_purpose
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+register.register module
+----------------------------
+
+.. automodule:: register.register
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: register
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/docs/source/src.rst b/docs/source/src.rst
new file mode 100644
index 0000000..fc81af9
--- /dev/null
+++ b/docs/source/src.rst
@@ -0,0 +1,22 @@
+src package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ src.algorithms
+ src.estimators
+ src.generators
+ src.mixtures
+ src.register
+
+Module contents
+---------------
+
+.. automodule:: src
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/pyproject.toml b/pyproject.toml
index f910d64..0b5d07c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -35,4 +35,20 @@ no_implicit_optional = "False"
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = ["--color=yes", "-s"]
-markers = ["ci: test that run on ci"]
\ No newline at end of file
+markers = ["ci: test that run on ci"]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pysatl-nmvm"
+version = "0.1.0"
+description = "PySATL NMVM Module"
+authors = [
+ { name="Engelsgeduld" },
+ { name="Andreev Sergey" },
+ { name="Sazonova Irina" }
+]
+readme = ""
+requires-python = ">=3.8"
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..b83428d
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,11 @@
+[options]
+packages =
+ register
+ mixtures
+ generators
+ estimators
+ algorithms
+package_dir =
+ =src
+exclude =
+ tests
\ No newline at end of file
diff --git a/src/algorithms/__init__.py b/src/algorithms/__init__.py
index eaddba8..efc492a 100644
--- a/src/algorithms/__init__.py
+++ b/src/algorithms/__init__.py
@@ -1,30 +1,36 @@
-from src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.g_estimation_convolution import (
+"""Algorithms module for PySATL NMVM.
+
+This module contains all algorithm implementations and provides a registry
+for parametric and semiparametric estimation algorithms.
+"""
+
+from algorithms.semiparam_algorithms.nm_semi_param_algorithms.g_estimation_convolution import (
NMSemiParametricGEstimation,
)
-from src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_eigenvalue_based import (
+from algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_eigenvalue_based import (
SemiParametricMeanSigmaEstimationEigenvalueBased,
)
-from src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_empirical import (
+from algorithms.semiparam_algorithms.nm_semi_param_algorithms.sigma_estimation_empirical import (
SemiParametricMeanSigmaEstimationEmpirical,
)
-from src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_given_mu import (
+from algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_given_mu import (
SemiParametricNVEstimation,
)
-from src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_post_widder import (
+from algorithms.semiparam_algorithms.nv_semi_param_algorithms.g_estimation_post_widder import (
NVSemiParametricGEstimationPostWidder,
)
-from src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu import (
+from algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu import (
SemiParametricGEstimationGivenMu,
)
-from src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu_rqmc_based import (
+from algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_given_mu_rqmc_based import (
SemiParametricGEstimationGivenMuRQMCBased,
)
-from src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_post_widder import (
+from algorithms.semiparam_algorithms.nvm_semi_param_algorithms.g_estimation_post_widder import (
SemiParametricGEstimationPostWidder,
)
-from src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation import SemiParametricMuEstimation
-from src.register.algorithm_purpose import AlgorithmPurpose
-from src.register.register import Registry
+from algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation import SemiParametricMuEstimation
+from register.algorithm_purpose import AlgorithmPurpose
+from register.register import Registry
ALGORITHM_REGISTRY: Registry = Registry()
ALGORITHM_REGISTRY.register("mu_estimation", AlgorithmPurpose.NMV_SEMIPARAMETRIC)(SemiParametricMuEstimation)
diff --git a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/g_estimation_convolution.py b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/g_estimation_convolution.py
index 3feb6cf..01d849a 100644
--- a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/g_estimation_convolution.py
+++ b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/g_estimation_convolution.py
@@ -1,10 +1,16 @@
+"""Convolution-based G-estimation for NM semiparametric mixtures.
+
+This module implements the estimation of mixing density function g using
+convolution methods for Normal Mean semiparametric mixtures.
+"""
+
import math
from typing import Any, Callable, Dict, List, Optional, TypedDict, Unpack
import numpy as np
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
SIGMA_DEFAULT_VALUE: float = 1
BOHMAN_N_DEFAULT_VALUE: int = 10000
diff --git a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_eigenvalue_based.py b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_eigenvalue_based.py
index 1148610..813ca38 100644
--- a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_eigenvalue_based.py
+++ b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_eigenvalue_based.py
@@ -1,10 +1,16 @@
+"""Eigenvalue-based sigma estimation for NM semiparametric mixtures.
+
+This module implements sigma estimation using eigenvalue decomposition
+for Normal Mean semiparametric mixtures.
+"""
+
import math
from typing import Optional, Tuple, TypedDict
import numpy as np
from scipy.linalg import eigh
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
L_DEFAULT_VALUE = 5
K_DEFAULT_VALUE = 10
diff --git a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_empirical.py b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_empirical.py
index 0ce471c..1387743 100644
--- a/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_empirical.py
+++ b/src/algorithms/semiparam_algorithms/nm_semi_param_algorithms/sigma_estimation_empirical.py
@@ -1,9 +1,15 @@
+"""Empirical sigma estimation for NM semiparametric mixtures.
+
+This module implements empirical sigma estimation methods for
+Normal Mean semiparametric mixtures.
+"""
+
import math
from typing import Optional, TypedDict
import numpy as np
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
T_DEFAULT_VALUE = 7.5
PARAMETER_KEYS = ["t"]
diff --git a/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_given_mu.py b/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_given_mu.py
index 7c810cc..f62bd26 100644
--- a/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_given_mu.py
+++ b/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_given_mu.py
@@ -1,3 +1,9 @@
+"""G-estimation given mu for NV semiparametric mixtures.
+
+This module implements the estimation of mixing density function g when
+mu is known in Normal Variance semiparametric mixtures.
+"""
+
import math
from bisect import bisect_left
from typing import Callable, Dict, List, Optional, TypedDict, Unpack
@@ -7,7 +13,7 @@
from scipy.integrate import quad_vec
from scipy.special import gamma
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
GAMMA_DEFAULT_VALUE = 0.25
diff --git a/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_post_widder.py b/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_post_widder.py
index 0c681d3..9f74451 100644
--- a/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_post_widder.py
+++ b/src/algorithms/semiparam_algorithms/nv_semi_param_algorithms/g_estimation_post_widder.py
@@ -1,3 +1,9 @@
+"""Post-Widder algorithm for G-estimation in NV semiparametric mixtures.
+
+This module implements the Post-Widder inversion method for estimating
+the mixing density function g in Normal Variance semiparametric mixtures.
+"""
+
import math
from typing import TypedDict, Unpack
@@ -6,7 +12,7 @@
from numpy import _typing
from sympy import bell
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
SIGMA_DEFAULT_VALUE = 1.0
N_DEFAULT_VALUE = 2
diff --git a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu.py b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu.py
index cbda86e..e0cb773 100644
--- a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu.py
+++ b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu.py
@@ -1,3 +1,9 @@
+"""G-estimation given mu for NVM semiparametric mixtures.
+
+This module implements the estimation of mixing density function g when
+mu is known in Normal Mean-Variance semiparametric mixtures.
+"""
+
import math
from bisect import bisect_left
from typing import Callable, Dict, List, Optional, TypedDict, Unpack
@@ -7,7 +13,7 @@
from scipy.integrate import quad_vec
from scipy.special import gamma
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
MU_DEFAULT_VALUE = 1.0
GAMMA_DEFAULT_VALUE = 0.25
diff --git a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu_rqmc_based.py b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu_rqmc_based.py
index 2f3da81..673fa76 100644
--- a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu_rqmc_based.py
+++ b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_given_mu_rqmc_based.py
@@ -1,3 +1,9 @@
+"""RQMC-based G-estimation given mu for NVM semiparametric mixtures.
+
+This module implements the estimation of mixing density function g when
+mu is known using Randomized Quasi-Monte Carlo methods.
+"""
+
import math
from bisect import bisect_left
from typing import Callable, Dict, List, Optional, TypedDict, Unpack
@@ -7,8 +13,8 @@
from scipy.integrate import quad_vec
from scipy.special import gamma
-from src.algorithms.support_algorithms.rqmc import RQMC
-from src.estimators.estimate_result import EstimateResult
+from algorithms.support_algorithms.rqmc import RQMC
+from estimators.estimate_result import EstimateResult
MU_DEFAULT_VALUE = 1.0
GAMMA_DEFAULT_VALUE = 0.25
diff --git a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_post_widder.py b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_post_widder.py
index 50c518e..7766ae3 100644
--- a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_post_widder.py
+++ b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/g_estimation_post_widder.py
@@ -1,3 +1,9 @@
+"""Post-Widder algorithm for G-estimation in NVM semiparametric mixtures.
+
+This module implements the Post-Widder inversion method for estimating
+the mixing density function g in Normal Mean-Variance semiparametric mixtures.
+"""
+
import math
from typing import TypedDict, Unpack
@@ -6,7 +12,7 @@
from numpy import _typing
from sympy import bell
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
MU_DEFAULT_VALUE = 0.1
SIGMA_DEFAULT_VALUE = 1.0
diff --git a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/mu_estimation.py b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/mu_estimation.py
index 9e2dad0..8bb0b7e 100644
--- a/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/mu_estimation.py
+++ b/src/algorithms/semiparam_algorithms/nvm_semi_param_algorithms/mu_estimation.py
@@ -1,3 +1,9 @@
+"""Mu estimation algorithm for NVM semiparametric mixtures.
+
+This module implements the estimation of mu parameter in Normal Mean-Variance
+semiparametric mixtures using binary search and Lipschitz continuous functions.
+"""
+
import math
from typing import Callable, Optional, TypedDict, Unpack
@@ -5,7 +11,7 @@
import numpy as np
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
+from estimators.estimate_result import EstimateResult
M_DEFAULT_VALUE = 1000
TOLERANCE_DEFAULT_VALUE = 10**-5
diff --git a/src/algorithms/support_algorithms/log_rqmc.py b/src/algorithms/support_algorithms/log_rqmc.py
index 4423294..664a50e 100644
--- a/src/algorithms/support_algorithms/log_rqmc.py
+++ b/src/algorithms/support_algorithms/log_rqmc.py
@@ -1,10 +1,16 @@
+"""Logarithmic Randomized Quasi-Monte Carlo (Log-RQMC) integration module.
+
+This module provides the LogRQMC class for numerical integration of
+logarithmic functions using randomized quasi-Monte Carlo methods.
+"""
+
from typing import Callable
import numpy as np
import numpy._typing as tpg
import scipy
-from src.algorithms.support_algorithms.rqmc import RQMC
+from algorithms.support_algorithms.rqmc import RQMC
class LogRQMC(RQMC):
diff --git a/src/algorithms/support_algorithms/rqmc.py b/src/algorithms/support_algorithms/rqmc.py
index 4b10c9d..7b68f75 100644
--- a/src/algorithms/support_algorithms/rqmc.py
+++ b/src/algorithms/support_algorithms/rqmc.py
@@ -1,9 +1,23 @@
+"""Randomized Quasi-Monte Carlo (RQMC) integration module.
+
+This module provides the RQMC class for numerical integration using
+randomized quasi-Monte Carlo methods with error estimation and adaptive
+refinement capabilities.
+"""
+
from typing import Callable
import numpy as np
import numpy._typing as tpg
import scipy
-from numba import njit
+
+try:
+ from numba import njit
+except ImportError:
+ def njit(*args: object, **kwargs: object) -> Callable:
+ def wrapper(f: Callable) -> Callable:
+ return f
+ return wrapper
BITS = 30
"""Number of bits in XOR. Should be less than 64"""
@@ -12,7 +26,7 @@
class RQMC:
- """Randomize Quasi Monte Carlo Method
+ """Randomized Quasi-Monte Carlo integration class.
Args:
func: integrated function
@@ -22,6 +36,8 @@ class RQMC:
i_max: allowed number of cycles
a: parameter for quantile of normal distribution
+ Returns: approximation for integral of function from 0 to 1
+
"""
def __init__(
diff --git a/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/__init__.py b/src/estimators/__init__.py
similarity index 100%
rename from tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/__init__.py
rename to src/estimators/__init__.py
diff --git a/src/estimators/abstract_estimator.py b/src/estimators/abstract_estimator.py
index 5afaea2..bd1c328 100644
--- a/src/estimators/abstract_estimator.py
+++ b/src/estimators/abstract_estimator.py
@@ -1,10 +1,16 @@
+"""Abstract estimator base class module.
+
+This module defines the AbstractEstimator base class that provides
+common functionality for all parametric and semiparametric estimators.
+"""
+
from typing import Self
from numpy import _typing
-from src.algorithms import ALGORITHM_REGISTRY
-from src.estimators.estimate_result import EstimateResult
-from src.register.algorithm_purpose import AlgorithmPurpose
+from algorithms import ALGORITHM_REGISTRY
+from estimators.estimate_result import EstimateResult
+from register.algorithm_purpose import AlgorithmPurpose
class AbstractEstimator:
diff --git a/src/estimators/estimate_result.py b/src/estimators/estimate_result.py
index cdd4dfb..66b665e 100644
--- a/src/estimators/estimate_result.py
+++ b/src/estimators/estimate_result.py
@@ -1,3 +1,9 @@
+"""Estimate result data structure module.
+
+This module defines the EstimateResult dataclass for storing
+estimation results and metadata.
+"""
+
from dataclasses import dataclass, field
from typing import List
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/__init__.py b/src/estimators/parametric/__init__.py
similarity index 100%
rename from tests/algorithms/nmv_algorithms/semiparametric_g_estimation/__init__.py
rename to src/estimators/parametric/__init__.py
diff --git a/src/estimators/parametric/abstract_parametric_estimator.py b/src/estimators/parametric/abstract_parametric_estimator.py
index 7951e4e..f9bee9e 100644
--- a/src/estimators/parametric/abstract_parametric_estimator.py
+++ b/src/estimators/parametric/abstract_parametric_estimator.py
@@ -1,7 +1,13 @@
+"""Abstract parametric estimator base class module.
+
+This module defines the AbstractParametricEstimator base class
+for parametric estimation algorithms.
+"""
+
from numpy import _typing
-from src.estimators.abstract_estimator import AbstractEstimator
-from src.estimators.estimate_result import EstimateResult
+from estimators.abstract_estimator import AbstractEstimator
+from estimators.estimate_result import EstimateResult
class AbstractParametricEstimator(AbstractEstimator):
diff --git a/src/estimators/parametric/nm_parametric_estimator.py b/src/estimators/parametric/nm_parametric_estimator.py
index c505758..726992e 100644
--- a/src/estimators/parametric/nm_parametric_estimator.py
+++ b/src/estimators/parametric/nm_parametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Mean parametric estimator module.
+
+This module provides the NMParametricEstimator class for
+parametric estimation in Normal Mean mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NMParametricEstimator(AbstractParametricEstimator):
diff --git a/src/estimators/parametric/nmv_parametric_estimator.py b/src/estimators/parametric/nmv_parametric_estimator.py
index c80183c..35b533a 100644
--- a/src/estimators/parametric/nmv_parametric_estimator.py
+++ b/src/estimators/parametric/nmv_parametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Mean-Variance parametric estimator module.
+
+This module provides the NMVParametricEstimator class for
+parametric estimation in Normal Mean-Variance mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NMVParametricEstimator(AbstractParametricEstimator):
diff --git a/src/estimators/parametric/nv_parametric_estimator.py b/src/estimators/parametric/nv_parametric_estimator.py
index fc3e108..03fd335 100644
--- a/src/estimators/parametric/nv_parametric_estimator.py
+++ b/src/estimators/parametric/nv_parametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Variance parametric estimator module.
+
+This module provides the NVParametricEstimator class for
+parametric estimation in Normal Variance mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.parametric.abstract_parametric_estimator import AbstractParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NVParametricEstimator(AbstractParametricEstimator):
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/__init__.py b/src/estimators/semiparametric/__init__.py
similarity index 100%
rename from tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/__init__.py
rename to src/estimators/semiparametric/__init__.py
diff --git a/src/estimators/semiparametric/abstract_semiparametric_estimator.py b/src/estimators/semiparametric/abstract_semiparametric_estimator.py
index b26db4b..a1842c0 100644
--- a/src/estimators/semiparametric/abstract_semiparametric_estimator.py
+++ b/src/estimators/semiparametric/abstract_semiparametric_estimator.py
@@ -1,7 +1,13 @@
+"""Abstract semiparametric estimator base class module.
+
+This module defines the AbstractSemiParametricEstimator base class
+for semiparametric estimation algorithms.
+"""
+
from numpy import _typing
-from src.estimators.abstract_estimator import AbstractEstimator
-from src.estimators.estimate_result import EstimateResult
+from estimators.abstract_estimator import AbstractEstimator
+from estimators.estimate_result import EstimateResult
class AbstractSemiParametricEstimator(AbstractEstimator):
diff --git a/src/estimators/semiparametric/nm_semiparametric_estimator.py b/src/estimators/semiparametric/nm_semiparametric_estimator.py
index 958ec5c..2b4096e 100644
--- a/src/estimators/semiparametric/nm_semiparametric_estimator.py
+++ b/src/estimators/semiparametric/nm_semiparametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Mean semiparametric estimator module.
+
+This module provides the NMSemiParametricEstimator class for
+semiparametric estimation in Normal Mean mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NMSemiParametricEstimator(AbstractSemiParametricEstimator):
diff --git a/src/estimators/semiparametric/nmv_semiparametric_estimator.py b/src/estimators/semiparametric/nmv_semiparametric_estimator.py
index e1f456d..17efeb2 100644
--- a/src/estimators/semiparametric/nmv_semiparametric_estimator.py
+++ b/src/estimators/semiparametric/nmv_semiparametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Mean-Variance semiparametric estimator module.
+
+This module provides the NMVSemiParametricEstimator class for
+semiparametric estimation in Normal Mean-Variance mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NMVSemiParametricEstimator(AbstractSemiParametricEstimator):
diff --git a/src/estimators/semiparametric/nv_semiparametric_estimator.py b/src/estimators/semiparametric/nv_semiparametric_estimator.py
index 95f0ce5..ae04aa4 100644
--- a/src/estimators/semiparametric/nv_semiparametric_estimator.py
+++ b/src/estimators/semiparametric/nv_semiparametric_estimator.py
@@ -1,8 +1,14 @@
+"""Normal Variance semiparametric estimator module.
+
+This module provides the NVSemiParametricEstimator class for
+semiparametric estimation in Normal Variance mixtures.
+"""
+
from numpy import _typing
-from src.estimators.estimate_result import EstimateResult
-from src.estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
-from src.register.algorithm_purpose import AlgorithmPurpose
+from estimators.estimate_result import EstimateResult
+from estimators.semiparametric.abstract_semiparametric_estimator import AbstractSemiParametricEstimator
+from register.algorithm_purpose import AlgorithmPurpose
class NVSemiParametricEstimator(AbstractSemiParametricEstimator):
diff --git a/tests/algorithms/nv_algorithms/__init__.py b/src/generators/__init__.py
similarity index 100%
rename from tests/algorithms/nv_algorithms/__init__.py
rename to src/generators/__init__.py
diff --git a/src/generators/abstract_generator.py b/src/generators/abstract_generator.py
index da0ad33..009ce36 100644
--- a/src/generators/abstract_generator.py
+++ b/src/generators/abstract_generator.py
@@ -1,8 +1,14 @@
+"""Abstract generator base class module.
+
+This module defines the AbstractGenerator base class for generating
+samples from various mixture distributions.
+"""
+
from abc import abstractmethod
import numpy._typing as tpg
-from src.mixtures.abstract_mixture import AbstractMixtures
+from mixtures.abstract_mixture import AbstractMixtures
class AbstractGenerator:
diff --git a/src/generators/nm_generator.py b/src/generators/nm_generator.py
index 4c95b0f..c9af059 100644
--- a/src/generators/nm_generator.py
+++ b/src/generators/nm_generator.py
@@ -1,9 +1,15 @@
+"""Normal Mean (NM) generator module.
+
+This module provides generators for Normal Mean mixtures
+in both classical and canonical forms.
+"""
+
import numpy._typing as tpg
import scipy
-from src.generators.abstract_generator import AbstractGenerator
-from src.mixtures.abstract_mixture import AbstractMixtures
-from src.mixtures.nm_mixture import NormalMeanMixtures
+from generators.abstract_generator import AbstractGenerator
+from mixtures.abstract_mixture import AbstractMixtures
+from mixtures.nm_mixture import NormalMeanMixtures
class NMGenerator(AbstractGenerator):
diff --git a/src/generators/nmv_generator.py b/src/generators/nmv_generator.py
index 5ff3221..5fcc0ef 100644
--- a/src/generators/nmv_generator.py
+++ b/src/generators/nmv_generator.py
@@ -1,9 +1,15 @@
+"""Normal Mean-Variance (NMV) generator module.
+
+This module provides generators for Normal Mean-Variance mixtures
+in both classical and canonical forms.
+"""
+
import numpy._typing as tpg
import scipy
-from src.generators.abstract_generator import AbstractGenerator
-from src.mixtures.abstract_mixture import AbstractMixtures
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from generators.abstract_generator import AbstractGenerator
+from mixtures.abstract_mixture import AbstractMixtures
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
class NMVGenerator(AbstractGenerator):
diff --git a/src/generators/nv_generator.py b/src/generators/nv_generator.py
index faa55f5..1c476ec 100644
--- a/src/generators/nv_generator.py
+++ b/src/generators/nv_generator.py
@@ -1,9 +1,15 @@
+"""Normal Variance (NV) generator module.
+
+This module provides generators for Normal Variance mixtures
+in both classical and canonical forms.
+"""
+
import numpy._typing as tpg
import scipy
-from src.generators.abstract_generator import AbstractGenerator
-from src.mixtures.abstract_mixture import AbstractMixtures
-from src.mixtures.nv_mixture import NormalVarianceMixtures
+from generators.abstract_generator import AbstractGenerator
+from mixtures.abstract_mixture import AbstractMixtures
+from mixtures.nv_mixture import NormalVarianceMixtures
class NVGenerator(AbstractGenerator):
diff --git a/src/mixtures/__init__.py b/src/mixtures/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/mixtures/abstract_mixture.py b/src/mixtures/abstract_mixture.py
index 13c8e42..c479b6e 100644
--- a/src/mixtures/abstract_mixture.py
+++ b/src/mixtures/abstract_mixture.py
@@ -1,3 +1,9 @@
+"""Abstract mixture base class module.
+
+This module defines the AbstractMixtures base class for various
+mixture distribution implementations.
+"""
+
from abc import ABCMeta, abstractmethod
from dataclasses import fields
from typing import Any
diff --git a/src/mixtures/nm_mixture.py b/src/mixtures/nm_mixture.py
index 33c7580..88b9639 100644
--- a/src/mixtures/nm_mixture.py
+++ b/src/mixtures/nm_mixture.py
@@ -1,3 +1,9 @@
+"""Normal Mean (NM) mixture module.
+
+This module provides the NormalMeanMixtures class for Normal Mean
+mixture distributions in classical and canonical forms.
+"""
+
from dataclasses import dataclass
from typing import Any
@@ -7,9 +13,9 @@
from scipy.stats import norm, rv_continuous
from scipy.stats.distributions import rv_frozen
-from src.algorithms.support_algorithms.log_rqmc import LogRQMC
-from src.algorithms.support_algorithms.rqmc import RQMC
-from src.mixtures.abstract_mixture import AbstractMixtures
+from algorithms.support_algorithms.log_rqmc import LogRQMC
+from algorithms.support_algorithms.rqmc import RQMC
+from mixtures.abstract_mixture import AbstractMixtures
@dataclass
@@ -147,11 +153,11 @@ def _classical_compute_cdf(self, x: float, params: dict) -> tuple[float, float]:
return rqmc()
def compute_cdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Choose equation for cdf estimation depends on Mixture form
+ """Choose equation for cdf estimation depends on Mixture form.
+
Args:
- x (): point
- params (): parameters of RQMC algorithm
+ x: point
+ params: parameters of RQMC algorithm
Returns: Computed pdf and error tolerance
@@ -161,11 +167,11 @@ def compute_cdf(self, x: float, params: dict) -> tuple[float, float]:
return self._classical_compute_cdf(x, params)
def _canonical_compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Equation for canonical pdf
+ """Equation for canonical pdf.
+
Args:
- x (): point
- params (): parameters of RQMC algorithm
+ x: point
+ params: parameters of RQMC algorithm
Returns: computed pdf and error tolerance
@@ -178,11 +184,11 @@ def _canonical_compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
return rqmc()
def _classical_compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Equation for classic pdf
+ """Equation for classic pdf.
+
Args:
- x (): point
- params (): parameters of RQMC algorithm
+ x: point
+ params: parameters of RQMC algorithm
Returns: computed pdf and error tolerance
@@ -197,11 +203,11 @@ def _classical_compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
return rqmc()
def compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Choose equation for pdf estimation depends on Mixture form
+ """Choose equation for pdf estimation depends on Mixture form.
+
Args:
- x (): point
- params (): parameters of RQMC algorithm
+ x: point
+ params: parameters of RQMC algorithm
Returns: Computed pdf and error tolerance
@@ -211,11 +217,11 @@ def compute_pdf(self, x: float, params: dict) -> tuple[float, float]:
return self._classical_compute_pdf(x, params)
def _classical_compute_log_pdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Equation for classic log pdf
+ """Equation for classic log pdf.
+
Args:
- x (): point
- params (): parameters of LogRQMC algorithm
+ x: point
+ params: parameters of LogRQMC algorithm
Returns: computed log pdf and error tolerance
@@ -230,11 +236,11 @@ def _classical_compute_log_pdf(self, x: float, params: dict) -> tuple[float, flo
return rqmc()
def _canonical_compute_log_pdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Equation for canonical log pdf
+ """Equation for canonical log pdf.
+
Args:
- x (): point
- params (): parameters of LogRQMC algorithm
+ x: point
+ params: parameters of LogRQMC algorithm
Returns: computed log pdf and error tolerance
@@ -247,11 +253,11 @@ def _canonical_compute_log_pdf(self, x: float, params: dict) -> tuple[float, flo
return rqmc()
def compute_logpdf(self, x: float, params: dict) -> tuple[float, float]:
- """
- Choose equation for log pdf estimation depends on Mixture form
+ """Choose equation for log pdf estimation depends on Mixture form.
+
Args:
- x (): point
- params (): parameters of LogRQMC algorithm
+ x: point
+ params: parameters of LogRQMC algorithm
Returns: Computed log pdf and error tolerance
diff --git a/src/mixtures/nmv_mixture.py b/src/mixtures/nmv_mixture.py
index c090ff3..38475ee 100644
--- a/src/mixtures/nmv_mixture.py
+++ b/src/mixtures/nmv_mixture.py
@@ -1,3 +1,9 @@
+"""Normal Mean-Variance (NMV) mixture module.
+
+This module provides the NormalMeanVarianceMixtures class for Normal Mean-Variance
+mixture distributions in classical and canonical forms.
+"""
+
from dataclasses import dataclass
from functools import lru_cache
from typing import Any
@@ -7,9 +13,9 @@
from scipy.stats import geninvgauss, norm, rv_continuous
from scipy.stats.distributions import rv_frozen
-from src.algorithms.support_algorithms.log_rqmc import LogRQMC
-from src.algorithms.support_algorithms.rqmc import RQMC
-from src.mixtures.abstract_mixture import AbstractMixtures
+from algorithms.support_algorithms.log_rqmc import LogRQMC
+from algorithms.support_algorithms.rqmc import RQMC
+from mixtures.abstract_mixture import AbstractMixtures
@dataclass
diff --git a/src/mixtures/nv_mixture.py b/src/mixtures/nv_mixture.py
index 7905e6e..02b13c7 100644
--- a/src/mixtures/nv_mixture.py
+++ b/src/mixtures/nv_mixture.py
@@ -1,3 +1,9 @@
+"""Normal Variance (NV) mixture module.
+
+This module provides the NormalVarianceMixtures class for Normal Variance
+mixture distributions in classical and canonical forms.
+"""
+
from dataclasses import dataclass
from functools import lru_cache
from typing import Any
@@ -7,9 +13,9 @@
from scipy.stats import norm, rv_continuous
from scipy.stats.distributions import rv_frozen
-from src.algorithms.support_algorithms.log_rqmc import LogRQMC
-from src.algorithms.support_algorithms.rqmc import RQMC
-from src.mixtures.abstract_mixture import AbstractMixtures
+from algorithms.support_algorithms.log_rqmc import LogRQMC
+from algorithms.support_algorithms.rqmc import RQMC
+from mixtures.abstract_mixture import AbstractMixtures
@dataclass
@@ -40,11 +46,12 @@ def __init__(self, mixture_form: str, **kwargs: Any) -> None:
super().__init__(mixture_form, **kwargs)
def compute_moment(self, n: int, params: dict) -> tuple[float, float]:
- """
- Compute n-th moment of NVM
+ """Compute n-th moment of NVM.
+
Args:
- n (): Moment ordinal
- params (): Parameters of integration algorithm
+ n: Moment ordinal
+ params: Parameters of integration algorithm
+
Returns: moment approximation and error tolerance
"""
gamma = self.params.gamma if isinstance(self.params, _NVMClassicDataCollector) else 1
diff --git a/src/pysatl_nmvm.egg-info/PKG-INFO b/src/pysatl_nmvm.egg-info/PKG-INFO
new file mode 100644
index 0000000..b346676
--- /dev/null
+++ b/src/pysatl_nmvm.egg-info/PKG-INFO
@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: pysatl-nmvm
+Version: 0.1.0
+Summary: PySATL NMVM Module
+Author: Engelsgeduld, Andreev Sergey, Sazonova Irina
+Requires-Python: >=3.8
+License-File: LICENSE
+Dynamic: license-file
diff --git a/src/pysatl_nmvm.egg-info/SOURCES.txt b/src/pysatl_nmvm.egg-info/SOURCES.txt
new file mode 100644
index 0000000..be205f8
--- /dev/null
+++ b/src/pysatl_nmvm.egg-info/SOURCES.txt
@@ -0,0 +1,26 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+src/algorithms/__init__.py
+src/estimators/__init__.py
+src/estimators/abstract_estimator.py
+src/estimators/estimate_result.py
+src/generators/__init__.py
+src/generators/abstract_generator.py
+src/generators/nm_generator.py
+src/generators/nmv_generator.py
+src/generators/nv_generator.py
+src/mixtures/__init__.py
+src/mixtures/abstract_mixture.py
+src/mixtures/nm_mixture.py
+src/mixtures/nmv_mixture.py
+src/mixtures/nv_mixture.py
+src/pysatl_nmvm.egg-info/PKG-INFO
+src/pysatl_nmvm.egg-info/SOURCES.txt
+src/pysatl_nmvm.egg-info/dependency_links.txt
+src/pysatl_nmvm.egg-info/top_level.txt
+src/register/__init__.py
+src/register/algorithm_purpose.py
+src/register/register.py
+tests/test_init.py
\ No newline at end of file
diff --git a/src/pysatl_nmvm.egg-info/dependency_links.txt b/src/pysatl_nmvm.egg-info/dependency_links.txt
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/src/pysatl_nmvm.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/src/pysatl_nmvm.egg-info/top_level.txt b/src/pysatl_nmvm.egg-info/top_level.txt
new file mode 100644
index 0000000..b029a33
--- /dev/null
+++ b/src/pysatl_nmvm.egg-info/top_level.txt
@@ -0,0 +1,5 @@
+algorithms
+estimators
+generators
+mixtures
+register
diff --git a/src/register/__init__.py b/src/register/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/register/algorithm_purpose.py b/src/register/algorithm_purpose.py
index 9b1aaec..9e15507 100644
--- a/src/register/algorithm_purpose.py
+++ b/src/register/algorithm_purpose.py
@@ -1,3 +1,9 @@
+"""Algorithm purpose enumeration module.
+
+This module defines the AlgorithmPurpose enum that specifies
+the purpose and type of estimation algorithms.
+"""
+
import enum
diff --git a/src/register/register.py b/src/register/register.py
index 983bba8..7f52c80 100644
--- a/src/register/register.py
+++ b/src/register/register.py
@@ -1,6 +1,6 @@
from typing import Callable, Generic, Optional, Tuple, Type, TypeVar
-from src.register.algorithm_purpose import AlgorithmPurpose
+from register.algorithm_purpose import AlgorithmPurpose
T = TypeVar("T")
@@ -19,12 +19,11 @@ def __init__(self, default: Optional[Type[T]] = None) -> None:
self.register_of_names: dict[Tuple[str, AlgorithmPurpose], Type[T]] = {}
def register(self, name: str, purpose: AlgorithmPurpose) -> Callable:
- """Register new object
+ """Register new object.
Args:
name: Class name
- purpose: Purpose of the algorithm ("NMParametric, NVParametric, NMVParametric,
- NMSemiparametric, NVSemiparametric, NMVSemiparametric")
+ purpose: Purpose of the algorithm ("NMParametric, NVParametric, NMVParametric, NMSemiparametric, NVSemiparametric, NMVSemiparametric")
Returns: Decorator function
@@ -44,12 +43,11 @@ def decorator(cls: Type[T]) -> Type[T]:
return decorator
def dispatch(self, name: str, purpose: AlgorithmPurpose) -> Type[T]:
- """Find object by name
+ """Find object by name.
Args:
name: Class name
- purpose: Purpose of the algorithm ("NMParametric, NVParametric, NMVParametric,
- NMSemiparametric, NVSemiparametric, NMVSemiparametric")
+ purpose: Purpose of the algorithm ("NMParametric, NVParametric, NMVParametric, NMSemiparametric, NVSemiparametric, NMVSemiparametric")
Returns: object
diff --git a/tests/__init__.py b/tests/__init__.py
index e69de29..0519ecb 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/tests/algorithms/__init__.py b/tests/algorithms/__init__.py
index e69de29..0519ecb 100644
--- a/tests/algorithms/__init__.py
+++ b/tests/algorithms/__init__.py
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_eigenvalue_based.py b/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_eigenvalue_based.py
index eb00242..26cd3a7 100644
--- a/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_eigenvalue_based.py
+++ b/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_eigenvalue_based.py
@@ -4,9 +4,9 @@
import pytest
from scipy.stats import expon, uniform
-from src.estimators.semiparametric.nm_semiparametric_estimator import NMSemiParametricEstimator
-from src.generators.nm_generator import NMGenerator
-from src.mixtures.nm_mixture import NormalMeanMixtures
+from estimators.semiparametric.nm_semiparametric_estimator import NMSemiParametricEstimator
+from generators.nm_generator import NMGenerator
+from mixtures.nm_mixture import NormalMeanMixtures
class TestSemiParametricSigmaEstimationEigenvalueBased:
diff --git a/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_empirical.py b/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_empirical.py
index daf5a7f..e3704cf 100644
--- a/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_empirical.py
+++ b/tests/algorithms/nm_algorithms/semiparametric_sigma_estimation/test_sigma_estimation_empirical.py
@@ -1,11 +1,12 @@
import math
+import numpy as np
import pytest
from scipy.stats import expon, uniform
-from src.estimators.semiparametric.nm_semiparametric_estimator import NMSemiParametricEstimator
-from src.generators.nm_generator import NMGenerator
-from src.mixtures.nm_mixture import NormalMeanMixtures
+from estimators.semiparametric.nm_semiparametric_estimator import NMSemiParametricEstimator
+from generators.nm_generator import NMGenerator
+from mixtures.nm_mixture import NormalMeanMixtures
class TestSemiParametricSigmaEstimationEmpirical:
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_g_estimation_given_mu.py b/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_g_estimation_given_mu.py
index d1f40e0..a8d0a50 100644
--- a/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_g_estimation_given_mu.py
+++ b/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_g_estimation_given_mu.py
@@ -1,11 +1,12 @@
+import numpy as np
import math
import pytest
-from scipy.stats import expon, gamma
+from scipy.stats import expon, gamma, uniform
-from src.estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
-from src.generators.nmv_generator import NMVGenerator
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
+from generators.nmv_generator import NMVGenerator
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
class TestSemiParametricMixingDensityEstimationGivenMu:
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_post_widder.py b/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_post_widder.py
index 2e8d4b3..25a4f8c 100644
--- a/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_post_widder.py
+++ b/tests/algorithms/nmv_algorithms/semiparametric_g_estimation/test_post_widder.py
@@ -1,11 +1,11 @@
import numpy as np
import pytest
from mpmath import ln
-from scipy.stats import expon, gamma
+from scipy.stats import expon, gamma, uniform
-from src.estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
-from src.generators.nmv_generator import NMVGenerator
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
+from generators.nmv_generator import NMVGenerator
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
class TestPostWidder:
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_semiparametric_mu_estimation.py b/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_semiparametric_mu_estimation.py
index f1736f8..0e61632 100644
--- a/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_semiparametric_mu_estimation.py
+++ b/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_semiparametric_mu_estimation.py
@@ -1,11 +1,12 @@
import math
+import numpy as np
import pytest
-from scipy.stats import expon, gamma, halfnorm, pareto
+from scipy.stats import expon, gamma, halfnorm, pareto, uniform
-from src.estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
-from src.generators.nmv_generator import NMVGenerator
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from estimators.semiparametric.nmv_semiparametric_estimator import NMVSemiParametricEstimator
+from generators.nmv_generator import NMVGenerator
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
class TestSemiParametricMuEstimation:
diff --git a/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_validate_kwargs.py b/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_validate_kwargs.py
index 781caf5..173cb34 100644
--- a/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_validate_kwargs.py
+++ b/tests/algorithms/nmv_algorithms/semiparametric_mu_estimation/test_validate_kwargs.py
@@ -3,7 +3,7 @@
import numpy as np
import pytest
-from src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation import SemiParametricMuEstimation
+from algorithms.semiparam_algorithms.nvm_semi_param_algorithms.mu_estimation import SemiParametricMuEstimation
def _test_omega(x: float) -> float:
diff --git a/tests/algorithms/nv_algorithms/test_g_estimation.py b/tests/algorithms/nv_algorithms/test_g_estimation.py
index f618be5..9eb64a9 100644
--- a/tests/algorithms/nv_algorithms/test_g_estimation.py
+++ b/tests/algorithms/nv_algorithms/test_g_estimation.py
@@ -2,11 +2,11 @@
import numpy as np
import pytest
-from scipy.stats import expon
+from scipy.stats import expon, uniform
-from src.estimators.semiparametric.nv_semiparametric_estimator import NVSemiParametricEstimator
-from src.generators.nv_generator import NVGenerator
-from src.mixtures.nv_mixture import NormalVarianceMixtures
+from estimators.semiparametric.nv_semiparametric_estimator import NVSemiParametricEstimator
+from generators.nv_generator import NVGenerator
+from mixtures.nv_mixture import NormalVarianceMixtures
class TestSemiParametricMixingDensityEstimationNV:
diff --git a/tests/algorithms/nv_algorithms/test_post_widder_nv.py b/tests/algorithms/nv_algorithms/test_post_widder_nv.py
index e2fdee3..f0e741a 100644
--- a/tests/algorithms/nv_algorithms/test_post_widder_nv.py
+++ b/tests/algorithms/nv_algorithms/test_post_widder_nv.py
@@ -1,11 +1,11 @@
import numpy as np
import pytest
from mpmath import ln
-from scipy.stats import expon, gamma
+from scipy.stats import expon, gamma, uniform
-from src.estimators.semiparametric.nv_semiparametric_estimator import NVSemiParametricEstimator
-from src.generators.nv_generator import NVGenerator
-from src.mixtures.nv_mixture import NormalVarianceMixtures
+from estimators.semiparametric.nv_semiparametric_estimator import NVSemiParametricEstimator
+from generators.nv_generator import NVGenerator
+from mixtures.nv_mixture import NormalVarianceMixtures
class TestPostWidderNV:
diff --git a/tests/algorithms/support_algorithms/test_rqmc.py b/tests/algorithms/support_algorithms/test_rqmc.py
index b5b6558..28e6cc0 100644
--- a/tests/algorithms/support_algorithms/test_rqmc.py
+++ b/tests/algorithms/support_algorithms/test_rqmc.py
@@ -3,7 +3,7 @@
import numpy as np
import pytest
-from src.algorithms.support_algorithms.rqmc import RQMC
+from algorithms.support_algorithms.rqmc import RQMC
def loss_func(true_func: Callable, rqms: Callable, count: int):
diff --git a/tests/generators/__init__.py b/tests/generators/__init__.py
new file mode 100644
index 0000000..0519ecb
--- /dev/null
+++ b/tests/generators/__init__.py
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/tests/generators/nm_generator/test_mixing_normal.py b/tests/generators/nm_generator/test_mixing_normal.py
index ea85692..14522e3 100644
--- a/tests/generators/nm_generator/test_mixing_normal.py
+++ b/tests/generators/nm_generator/test_mixing_normal.py
@@ -1,10 +1,10 @@
import numpy as np
import pytest
from scipy import ndimage
-from scipy.stats import norm
+from scipy.stats import norm, expon, uniform
-from src.generators.nm_generator import NMGenerator
-from src.mixtures.nm_mixture import *
+from generators.nm_generator import NMGenerator
+from mixtures.nm_mixture import *
class TestMixingNormal:
diff --git a/tests/generators/nm_generator/test_nm_params_validator.py b/tests/generators/nm_generator/test_nm_params_validator.py
index 680cc97..71ecd9b 100644
--- a/tests/generators/nm_generator/test_nm_params_validator.py
+++ b/tests/generators/nm_generator/test_nm_params_validator.py
@@ -1,7 +1,7 @@
import pytest
from scipy.stats import norm
-from src.mixtures.nm_mixture import NormalMeanMixtures
+from mixtures.nm_mixture import NormalMeanMixtures
@pytest.mark.ci
diff --git a/tests/generators/nmv_generator/test_nmv_params_validator.py b/tests/generators/nmv_generator/test_nmv_params_validator.py
index 66f92eb..cc2ad8b 100644
--- a/tests/generators/nmv_generator/test_nmv_params_validator.py
+++ b/tests/generators/nmv_generator/test_nmv_params_validator.py
@@ -1,7 +1,7 @@
import pytest
from scipy.stats import norm
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
@pytest.mark.ci
diff --git a/tests/generators/nv_generator/test_nv_params_validator.py b/tests/generators/nv_generator/test_nv_params_validator.py
index 7b2a700..ec378c2 100644
--- a/tests/generators/nv_generator/test_nv_params_validator.py
+++ b/tests/generators/nv_generator/test_nv_params_validator.py
@@ -1,7 +1,7 @@
import pytest
from scipy.stats import norm
-from src.mixtures.nv_mixture import NormalVarianceMixtures
+from mixtures.nv_mixture import NormalVarianceMixtures
@pytest.mark.ci
diff --git a/tests/mixtures/__init__.py b/tests/mixtures/__init__.py
new file mode 100644
index 0000000..0519ecb
--- /dev/null
+++ b/tests/mixtures/__init__.py
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/tests/mixtures/nm_mixture/test_nm_mixture.py b/tests/mixtures/nm_mixture/test_nm_mixture.py
index c860973..939f5ce 100644
--- a/tests/mixtures/nm_mixture/test_nm_mixture.py
+++ b/tests/mixtures/nm_mixture/test_nm_mixture.py
@@ -2,10 +2,10 @@
import numpy as np
import pytest
-from scipy.stats import halfnorm, norm, skewnorm
+from scipy.stats import halfnorm, norm, skewnorm, expon, uniform
from sklearn.metrics import mean_absolute_error
-from src.mixtures.nm_mixture import NormalMeanMixtures, _NMMCanonicalDataCollector, _NMMClassicDataCollector
+from mixtures.nm_mixture import NormalMeanMixtures, _NMMCanonicalDataCollector, _NMMClassicDataCollector
def create_mixture_and_grid(params):
diff --git a/tests/mixtures/nmv_mixture/test_nmvm_mixture.py b/tests/mixtures/nmv_mixture/test_nmvm_mixture.py
index bdb1157..6f94a27 100644
--- a/tests/mixtures/nmv_mixture/test_nmvm_mixture.py
+++ b/tests/mixtures/nmv_mixture/test_nmvm_mixture.py
@@ -2,10 +2,10 @@
import numpy as np
import pytest
-from scipy.stats import genhyperbolic, geninvgauss
+from scipy.stats import genhyperbolic, geninvgauss, expon, uniform
from sklearn.metrics import mean_absolute_error
-from src.mixtures.nmv_mixture import NormalMeanVarianceMixtures
+from mixtures.nmv_mixture import NormalMeanVarianceMixtures
def get_datasets(mixture_func, distribution_func, values):
diff --git a/tests/mixtures/nv_mixture/test_nv_mixture.py b/tests/mixtures/nv_mixture/test_nv_mixture.py
index 12b530a..b3ce145 100644
--- a/tests/mixtures/nv_mixture/test_nv_mixture.py
+++ b/tests/mixtures/nv_mixture/test_nv_mixture.py
@@ -2,10 +2,10 @@
import numpy as np
import pytest
-from scipy.stats import invgamma, t
+from scipy.stats import invgamma, t, expon, uniform
from sklearn.metrics import mean_absolute_error
-from src.mixtures.nv_mixture import NormalVarianceMixtures
+from mixtures.nv_mixture import NormalVarianceMixtures
def get_datasets(mixture_func, distribution_func, values):
